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 (w
, area
, top_left_x
, top_left_y
,
1315 bottom_right_x
, bottom_right_y
)
1318 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1320 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1322 *bottom_right_x
+= *top_left_x
;
1323 *bottom_right_y
+= *top_left_y
;
1328 /***********************************************************************
1330 ***********************************************************************/
1332 /* Return the bottom y-position of the line the iterator IT is in.
1333 This can modify IT's settings. */
1336 line_bottom_y (struct it
*it
)
1338 int line_height
= it
->max_ascent
+ it
->max_descent
;
1339 int line_top_y
= it
->current_y
;
1341 if (line_height
== 0)
1344 line_height
= last_height
;
1345 else if (IT_CHARPOS (*it
) < ZV
)
1347 move_it_by_lines (it
, 1, 1);
1348 line_height
= (it
->max_ascent
|| it
->max_descent
1349 ? it
->max_ascent
+ it
->max_descent
1354 struct glyph_row
*row
= it
->glyph_row
;
1356 /* Use the default character height. */
1357 it
->glyph_row
= NULL
;
1358 it
->what
= IT_CHARACTER
;
1361 PRODUCE_GLYPHS (it
);
1362 line_height
= it
->ascent
+ it
->descent
;
1363 it
->glyph_row
= row
;
1367 return line_top_y
+ line_height
;
1371 /* Return 1 if position CHARPOS is visible in window W.
1372 CHARPOS < 0 means return info about WINDOW_END position.
1373 If visible, set *X and *Y to pixel coordinates of top left corner.
1374 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1375 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1378 pos_visible_p (struct window
*w
, int charpos
, int *x
, int *y
,
1379 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1382 struct text_pos top
;
1384 struct buffer
*old_buffer
= NULL
;
1386 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1389 if (XBUFFER (w
->buffer
) != current_buffer
)
1391 old_buffer
= current_buffer
;
1392 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1395 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1397 /* Compute exact mode line heights. */
1398 if (WINDOW_WANTS_MODELINE_P (w
))
1399 current_mode_line_height
1400 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1401 current_buffer
->mode_line_format
);
1403 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1404 current_header_line_height
1405 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1406 current_buffer
->header_line_format
);
1408 start_display (&it
, w
, top
);
1409 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1410 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1412 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1414 /* We have reached CHARPOS, or passed it. How the call to
1415 move_it_to can overshoot: (i) If CHARPOS is on invisible
1416 text, move_it_to stops at the end of the invisible text,
1417 after CHARPOS. (ii) If CHARPOS is in a display vector,
1418 move_it_to stops on its last glyph. */
1419 int top_x
= it
.current_x
;
1420 int top_y
= it
.current_y
;
1421 enum it_method it_method
= it
.method
;
1422 /* Calling line_bottom_y may change it.method, it.position, etc. */
1423 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1424 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1426 if (top_y
< window_top_y
)
1427 visible_p
= bottom_y
> window_top_y
;
1428 else if (top_y
< it
.last_visible_y
)
1432 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1434 /* We stopped on the last glyph of a display vector.
1435 Try and recompute. Hack alert! */
1436 if (charpos
< 2 || top
.charpos
>= charpos
)
1437 top_x
= it
.glyph_row
->x
;
1441 start_display (&it2
, w
, top
);
1442 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1443 get_next_display_element (&it2
);
1444 PRODUCE_GLYPHS (&it2
);
1445 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1446 || it2
.current_x
> it2
.last_visible_x
)
1447 top_x
= it
.glyph_row
->x
;
1450 top_x
= it2
.current_x
;
1451 top_y
= it2
.current_y
;
1457 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1458 *rtop
= max (0, window_top_y
- top_y
);
1459 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1460 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1461 - max (top_y
, window_top_y
)));
1470 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1471 move_it_by_lines (&it
, 1, 0);
1472 if (charpos
< IT_CHARPOS (it
)
1473 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1476 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1478 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1479 *rtop
= max (0, -it2
.current_y
);
1480 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1481 - it
.last_visible_y
));
1482 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1484 - max (it2
.current_y
,
1485 WINDOW_HEADER_LINE_HEIGHT (w
))));
1491 set_buffer_internal_1 (old_buffer
);
1493 current_header_line_height
= current_mode_line_height
= -1;
1495 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1496 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1499 /* Debugging code. */
1501 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1502 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1504 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1511 /* Return the next character from STR which is MAXLEN bytes long.
1512 Return in *LEN the length of the character. This is like
1513 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1514 we find one, we return a `?', but with the length of the invalid
1518 string_char_and_length (const unsigned char *str
, int *len
)
1522 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1523 if (!CHAR_VALID_P (c
, 1))
1524 /* We may not change the length here because other places in Emacs
1525 don't use this function, i.e. they silently accept invalid
1534 /* Given a position POS containing a valid character and byte position
1535 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1537 static struct text_pos
1538 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, int nchars
)
1540 xassert (STRINGP (string
) && nchars
>= 0);
1542 if (STRING_MULTIBYTE (string
))
1544 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1545 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1550 string_char_and_length (p
, &len
);
1551 p
+= len
, rest
-= len
;
1552 xassert (rest
>= 0);
1554 BYTEPOS (pos
) += len
;
1558 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1564 /* Value is the text position, i.e. character and byte position,
1565 for character position CHARPOS in STRING. */
1567 static INLINE
struct text_pos
1568 string_pos (int charpos
, Lisp_Object string
)
1570 struct text_pos pos
;
1571 xassert (STRINGP (string
));
1572 xassert (charpos
>= 0);
1573 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1578 /* Value is a text position, i.e. character and byte position, for
1579 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1580 means recognize multibyte characters. */
1582 static struct text_pos
1583 c_string_pos (int charpos
, unsigned char *s
, int multibyte_p
)
1585 struct text_pos pos
;
1587 xassert (s
!= NULL
);
1588 xassert (charpos
>= 0);
1592 int rest
= strlen (s
), len
;
1594 SET_TEXT_POS (pos
, 0, 0);
1597 string_char_and_length (s
, &len
);
1598 s
+= len
, rest
-= len
;
1599 xassert (rest
>= 0);
1601 BYTEPOS (pos
) += len
;
1605 SET_TEXT_POS (pos
, charpos
, charpos
);
1611 /* Value is the number of characters in C string S. MULTIBYTE_P
1612 non-zero means recognize multibyte characters. */
1615 number_of_chars (unsigned char *s
, int multibyte_p
)
1621 int rest
= strlen (s
), len
;
1622 unsigned char *p
= (unsigned char *) s
;
1624 for (nchars
= 0; rest
> 0; ++nchars
)
1626 string_char_and_length (p
, &len
);
1627 rest
-= len
, p
+= len
;
1631 nchars
= strlen (s
);
1637 /* Compute byte position NEWPOS->bytepos corresponding to
1638 NEWPOS->charpos. POS is a known position in string STRING.
1639 NEWPOS->charpos must be >= POS.charpos. */
1642 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1644 xassert (STRINGP (string
));
1645 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1647 if (STRING_MULTIBYTE (string
))
1648 *newpos
= string_pos_nchars_ahead (pos
, string
,
1649 CHARPOS (*newpos
) - CHARPOS (pos
));
1651 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1655 Return an estimation of the pixel height of mode or header lines on
1656 frame F. FACE_ID specifies what line's height to estimate. */
1659 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1661 #ifdef HAVE_WINDOW_SYSTEM
1662 if (FRAME_WINDOW_P (f
))
1664 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1666 /* This function is called so early when Emacs starts that the face
1667 cache and mode line face are not yet initialized. */
1668 if (FRAME_FACE_CACHE (f
))
1670 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1674 height
= FONT_HEIGHT (face
->font
);
1675 if (face
->box_line_width
> 0)
1676 height
+= 2 * face
->box_line_width
;
1687 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1688 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1689 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1690 not force the value into range. */
1693 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1694 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1697 #ifdef HAVE_WINDOW_SYSTEM
1698 if (FRAME_WINDOW_P (f
))
1700 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1701 even for negative values. */
1703 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1705 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1707 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1708 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1711 STORE_NATIVE_RECT (*bounds
,
1712 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1713 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1714 FRAME_COLUMN_WIDTH (f
) - 1,
1715 FRAME_LINE_HEIGHT (f
) - 1);
1721 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1722 pix_x
= FRAME_TOTAL_COLS (f
);
1726 else if (pix_y
> FRAME_LINES (f
))
1727 pix_y
= FRAME_LINES (f
);
1737 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1738 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1739 can't tell the positions because W's display is not up to date,
1743 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1744 int *frame_x
, int *frame_y
)
1746 #ifdef HAVE_WINDOW_SYSTEM
1747 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1751 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1752 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1754 if (display_completed
)
1756 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1757 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1758 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1764 hpos
+= glyph
->pixel_width
;
1768 /* If first glyph is partially visible, its first visible position is still 0. */
1780 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1781 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1792 #ifdef HAVE_WINDOW_SYSTEM
1794 /* Find the glyph under window-relative coordinates X/Y in window W.
1795 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1796 strings. Return in *HPOS and *VPOS the row and column number of
1797 the glyph found. Return in *AREA the glyph area containing X.
1798 Value is a pointer to the glyph found or null if X/Y is not on
1799 text, or we can't tell because W's current matrix is not up to
1804 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1805 int *dx
, int *dy
, int *area
)
1807 struct glyph
*glyph
, *end
;
1808 struct glyph_row
*row
= NULL
;
1811 /* Find row containing Y. Give up if some row is not enabled. */
1812 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1814 row
= MATRIX_ROW (w
->current_matrix
, i
);
1815 if (!row
->enabled_p
)
1817 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1824 /* Give up if Y is not in the window. */
1825 if (i
== w
->current_matrix
->nrows
)
1828 /* Get the glyph area containing X. */
1829 if (w
->pseudo_window_p
)
1836 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1838 *area
= LEFT_MARGIN_AREA
;
1839 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1841 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1844 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1848 *area
= RIGHT_MARGIN_AREA
;
1849 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1853 /* Find glyph containing X. */
1854 glyph
= row
->glyphs
[*area
];
1855 end
= glyph
+ row
->used
[*area
];
1857 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1859 x
-= glyph
->pixel_width
;
1869 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1872 *hpos
= glyph
- row
->glyphs
[*area
];
1878 Convert frame-relative x/y to coordinates relative to window W.
1879 Takes pseudo-windows into account. */
1882 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1884 if (w
->pseudo_window_p
)
1886 /* A pseudo-window is always full-width, and starts at the
1887 left edge of the frame, plus a frame border. */
1888 struct frame
*f
= XFRAME (w
->frame
);
1889 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1890 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1894 *x
-= WINDOW_LEFT_EDGE_X (w
);
1895 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1900 Return in RECTS[] at most N clipping rectangles for glyph string S.
1901 Return the number of stored rectangles. */
1904 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1911 if (s
->row
->full_width_p
)
1913 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1914 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1915 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1917 /* Unless displaying a mode or menu bar line, which are always
1918 fully visible, clip to the visible part of the row. */
1919 if (s
->w
->pseudo_window_p
)
1920 r
.height
= s
->row
->visible_height
;
1922 r
.height
= s
->height
;
1926 /* This is a text line that may be partially visible. */
1927 r
.x
= window_box_left (s
->w
, s
->area
);
1928 r
.width
= window_box_width (s
->w
, s
->area
);
1929 r
.height
= s
->row
->visible_height
;
1933 if (r
.x
< s
->clip_head
->x
)
1935 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1936 r
.width
-= s
->clip_head
->x
- r
.x
;
1939 r
.x
= s
->clip_head
->x
;
1942 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1944 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1945 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1950 /* If S draws overlapping rows, it's sufficient to use the top and
1951 bottom of the window for clipping because this glyph string
1952 intentionally draws over other lines. */
1953 if (s
->for_overlaps
)
1955 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1956 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1958 /* Alas, the above simple strategy does not work for the
1959 environments with anti-aliased text: if the same text is
1960 drawn onto the same place multiple times, it gets thicker.
1961 If the overlap we are processing is for the erased cursor, we
1962 take the intersection with the rectagle of the cursor. */
1963 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1965 XRectangle rc
, r_save
= r
;
1967 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1968 rc
.y
= s
->w
->phys_cursor
.y
;
1969 rc
.width
= s
->w
->phys_cursor_width
;
1970 rc
.height
= s
->w
->phys_cursor_height
;
1972 x_intersect_rectangles (&r_save
, &rc
, &r
);
1977 /* Don't use S->y for clipping because it doesn't take partially
1978 visible lines into account. For example, it can be negative for
1979 partially visible lines at the top of a window. */
1980 if (!s
->row
->full_width_p
1981 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1982 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1984 r
.y
= max (0, s
->row
->y
);
1987 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1989 /* If drawing the cursor, don't let glyph draw outside its
1990 advertised boundaries. Cleartype does this under some circumstances. */
1991 if (s
->hl
== DRAW_CURSOR
)
1993 struct glyph
*glyph
= s
->first_glyph
;
1998 r
.width
-= s
->x
- r
.x
;
2001 r
.width
= min (r
.width
, glyph
->pixel_width
);
2003 /* If r.y is below window bottom, ensure that we still see a cursor. */
2004 height
= min (glyph
->ascent
+ glyph
->descent
,
2005 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2006 max_y
= window_text_bottom_y (s
->w
) - height
;
2007 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2008 if (s
->ybase
- glyph
->ascent
> max_y
)
2015 /* Don't draw cursor glyph taller than our actual glyph. */
2016 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2017 if (height
< r
.height
)
2019 max_y
= r
.y
+ r
.height
;
2020 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2021 r
.height
= min (max_y
- r
.y
, height
);
2028 XRectangle r_save
= r
;
2030 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2034 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2035 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2037 #ifdef CONVERT_FROM_XRECT
2038 CONVERT_FROM_XRECT (r
, *rects
);
2046 /* If we are processing overlapping and allowed to return
2047 multiple clipping rectangles, we exclude the row of the glyph
2048 string from the clipping rectangle. This is to avoid drawing
2049 the same text on the environment with anti-aliasing. */
2050 #ifdef CONVERT_FROM_XRECT
2053 XRectangle
*rs
= rects
;
2055 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2057 if (s
->for_overlaps
& OVERLAPS_PRED
)
2060 if (r
.y
+ r
.height
> row_y
)
2063 rs
[i
].height
= row_y
- r
.y
;
2069 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2072 if (r
.y
< row_y
+ s
->row
->visible_height
)
2074 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2076 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2077 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2086 #ifdef CONVERT_FROM_XRECT
2087 for (i
= 0; i
< n
; i
++)
2088 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2095 Return in *NR the clipping rectangle for glyph string S. */
2098 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2100 get_glyph_string_clip_rects (s
, nr
, 1);
2105 Return the position and height of the phys cursor in window W.
2106 Set w->phys_cursor_width to width of phys cursor.
2110 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2111 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2113 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2114 int x
, y
, wd
, h
, h0
, y0
;
2116 /* Compute the width of the rectangle to draw. If on a stretch
2117 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2118 rectangle as wide as the glyph, but use a canonical character
2120 wd
= glyph
->pixel_width
- 1;
2121 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2125 x
= w
->phys_cursor
.x
;
2132 if (glyph
->type
== STRETCH_GLYPH
2133 && !x_stretch_cursor_p
)
2134 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2135 w
->phys_cursor_width
= wd
;
2137 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2139 /* If y is below window bottom, ensure that we still see a cursor. */
2140 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2142 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2143 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2145 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2148 h
= max (h
- (y0
- y
) + 1, h0
);
2153 y0
= window_text_bottom_y (w
) - h0
;
2161 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2162 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2167 * Remember which glyph the mouse is over.
2171 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2175 struct glyph_row
*r
, *gr
, *end_row
;
2176 enum window_part part
;
2177 enum glyph_row_area area
;
2178 int x
, y
, width
, height
;
2180 /* Try to determine frame pixel position and size of the glyph under
2181 frame pixel coordinates X/Y on frame F. */
2183 if (!f
->glyphs_initialized_p
2184 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2187 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2188 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2192 w
= XWINDOW (window
);
2193 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2194 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2196 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2197 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2199 if (w
->pseudo_window_p
)
2202 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2208 case ON_LEFT_MARGIN
:
2209 area
= LEFT_MARGIN_AREA
;
2212 case ON_RIGHT_MARGIN
:
2213 area
= RIGHT_MARGIN_AREA
;
2216 case ON_HEADER_LINE
:
2218 gr
= (part
== ON_HEADER_LINE
2219 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2220 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2223 goto text_glyph_row_found
;
2230 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2231 if (r
->y
+ r
->height
> y
)
2237 text_glyph_row_found
:
2240 struct glyph
*g
= gr
->glyphs
[area
];
2241 struct glyph
*end
= g
+ gr
->used
[area
];
2243 height
= gr
->height
;
2244 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2245 if (gx
+ g
->pixel_width
> x
)
2250 if (g
->type
== IMAGE_GLYPH
)
2252 /* Don't remember when mouse is over image, as
2253 image may have hot-spots. */
2254 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2257 width
= g
->pixel_width
;
2261 /* Use nominal char spacing at end of line. */
2263 gx
+= (x
/ width
) * width
;
2266 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2267 gx
+= window_box_left_offset (w
, area
);
2271 /* Use nominal line height at end of window. */
2272 gx
= (x
/ width
) * width
;
2274 gy
+= (y
/ height
) * height
;
2278 case ON_LEFT_FRINGE
:
2279 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2280 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2281 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2282 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2285 case ON_RIGHT_FRINGE
:
2286 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2287 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2288 : window_box_right_offset (w
, TEXT_AREA
));
2289 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2293 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2295 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2296 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2297 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2299 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2303 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2304 if (r
->y
+ r
->height
> y
)
2311 height
= gr
->height
;
2314 /* Use nominal line height at end of window. */
2316 gy
+= (y
/ height
) * height
;
2323 /* If there is no glyph under the mouse, then we divide the screen
2324 into a grid of the smallest glyph in the frame, and use that
2327 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2328 round down even for negative values. */
2334 gx
= (gx
/ width
) * width
;
2335 gy
= (gy
/ height
) * height
;
2340 gx
+= WINDOW_LEFT_EDGE_X (w
);
2341 gy
+= WINDOW_TOP_EDGE_Y (w
);
2344 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2346 /* Visible feedback for debugging. */
2349 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2350 f
->output_data
.x
->normal_gc
,
2351 gx
, gy
, width
, height
);
2357 #endif /* HAVE_WINDOW_SYSTEM */
2360 /***********************************************************************
2361 Lisp form evaluation
2362 ***********************************************************************/
2364 /* Error handler for safe_eval and safe_call. */
2367 safe_eval_handler (Lisp_Object arg
)
2369 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2374 /* Evaluate SEXPR and return the result, or nil if something went
2375 wrong. Prevent redisplay during the evaluation. */
2377 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2378 Return the result, or nil if something went wrong. Prevent
2379 redisplay during the evaluation. */
2382 safe_call (int nargs
, Lisp_Object
*args
)
2386 if (inhibit_eval_during_redisplay
)
2390 int count
= SPECPDL_INDEX ();
2391 struct gcpro gcpro1
;
2394 gcpro1
.nvars
= nargs
;
2395 specbind (Qinhibit_redisplay
, Qt
);
2396 /* Use Qt to ensure debugger does not run,
2397 so there is no possibility of wanting to redisplay. */
2398 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2401 val
= unbind_to (count
, val
);
2408 /* Call function FN with one argument ARG.
2409 Return the result, or nil if something went wrong. */
2412 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2414 Lisp_Object args
[2];
2417 return safe_call (2, args
);
2420 static Lisp_Object Qeval
;
2423 safe_eval (Lisp_Object sexpr
)
2425 return safe_call1 (Qeval
, sexpr
);
2428 /* Call function FN with one argument ARG.
2429 Return the result, or nil if something went wrong. */
2432 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2434 Lisp_Object args
[3];
2438 return safe_call (3, args
);
2443 /***********************************************************************
2445 ***********************************************************************/
2449 /* Define CHECK_IT to perform sanity checks on iterators.
2450 This is for debugging. It is too slow to do unconditionally. */
2456 if (it
->method
== GET_FROM_STRING
)
2458 xassert (STRINGP (it
->string
));
2459 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2463 xassert (IT_STRING_CHARPOS (*it
) < 0);
2464 if (it
->method
== GET_FROM_BUFFER
)
2466 /* Check that character and byte positions agree. */
2467 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2472 xassert (it
->current
.dpvec_index
>= 0);
2474 xassert (it
->current
.dpvec_index
< 0);
2477 #define CHECK_IT(IT) check_it ((IT))
2481 #define CHECK_IT(IT) (void) 0
2488 /* Check that the window end of window W is what we expect it
2489 to be---the last row in the current matrix displaying text. */
2492 check_window_end (w
)
2495 if (!MINI_WINDOW_P (w
)
2496 && !NILP (w
->window_end_valid
))
2498 struct glyph_row
*row
;
2499 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2500 XFASTINT (w
->window_end_vpos
)),
2502 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2503 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2507 #define CHECK_WINDOW_END(W) check_window_end ((W))
2509 #else /* not GLYPH_DEBUG */
2511 #define CHECK_WINDOW_END(W) (void) 0
2513 #endif /* not GLYPH_DEBUG */
2517 /***********************************************************************
2518 Iterator initialization
2519 ***********************************************************************/
2521 /* Initialize IT for displaying current_buffer in window W, starting
2522 at character position CHARPOS. CHARPOS < 0 means that no buffer
2523 position is specified which is useful when the iterator is assigned
2524 a position later. BYTEPOS is the byte position corresponding to
2525 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2527 If ROW is not null, calls to produce_glyphs with IT as parameter
2528 will produce glyphs in that row.
2530 BASE_FACE_ID is the id of a base face to use. It must be one of
2531 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2532 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2533 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2535 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2536 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2537 will be initialized to use the corresponding mode line glyph row of
2538 the desired matrix of W. */
2541 init_iterator (struct it
*it
, struct window
*w
,
2542 EMACS_INT charpos
, EMACS_INT bytepos
,
2543 struct glyph_row
*row
, enum face_id base_face_id
)
2545 int highlight_region_p
;
2546 enum face_id remapped_base_face_id
= base_face_id
;
2548 /* Some precondition checks. */
2549 xassert (w
!= NULL
&& it
!= NULL
);
2550 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2553 /* If face attributes have been changed since the last redisplay,
2554 free realized faces now because they depend on face definitions
2555 that might have changed. Don't free faces while there might be
2556 desired matrices pending which reference these faces. */
2557 if (face_change_count
&& !inhibit_free_realized_faces
)
2559 face_change_count
= 0;
2560 free_all_realized_faces (Qnil
);
2563 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2564 if (! NILP (Vface_remapping_alist
))
2565 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2567 /* Use one of the mode line rows of W's desired matrix if
2571 if (base_face_id
== MODE_LINE_FACE_ID
2572 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2573 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2574 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2575 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2579 bzero (it
, sizeof *it
);
2580 it
->current
.overlay_string_index
= -1;
2581 it
->current
.dpvec_index
= -1;
2582 it
->base_face_id
= remapped_base_face_id
;
2584 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2586 /* The window in which we iterate over current_buffer: */
2587 XSETWINDOW (it
->window
, w
);
2589 it
->f
= XFRAME (w
->frame
);
2593 /* Extra space between lines (on window systems only). */
2594 if (base_face_id
== DEFAULT_FACE_ID
2595 && FRAME_WINDOW_P (it
->f
))
2597 if (NATNUMP (current_buffer
->extra_line_spacing
))
2598 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2599 else if (FLOATP (current_buffer
->extra_line_spacing
))
2600 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2601 * FRAME_LINE_HEIGHT (it
->f
));
2602 else if (it
->f
->extra_line_spacing
> 0)
2603 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2604 it
->max_extra_line_spacing
= 0;
2607 /* If realized faces have been removed, e.g. because of face
2608 attribute changes of named faces, recompute them. When running
2609 in batch mode, the face cache of the initial frame is null. If
2610 we happen to get called, make a dummy face cache. */
2611 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2612 init_frame_faces (it
->f
);
2613 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2614 recompute_basic_faces (it
->f
);
2616 /* Current value of the `slice', `space-width', and 'height' properties. */
2617 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2618 it
->space_width
= Qnil
;
2619 it
->font_height
= Qnil
;
2620 it
->override_ascent
= -1;
2622 /* Are control characters displayed as `^C'? */
2623 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2625 /* -1 means everything between a CR and the following line end
2626 is invisible. >0 means lines indented more than this value are
2628 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2629 ? XFASTINT (current_buffer
->selective_display
)
2630 : (!NILP (current_buffer
->selective_display
)
2632 it
->selective_display_ellipsis_p
2633 = !NILP (current_buffer
->selective_display_ellipses
);
2635 /* Display table to use. */
2636 it
->dp
= window_display_table (w
);
2638 /* Are multibyte characters enabled in current_buffer? */
2639 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2641 /* Do we need to reorder bidirectional text? Not if this is a
2642 unibyte buffer: by definition, none of the single-byte characters
2643 are strong R2L, so no reordering is needed. And bidi.c doesn't
2644 support unibyte buffers anyway. */
2646 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2648 /* Non-zero if we should highlight the region. */
2650 = (!NILP (Vtransient_mark_mode
)
2651 && !NILP (current_buffer
->mark_active
)
2652 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2654 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2655 start and end of a visible region in window IT->w. Set both to
2656 -1 to indicate no region. */
2657 if (highlight_region_p
2658 /* Maybe highlight only in selected window. */
2659 && (/* Either show region everywhere. */
2660 highlight_nonselected_windows
2661 /* Or show region in the selected window. */
2662 || w
== XWINDOW (selected_window
)
2663 /* Or show the region if we are in the mini-buffer and W is
2664 the window the mini-buffer refers to. */
2665 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2666 && WINDOWP (minibuf_selected_window
)
2667 && w
== XWINDOW (minibuf_selected_window
))))
2669 int charpos
= marker_position (current_buffer
->mark
);
2670 it
->region_beg_charpos
= min (PT
, charpos
);
2671 it
->region_end_charpos
= max (PT
, charpos
);
2674 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2676 /* Get the position at which the redisplay_end_trigger hook should
2677 be run, if it is to be run at all. */
2678 if (MARKERP (w
->redisplay_end_trigger
)
2679 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2680 it
->redisplay_end_trigger_charpos
2681 = marker_position (w
->redisplay_end_trigger
);
2682 else if (INTEGERP (w
->redisplay_end_trigger
))
2683 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2685 /* Correct bogus values of tab_width. */
2686 it
->tab_width
= XINT (current_buffer
->tab_width
);
2687 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2690 /* Are lines in the display truncated? */
2691 if (base_face_id
!= DEFAULT_FACE_ID
2692 || XINT (it
->w
->hscroll
)
2693 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2694 && ((!NILP (Vtruncate_partial_width_windows
)
2695 && !INTEGERP (Vtruncate_partial_width_windows
))
2696 || (INTEGERP (Vtruncate_partial_width_windows
)
2697 && (WINDOW_TOTAL_COLS (it
->w
)
2698 < XINT (Vtruncate_partial_width_windows
))))))
2699 it
->line_wrap
= TRUNCATE
;
2700 else if (NILP (current_buffer
->truncate_lines
))
2701 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2702 ? WINDOW_WRAP
: WORD_WRAP
;
2704 it
->line_wrap
= TRUNCATE
;
2706 /* Get dimensions of truncation and continuation glyphs. These are
2707 displayed as fringe bitmaps under X, so we don't need them for such
2709 if (!FRAME_WINDOW_P (it
->f
))
2711 if (it
->line_wrap
== TRUNCATE
)
2713 /* We will need the truncation glyph. */
2714 xassert (it
->glyph_row
== NULL
);
2715 produce_special_glyphs (it
, IT_TRUNCATION
);
2716 it
->truncation_pixel_width
= it
->pixel_width
;
2720 /* We will need the continuation glyph. */
2721 xassert (it
->glyph_row
== NULL
);
2722 produce_special_glyphs (it
, IT_CONTINUATION
);
2723 it
->continuation_pixel_width
= it
->pixel_width
;
2726 /* Reset these values to zero because the produce_special_glyphs
2727 above has changed them. */
2728 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2729 it
->phys_ascent
= it
->phys_descent
= 0;
2732 /* Set this after getting the dimensions of truncation and
2733 continuation glyphs, so that we don't produce glyphs when calling
2734 produce_special_glyphs, above. */
2735 it
->glyph_row
= row
;
2736 it
->area
= TEXT_AREA
;
2738 /* Forget any previous info about this row being reversed. */
2740 it
->glyph_row
->reversed_p
= 0;
2742 /* Get the dimensions of the display area. The display area
2743 consists of the visible window area plus a horizontally scrolled
2744 part to the left of the window. All x-values are relative to the
2745 start of this total display area. */
2746 if (base_face_id
!= DEFAULT_FACE_ID
)
2748 /* Mode lines, menu bar in terminal frames. */
2749 it
->first_visible_x
= 0;
2750 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2755 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2756 it
->last_visible_x
= (it
->first_visible_x
2757 + window_box_width (w
, TEXT_AREA
));
2759 /* If we truncate lines, leave room for the truncator glyph(s) at
2760 the right margin. Otherwise, leave room for the continuation
2761 glyph(s). Truncation and continuation glyphs are not inserted
2762 for window-based redisplay. */
2763 if (!FRAME_WINDOW_P (it
->f
))
2765 if (it
->line_wrap
== TRUNCATE
)
2766 it
->last_visible_x
-= it
->truncation_pixel_width
;
2768 it
->last_visible_x
-= it
->continuation_pixel_width
;
2771 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2772 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2775 /* Leave room for a border glyph. */
2776 if (!FRAME_WINDOW_P (it
->f
)
2777 && !WINDOW_RIGHTMOST_P (it
->w
))
2778 it
->last_visible_x
-= 1;
2780 it
->last_visible_y
= window_text_bottom_y (w
);
2782 /* For mode lines and alike, arrange for the first glyph having a
2783 left box line if the face specifies a box. */
2784 if (base_face_id
!= DEFAULT_FACE_ID
)
2788 it
->face_id
= remapped_base_face_id
;
2790 /* If we have a boxed mode line, make the first character appear
2791 with a left box line. */
2792 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2793 if (face
->box
!= FACE_NO_BOX
)
2794 it
->start_of_box_run_p
= 1;
2797 /* If we are to reorder bidirectional text, init the bidi
2801 /* Note the paragraph direction that this buffer wants to
2803 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2804 it
->paragraph_embedding
= L2R
;
2805 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2806 it
->paragraph_embedding
= R2L
;
2808 it
->paragraph_embedding
= NEUTRAL_DIR
;
2809 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2812 /* If a buffer position was specified, set the iterator there,
2813 getting overlays and face properties from that position. */
2814 if (charpos
>= BUF_BEG (current_buffer
))
2816 it
->end_charpos
= ZV
;
2818 IT_CHARPOS (*it
) = charpos
;
2820 /* Compute byte position if not specified. */
2821 if (bytepos
< charpos
)
2822 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2824 IT_BYTEPOS (*it
) = bytepos
;
2826 it
->start
= it
->current
;
2828 /* Compute faces etc. */
2829 reseat (it
, it
->current
.pos
, 1);
2836 /* Initialize IT for the display of window W with window start POS. */
2839 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2841 struct glyph_row
*row
;
2842 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2844 row
= w
->desired_matrix
->rows
+ first_vpos
;
2845 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2846 it
->first_vpos
= first_vpos
;
2848 /* Don't reseat to previous visible line start if current start
2849 position is in a string or image. */
2850 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2852 int start_at_line_beg_p
;
2853 int first_y
= it
->current_y
;
2855 /* If window start is not at a line start, skip forward to POS to
2856 get the correct continuation lines width. */
2857 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2858 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2859 if (!start_at_line_beg_p
)
2863 reseat_at_previous_visible_line_start (it
);
2864 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2866 new_x
= it
->current_x
+ it
->pixel_width
;
2868 /* If lines are continued, this line may end in the middle
2869 of a multi-glyph character (e.g. a control character
2870 displayed as \003, or in the middle of an overlay
2871 string). In this case move_it_to above will not have
2872 taken us to the start of the continuation line but to the
2873 end of the continued line. */
2874 if (it
->current_x
> 0
2875 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2876 && (/* And glyph doesn't fit on the line. */
2877 new_x
> it
->last_visible_x
2878 /* Or it fits exactly and we're on a window
2880 || (new_x
== it
->last_visible_x
2881 && FRAME_WINDOW_P (it
->f
))))
2883 if (it
->current
.dpvec_index
>= 0
2884 || it
->current
.overlay_string_index
>= 0)
2886 set_iterator_to_next (it
, 1);
2887 move_it_in_display_line_to (it
, -1, -1, 0);
2890 it
->continuation_lines_width
+= it
->current_x
;
2893 /* We're starting a new display line, not affected by the
2894 height of the continued line, so clear the appropriate
2895 fields in the iterator structure. */
2896 it
->max_ascent
= it
->max_descent
= 0;
2897 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2899 it
->current_y
= first_y
;
2901 it
->current_x
= it
->hpos
= 0;
2907 /* Return 1 if POS is a position in ellipses displayed for invisible
2908 text. W is the window we display, for text property lookup. */
2911 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2913 Lisp_Object prop
, window
;
2915 int charpos
= CHARPOS (pos
->pos
);
2917 /* If POS specifies a position in a display vector, this might
2918 be for an ellipsis displayed for invisible text. We won't
2919 get the iterator set up for delivering that ellipsis unless
2920 we make sure that it gets aware of the invisible text. */
2921 if (pos
->dpvec_index
>= 0
2922 && pos
->overlay_string_index
< 0
2923 && CHARPOS (pos
->string_pos
) < 0
2925 && (XSETWINDOW (window
, w
),
2926 prop
= Fget_char_property (make_number (charpos
),
2927 Qinvisible
, window
),
2928 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2930 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2932 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2939 /* Initialize IT for stepping through current_buffer in window W,
2940 starting at position POS that includes overlay string and display
2941 vector/ control character translation position information. Value
2942 is zero if there are overlay strings with newlines at POS. */
2945 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2947 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2948 int i
, overlay_strings_with_newlines
= 0;
2950 /* If POS specifies a position in a display vector, this might
2951 be for an ellipsis displayed for invisible text. We won't
2952 get the iterator set up for delivering that ellipsis unless
2953 we make sure that it gets aware of the invisible text. */
2954 if (in_ellipses_for_invisible_text_p (pos
, w
))
2960 /* Keep in mind: the call to reseat in init_iterator skips invisible
2961 text, so we might end up at a position different from POS. This
2962 is only a problem when POS is a row start after a newline and an
2963 overlay starts there with an after-string, and the overlay has an
2964 invisible property. Since we don't skip invisible text in
2965 display_line and elsewhere immediately after consuming the
2966 newline before the row start, such a POS will not be in a string,
2967 but the call to init_iterator below will move us to the
2969 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2971 /* This only scans the current chunk -- it should scan all chunks.
2972 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2973 to 16 in 22.1 to make this a lesser problem. */
2974 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2976 const char *s
= SDATA (it
->overlay_strings
[i
]);
2977 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2979 while (s
< e
&& *s
!= '\n')
2984 overlay_strings_with_newlines
= 1;
2989 /* If position is within an overlay string, set up IT to the right
2991 if (pos
->overlay_string_index
>= 0)
2995 /* If the first overlay string happens to have a `display'
2996 property for an image, the iterator will be set up for that
2997 image, and we have to undo that setup first before we can
2998 correct the overlay string index. */
2999 if (it
->method
== GET_FROM_IMAGE
)
3002 /* We already have the first chunk of overlay strings in
3003 IT->overlay_strings. Load more until the one for
3004 pos->overlay_string_index is in IT->overlay_strings. */
3005 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3007 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3008 it
->current
.overlay_string_index
= 0;
3011 load_overlay_strings (it
, 0);
3012 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3016 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3017 relative_index
= (it
->current
.overlay_string_index
3018 % OVERLAY_STRING_CHUNK_SIZE
);
3019 it
->string
= it
->overlay_strings
[relative_index
];
3020 xassert (STRINGP (it
->string
));
3021 it
->current
.string_pos
= pos
->string_pos
;
3022 it
->method
= GET_FROM_STRING
;
3025 if (CHARPOS (pos
->string_pos
) >= 0)
3027 /* Recorded position is not in an overlay string, but in another
3028 string. This can only be a string from a `display' property.
3029 IT should already be filled with that string. */
3030 it
->current
.string_pos
= pos
->string_pos
;
3031 xassert (STRINGP (it
->string
));
3034 /* Restore position in display vector translations, control
3035 character translations or ellipses. */
3036 if (pos
->dpvec_index
>= 0)
3038 if (it
->dpvec
== NULL
)
3039 get_next_display_element (it
);
3040 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3041 it
->current
.dpvec_index
= pos
->dpvec_index
;
3045 return !overlay_strings_with_newlines
;
3049 /* Initialize IT for stepping through current_buffer in window W
3050 starting at ROW->start. */
3053 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3055 init_from_display_pos (it
, w
, &row
->start
);
3056 it
->start
= row
->start
;
3057 it
->continuation_lines_width
= row
->continuation_lines_width
;
3062 /* Initialize IT for stepping through current_buffer in window W
3063 starting in the line following ROW, i.e. starting at ROW->end.
3064 Value is zero if there are overlay strings with newlines at ROW's
3068 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3072 if (init_from_display_pos (it
, w
, &row
->end
))
3074 if (row
->continued_p
)
3075 it
->continuation_lines_width
3076 = row
->continuation_lines_width
+ row
->pixel_width
;
3087 /***********************************************************************
3089 ***********************************************************************/
3091 /* Called when IT reaches IT->stop_charpos. Handle text property and
3092 overlay changes. Set IT->stop_charpos to the next position where
3096 handle_stop (struct it
*it
)
3098 enum prop_handled handled
;
3099 int handle_overlay_change_p
;
3103 it
->current
.dpvec_index
= -1;
3104 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3105 it
->ignore_overlay_strings_at_pos_p
= 0;
3108 /* Use face of preceding text for ellipsis (if invisible) */
3109 if (it
->selective_display_ellipsis_p
)
3110 it
->saved_face_id
= it
->face_id
;
3114 handled
= HANDLED_NORMALLY
;
3116 /* Call text property handlers. */
3117 for (p
= it_props
; p
->handler
; ++p
)
3119 handled
= p
->handler (it
);
3121 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3123 else if (handled
== HANDLED_RETURN
)
3125 /* We still want to show before and after strings from
3126 overlays even if the actual buffer text is replaced. */
3127 if (!handle_overlay_change_p
3129 || !get_overlay_strings_1 (it
, 0, 0))
3132 setup_for_ellipsis (it
, 0);
3133 /* When handling a display spec, we might load an
3134 empty string. In that case, discard it here. We
3135 used to discard it in handle_single_display_spec,
3136 but that causes get_overlay_strings_1, above, to
3137 ignore overlay strings that we must check. */
3138 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3142 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3146 it
->ignore_overlay_strings_at_pos_p
= 1;
3147 it
->string_from_display_prop_p
= 0;
3148 handle_overlay_change_p
= 0;
3150 handled
= HANDLED_RECOMPUTE_PROPS
;
3153 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3154 handle_overlay_change_p
= 0;
3157 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3159 /* Don't check for overlay strings below when set to deliver
3160 characters from a display vector. */
3161 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3162 handle_overlay_change_p
= 0;
3164 /* Handle overlay changes.
3165 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3166 if it finds overlays. */
3167 if (handle_overlay_change_p
)
3168 handled
= handle_overlay_change (it
);
3173 setup_for_ellipsis (it
, 0);
3177 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3179 /* Determine where to stop next. */
3180 if (handled
== HANDLED_NORMALLY
)
3181 compute_stop_pos (it
);
3185 /* Compute IT->stop_charpos from text property and overlay change
3186 information for IT's current position. */
3189 compute_stop_pos (struct it
*it
)
3191 register INTERVAL iv
, next_iv
;
3192 Lisp_Object object
, limit
, position
;
3193 EMACS_INT charpos
, bytepos
;
3195 /* If nowhere else, stop at the end. */
3196 it
->stop_charpos
= it
->end_charpos
;
3198 if (STRINGP (it
->string
))
3200 /* Strings are usually short, so don't limit the search for
3202 object
= it
->string
;
3204 charpos
= IT_STRING_CHARPOS (*it
);
3205 bytepos
= IT_STRING_BYTEPOS (*it
);
3211 /* If next overlay change is in front of the current stop pos
3212 (which is IT->end_charpos), stop there. Note: value of
3213 next_overlay_change is point-max if no overlay change
3215 charpos
= IT_CHARPOS (*it
);
3216 bytepos
= IT_BYTEPOS (*it
);
3217 pos
= next_overlay_change (charpos
);
3218 if (pos
< it
->stop_charpos
)
3219 it
->stop_charpos
= pos
;
3221 /* If showing the region, we have to stop at the region
3222 start or end because the face might change there. */
3223 if (it
->region_beg_charpos
> 0)
3225 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3226 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3227 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3228 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3231 /* Set up variables for computing the stop position from text
3232 property changes. */
3233 XSETBUFFER (object
, current_buffer
);
3234 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3237 /* Get the interval containing IT's position. Value is a null
3238 interval if there isn't such an interval. */
3239 position
= make_number (charpos
);
3240 iv
= validate_interval_range (object
, &position
, &position
, 0);
3241 if (!NULL_INTERVAL_P (iv
))
3243 Lisp_Object values_here
[LAST_PROP_IDX
];
3246 /* Get properties here. */
3247 for (p
= it_props
; p
->handler
; ++p
)
3248 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3250 /* Look for an interval following iv that has different
3252 for (next_iv
= next_interval (iv
);
3253 (!NULL_INTERVAL_P (next_iv
)
3255 || XFASTINT (limit
) > next_iv
->position
));
3256 next_iv
= next_interval (next_iv
))
3258 for (p
= it_props
; p
->handler
; ++p
)
3260 Lisp_Object new_value
;
3262 new_value
= textget (next_iv
->plist
, *p
->name
);
3263 if (!EQ (values_here
[p
->idx
], new_value
))
3271 if (!NULL_INTERVAL_P (next_iv
))
3273 if (INTEGERP (limit
)
3274 && next_iv
->position
>= XFASTINT (limit
))
3275 /* No text property change up to limit. */
3276 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3278 /* Text properties change in next_iv. */
3279 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3283 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3284 it
->stop_charpos
, it
->string
);
3286 xassert (STRINGP (it
->string
)
3287 || (it
->stop_charpos
>= BEGV
3288 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3292 /* Return the position of the next overlay change after POS in
3293 current_buffer. Value is point-max if no overlay change
3294 follows. This is like `next-overlay-change' but doesn't use
3298 next_overlay_change (EMACS_INT pos
)
3302 Lisp_Object
*overlays
;
3305 /* Get all overlays at the given position. */
3306 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3308 /* If any of these overlays ends before endpos,
3309 use its ending point instead. */
3310 for (i
= 0; i
< noverlays
; ++i
)
3315 oend
= OVERLAY_END (overlays
[i
]);
3316 oendpos
= OVERLAY_POSITION (oend
);
3317 endpos
= min (endpos
, oendpos
);
3325 /***********************************************************************
3327 ***********************************************************************/
3329 /* Handle changes in the `fontified' property of the current buffer by
3330 calling hook functions from Qfontification_functions to fontify
3333 static enum prop_handled
3334 handle_fontified_prop (struct it
*it
)
3336 Lisp_Object prop
, pos
;
3337 enum prop_handled handled
= HANDLED_NORMALLY
;
3339 if (!NILP (Vmemory_full
))
3342 /* Get the value of the `fontified' property at IT's current buffer
3343 position. (The `fontified' property doesn't have a special
3344 meaning in strings.) If the value is nil, call functions from
3345 Qfontification_functions. */
3346 if (!STRINGP (it
->string
)
3348 && !NILP (Vfontification_functions
)
3349 && !NILP (Vrun_hooks
)
3350 && (pos
= make_number (IT_CHARPOS (*it
)),
3351 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3352 /* Ignore the special cased nil value always present at EOB since
3353 no amount of fontifying will be able to change it. */
3354 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3356 int count
= SPECPDL_INDEX ();
3359 val
= Vfontification_functions
;
3360 specbind (Qfontification_functions
, Qnil
);
3362 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3363 safe_call1 (val
, pos
);
3366 Lisp_Object globals
, fn
;
3367 struct gcpro gcpro1
, gcpro2
;
3370 GCPRO2 (val
, globals
);
3372 for (; CONSP (val
); val
= XCDR (val
))
3378 /* A value of t indicates this hook has a local
3379 binding; it means to run the global binding too.
3380 In a global value, t should not occur. If it
3381 does, we must ignore it to avoid an endless
3383 for (globals
= Fdefault_value (Qfontification_functions
);
3385 globals
= XCDR (globals
))
3387 fn
= XCAR (globals
);
3389 safe_call1 (fn
, pos
);
3393 safe_call1 (fn
, pos
);
3399 unbind_to (count
, Qnil
);
3401 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3402 something. This avoids an endless loop if they failed to
3403 fontify the text for which reason ever. */
3404 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3405 handled
= HANDLED_RECOMPUTE_PROPS
;
3413 /***********************************************************************
3415 ***********************************************************************/
3417 /* Set up iterator IT from face properties at its current position.
3418 Called from handle_stop. */
3420 static enum prop_handled
3421 handle_face_prop (struct it
*it
)
3424 EMACS_INT next_stop
;
3426 if (!STRINGP (it
->string
))
3429 = face_at_buffer_position (it
->w
,
3431 it
->region_beg_charpos
,
3432 it
->region_end_charpos
,
3435 + TEXT_PROP_DISTANCE_LIMIT
),
3436 0, it
->base_face_id
);
3438 /* Is this a start of a run of characters with box face?
3439 Caveat: this can be called for a freshly initialized
3440 iterator; face_id is -1 in this case. We know that the new
3441 face will not change until limit, i.e. if the new face has a
3442 box, all characters up to limit will have one. But, as
3443 usual, we don't know whether limit is really the end. */
3444 if (new_face_id
!= it
->face_id
)
3446 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3448 /* If new face has a box but old face has not, this is
3449 the start of a run of characters with box, i.e. it has
3450 a shadow on the left side. The value of face_id of the
3451 iterator will be -1 if this is the initial call that gets
3452 the face. In this case, we have to look in front of IT's
3453 position and see whether there is a face != new_face_id. */
3454 it
->start_of_box_run_p
3455 = (new_face
->box
!= FACE_NO_BOX
3456 && (it
->face_id
>= 0
3457 || IT_CHARPOS (*it
) == BEG
3458 || new_face_id
!= face_before_it_pos (it
)));
3459 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3464 int base_face_id
, bufpos
;
3466 Lisp_Object from_overlay
3467 = (it
->current
.overlay_string_index
>= 0
3468 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3471 /* See if we got to this string directly or indirectly from
3472 an overlay property. That includes the before-string or
3473 after-string of an overlay, strings in display properties
3474 provided by an overlay, their text properties, etc.
3476 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3477 if (! NILP (from_overlay
))
3478 for (i
= it
->sp
- 1; i
>= 0; i
--)
3480 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3482 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3483 else if (! NILP (it
->stack
[i
].from_overlay
))
3484 from_overlay
= it
->stack
[i
].from_overlay
;
3486 if (!NILP (from_overlay
))
3490 if (! NILP (from_overlay
))
3492 bufpos
= IT_CHARPOS (*it
);
3493 /* For a string from an overlay, the base face depends
3494 only on text properties and ignores overlays. */
3496 = face_for_overlay_string (it
->w
,
3498 it
->region_beg_charpos
,
3499 it
->region_end_charpos
,
3502 + TEXT_PROP_DISTANCE_LIMIT
),
3510 /* For strings from a `display' property, use the face at
3511 IT's current buffer position as the base face to merge
3512 with, so that overlay strings appear in the same face as
3513 surrounding text, unless they specify their own
3515 base_face_id
= underlying_face_id (it
);
3518 new_face_id
= face_at_string_position (it
->w
,
3520 IT_STRING_CHARPOS (*it
),
3522 it
->region_beg_charpos
,
3523 it
->region_end_charpos
,
3527 /* Is this a start of a run of characters with box? Caveat:
3528 this can be called for a freshly allocated iterator; face_id
3529 is -1 is this case. We know that the new face will not
3530 change until the next check pos, i.e. if the new face has a
3531 box, all characters up to that position will have a
3532 box. But, as usual, we don't know whether that position
3533 is really the end. */
3534 if (new_face_id
!= it
->face_id
)
3536 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3537 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3539 /* If new face has a box but old face hasn't, this is the
3540 start of a run of characters with box, i.e. it has a
3541 shadow on the left side. */
3542 it
->start_of_box_run_p
3543 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3544 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3548 it
->face_id
= new_face_id
;
3549 return HANDLED_NORMALLY
;
3553 /* Return the ID of the face ``underlying'' IT's current position,
3554 which is in a string. If the iterator is associated with a
3555 buffer, return the face at IT's current buffer position.
3556 Otherwise, use the iterator's base_face_id. */
3559 underlying_face_id (struct it
*it
)
3561 int face_id
= it
->base_face_id
, i
;
3563 xassert (STRINGP (it
->string
));
3565 for (i
= it
->sp
- 1; i
>= 0; --i
)
3566 if (NILP (it
->stack
[i
].string
))
3567 face_id
= it
->stack
[i
].face_id
;
3573 /* Compute the face one character before or after the current position
3574 of IT. BEFORE_P non-zero means get the face in front of IT's
3575 position. Value is the id of the face. */
3578 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3581 EMACS_INT next_check_charpos
;
3582 struct text_pos pos
;
3584 xassert (it
->s
== NULL
);
3586 if (STRINGP (it
->string
))
3588 int bufpos
, base_face_id
;
3590 /* No face change past the end of the string (for the case
3591 we are padding with spaces). No face change before the
3593 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3594 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3597 /* Set pos to the position before or after IT's current position. */
3599 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3601 /* For composition, we must check the character after the
3603 pos
= (it
->what
== IT_COMPOSITION
3604 ? string_pos (IT_STRING_CHARPOS (*it
)
3605 + it
->cmp_it
.nchars
, it
->string
)
3606 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3608 if (it
->current
.overlay_string_index
>= 0)
3609 bufpos
= IT_CHARPOS (*it
);
3613 base_face_id
= underlying_face_id (it
);
3615 /* Get the face for ASCII, or unibyte. */
3616 face_id
= face_at_string_position (it
->w
,
3620 it
->region_beg_charpos
,
3621 it
->region_end_charpos
,
3622 &next_check_charpos
,
3625 /* Correct the face for charsets different from ASCII. Do it
3626 for the multibyte case only. The face returned above is
3627 suitable for unibyte text if IT->string is unibyte. */
3628 if (STRING_MULTIBYTE (it
->string
))
3630 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3631 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3633 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3635 c
= string_char_and_length (p
, &len
);
3636 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3641 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3642 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3645 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3646 pos
= it
->current
.pos
;
3649 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3652 if (it
->what
== IT_COMPOSITION
)
3653 /* For composition, we must check the position after the
3655 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3657 INC_TEXT_POS (pos
, it
->multibyte_p
);
3660 /* Determine face for CHARSET_ASCII, or unibyte. */
3661 face_id
= face_at_buffer_position (it
->w
,
3663 it
->region_beg_charpos
,
3664 it
->region_end_charpos
,
3665 &next_check_charpos
,
3668 /* Correct the face for charsets different from ASCII. Do it
3669 for the multibyte case only. The face returned above is
3670 suitable for unibyte text if current_buffer is unibyte. */
3671 if (it
->multibyte_p
)
3673 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3674 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3675 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3684 /***********************************************************************
3686 ***********************************************************************/
3688 /* Set up iterator IT from invisible properties at its current
3689 position. Called from handle_stop. */
3691 static enum prop_handled
3692 handle_invisible_prop (struct it
*it
)
3694 enum prop_handled handled
= HANDLED_NORMALLY
;
3696 if (STRINGP (it
->string
))
3698 extern Lisp_Object Qinvisible
;
3699 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3701 /* Get the value of the invisible text property at the
3702 current position. Value will be nil if there is no such
3704 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3705 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3708 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3710 handled
= HANDLED_RECOMPUTE_PROPS
;
3712 /* Get the position at which the next change of the
3713 invisible text property can be found in IT->string.
3714 Value will be nil if the property value is the same for
3715 all the rest of IT->string. */
3716 XSETINT (limit
, SCHARS (it
->string
));
3717 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3720 /* Text at current position is invisible. The next
3721 change in the property is at position end_charpos.
3722 Move IT's current position to that position. */
3723 if (INTEGERP (end_charpos
)
3724 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3726 struct text_pos old
;
3727 old
= it
->current
.string_pos
;
3728 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3729 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3733 /* The rest of the string is invisible. If this is an
3734 overlay string, proceed with the next overlay string
3735 or whatever comes and return a character from there. */
3736 if (it
->current
.overlay_string_index
>= 0)
3738 next_overlay_string (it
);
3739 /* Don't check for overlay strings when we just
3740 finished processing them. */
3741 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3745 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3746 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3754 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3755 Lisp_Object pos
, prop
, overlay
;
3757 /* First of all, is there invisible text at this position? */
3758 tem
= start_charpos
= IT_CHARPOS (*it
);
3759 pos
= make_number (tem
);
3760 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3762 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3764 /* If we are on invisible text, skip over it. */
3765 if (invis_p
&& start_charpos
< it
->end_charpos
)
3767 /* Record whether we have to display an ellipsis for the
3769 int display_ellipsis_p
= invis_p
== 2;
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3773 /* Loop skipping over invisible text. The loop is left at
3774 ZV or with IT on the first char being visible again. */
3777 /* Try to skip some invisible text. Return value is the
3778 position reached which can be equal to where we start
3779 if there is nothing invisible there. This skips both
3780 over invisible text properties and overlays with
3781 invisible property. */
3782 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3784 /* If we skipped nothing at all we weren't at invisible
3785 text in the first place. If everything to the end of
3786 the buffer was skipped, end the loop. */
3787 if (newpos
== tem
|| newpos
>= ZV
)
3791 /* We skipped some characters but not necessarily
3792 all there are. Check if we ended up on visible
3793 text. Fget_char_property returns the property of
3794 the char before the given position, i.e. if we
3795 get invis_p = 0, this means that the char at
3796 newpos is visible. */
3797 pos
= make_number (newpos
);
3798 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3799 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3802 /* If we ended up on invisible text, proceed to
3803 skip starting with next_stop. */
3807 /* If there are adjacent invisible texts, don't lose the
3808 second one's ellipsis. */
3810 display_ellipsis_p
= 1;
3814 /* The position newpos is now either ZV or on visible text. */
3815 if (it
->bidi_p
&& newpos
< ZV
)
3817 /* With bidi iteration, the region of invisible text
3818 could start and/or end in the middle of a non-base
3819 embedding level. Therefore, we need to skip
3820 invisible text using the bidi iterator, starting at
3821 IT's current position, until we find ourselves
3822 outside the invisible text. Skipping invisible text
3823 _after_ bidi iteration avoids affecting the visual
3824 order of the displayed text when invisible properties
3825 are added or removed. */
3826 if (it
->bidi_it
.first_elt
)
3828 /* If we were `reseat'ed to a new paragraph,
3829 determine the paragraph base direction. We need
3830 to do it now because next_element_from_buffer may
3831 not have a chance to do it, if we are going to
3832 skip any text at the beginning, which resets the
3834 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3838 bidi_move_to_visually_next (&it
->bidi_it
);
3840 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3841 && it
->bidi_it
.charpos
< newpos
);
3842 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3843 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3844 /* If we overstepped NEWPOS, record its position in the
3845 iterator, so that we skip invisible text if later the
3846 bidi iteration lands us in the invisible region
3848 if (IT_CHARPOS (*it
) >= newpos
)
3849 it
->prev_stop
= newpos
;
3853 IT_CHARPOS (*it
) = newpos
;
3854 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3857 /* If there are before-strings at the start of invisible
3858 text, and the text is invisible because of a text
3859 property, arrange to show before-strings because 20.x did
3860 it that way. (If the text is invisible because of an
3861 overlay property instead of a text property, this is
3862 already handled in the overlay code.) */
3864 && get_overlay_strings (it
, it
->stop_charpos
))
3866 handled
= HANDLED_RECOMPUTE_PROPS
;
3867 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3869 else if (display_ellipsis_p
)
3871 /* Make sure that the glyphs of the ellipsis will get
3872 correct `charpos' values. If we would not update
3873 it->position here, the glyphs would belong to the
3874 last visible character _before_ the invisible
3875 text, which confuses `set_cursor_from_row'.
3877 We use the last invisible position instead of the
3878 first because this way the cursor is always drawn on
3879 the first "." of the ellipsis, whenever PT is inside
3880 the invisible text. Otherwise the cursor would be
3881 placed _after_ the ellipsis when the point is after the
3882 first invisible character. */
3883 if (!STRINGP (it
->object
))
3885 it
->position
.charpos
= newpos
- 1;
3886 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3889 /* Let the ellipsis display before
3890 considering any properties of the following char.
3891 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3892 handled
= HANDLED_RETURN
;
3901 /* Make iterator IT return `...' next.
3902 Replaces LEN characters from buffer. */
3905 setup_for_ellipsis (struct it
*it
, int len
)
3907 /* Use the display table definition for `...'. Invalid glyphs
3908 will be handled by the method returning elements from dpvec. */
3909 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3911 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3912 it
->dpvec
= v
->contents
;
3913 it
->dpend
= v
->contents
+ v
->size
;
3917 /* Default `...'. */
3918 it
->dpvec
= default_invis_vector
;
3919 it
->dpend
= default_invis_vector
+ 3;
3922 it
->dpvec_char_len
= len
;
3923 it
->current
.dpvec_index
= 0;
3924 it
->dpvec_face_id
= -1;
3926 /* Remember the current face id in case glyphs specify faces.
3927 IT's face is restored in set_iterator_to_next.
3928 saved_face_id was set to preceding char's face in handle_stop. */
3929 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3930 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3932 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3938 /***********************************************************************
3940 ***********************************************************************/
3942 /* Set up iterator IT from `display' property at its current position.
3943 Called from handle_stop.
3944 We return HANDLED_RETURN if some part of the display property
3945 overrides the display of the buffer text itself.
3946 Otherwise we return HANDLED_NORMALLY. */
3948 static enum prop_handled
3949 handle_display_prop (struct it
*it
)
3951 Lisp_Object prop
, object
, overlay
;
3952 struct text_pos
*position
;
3953 /* Nonzero if some property replaces the display of the text itself. */
3954 int display_replaced_p
= 0;
3956 if (STRINGP (it
->string
))
3958 object
= it
->string
;
3959 position
= &it
->current
.string_pos
;
3963 XSETWINDOW (object
, it
->w
);
3964 position
= &it
->current
.pos
;
3967 /* Reset those iterator values set from display property values. */
3968 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3969 it
->space_width
= Qnil
;
3970 it
->font_height
= Qnil
;
3973 /* We don't support recursive `display' properties, i.e. string
3974 values that have a string `display' property, that have a string
3975 `display' property etc. */
3976 if (!it
->string_from_display_prop_p
)
3977 it
->area
= TEXT_AREA
;
3979 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3980 Qdisplay
, object
, &overlay
);
3982 return HANDLED_NORMALLY
;
3983 /* Now OVERLAY is the overlay that gave us this property, or nil
3984 if it was a text property. */
3986 if (!STRINGP (it
->string
))
3987 object
= it
->w
->buffer
;
3990 /* Simple properties. */
3991 && !EQ (XCAR (prop
), Qimage
)
3992 && !EQ (XCAR (prop
), Qspace
)
3993 && !EQ (XCAR (prop
), Qwhen
)
3994 && !EQ (XCAR (prop
), Qslice
)
3995 && !EQ (XCAR (prop
), Qspace_width
)
3996 && !EQ (XCAR (prop
), Qheight
)
3997 && !EQ (XCAR (prop
), Qraise
)
3998 /* Marginal area specifications. */
3999 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
4000 && !EQ (XCAR (prop
), Qleft_fringe
)
4001 && !EQ (XCAR (prop
), Qright_fringe
)
4002 && !NILP (XCAR (prop
)))
4004 for (; CONSP (prop
); prop
= XCDR (prop
))
4006 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4007 position
, display_replaced_p
))
4009 display_replaced_p
= 1;
4010 /* If some text in a string is replaced, `position' no
4011 longer points to the position of `object'. */
4012 if (STRINGP (object
))
4017 else if (VECTORP (prop
))
4020 for (i
= 0; i
< ASIZE (prop
); ++i
)
4021 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4022 position
, display_replaced_p
))
4024 display_replaced_p
= 1;
4025 /* If some text in a string is replaced, `position' no
4026 longer points to the position of `object'. */
4027 if (STRINGP (object
))
4033 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4035 display_replaced_p
= 1;
4038 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4042 /* Value is the position of the end of the `display' property starting
4043 at START_POS in OBJECT. */
4045 static struct text_pos
4046 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4049 struct text_pos end_pos
;
4051 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4052 Qdisplay
, object
, Qnil
);
4053 CHARPOS (end_pos
) = XFASTINT (end
);
4054 if (STRINGP (object
))
4055 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4057 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4063 /* Set up IT from a single `display' specification PROP. OBJECT
4064 is the object in which the `display' property was found. *POSITION
4065 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4066 means that we previously saw a display specification which already
4067 replaced text display with something else, for example an image;
4068 we ignore such properties after the first one has been processed.
4070 OVERLAY is the overlay this `display' property came from,
4071 or nil if it was a text property.
4073 If PROP is a `space' or `image' specification, and in some other
4074 cases too, set *POSITION to the position where the `display'
4077 Value is non-zero if something was found which replaces the display
4078 of buffer or string text. */
4081 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4082 display_replaced_before_p
)
4086 Lisp_Object overlay
;
4087 struct text_pos
*position
;
4088 int display_replaced_before_p
;
4091 Lisp_Object location
, value
;
4092 struct text_pos start_pos
, save_pos
;
4095 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4096 If the result is non-nil, use VALUE instead of SPEC. */
4098 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4107 if (!NILP (form
) && !EQ (form
, Qt
))
4109 int count
= SPECPDL_INDEX ();
4110 struct gcpro gcpro1
;
4112 /* Bind `object' to the object having the `display' property, a
4113 buffer or string. Bind `position' to the position in the
4114 object where the property was found, and `buffer-position'
4115 to the current position in the buffer. */
4116 specbind (Qobject
, object
);
4117 specbind (Qposition
, make_number (CHARPOS (*position
)));
4118 specbind (Qbuffer_position
,
4119 make_number (STRINGP (object
)
4120 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4122 form
= safe_eval (form
);
4124 unbind_to (count
, Qnil
);
4130 /* Handle `(height HEIGHT)' specifications. */
4132 && EQ (XCAR (spec
), Qheight
)
4133 && CONSP (XCDR (spec
)))
4135 if (!FRAME_WINDOW_P (it
->f
))
4138 it
->font_height
= XCAR (XCDR (spec
));
4139 if (!NILP (it
->font_height
))
4141 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4142 int new_height
= -1;
4144 if (CONSP (it
->font_height
)
4145 && (EQ (XCAR (it
->font_height
), Qplus
)
4146 || EQ (XCAR (it
->font_height
), Qminus
))
4147 && CONSP (XCDR (it
->font_height
))
4148 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4150 /* `(+ N)' or `(- N)' where N is an integer. */
4151 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4152 if (EQ (XCAR (it
->font_height
), Qplus
))
4154 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4156 else if (FUNCTIONP (it
->font_height
))
4158 /* Call function with current height as argument.
4159 Value is the new height. */
4161 height
= safe_call1 (it
->font_height
,
4162 face
->lface
[LFACE_HEIGHT_INDEX
]);
4163 if (NUMBERP (height
))
4164 new_height
= XFLOATINT (height
);
4166 else if (NUMBERP (it
->font_height
))
4168 /* Value is a multiple of the canonical char height. */
4171 face
= FACE_FROM_ID (it
->f
,
4172 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4173 new_height
= (XFLOATINT (it
->font_height
)
4174 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4178 /* Evaluate IT->font_height with `height' bound to the
4179 current specified height to get the new height. */
4180 int count
= SPECPDL_INDEX ();
4182 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4183 value
= safe_eval (it
->font_height
);
4184 unbind_to (count
, Qnil
);
4186 if (NUMBERP (value
))
4187 new_height
= XFLOATINT (value
);
4191 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4197 /* Handle `(space-width WIDTH)'. */
4199 && EQ (XCAR (spec
), Qspace_width
)
4200 && CONSP (XCDR (spec
)))
4202 if (!FRAME_WINDOW_P (it
->f
))
4205 value
= XCAR (XCDR (spec
));
4206 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4207 it
->space_width
= value
;
4212 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4214 && EQ (XCAR (spec
), Qslice
))
4218 if (!FRAME_WINDOW_P (it
->f
))
4221 if (tem
= XCDR (spec
), CONSP (tem
))
4223 it
->slice
.x
= XCAR (tem
);
4224 if (tem
= XCDR (tem
), CONSP (tem
))
4226 it
->slice
.y
= XCAR (tem
);
4227 if (tem
= XCDR (tem
), CONSP (tem
))
4229 it
->slice
.width
= XCAR (tem
);
4230 if (tem
= XCDR (tem
), CONSP (tem
))
4231 it
->slice
.height
= XCAR (tem
);
4239 /* Handle `(raise FACTOR)'. */
4241 && EQ (XCAR (spec
), Qraise
)
4242 && CONSP (XCDR (spec
)))
4244 if (!FRAME_WINDOW_P (it
->f
))
4247 #ifdef HAVE_WINDOW_SYSTEM
4248 value
= XCAR (XCDR (spec
));
4249 if (NUMBERP (value
))
4251 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4252 it
->voffset
= - (XFLOATINT (value
)
4253 * (FONT_HEIGHT (face
->font
)));
4255 #endif /* HAVE_WINDOW_SYSTEM */
4260 /* Don't handle the other kinds of display specifications
4261 inside a string that we got from a `display' property. */
4262 if (it
->string_from_display_prop_p
)
4265 /* Characters having this form of property are not displayed, so
4266 we have to find the end of the property. */
4267 start_pos
= *position
;
4268 *position
= display_prop_end (it
, object
, start_pos
);
4271 /* Stop the scan at that end position--we assume that all
4272 text properties change there. */
4273 it
->stop_charpos
= position
->charpos
;
4275 /* Handle `(left-fringe BITMAP [FACE])'
4276 and `(right-fringe BITMAP [FACE])'. */
4278 && (EQ (XCAR (spec
), Qleft_fringe
)
4279 || EQ (XCAR (spec
), Qright_fringe
))
4280 && CONSP (XCDR (spec
)))
4282 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4285 if (!FRAME_WINDOW_P (it
->f
))
4286 /* If we return here, POSITION has been advanced
4287 across the text with this property. */
4290 #ifdef HAVE_WINDOW_SYSTEM
4291 value
= XCAR (XCDR (spec
));
4292 if (!SYMBOLP (value
)
4293 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4294 /* If we return here, POSITION has been advanced
4295 across the text with this property. */
4298 if (CONSP (XCDR (XCDR (spec
))))
4300 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4301 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4307 /* Save current settings of IT so that we can restore them
4308 when we are finished with the glyph property value. */
4310 save_pos
= it
->position
;
4311 it
->position
= *position
;
4313 it
->position
= save_pos
;
4315 it
->area
= TEXT_AREA
;
4316 it
->what
= IT_IMAGE
;
4317 it
->image_id
= -1; /* no image */
4318 it
->position
= start_pos
;
4319 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4320 it
->method
= GET_FROM_IMAGE
;
4321 it
->from_overlay
= Qnil
;
4322 it
->face_id
= face_id
;
4324 /* Say that we haven't consumed the characters with
4325 `display' property yet. The call to pop_it in
4326 set_iterator_to_next will clean this up. */
4327 *position
= start_pos
;
4329 if (EQ (XCAR (spec
), Qleft_fringe
))
4331 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4332 it
->left_user_fringe_face_id
= face_id
;
4336 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4337 it
->right_user_fringe_face_id
= face_id
;
4339 #endif /* HAVE_WINDOW_SYSTEM */
4343 /* Prepare to handle `((margin left-margin) ...)',
4344 `((margin right-margin) ...)' and `((margin nil) ...)'
4345 prefixes for display specifications. */
4346 location
= Qunbound
;
4347 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4351 value
= XCDR (spec
);
4353 value
= XCAR (value
);
4356 if (EQ (XCAR (tem
), Qmargin
)
4357 && (tem
= XCDR (tem
),
4358 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4360 || EQ (tem
, Qleft_margin
)
4361 || EQ (tem
, Qright_margin
))))
4365 if (EQ (location
, Qunbound
))
4371 /* After this point, VALUE is the property after any
4372 margin prefix has been stripped. It must be a string,
4373 an image specification, or `(space ...)'.
4375 LOCATION specifies where to display: `left-margin',
4376 `right-margin' or nil. */
4378 valid_p
= (STRINGP (value
)
4379 #ifdef HAVE_WINDOW_SYSTEM
4380 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4381 #endif /* not HAVE_WINDOW_SYSTEM */
4382 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4384 if (valid_p
&& !display_replaced_before_p
)
4386 /* Save current settings of IT so that we can restore them
4387 when we are finished with the glyph property value. */
4388 save_pos
= it
->position
;
4389 it
->position
= *position
;
4391 it
->position
= save_pos
;
4392 it
->from_overlay
= overlay
;
4394 if (NILP (location
))
4395 it
->area
= TEXT_AREA
;
4396 else if (EQ (location
, Qleft_margin
))
4397 it
->area
= LEFT_MARGIN_AREA
;
4399 it
->area
= RIGHT_MARGIN_AREA
;
4401 if (STRINGP (value
))
4404 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4405 it
->current
.overlay_string_index
= -1;
4406 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4407 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4408 it
->method
= GET_FROM_STRING
;
4409 it
->stop_charpos
= 0;
4410 it
->string_from_display_prop_p
= 1;
4411 /* Say that we haven't consumed the characters with
4412 `display' property yet. The call to pop_it in
4413 set_iterator_to_next will clean this up. */
4414 if (BUFFERP (object
))
4415 *position
= start_pos
;
4417 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4419 it
->method
= GET_FROM_STRETCH
;
4421 *position
= it
->position
= start_pos
;
4423 #ifdef HAVE_WINDOW_SYSTEM
4426 it
->what
= IT_IMAGE
;
4427 it
->image_id
= lookup_image (it
->f
, value
);
4428 it
->position
= start_pos
;
4429 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4430 it
->method
= GET_FROM_IMAGE
;
4432 /* Say that we haven't consumed the characters with
4433 `display' property yet. The call to pop_it in
4434 set_iterator_to_next will clean this up. */
4435 *position
= start_pos
;
4437 #endif /* HAVE_WINDOW_SYSTEM */
4442 /* Invalid property or property not supported. Restore
4443 POSITION to what it was before. */
4444 *position
= start_pos
;
4449 /* Check if SPEC is a display sub-property value whose text should be
4450 treated as intangible. */
4453 single_display_spec_intangible_p (Lisp_Object prop
)
4455 /* Skip over `when FORM'. */
4456 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4470 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4471 we don't need to treat text as intangible. */
4472 if (EQ (XCAR (prop
), Qmargin
))
4480 || EQ (XCAR (prop
), Qleft_margin
)
4481 || EQ (XCAR (prop
), Qright_margin
))
4485 return (CONSP (prop
)
4486 && (EQ (XCAR (prop
), Qimage
)
4487 || EQ (XCAR (prop
), Qspace
)));
4491 /* Check if PROP is a display property value whose text should be
4492 treated as intangible. */
4495 display_prop_intangible_p (Lisp_Object prop
)
4498 && CONSP (XCAR (prop
))
4499 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4501 /* A list of sub-properties. */
4502 while (CONSP (prop
))
4504 if (single_display_spec_intangible_p (XCAR (prop
)))
4509 else if (VECTORP (prop
))
4511 /* A vector of sub-properties. */
4513 for (i
= 0; i
< ASIZE (prop
); ++i
)
4514 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4518 return single_display_spec_intangible_p (prop
);
4524 /* Return 1 if PROP is a display sub-property value containing STRING. */
4527 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4529 if (EQ (string
, prop
))
4532 /* Skip over `when FORM'. */
4533 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4542 /* Skip over `margin LOCATION'. */
4543 if (EQ (XCAR (prop
), Qmargin
))
4554 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4558 /* Return 1 if STRING appears in the `display' property PROP. */
4561 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4564 && CONSP (XCAR (prop
))
4565 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4567 /* A list of sub-properties. */
4568 while (CONSP (prop
))
4570 if (single_display_spec_string_p (XCAR (prop
), string
))
4575 else if (VECTORP (prop
))
4577 /* A vector of sub-properties. */
4579 for (i
= 0; i
< ASIZE (prop
); ++i
)
4580 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4584 return single_display_spec_string_p (prop
, string
);
4589 /* Look for STRING in overlays and text properties in W's buffer,
4590 between character positions FROM and TO (excluding TO).
4591 BACK_P non-zero means look back (in this case, TO is supposed to be
4593 Value is the first character position where STRING was found, or
4594 zero if it wasn't found before hitting TO.
4596 W's buffer must be current.
4598 This function may only use code that doesn't eval because it is
4599 called asynchronously from note_mouse_highlight. */
4602 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4603 EMACS_INT from
, EMACS_INT to
, int back_p
)
4605 Lisp_Object limit
, prop
, pos
;
4608 pos
= make_number (from
);
4610 if (!back_p
) /* looking forward */
4612 limit
= make_number (min (to
, ZV
));
4613 while (!found
&& !EQ (pos
, limit
))
4615 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4616 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4619 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4623 else /* looking back */
4625 limit
= make_number (max (to
, BEGV
));
4626 while (!found
&& !EQ (pos
, limit
))
4628 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4629 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4632 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4637 return found
? XINT (pos
) : 0;
4640 /* Determine which buffer position in W's buffer STRING comes from.
4641 AROUND_CHARPOS is an approximate position where it could come from.
4642 Value is the buffer position or 0 if it couldn't be determined.
4644 W's buffer must be current.
4646 This function is necessary because we don't record buffer positions
4647 in glyphs generated from strings (to keep struct glyph small).
4648 This function may only use code that doesn't eval because it is
4649 called asynchronously from note_mouse_highlight. */
4652 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4654 Lisp_Object limit
, prop
, pos
;
4655 const int MAX_DISTANCE
= 1000;
4656 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4657 around_charpos
+ MAX_DISTANCE
,
4661 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4662 around_charpos
- MAX_DISTANCE
, 1);
4668 /***********************************************************************
4669 `composition' property
4670 ***********************************************************************/
4672 /* Set up iterator IT from `composition' property at its current
4673 position. Called from handle_stop. */
4675 static enum prop_handled
4676 handle_composition_prop (struct it
*it
)
4678 Lisp_Object prop
, string
;
4679 EMACS_INT pos
, pos_byte
, start
, end
;
4681 if (STRINGP (it
->string
))
4685 pos
= IT_STRING_CHARPOS (*it
);
4686 pos_byte
= IT_STRING_BYTEPOS (*it
);
4687 string
= it
->string
;
4688 s
= SDATA (string
) + pos_byte
;
4689 it
->c
= STRING_CHAR (s
);
4693 pos
= IT_CHARPOS (*it
);
4694 pos_byte
= IT_BYTEPOS (*it
);
4696 it
->c
= FETCH_CHAR (pos_byte
);
4699 /* If there's a valid composition and point is not inside of the
4700 composition (in the case that the composition is from the current
4701 buffer), draw a glyph composed from the composition components. */
4702 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4703 && COMPOSITION_VALID_P (start
, end
, prop
)
4704 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4708 if (STRINGP (it
->string
))
4709 pos_byte
= string_char_to_byte (it
->string
, start
);
4711 pos_byte
= CHAR_TO_BYTE (start
);
4713 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4716 if (it
->cmp_it
.id
>= 0)
4719 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4720 it
->cmp_it
.nglyphs
= -1;
4724 return HANDLED_NORMALLY
;
4729 /***********************************************************************
4731 ***********************************************************************/
4733 /* The following structure is used to record overlay strings for
4734 later sorting in load_overlay_strings. */
4736 struct overlay_entry
4738 Lisp_Object overlay
;
4745 /* Set up iterator IT from overlay strings at its current position.
4746 Called from handle_stop. */
4748 static enum prop_handled
4749 handle_overlay_change (struct it
*it
)
4751 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4752 return HANDLED_RECOMPUTE_PROPS
;
4754 return HANDLED_NORMALLY
;
4758 /* Set up the next overlay string for delivery by IT, if there is an
4759 overlay string to deliver. Called by set_iterator_to_next when the
4760 end of the current overlay string is reached. If there are more
4761 overlay strings to display, IT->string and
4762 IT->current.overlay_string_index are set appropriately here.
4763 Otherwise IT->string is set to nil. */
4766 next_overlay_string (struct it
*it
)
4768 ++it
->current
.overlay_string_index
;
4769 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4771 /* No more overlay strings. Restore IT's settings to what
4772 they were before overlay strings were processed, and
4773 continue to deliver from current_buffer. */
4775 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4778 || (NILP (it
->string
)
4779 && it
->method
== GET_FROM_BUFFER
4780 && it
->stop_charpos
>= BEGV
4781 && it
->stop_charpos
<= it
->end_charpos
));
4782 it
->current
.overlay_string_index
= -1;
4783 it
->n_overlay_strings
= 0;
4785 /* If we're at the end of the buffer, record that we have
4786 processed the overlay strings there already, so that
4787 next_element_from_buffer doesn't try it again. */
4788 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4789 it
->overlay_strings_at_end_processed_p
= 1;
4793 /* There are more overlay strings to process. If
4794 IT->current.overlay_string_index has advanced to a position
4795 where we must load IT->overlay_strings with more strings, do
4797 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4799 if (it
->current
.overlay_string_index
&& i
== 0)
4800 load_overlay_strings (it
, 0);
4802 /* Initialize IT to deliver display elements from the overlay
4804 it
->string
= it
->overlay_strings
[i
];
4805 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4806 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4807 it
->method
= GET_FROM_STRING
;
4808 it
->stop_charpos
= 0;
4809 if (it
->cmp_it
.stop_pos
>= 0)
4810 it
->cmp_it
.stop_pos
= 0;
4817 /* Compare two overlay_entry structures E1 and E2. Used as a
4818 comparison function for qsort in load_overlay_strings. Overlay
4819 strings for the same position are sorted so that
4821 1. All after-strings come in front of before-strings, except
4822 when they come from the same overlay.
4824 2. Within after-strings, strings are sorted so that overlay strings
4825 from overlays with higher priorities come first.
4827 2. Within before-strings, strings are sorted so that overlay
4828 strings from overlays with higher priorities come last.
4830 Value is analogous to strcmp. */
4834 compare_overlay_entries (const void *e1
, const void *e2
)
4836 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4837 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4840 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4842 /* Let after-strings appear in front of before-strings if
4843 they come from different overlays. */
4844 if (EQ (entry1
->overlay
, entry2
->overlay
))
4845 result
= entry1
->after_string_p
? 1 : -1;
4847 result
= entry1
->after_string_p
? -1 : 1;
4849 else if (entry1
->after_string_p
)
4850 /* After-strings sorted in order of decreasing priority. */
4851 result
= entry2
->priority
- entry1
->priority
;
4853 /* Before-strings sorted in order of increasing priority. */
4854 result
= entry1
->priority
- entry2
->priority
;
4860 /* Load the vector IT->overlay_strings with overlay strings from IT's
4861 current buffer position, or from CHARPOS if that is > 0. Set
4862 IT->n_overlays to the total number of overlay strings found.
4864 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4865 a time. On entry into load_overlay_strings,
4866 IT->current.overlay_string_index gives the number of overlay
4867 strings that have already been loaded by previous calls to this
4870 IT->add_overlay_start contains an additional overlay start
4871 position to consider for taking overlay strings from, if non-zero.
4872 This position comes into play when the overlay has an `invisible'
4873 property, and both before and after-strings. When we've skipped to
4874 the end of the overlay, because of its `invisible' property, we
4875 nevertheless want its before-string to appear.
4876 IT->add_overlay_start will contain the overlay start position
4879 Overlay strings are sorted so that after-string strings come in
4880 front of before-string strings. Within before and after-strings,
4881 strings are sorted by overlay priority. See also function
4882 compare_overlay_entries. */
4885 load_overlay_strings (struct it
*it
, int charpos
)
4887 extern Lisp_Object Qwindow
, Qpriority
;
4888 Lisp_Object overlay
, window
, str
, invisible
;
4889 struct Lisp_Overlay
*ov
;
4892 int n
= 0, i
, j
, invis_p
;
4893 struct overlay_entry
*entries
4894 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4897 charpos
= IT_CHARPOS (*it
);
4899 /* Append the overlay string STRING of overlay OVERLAY to vector
4900 `entries' which has size `size' and currently contains `n'
4901 elements. AFTER_P non-zero means STRING is an after-string of
4903 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4906 Lisp_Object priority; \
4910 int new_size = 2 * size; \
4911 struct overlay_entry *old = entries; \
4913 (struct overlay_entry *) alloca (new_size \
4914 * sizeof *entries); \
4915 bcopy (old, entries, size * sizeof *entries); \
4919 entries[n].string = (STRING); \
4920 entries[n].overlay = (OVERLAY); \
4921 priority = Foverlay_get ((OVERLAY), Qpriority); \
4922 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4923 entries[n].after_string_p = (AFTER_P); \
4928 /* Process overlay before the overlay center. */
4929 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4931 XSETMISC (overlay
, ov
);
4932 xassert (OVERLAYP (overlay
));
4933 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4934 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4939 /* Skip this overlay if it doesn't start or end at IT's current
4941 if (end
!= charpos
&& start
!= charpos
)
4944 /* Skip this overlay if it doesn't apply to IT->w. */
4945 window
= Foverlay_get (overlay
, Qwindow
);
4946 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4949 /* If the text ``under'' the overlay is invisible, both before-
4950 and after-strings from this overlay are visible; start and
4951 end position are indistinguishable. */
4952 invisible
= Foverlay_get (overlay
, Qinvisible
);
4953 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4955 /* If overlay has a non-empty before-string, record it. */
4956 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4957 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4959 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4961 /* If overlay has a non-empty after-string, record it. */
4962 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4963 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4965 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4968 /* Process overlays after the overlay center. */
4969 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4971 XSETMISC (overlay
, ov
);
4972 xassert (OVERLAYP (overlay
));
4973 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4974 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4976 if (start
> charpos
)
4979 /* Skip this overlay if it doesn't start or end at IT's current
4981 if (end
!= charpos
&& start
!= charpos
)
4984 /* Skip this overlay if it doesn't apply to IT->w. */
4985 window
= Foverlay_get (overlay
, Qwindow
);
4986 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4989 /* If the text ``under'' the overlay is invisible, it has a zero
4990 dimension, and both before- and after-strings apply. */
4991 invisible
= Foverlay_get (overlay
, Qinvisible
);
4992 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4994 /* If overlay has a non-empty before-string, record it. */
4995 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4996 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4998 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5000 /* If overlay has a non-empty after-string, record it. */
5001 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5002 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5004 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5007 #undef RECORD_OVERLAY_STRING
5011 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5013 /* Record the total number of strings to process. */
5014 it
->n_overlay_strings
= n
;
5016 /* IT->current.overlay_string_index is the number of overlay strings
5017 that have already been consumed by IT. Copy some of the
5018 remaining overlay strings to IT->overlay_strings. */
5020 j
= it
->current
.overlay_string_index
;
5021 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5023 it
->overlay_strings
[i
] = entries
[j
].string
;
5024 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5031 /* Get the first chunk of overlay strings at IT's current buffer
5032 position, or at CHARPOS if that is > 0. Value is non-zero if at
5033 least one overlay string was found. */
5036 get_overlay_strings_1 (struct it
*it
, int charpos
, int compute_stop_p
)
5038 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5039 process. This fills IT->overlay_strings with strings, and sets
5040 IT->n_overlay_strings to the total number of strings to process.
5041 IT->pos.overlay_string_index has to be set temporarily to zero
5042 because load_overlay_strings needs this; it must be set to -1
5043 when no overlay strings are found because a zero value would
5044 indicate a position in the first overlay string. */
5045 it
->current
.overlay_string_index
= 0;
5046 load_overlay_strings (it
, charpos
);
5048 /* If we found overlay strings, set up IT to deliver display
5049 elements from the first one. Otherwise set up IT to deliver
5050 from current_buffer. */
5051 if (it
->n_overlay_strings
)
5053 /* Make sure we know settings in current_buffer, so that we can
5054 restore meaningful values when we're done with the overlay
5057 compute_stop_pos (it
);
5058 xassert (it
->face_id
>= 0);
5060 /* Save IT's settings. They are restored after all overlay
5061 strings have been processed. */
5062 xassert (!compute_stop_p
|| it
->sp
== 0);
5064 /* When called from handle_stop, there might be an empty display
5065 string loaded. In that case, don't bother saving it. */
5066 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5069 /* Set up IT to deliver display elements from the first overlay
5071 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5072 it
->string
= it
->overlay_strings
[0];
5073 it
->from_overlay
= Qnil
;
5074 it
->stop_charpos
= 0;
5075 xassert (STRINGP (it
->string
));
5076 it
->end_charpos
= SCHARS (it
->string
);
5077 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5078 it
->method
= GET_FROM_STRING
;
5082 it
->current
.overlay_string_index
= -1;
5087 get_overlay_strings (struct it
*it
, int charpos
)
5090 it
->method
= GET_FROM_BUFFER
;
5092 (void) get_overlay_strings_1 (it
, charpos
, 1);
5096 /* Value is non-zero if we found at least one overlay string. */
5097 return STRINGP (it
->string
);
5102 /***********************************************************************
5103 Saving and restoring state
5104 ***********************************************************************/
5106 /* Save current settings of IT on IT->stack. Called, for example,
5107 before setting up IT for an overlay string, to be able to restore
5108 IT's settings to what they were after the overlay string has been
5112 push_it (struct it
*it
)
5114 struct iterator_stack_entry
*p
;
5116 xassert (it
->sp
< IT_STACK_SIZE
);
5117 p
= it
->stack
+ it
->sp
;
5119 p
->stop_charpos
= it
->stop_charpos
;
5120 p
->prev_stop
= it
->prev_stop
;
5121 p
->base_level_stop
= it
->base_level_stop
;
5122 p
->cmp_it
= it
->cmp_it
;
5123 xassert (it
->face_id
>= 0);
5124 p
->face_id
= it
->face_id
;
5125 p
->string
= it
->string
;
5126 p
->method
= it
->method
;
5127 p
->from_overlay
= it
->from_overlay
;
5130 case GET_FROM_IMAGE
:
5131 p
->u
.image
.object
= it
->object
;
5132 p
->u
.image
.image_id
= it
->image_id
;
5133 p
->u
.image
.slice
= it
->slice
;
5135 case GET_FROM_STRETCH
:
5136 p
->u
.stretch
.object
= it
->object
;
5139 p
->position
= it
->position
;
5140 p
->current
= it
->current
;
5141 p
->end_charpos
= it
->end_charpos
;
5142 p
->string_nchars
= it
->string_nchars
;
5144 p
->multibyte_p
= it
->multibyte_p
;
5145 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5146 p
->space_width
= it
->space_width
;
5147 p
->font_height
= it
->font_height
;
5148 p
->voffset
= it
->voffset
;
5149 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5150 p
->display_ellipsis_p
= 0;
5151 p
->line_wrap
= it
->line_wrap
;
5156 iterate_out_of_display_property (struct it
*it
)
5158 /* Maybe initialize paragraph direction. If we are at the beginning
5159 of a new paragraph, next_element_from_buffer may not have a
5160 chance to do that. */
5161 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5162 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5163 /* prev_stop can be zero, so check against BEGV as well. */
5164 while (it
->bidi_it
.charpos
>= BEGV
5165 && it
->prev_stop
<= it
->bidi_it
.charpos
5166 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5167 bidi_move_to_visually_next (&it
->bidi_it
);
5168 /* Record the stop_pos we just crossed, for when we cross it
5170 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5171 it
->prev_stop
= CHARPOS (it
->position
);
5172 /* If we ended up not where pop_it put us, resync IT's
5173 positional members with the bidi iterator. */
5174 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5176 SET_TEXT_POS (it
->position
,
5177 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5178 it
->current
.pos
= it
->position
;
5182 /* Restore IT's settings from IT->stack. Called, for example, when no
5183 more overlay strings must be processed, and we return to delivering
5184 display elements from a buffer, or when the end of a string from a
5185 `display' property is reached and we return to delivering display
5186 elements from an overlay string, or from a buffer. */
5189 pop_it (struct it
*it
)
5191 struct iterator_stack_entry
*p
;
5193 xassert (it
->sp
> 0);
5195 p
= it
->stack
+ it
->sp
;
5196 it
->stop_charpos
= p
->stop_charpos
;
5197 it
->prev_stop
= p
->prev_stop
;
5198 it
->base_level_stop
= p
->base_level_stop
;
5199 it
->cmp_it
= p
->cmp_it
;
5200 it
->face_id
= p
->face_id
;
5201 it
->current
= p
->current
;
5202 it
->position
= p
->position
;
5203 it
->string
= p
->string
;
5204 it
->from_overlay
= p
->from_overlay
;
5205 if (NILP (it
->string
))
5206 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5207 it
->method
= p
->method
;
5210 case GET_FROM_IMAGE
:
5211 it
->image_id
= p
->u
.image
.image_id
;
5212 it
->object
= p
->u
.image
.object
;
5213 it
->slice
= p
->u
.image
.slice
;
5215 case GET_FROM_STRETCH
:
5216 it
->object
= p
->u
.comp
.object
;
5218 case GET_FROM_BUFFER
:
5219 it
->object
= it
->w
->buffer
;
5222 /* Bidi-iterate until we get out of the portion of text, if
5223 any, covered by a `display' text property or an overlay
5224 with `display' property. (We cannot just jump there,
5225 because the internal coherency of the bidi iterator state
5226 can not be preserved across such jumps.) We also must
5227 determine the paragraph base direction if the overlay we
5228 just processed is at the beginning of a new
5230 iterate_out_of_display_property (it
);
5233 case GET_FROM_STRING
:
5234 it
->object
= it
->string
;
5236 case GET_FROM_DISPLAY_VECTOR
:
5238 it
->method
= GET_FROM_C_STRING
;
5239 else if (STRINGP (it
->string
))
5240 it
->method
= GET_FROM_STRING
;
5243 it
->method
= GET_FROM_BUFFER
;
5244 it
->object
= it
->w
->buffer
;
5247 it
->end_charpos
= p
->end_charpos
;
5248 it
->string_nchars
= p
->string_nchars
;
5250 it
->multibyte_p
= p
->multibyte_p
;
5251 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5252 it
->space_width
= p
->space_width
;
5253 it
->font_height
= p
->font_height
;
5254 it
->voffset
= p
->voffset
;
5255 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5256 it
->line_wrap
= p
->line_wrap
;
5261 /***********************************************************************
5263 ***********************************************************************/
5265 /* Set IT's current position to the previous line start. */
5268 back_to_previous_line_start (struct it
*it
)
5270 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5271 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5275 /* Move IT to the next line start.
5277 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5278 we skipped over part of the text (as opposed to moving the iterator
5279 continuously over the text). Otherwise, don't change the value
5282 Newlines may come from buffer text, overlay strings, or strings
5283 displayed via the `display' property. That's the reason we can't
5284 simply use find_next_newline_no_quit.
5286 Note that this function may not skip over invisible text that is so
5287 because of text properties and immediately follows a newline. If
5288 it would, function reseat_at_next_visible_line_start, when called
5289 from set_iterator_to_next, would effectively make invisible
5290 characters following a newline part of the wrong glyph row, which
5291 leads to wrong cursor motion. */
5294 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5296 int old_selective
, newline_found_p
, n
;
5297 const int MAX_NEWLINE_DISTANCE
= 500;
5299 /* If already on a newline, just consume it to avoid unintended
5300 skipping over invisible text below. */
5301 if (it
->what
== IT_CHARACTER
5303 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5305 set_iterator_to_next (it
, 0);
5310 /* Don't handle selective display in the following. It's (a)
5311 unnecessary because it's done by the caller, and (b) leads to an
5312 infinite recursion because next_element_from_ellipsis indirectly
5313 calls this function. */
5314 old_selective
= it
->selective
;
5317 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5318 from buffer text. */
5319 for (n
= newline_found_p
= 0;
5320 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5321 n
+= STRINGP (it
->string
) ? 0 : 1)
5323 if (!get_next_display_element (it
))
5325 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5326 set_iterator_to_next (it
, 0);
5329 /* If we didn't find a newline near enough, see if we can use a
5331 if (!newline_found_p
)
5333 int start
= IT_CHARPOS (*it
);
5334 int limit
= find_next_newline_no_quit (start
, 1);
5337 xassert (!STRINGP (it
->string
));
5339 /* If there isn't any `display' property in sight, and no
5340 overlays, we can just use the position of the newline in
5342 if (it
->stop_charpos
>= limit
5343 || ((pos
= Fnext_single_property_change (make_number (start
),
5345 Qnil
, make_number (limit
)),
5347 && next_overlay_change (start
) == ZV
))
5349 IT_CHARPOS (*it
) = limit
;
5350 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5351 *skipped_p
= newline_found_p
= 1;
5355 while (get_next_display_element (it
)
5356 && !newline_found_p
)
5358 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5359 set_iterator_to_next (it
, 0);
5364 it
->selective
= old_selective
;
5365 return newline_found_p
;
5369 /* Set IT's current position to the previous visible line start. Skip
5370 invisible text that is so either due to text properties or due to
5371 selective display. Caution: this does not change IT->current_x and
5375 back_to_previous_visible_line_start (struct it
*it
)
5377 while (IT_CHARPOS (*it
) > BEGV
)
5379 back_to_previous_line_start (it
);
5381 if (IT_CHARPOS (*it
) <= BEGV
)
5384 /* If selective > 0, then lines indented more than its value are
5386 if (it
->selective
> 0
5387 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5388 (double) it
->selective
)) /* iftc */
5391 /* Check the newline before point for invisibility. */
5394 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5395 Qinvisible
, it
->window
);
5396 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5400 if (IT_CHARPOS (*it
) <= BEGV
)
5407 Lisp_Object val
, overlay
;
5409 /* If newline is part of a composition, continue from start of composition */
5410 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5411 && beg
< IT_CHARPOS (*it
))
5414 /* If newline is replaced by a display property, find start of overlay
5415 or interval and continue search from that point. */
5417 pos
= --IT_CHARPOS (it2
);
5420 it2
.string_from_display_prop_p
= 0;
5421 if (handle_display_prop (&it2
) == HANDLED_RETURN
5422 && !NILP (val
= get_char_property_and_overlay
5423 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5424 && (OVERLAYP (overlay
)
5425 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5426 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5429 /* Newline is not replaced by anything -- so we are done. */
5435 IT_CHARPOS (*it
) = beg
;
5436 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5440 it
->continuation_lines_width
= 0;
5442 xassert (IT_CHARPOS (*it
) >= BEGV
);
5443 xassert (IT_CHARPOS (*it
) == BEGV
5444 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5449 /* Reseat iterator IT at the previous visible line start. Skip
5450 invisible text that is so either due to text properties or due to
5451 selective display. At the end, update IT's overlay information,
5452 face information etc. */
5455 reseat_at_previous_visible_line_start (struct it
*it
)
5457 back_to_previous_visible_line_start (it
);
5458 reseat (it
, it
->current
.pos
, 1);
5463 /* Reseat iterator IT on the next visible line start in the current
5464 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5465 preceding the line start. Skip over invisible text that is so
5466 because of selective display. Compute faces, overlays etc at the
5467 new position. Note that this function does not skip over text that
5468 is invisible because of text properties. */
5471 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5473 int newline_found_p
, skipped_p
= 0;
5475 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5477 /* Skip over lines that are invisible because they are indented
5478 more than the value of IT->selective. */
5479 if (it
->selective
> 0)
5480 while (IT_CHARPOS (*it
) < ZV
5481 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5482 (double) it
->selective
)) /* iftc */
5484 xassert (IT_BYTEPOS (*it
) == BEGV
5485 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5486 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5489 /* Position on the newline if that's what's requested. */
5490 if (on_newline_p
&& newline_found_p
)
5492 if (STRINGP (it
->string
))
5494 if (IT_STRING_CHARPOS (*it
) > 0)
5496 --IT_STRING_CHARPOS (*it
);
5497 --IT_STRING_BYTEPOS (*it
);
5500 else if (IT_CHARPOS (*it
) > BEGV
)
5504 reseat (it
, it
->current
.pos
, 0);
5508 reseat (it
, it
->current
.pos
, 0);
5515 /***********************************************************************
5516 Changing an iterator's position
5517 ***********************************************************************/
5519 /* Change IT's current position to POS in current_buffer. If FORCE_P
5520 is non-zero, always check for text properties at the new position.
5521 Otherwise, text properties are only looked up if POS >=
5522 IT->check_charpos of a property. */
5525 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5527 int original_pos
= IT_CHARPOS (*it
);
5529 reseat_1 (it
, pos
, 0);
5531 /* Determine where to check text properties. Avoid doing it
5532 where possible because text property lookup is very expensive. */
5534 || CHARPOS (pos
) > it
->stop_charpos
5535 || CHARPOS (pos
) < original_pos
)
5539 /* For bidi iteration, we need to prime prev_stop and
5540 base_level_stop with our best estimations. */
5541 if (CHARPOS (pos
) < it
->prev_stop
)
5543 handle_stop_backwards (it
, BEGV
);
5544 if (CHARPOS (pos
) < it
->base_level_stop
)
5545 it
->base_level_stop
= 0;
5547 else if (CHARPOS (pos
) > it
->stop_charpos
5548 && it
->stop_charpos
>= BEGV
)
5549 handle_stop_backwards (it
, it
->stop_charpos
);
5556 it
->prev_stop
= it
->base_level_stop
= 0;
5565 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5566 IT->stop_pos to POS, also. */
5569 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5571 /* Don't call this function when scanning a C string. */
5572 xassert (it
->s
== NULL
);
5574 /* POS must be a reasonable value. */
5575 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5577 it
->current
.pos
= it
->position
= pos
;
5578 it
->end_charpos
= ZV
;
5580 it
->current
.dpvec_index
= -1;
5581 it
->current
.overlay_string_index
= -1;
5582 IT_STRING_CHARPOS (*it
) = -1;
5583 IT_STRING_BYTEPOS (*it
) = -1;
5585 it
->string_from_display_prop_p
= 0;
5586 it
->method
= GET_FROM_BUFFER
;
5587 it
->object
= it
->w
->buffer
;
5588 it
->area
= TEXT_AREA
;
5589 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5591 it
->string_from_display_prop_p
= 0;
5592 it
->face_before_selective_p
= 0;
5594 it
->bidi_it
.first_elt
= 1;
5598 it
->stop_charpos
= CHARPOS (pos
);
5599 it
->base_level_stop
= CHARPOS (pos
);
5604 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5605 If S is non-null, it is a C string to iterate over. Otherwise,
5606 STRING gives a Lisp string to iterate over.
5608 If PRECISION > 0, don't return more then PRECISION number of
5609 characters from the string.
5611 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5612 characters have been returned. FIELD_WIDTH < 0 means an infinite
5615 MULTIBYTE = 0 means disable processing of multibyte characters,
5616 MULTIBYTE > 0 means enable it,
5617 MULTIBYTE < 0 means use IT->multibyte_p.
5619 IT must be initialized via a prior call to init_iterator before
5620 calling this function. */
5623 reseat_to_string (struct it
*it
, unsigned char *s
, Lisp_Object string
,
5624 int charpos
, int precision
, int field_width
, int multibyte
)
5626 /* No region in strings. */
5627 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5629 /* No text property checks performed by default, but see below. */
5630 it
->stop_charpos
= -1;
5632 /* Set iterator position and end position. */
5633 bzero (&it
->current
, sizeof it
->current
);
5634 it
->current
.overlay_string_index
= -1;
5635 it
->current
.dpvec_index
= -1;
5636 xassert (charpos
>= 0);
5638 /* If STRING is specified, use its multibyteness, otherwise use the
5639 setting of MULTIBYTE, if specified. */
5641 it
->multibyte_p
= multibyte
> 0;
5645 xassert (STRINGP (string
));
5646 it
->string
= string
;
5648 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5649 it
->method
= GET_FROM_STRING
;
5650 it
->current
.string_pos
= string_pos (charpos
, string
);
5657 /* Note that we use IT->current.pos, not it->current.string_pos,
5658 for displaying C strings. */
5659 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5660 if (it
->multibyte_p
)
5662 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5663 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5667 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5668 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5671 it
->method
= GET_FROM_C_STRING
;
5674 /* PRECISION > 0 means don't return more than PRECISION characters
5676 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5677 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5679 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5680 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5681 FIELD_WIDTH < 0 means infinite field width. This is useful for
5682 padding with `-' at the end of a mode line. */
5683 if (field_width
< 0)
5684 field_width
= INFINITY
;
5685 if (field_width
> it
->end_charpos
- charpos
)
5686 it
->end_charpos
= charpos
+ field_width
;
5688 /* Use the standard display table for displaying strings. */
5689 if (DISP_TABLE_P (Vstandard_display_table
))
5690 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5692 it
->stop_charpos
= charpos
;
5693 if (s
== NULL
&& it
->multibyte_p
)
5695 EMACS_INT endpos
= SCHARS (it
->string
);
5696 if (endpos
> it
->end_charpos
)
5697 endpos
= it
->end_charpos
;
5698 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5706 /***********************************************************************
5708 ***********************************************************************/
5710 /* Map enum it_method value to corresponding next_element_from_* function. */
5712 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5714 next_element_from_buffer
,
5715 next_element_from_display_vector
,
5716 next_element_from_string
,
5717 next_element_from_c_string
,
5718 next_element_from_image
,
5719 next_element_from_stretch
5722 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5725 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5726 (possibly with the following characters). */
5728 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5729 ((IT)->cmp_it.id >= 0 \
5730 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5731 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5732 END_CHARPOS, (IT)->w, \
5733 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5737 /* Load IT's display element fields with information about the next
5738 display element from the current position of IT. Value is zero if
5739 end of buffer (or C string) is reached. */
5741 static struct frame
*last_escape_glyph_frame
= NULL
;
5742 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5743 static int last_escape_glyph_merged_face_id
= 0;
5746 get_next_display_element (struct it
*it
)
5748 /* Non-zero means that we found a display element. Zero means that
5749 we hit the end of what we iterate over. Performance note: the
5750 function pointer `method' used here turns out to be faster than
5751 using a sequence of if-statements. */
5755 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5757 if (it
->what
== IT_CHARACTER
)
5759 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5760 and only if (a) the resolved directionality of that character
5762 /* FIXME: Do we need an exception for characters from display
5764 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5765 it
->c
= bidi_mirror_char (it
->c
);
5766 /* Map via display table or translate control characters.
5767 IT->c, IT->len etc. have been set to the next character by
5768 the function call above. If we have a display table, and it
5769 contains an entry for IT->c, translate it. Don't do this if
5770 IT->c itself comes from a display table, otherwise we could
5771 end up in an infinite recursion. (An alternative could be to
5772 count the recursion depth of this function and signal an
5773 error when a certain maximum depth is reached.) Is it worth
5775 if (success_p
&& it
->dpvec
== NULL
)
5778 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5779 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5780 nbsp_or_shy
= char_is_other
;
5781 int decoded
= it
->c
;
5784 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5787 struct Lisp_Vector
*v
= XVECTOR (dv
);
5789 /* Return the first character from the display table
5790 entry, if not empty. If empty, don't display the
5791 current character. */
5794 it
->dpvec_char_len
= it
->len
;
5795 it
->dpvec
= v
->contents
;
5796 it
->dpend
= v
->contents
+ v
->size
;
5797 it
->current
.dpvec_index
= 0;
5798 it
->dpvec_face_id
= -1;
5799 it
->saved_face_id
= it
->face_id
;
5800 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5805 set_iterator_to_next (it
, 0);
5810 if (unibyte_display_via_language_environment
5811 && !ASCII_CHAR_P (it
->c
))
5812 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5814 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5816 if (it
->multibyte_p
)
5817 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5818 : it
->c
== 0xAD ? char_is_soft_hyphen
5820 else if (unibyte_display_via_language_environment
)
5821 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5822 : decoded
== 0xAD ? char_is_soft_hyphen
5826 /* Translate control characters into `\003' or `^C' form.
5827 Control characters coming from a display table entry are
5828 currently not translated because we use IT->dpvec to hold
5829 the translation. This could easily be changed but I
5830 don't believe that it is worth doing.
5832 If it->multibyte_p is nonzero, non-printable non-ASCII
5833 characters are also translated to octal form.
5835 If it->multibyte_p is zero, eight-bit characters that
5836 don't have corresponding multibyte char code are also
5837 translated to octal form. */
5839 ? (it
->area
!= TEXT_AREA
5840 /* In mode line, treat \n, \t like other crl chars. */
5843 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5844 || (it
->c
!= '\n' && it
->c
!= '\t'))
5847 ? ! CHAR_PRINTABLE_P (it
->c
)
5848 : (! unibyte_display_via_language_environment
5850 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5852 /* IT->c is a control character which must be displayed
5853 either as '\003' or as `^C' where the '\\' and '^'
5854 can be defined in the display table. Fill
5855 IT->ctl_chars with glyphs for what we have to
5856 display. Then, set IT->dpvec to these glyphs. */
5859 int face_id
, lface_id
= 0 ;
5862 /* Handle control characters with ^. */
5864 if (it
->c
< 128 && it
->ctl_arrow_p
)
5868 g
= '^'; /* default glyph for Control */
5869 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5871 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5872 && GLYPH_CODE_CHAR_VALID_P (gc
))
5874 g
= GLYPH_CODE_CHAR (gc
);
5875 lface_id
= GLYPH_CODE_FACE (gc
);
5879 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5881 else if (it
->f
== last_escape_glyph_frame
5882 && it
->face_id
== last_escape_glyph_face_id
)
5884 face_id
= last_escape_glyph_merged_face_id
;
5888 /* Merge the escape-glyph face into the current face. */
5889 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5891 last_escape_glyph_frame
= it
->f
;
5892 last_escape_glyph_face_id
= it
->face_id
;
5893 last_escape_glyph_merged_face_id
= face_id
;
5896 XSETINT (it
->ctl_chars
[0], g
);
5897 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5899 goto display_control
;
5902 /* Handle non-break space in the mode where it only gets
5905 if (EQ (Vnobreak_char_display
, Qt
)
5906 && nbsp_or_shy
== char_is_nbsp
)
5908 /* Merge the no-break-space face into the current face. */
5909 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5913 XSETINT (it
->ctl_chars
[0], ' ');
5915 goto display_control
;
5918 /* Handle sequences that start with the "escape glyph". */
5920 /* the default escape glyph is \. */
5921 escape_glyph
= '\\';
5924 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5925 && GLYPH_CODE_CHAR_VALID_P (gc
))
5927 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5928 lface_id
= GLYPH_CODE_FACE (gc
);
5932 /* The display table specified a face.
5933 Merge it into face_id and also into escape_glyph. */
5934 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5937 else if (it
->f
== last_escape_glyph_frame
5938 && it
->face_id
== last_escape_glyph_face_id
)
5940 face_id
= last_escape_glyph_merged_face_id
;
5944 /* Merge the escape-glyph face into the current face. */
5945 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5947 last_escape_glyph_frame
= it
->f
;
5948 last_escape_glyph_face_id
= it
->face_id
;
5949 last_escape_glyph_merged_face_id
= face_id
;
5952 /* Handle soft hyphens in the mode where they only get
5955 if (EQ (Vnobreak_char_display
, Qt
)
5956 && nbsp_or_shy
== char_is_soft_hyphen
)
5959 XSETINT (it
->ctl_chars
[0], '-');
5961 goto display_control
;
5964 /* Handle non-break space and soft hyphen
5965 with the escape glyph. */
5969 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5970 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5971 XSETINT (it
->ctl_chars
[1], it
->c
);
5973 goto display_control
;
5977 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5981 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5982 if (CHAR_BYTE8_P (it
->c
))
5984 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5987 else if (it
->c
< 256)
5994 /* It's an invalid character, which shouldn't
5995 happen actually, but due to bugs it may
5996 happen. Let's print the char as is, there's
5997 not much meaningful we can do with it. */
5999 str
[1] = it
->c
>> 8;
6000 str
[2] = it
->c
>> 16;
6001 str
[3] = it
->c
>> 24;
6005 for (i
= 0; i
< len
; i
++)
6008 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6009 /* Insert three more glyphs into IT->ctl_chars for
6010 the octal display of the character. */
6011 g
= ((str
[i
] >> 6) & 7) + '0';
6012 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6013 g
= ((str
[i
] >> 3) & 7) + '0';
6014 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6015 g
= (str
[i
] & 7) + '0';
6016 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6022 /* Set up IT->dpvec and return first character from it. */
6023 it
->dpvec_char_len
= it
->len
;
6024 it
->dpvec
= it
->ctl_chars
;
6025 it
->dpend
= it
->dpvec
+ ctl_len
;
6026 it
->current
.dpvec_index
= 0;
6027 it
->dpvec_face_id
= face_id
;
6028 it
->saved_face_id
= it
->face_id
;
6029 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6036 #ifdef HAVE_WINDOW_SYSTEM
6037 /* Adjust face id for a multibyte character. There are no multibyte
6038 character in unibyte text. */
6039 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6042 && FRAME_WINDOW_P (it
->f
))
6044 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6046 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6048 /* Automatic composition with glyph-string. */
6049 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6051 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6055 int pos
= (it
->s
? -1
6056 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6057 : IT_CHARPOS (*it
));
6059 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6064 /* Is this character the last one of a run of characters with
6065 box? If yes, set IT->end_of_box_run_p to 1. */
6069 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6071 int face_id
= underlying_face_id (it
);
6072 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6076 if (face
->box
== FACE_NO_BOX
)
6078 /* If the box comes from face properties in a
6079 display string, check faces in that string. */
6080 int string_face_id
= face_after_it_pos (it
);
6081 it
->end_of_box_run_p
6082 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6085 /* Otherwise, the box comes from the underlying face.
6086 If this is the last string character displayed, check
6087 the next buffer location. */
6088 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6089 && (it
->current
.overlay_string_index
6090 == it
->n_overlay_strings
- 1))
6094 struct text_pos pos
= it
->current
.pos
;
6095 INC_TEXT_POS (pos
, it
->multibyte_p
);
6097 next_face_id
= face_at_buffer_position
6098 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6099 it
->region_end_charpos
, &ignore
,
6100 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6102 it
->end_of_box_run_p
6103 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6110 int face_id
= face_after_it_pos (it
);
6111 it
->end_of_box_run_p
6112 = (face_id
!= it
->face_id
6113 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6117 /* Value is 0 if end of buffer or string reached. */
6122 /* Move IT to the next display element.
6124 RESEAT_P non-zero means if called on a newline in buffer text,
6125 skip to the next visible line start.
6127 Functions get_next_display_element and set_iterator_to_next are
6128 separate because I find this arrangement easier to handle than a
6129 get_next_display_element function that also increments IT's
6130 position. The way it is we can first look at an iterator's current
6131 display element, decide whether it fits on a line, and if it does,
6132 increment the iterator position. The other way around we probably
6133 would either need a flag indicating whether the iterator has to be
6134 incremented the next time, or we would have to implement a
6135 decrement position function which would not be easy to write. */
6138 set_iterator_to_next (struct it
*it
, int reseat_p
)
6140 /* Reset flags indicating start and end of a sequence of characters
6141 with box. Reset them at the start of this function because
6142 moving the iterator to a new position might set them. */
6143 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6147 case GET_FROM_BUFFER
:
6148 /* The current display element of IT is a character from
6149 current_buffer. Advance in the buffer, and maybe skip over
6150 invisible lines that are so because of selective display. */
6151 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6152 reseat_at_next_visible_line_start (it
, 0);
6153 else if (it
->cmp_it
.id
>= 0)
6155 /* We are currently getting glyphs from a composition. */
6160 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6161 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6162 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6164 it
->cmp_it
.from
= it
->cmp_it
.to
;
6169 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6171 it
->stop_charpos
, Qnil
);
6174 else if (! it
->cmp_it
.reversed_p
)
6176 /* Composition created while scanning forward. */
6177 /* Update IT's char/byte positions to point to the first
6178 character of the next grapheme cluster, or to the
6179 character visually after the current composition. */
6180 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6181 bidi_move_to_visually_next (&it
->bidi_it
);
6182 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6183 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6185 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6187 /* Proceed to the next grapheme cluster. */
6188 it
->cmp_it
.from
= it
->cmp_it
.to
;
6192 /* No more grapheme clusters in this composition.
6193 Find the next stop position. */
6194 EMACS_INT stop
= it
->stop_charpos
;
6195 if (it
->bidi_it
.scan_dir
< 0)
6196 /* Now we are scanning backward and don't know
6199 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6200 IT_BYTEPOS (*it
), stop
, Qnil
);
6205 /* Composition created while scanning backward. */
6206 /* Update IT's char/byte positions to point to the last
6207 character of the previous grapheme cluster, or the
6208 character visually after the current composition. */
6209 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6210 bidi_move_to_visually_next (&it
->bidi_it
);
6211 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6212 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6213 if (it
->cmp_it
.from
> 0)
6215 /* Proceed to the previous grapheme cluster. */
6216 it
->cmp_it
.to
= it
->cmp_it
.from
;
6220 /* No more grapheme clusters in this composition.
6221 Find the next stop position. */
6222 EMACS_INT stop
= it
->stop_charpos
;
6223 if (it
->bidi_it
.scan_dir
< 0)
6224 /* Now we are scanning backward and don't know
6227 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6228 IT_BYTEPOS (*it
), stop
, Qnil
);
6234 xassert (it
->len
!= 0);
6238 IT_BYTEPOS (*it
) += it
->len
;
6239 IT_CHARPOS (*it
) += 1;
6243 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6244 /* If this is a new paragraph, determine its base
6245 direction (a.k.a. its base embedding level). */
6246 if (it
->bidi_it
.new_paragraph
)
6247 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6248 bidi_move_to_visually_next (&it
->bidi_it
);
6249 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6250 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6251 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6253 /* As the scan direction was changed, we must
6254 re-compute the stop position for composition. */
6255 EMACS_INT stop
= it
->stop_charpos
;
6256 if (it
->bidi_it
.scan_dir
< 0)
6258 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6259 IT_BYTEPOS (*it
), stop
, Qnil
);
6262 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6266 case GET_FROM_C_STRING
:
6267 /* Current display element of IT is from a C string. */
6268 IT_BYTEPOS (*it
) += it
->len
;
6269 IT_CHARPOS (*it
) += 1;
6272 case GET_FROM_DISPLAY_VECTOR
:
6273 /* Current display element of IT is from a display table entry.
6274 Advance in the display table definition. Reset it to null if
6275 end reached, and continue with characters from buffers/
6277 ++it
->current
.dpvec_index
;
6279 /* Restore face of the iterator to what they were before the
6280 display vector entry (these entries may contain faces). */
6281 it
->face_id
= it
->saved_face_id
;
6283 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6285 int recheck_faces
= it
->ellipsis_p
;
6288 it
->method
= GET_FROM_C_STRING
;
6289 else if (STRINGP (it
->string
))
6290 it
->method
= GET_FROM_STRING
;
6293 it
->method
= GET_FROM_BUFFER
;
6294 it
->object
= it
->w
->buffer
;
6298 it
->current
.dpvec_index
= -1;
6300 /* Skip over characters which were displayed via IT->dpvec. */
6301 if (it
->dpvec_char_len
< 0)
6302 reseat_at_next_visible_line_start (it
, 1);
6303 else if (it
->dpvec_char_len
> 0)
6305 if (it
->method
== GET_FROM_STRING
6306 && it
->n_overlay_strings
> 0)
6307 it
->ignore_overlay_strings_at_pos_p
= 1;
6308 it
->len
= it
->dpvec_char_len
;
6309 set_iterator_to_next (it
, reseat_p
);
6312 /* Maybe recheck faces after display vector */
6314 it
->stop_charpos
= IT_CHARPOS (*it
);
6318 case GET_FROM_STRING
:
6319 /* Current display element is a character from a Lisp string. */
6320 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6321 if (it
->cmp_it
.id
>= 0)
6323 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6324 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6325 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6326 it
->cmp_it
.from
= it
->cmp_it
.to
;
6330 composition_compute_stop_pos (&it
->cmp_it
,
6331 IT_STRING_CHARPOS (*it
),
6332 IT_STRING_BYTEPOS (*it
),
6333 it
->stop_charpos
, it
->string
);
6338 IT_STRING_BYTEPOS (*it
) += it
->len
;
6339 IT_STRING_CHARPOS (*it
) += 1;
6342 consider_string_end
:
6344 if (it
->current
.overlay_string_index
>= 0)
6346 /* IT->string is an overlay string. Advance to the
6347 next, if there is one. */
6348 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6351 next_overlay_string (it
);
6353 setup_for_ellipsis (it
, 0);
6358 /* IT->string is not an overlay string. If we reached
6359 its end, and there is something on IT->stack, proceed
6360 with what is on the stack. This can be either another
6361 string, this time an overlay string, or a buffer. */
6362 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6366 if (it
->method
== GET_FROM_STRING
)
6367 goto consider_string_end
;
6372 case GET_FROM_IMAGE
:
6373 case GET_FROM_STRETCH
:
6374 /* The position etc with which we have to proceed are on
6375 the stack. The position may be at the end of a string,
6376 if the `display' property takes up the whole string. */
6377 xassert (it
->sp
> 0);
6379 if (it
->method
== GET_FROM_STRING
)
6380 goto consider_string_end
;
6384 /* There are no other methods defined, so this should be a bug. */
6388 xassert (it
->method
!= GET_FROM_STRING
6389 || (STRINGP (it
->string
)
6390 && IT_STRING_CHARPOS (*it
) >= 0));
6393 /* Load IT's display element fields with information about the next
6394 display element which comes from a display table entry or from the
6395 result of translating a control character to one of the forms `^C'
6398 IT->dpvec holds the glyphs to return as characters.
6399 IT->saved_face_id holds the face id before the display vector--it
6400 is restored into IT->face_id in set_iterator_to_next. */
6403 next_element_from_display_vector (struct it
*it
)
6408 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6410 it
->face_id
= it
->saved_face_id
;
6412 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6413 That seemed totally bogus - so I changed it... */
6414 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6416 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6418 it
->c
= GLYPH_CODE_CHAR (gc
);
6419 it
->len
= CHAR_BYTES (it
->c
);
6421 /* The entry may contain a face id to use. Such a face id is
6422 the id of a Lisp face, not a realized face. A face id of
6423 zero means no face is specified. */
6424 if (it
->dpvec_face_id
>= 0)
6425 it
->face_id
= it
->dpvec_face_id
;
6428 int lface_id
= GLYPH_CODE_FACE (gc
);
6430 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6435 /* Display table entry is invalid. Return a space. */
6436 it
->c
= ' ', it
->len
= 1;
6438 /* Don't change position and object of the iterator here. They are
6439 still the values of the character that had this display table
6440 entry or was translated, and that's what we want. */
6441 it
->what
= IT_CHARACTER
;
6446 /* Load IT with the next display element from Lisp string IT->string.
6447 IT->current.string_pos is the current position within the string.
6448 If IT->current.overlay_string_index >= 0, the Lisp string is an
6452 next_element_from_string (struct it
*it
)
6454 struct text_pos position
;
6456 xassert (STRINGP (it
->string
));
6457 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6458 position
= it
->current
.string_pos
;
6460 /* Time to check for invisible text? */
6461 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6462 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6466 /* Since a handler may have changed IT->method, we must
6468 return GET_NEXT_DISPLAY_ELEMENT (it
);
6471 if (it
->current
.overlay_string_index
>= 0)
6473 /* Get the next character from an overlay string. In overlay
6474 strings, There is no field width or padding with spaces to
6476 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6481 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6482 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6483 && next_element_from_composition (it
))
6487 else if (STRING_MULTIBYTE (it
->string
))
6489 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6490 const unsigned char *s
= (SDATA (it
->string
)
6491 + IT_STRING_BYTEPOS (*it
));
6492 it
->c
= string_char_and_length (s
, &it
->len
);
6496 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6502 /* Get the next character from a Lisp string that is not an
6503 overlay string. Such strings come from the mode line, for
6504 example. We may have to pad with spaces, or truncate the
6505 string. See also next_element_from_c_string. */
6506 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6511 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6513 /* Pad with spaces. */
6514 it
->c
= ' ', it
->len
= 1;
6515 CHARPOS (position
) = BYTEPOS (position
) = -1;
6517 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6518 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6519 && next_element_from_composition (it
))
6523 else if (STRING_MULTIBYTE (it
->string
))
6525 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6526 const unsigned char *s
= (SDATA (it
->string
)
6527 + IT_STRING_BYTEPOS (*it
));
6528 it
->c
= string_char_and_length (s
, &it
->len
);
6532 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6537 /* Record what we have and where it came from. */
6538 it
->what
= IT_CHARACTER
;
6539 it
->object
= it
->string
;
6540 it
->position
= position
;
6545 /* Load IT with next display element from C string IT->s.
6546 IT->string_nchars is the maximum number of characters to return
6547 from the string. IT->end_charpos may be greater than
6548 IT->string_nchars when this function is called, in which case we
6549 may have to return padding spaces. Value is zero if end of string
6550 reached, including padding spaces. */
6553 next_element_from_c_string (struct it
*it
)
6558 it
->what
= IT_CHARACTER
;
6559 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6562 /* IT's position can be greater IT->string_nchars in case a field
6563 width or precision has been specified when the iterator was
6565 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6567 /* End of the game. */
6571 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6573 /* Pad with spaces. */
6574 it
->c
= ' ', it
->len
= 1;
6575 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6577 else if (it
->multibyte_p
)
6579 /* Implementation note: The calls to strlen apparently aren't a
6580 performance problem because there is no noticeable performance
6581 difference between Emacs running in unibyte or multibyte mode. */
6582 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6583 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6586 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6592 /* Set up IT to return characters from an ellipsis, if appropriate.
6593 The definition of the ellipsis glyphs may come from a display table
6594 entry. This function fills IT with the first glyph from the
6595 ellipsis if an ellipsis is to be displayed. */
6598 next_element_from_ellipsis (struct it
*it
)
6600 if (it
->selective_display_ellipsis_p
)
6601 setup_for_ellipsis (it
, it
->len
);
6604 /* The face at the current position may be different from the
6605 face we find after the invisible text. Remember what it
6606 was in IT->saved_face_id, and signal that it's there by
6607 setting face_before_selective_p. */
6608 it
->saved_face_id
= it
->face_id
;
6609 it
->method
= GET_FROM_BUFFER
;
6610 it
->object
= it
->w
->buffer
;
6611 reseat_at_next_visible_line_start (it
, 1);
6612 it
->face_before_selective_p
= 1;
6615 return GET_NEXT_DISPLAY_ELEMENT (it
);
6619 /* Deliver an image display element. The iterator IT is already
6620 filled with image information (done in handle_display_prop). Value
6625 next_element_from_image (struct it
*it
)
6627 it
->what
= IT_IMAGE
;
6632 /* Fill iterator IT with next display element from a stretch glyph
6633 property. IT->object is the value of the text property. Value is
6637 next_element_from_stretch (struct it
*it
)
6639 it
->what
= IT_STRETCH
;
6643 /* Scan forward from CHARPOS in the current buffer, until we find a
6644 stop position > current IT's position. Then handle the stop
6645 position before that. This is called when we bump into a stop
6646 position while reordering bidirectional text. CHARPOS should be
6647 the last previously processed stop_pos (or BEGV, if none were
6648 processed yet) whose position is less that IT's current
6652 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6654 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6655 struct display_pos save_current
= it
->current
;
6656 struct text_pos save_position
= it
->position
;
6657 struct text_pos pos1
;
6658 EMACS_INT next_stop
;
6660 /* Scan in strict logical order. */
6664 it
->prev_stop
= charpos
;
6665 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6666 reseat_1 (it
, pos1
, 0);
6667 compute_stop_pos (it
);
6668 /* We must advance forward, right? */
6669 if (it
->stop_charpos
<= it
->prev_stop
)
6671 charpos
= it
->stop_charpos
;
6673 while (charpos
<= where_we_are
);
6675 next_stop
= it
->stop_charpos
;
6676 it
->stop_charpos
= it
->prev_stop
;
6678 it
->current
= save_current
;
6679 it
->position
= save_position
;
6681 it
->stop_charpos
= next_stop
;
6684 /* Load IT with the next display element from current_buffer. Value
6685 is zero if end of buffer reached. IT->stop_charpos is the next
6686 position at which to stop and check for text properties or buffer
6690 next_element_from_buffer (struct it
*it
)
6694 xassert (IT_CHARPOS (*it
) >= BEGV
);
6696 /* With bidi reordering, the character to display might not be the
6697 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6698 we were reseat()ed to a new buffer position, which is potentially
6699 a different paragraph. */
6700 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6702 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6703 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6704 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6706 /* Nothing to do, but reset the FIRST_ELT flag, like
6707 bidi_paragraph_init does, because we are not going to
6709 it
->bidi_it
.first_elt
= 0;
6711 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6712 /* FIXME: Should support all Unicode line separators. */
6713 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6714 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6716 /* If we are at the beginning of a line, we can produce the
6717 next element right away. */
6718 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6719 bidi_move_to_visually_next (&it
->bidi_it
);
6723 int orig_bytepos
= IT_BYTEPOS (*it
);
6725 /* We need to prime the bidi iterator starting at the line's
6726 beginning, before we will be able to produce the next
6728 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6729 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6730 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6731 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6732 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6735 /* Now return to buffer position where we were asked to
6736 get the next display element, and produce that. */
6737 bidi_move_to_visually_next (&it
->bidi_it
);
6739 while (it
->bidi_it
.bytepos
!= orig_bytepos
6740 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6743 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6744 /* Adjust IT's position information to where we ended up. */
6745 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6746 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6747 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6749 EMACS_INT stop
= it
->stop_charpos
;
6750 if (it
->bidi_it
.scan_dir
< 0)
6752 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6753 IT_BYTEPOS (*it
), stop
, Qnil
);
6757 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6759 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6761 int overlay_strings_follow_p
;
6763 /* End of the game, except when overlay strings follow that
6764 haven't been returned yet. */
6765 if (it
->overlay_strings_at_end_processed_p
)
6766 overlay_strings_follow_p
= 0;
6769 it
->overlay_strings_at_end_processed_p
= 1;
6770 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6773 if (overlay_strings_follow_p
)
6774 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6778 it
->position
= it
->current
.pos
;
6782 else if (!(!it
->bidi_p
6783 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6784 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6786 /* With bidi non-linear iteration, we could find ourselves
6787 far beyond the last computed stop_charpos, with several
6788 other stop positions in between that we missed. Scan
6789 them all now, in buffer's logical order, until we find
6790 and handle the last stop_charpos that precedes our
6791 current position. */
6792 handle_stop_backwards (it
, it
->stop_charpos
);
6793 return GET_NEXT_DISPLAY_ELEMENT (it
);
6799 /* Take note of the stop position we just moved across,
6800 for when we will move back across it. */
6801 it
->prev_stop
= it
->stop_charpos
;
6802 /* If we are at base paragraph embedding level, take
6803 note of the last stop position seen at this
6805 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6806 it
->base_level_stop
= it
->stop_charpos
;
6809 return GET_NEXT_DISPLAY_ELEMENT (it
);
6813 /* We can sometimes back up for reasons that have nothing
6814 to do with bidi reordering. E.g., compositions. The
6815 code below is only needed when we are above the base
6816 embedding level, so test for that explicitly. */
6817 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6818 && IT_CHARPOS (*it
) < it
->prev_stop
)
6820 if (it
->base_level_stop
<= 0)
6821 it
->base_level_stop
= BEGV
;
6822 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6824 handle_stop_backwards (it
, it
->base_level_stop
);
6825 return GET_NEXT_DISPLAY_ELEMENT (it
);
6829 /* No face changes, overlays etc. in sight, so just return a
6830 character from current_buffer. */
6834 /* Maybe run the redisplay end trigger hook. Performance note:
6835 This doesn't seem to cost measurable time. */
6836 if (it
->redisplay_end_trigger_charpos
6838 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6839 run_redisplay_end_trigger_hook (it
);
6841 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6842 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6844 && next_element_from_composition (it
))
6849 /* Get the next character, maybe multibyte. */
6850 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6851 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6852 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6854 it
->c
= *p
, it
->len
= 1;
6856 /* Record what we have and where it came from. */
6857 it
->what
= IT_CHARACTER
;
6858 it
->object
= it
->w
->buffer
;
6859 it
->position
= it
->current
.pos
;
6861 /* Normally we return the character found above, except when we
6862 really want to return an ellipsis for selective display. */
6867 /* A value of selective > 0 means hide lines indented more
6868 than that number of columns. */
6869 if (it
->selective
> 0
6870 && IT_CHARPOS (*it
) + 1 < ZV
6871 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6872 IT_BYTEPOS (*it
) + 1,
6873 (double) it
->selective
)) /* iftc */
6875 success_p
= next_element_from_ellipsis (it
);
6876 it
->dpvec_char_len
= -1;
6879 else if (it
->c
== '\r' && it
->selective
== -1)
6881 /* A value of selective == -1 means that everything from the
6882 CR to the end of the line is invisible, with maybe an
6883 ellipsis displayed for it. */
6884 success_p
= next_element_from_ellipsis (it
);
6885 it
->dpvec_char_len
= -1;
6890 /* Value is zero if end of buffer reached. */
6891 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6896 /* Run the redisplay end trigger hook for IT. */
6899 run_redisplay_end_trigger_hook (struct it
*it
)
6901 Lisp_Object args
[3];
6903 /* IT->glyph_row should be non-null, i.e. we should be actually
6904 displaying something, or otherwise we should not run the hook. */
6905 xassert (it
->glyph_row
);
6907 /* Set up hook arguments. */
6908 args
[0] = Qredisplay_end_trigger_functions
;
6909 args
[1] = it
->window
;
6910 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6911 it
->redisplay_end_trigger_charpos
= 0;
6913 /* Since we are *trying* to run these functions, don't try to run
6914 them again, even if they get an error. */
6915 it
->w
->redisplay_end_trigger
= Qnil
;
6916 Frun_hook_with_args (3, args
);
6918 /* Notice if it changed the face of the character we are on. */
6919 handle_face_prop (it
);
6923 /* Deliver a composition display element. Unlike the other
6924 next_element_from_XXX, this function is not registered in the array
6925 get_next_element[]. It is called from next_element_from_buffer and
6926 next_element_from_string when necessary. */
6929 next_element_from_composition (struct it
*it
)
6931 it
->what
= IT_COMPOSITION
;
6932 it
->len
= it
->cmp_it
.nbytes
;
6933 if (STRINGP (it
->string
))
6937 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6938 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6941 it
->position
= it
->current
.string_pos
;
6942 it
->object
= it
->string
;
6943 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6944 IT_STRING_BYTEPOS (*it
), it
->string
);
6950 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6951 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6954 if (it
->bidi_it
.new_paragraph
)
6955 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6956 /* Resync the bidi iterator with IT's new position.
6957 FIXME: this doesn't support bidirectional text. */
6958 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6959 bidi_move_to_visually_next (&it
->bidi_it
);
6963 it
->position
= it
->current
.pos
;
6964 it
->object
= it
->w
->buffer
;
6965 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6966 IT_BYTEPOS (*it
), Qnil
);
6973 /***********************************************************************
6974 Moving an iterator without producing glyphs
6975 ***********************************************************************/
6977 /* Check if iterator is at a position corresponding to a valid buffer
6978 position after some move_it_ call. */
6980 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6981 ((it)->method == GET_FROM_STRING \
6982 ? IT_STRING_CHARPOS (*it) == 0 \
6986 /* Move iterator IT to a specified buffer or X position within one
6987 line on the display without producing glyphs.
6989 OP should be a bit mask including some or all of these bits:
6990 MOVE_TO_X: Stop upon reaching x-position TO_X.
6991 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6992 Regardless of OP's value, stop upon reaching the end of the display line.
6994 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6995 This means, in particular, that TO_X includes window's horizontal
6998 The return value has several possible values that
6999 say what condition caused the scan to stop:
7001 MOVE_POS_MATCH_OR_ZV
7002 - when TO_POS or ZV was reached.
7005 -when TO_X was reached before TO_POS or ZV were reached.
7008 - when we reached the end of the display area and the line must
7012 - when we reached the end of the display area and the line is
7016 - when we stopped at a line end, i.e. a newline or a CR and selective
7019 static enum move_it_result
7020 move_it_in_display_line_to (struct it
*it
,
7021 EMACS_INT to_charpos
, int to_x
,
7022 enum move_operation_enum op
)
7024 enum move_it_result result
= MOVE_UNDEFINED
;
7025 struct glyph_row
*saved_glyph_row
;
7026 struct it wrap_it
, atpos_it
, atx_it
;
7028 enum it_method prev_method
= it
->method
;
7029 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7031 /* Don't produce glyphs in produce_glyphs. */
7032 saved_glyph_row
= it
->glyph_row
;
7033 it
->glyph_row
= NULL
;
7035 /* Use wrap_it to save a copy of IT wherever a word wrap could
7036 occur. Use atpos_it to save a copy of IT at the desired buffer
7037 position, if found, so that we can scan ahead and check if the
7038 word later overshoots the window edge. Use atx_it similarly, for
7044 #define BUFFER_POS_REACHED_P() \
7045 ((op & MOVE_TO_POS) != 0 \
7046 && BUFFERP (it->object) \
7047 && (IT_CHARPOS (*it) == to_charpos \
7048 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7049 && (it->method == GET_FROM_BUFFER \
7050 || (it->method == GET_FROM_DISPLAY_VECTOR \
7051 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7053 /* If there's a line-/wrap-prefix, handle it. */
7054 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7055 && it
->current_y
< it
->last_visible_y
)
7056 handle_line_prefix (it
);
7060 int x
, i
, ascent
= 0, descent
= 0;
7062 /* Utility macro to reset an iterator with x, ascent, and descent. */
7063 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7064 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7065 (IT)->max_descent = descent)
7067 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7069 if ((op
& MOVE_TO_POS
) != 0
7070 && BUFFERP (it
->object
)
7071 && it
->method
== GET_FROM_BUFFER
7072 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7074 && (prev_method
== GET_FROM_IMAGE
7075 || prev_method
== GET_FROM_STRETCH
)
7076 /* Passed TO_CHARPOS from left to right. */
7077 && ((prev_pos
< to_charpos
7078 && IT_CHARPOS (*it
) > to_charpos
)
7079 /* Passed TO_CHARPOS from right to left. */
7080 || (prev_pos
> to_charpos
7081 && IT_CHARPOS (*it
) < to_charpos
)))))
7083 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7085 result
= MOVE_POS_MATCH_OR_ZV
;
7088 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7089 /* If wrap_it is valid, the current position might be in a
7090 word that is wrapped. So, save the iterator in
7091 atpos_it and continue to see if wrapping happens. */
7095 prev_method
= it
->method
;
7096 if (it
->method
== GET_FROM_BUFFER
)
7097 prev_pos
= IT_CHARPOS (*it
);
7098 /* Stop when ZV reached.
7099 We used to stop here when TO_CHARPOS reached as well, but that is
7100 too soon if this glyph does not fit on this line. So we handle it
7101 explicitly below. */
7102 if (!get_next_display_element (it
))
7104 result
= MOVE_POS_MATCH_OR_ZV
;
7108 if (it
->line_wrap
== TRUNCATE
)
7110 if (BUFFER_POS_REACHED_P ())
7112 result
= MOVE_POS_MATCH_OR_ZV
;
7118 if (it
->line_wrap
== WORD_WRAP
)
7120 if (IT_DISPLAYING_WHITESPACE (it
))
7124 /* We have reached a glyph that follows one or more
7125 whitespace characters. If the position is
7126 already found, we are done. */
7127 if (atpos_it
.sp
>= 0)
7130 result
= MOVE_POS_MATCH_OR_ZV
;
7136 result
= MOVE_X_REACHED
;
7139 /* Otherwise, we can wrap here. */
7146 /* Remember the line height for the current line, in case
7147 the next element doesn't fit on the line. */
7148 ascent
= it
->max_ascent
;
7149 descent
= it
->max_descent
;
7151 /* The call to produce_glyphs will get the metrics of the
7152 display element IT is loaded with. Record the x-position
7153 before this display element, in case it doesn't fit on the
7157 PRODUCE_GLYPHS (it
);
7159 if (it
->area
!= TEXT_AREA
)
7161 set_iterator_to_next (it
, 1);
7165 /* The number of glyphs we get back in IT->nglyphs will normally
7166 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7167 character on a terminal frame, or (iii) a line end. For the
7168 second case, IT->nglyphs - 1 padding glyphs will be present.
7169 (On X frames, there is only one glyph produced for a
7170 composite character.)
7172 The behavior implemented below means, for continuation lines,
7173 that as many spaces of a TAB as fit on the current line are
7174 displayed there. For terminal frames, as many glyphs of a
7175 multi-glyph character are displayed in the current line, too.
7176 This is what the old redisplay code did, and we keep it that
7177 way. Under X, the whole shape of a complex character must
7178 fit on the line or it will be completely displayed in the
7181 Note that both for tabs and padding glyphs, all glyphs have
7185 /* More than one glyph or glyph doesn't fit on line. All
7186 glyphs have the same width. */
7187 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7189 int x_before_this_char
= x
;
7190 int hpos_before_this_char
= it
->hpos
;
7192 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7194 new_x
= x
+ single_glyph_width
;
7196 /* We want to leave anything reaching TO_X to the caller. */
7197 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7199 if (BUFFER_POS_REACHED_P ())
7201 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7202 goto buffer_pos_reached
;
7203 if (atpos_it
.sp
< 0)
7206 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7211 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7214 result
= MOVE_X_REACHED
;
7220 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7225 if (/* Lines are continued. */
7226 it
->line_wrap
!= TRUNCATE
7227 && (/* And glyph doesn't fit on the line. */
7228 new_x
> it
->last_visible_x
7229 /* Or it fits exactly and we're on a window
7231 || (new_x
== it
->last_visible_x
7232 && FRAME_WINDOW_P (it
->f
))))
7234 if (/* IT->hpos == 0 means the very first glyph
7235 doesn't fit on the line, e.g. a wide image. */
7237 || (new_x
== it
->last_visible_x
7238 && FRAME_WINDOW_P (it
->f
)))
7241 it
->current_x
= new_x
;
7243 /* The character's last glyph just barely fits
7245 if (i
== it
->nglyphs
- 1)
7247 /* If this is the destination position,
7248 return a position *before* it in this row,
7249 now that we know it fits in this row. */
7250 if (BUFFER_POS_REACHED_P ())
7252 if (it
->line_wrap
!= WORD_WRAP
7255 it
->hpos
= hpos_before_this_char
;
7256 it
->current_x
= x_before_this_char
;
7257 result
= MOVE_POS_MATCH_OR_ZV
;
7260 if (it
->line_wrap
== WORD_WRAP
7264 atpos_it
.current_x
= x_before_this_char
;
7265 atpos_it
.hpos
= hpos_before_this_char
;
7269 set_iterator_to_next (it
, 1);
7270 /* On graphical terminals, newlines may
7271 "overflow" into the fringe if
7272 overflow-newline-into-fringe is non-nil.
7273 On text-only terminals, newlines may
7274 overflow into the last glyph on the
7276 if (!FRAME_WINDOW_P (it
->f
)
7277 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7279 if (!get_next_display_element (it
))
7281 result
= MOVE_POS_MATCH_OR_ZV
;
7284 if (BUFFER_POS_REACHED_P ())
7286 if (ITERATOR_AT_END_OF_LINE_P (it
))
7287 result
= MOVE_POS_MATCH_OR_ZV
;
7289 result
= MOVE_LINE_CONTINUED
;
7292 if (ITERATOR_AT_END_OF_LINE_P (it
))
7294 result
= MOVE_NEWLINE_OR_CR
;
7301 IT_RESET_X_ASCENT_DESCENT (it
);
7303 if (wrap_it
.sp
>= 0)
7310 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7312 result
= MOVE_LINE_CONTINUED
;
7316 if (BUFFER_POS_REACHED_P ())
7318 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7319 goto buffer_pos_reached
;
7320 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7323 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7327 if (new_x
> it
->first_visible_x
)
7329 /* Glyph is visible. Increment number of glyphs that
7330 would be displayed. */
7335 if (result
!= MOVE_UNDEFINED
)
7338 else if (BUFFER_POS_REACHED_P ())
7341 IT_RESET_X_ASCENT_DESCENT (it
);
7342 result
= MOVE_POS_MATCH_OR_ZV
;
7345 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7347 /* Stop when TO_X specified and reached. This check is
7348 necessary here because of lines consisting of a line end,
7349 only. The line end will not produce any glyphs and we
7350 would never get MOVE_X_REACHED. */
7351 xassert (it
->nglyphs
== 0);
7352 result
= MOVE_X_REACHED
;
7356 /* Is this a line end? If yes, we're done. */
7357 if (ITERATOR_AT_END_OF_LINE_P (it
))
7359 result
= MOVE_NEWLINE_OR_CR
;
7363 if (it
->method
== GET_FROM_BUFFER
)
7364 prev_pos
= IT_CHARPOS (*it
);
7365 /* The current display element has been consumed. Advance
7367 set_iterator_to_next (it
, 1);
7369 /* Stop if lines are truncated and IT's current x-position is
7370 past the right edge of the window now. */
7371 if (it
->line_wrap
== TRUNCATE
7372 && it
->current_x
>= it
->last_visible_x
)
7374 if (!FRAME_WINDOW_P (it
->f
)
7375 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7377 if (!get_next_display_element (it
)
7378 || BUFFER_POS_REACHED_P ())
7380 result
= MOVE_POS_MATCH_OR_ZV
;
7383 if (ITERATOR_AT_END_OF_LINE_P (it
))
7385 result
= MOVE_NEWLINE_OR_CR
;
7389 result
= MOVE_LINE_TRUNCATED
;
7392 #undef IT_RESET_X_ASCENT_DESCENT
7395 #undef BUFFER_POS_REACHED_P
7397 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7398 restore the saved iterator. */
7399 if (atpos_it
.sp
>= 0)
7401 else if (atx_it
.sp
>= 0)
7406 /* Restore the iterator settings altered at the beginning of this
7408 it
->glyph_row
= saved_glyph_row
;
7412 /* For external use. */
7414 move_it_in_display_line (struct it
*it
,
7415 EMACS_INT to_charpos
, int to_x
,
7416 enum move_operation_enum op
)
7418 if (it
->line_wrap
== WORD_WRAP
7419 && (op
& MOVE_TO_X
))
7421 struct it save_it
= *it
;
7422 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7423 /* When word-wrap is on, TO_X may lie past the end
7424 of a wrapped line. Then it->current is the
7425 character on the next line, so backtrack to the
7426 space before the wrap point. */
7427 if (skip
== MOVE_LINE_CONTINUED
)
7429 int prev_x
= max (it
->current_x
- 1, 0);
7431 move_it_in_display_line_to
7432 (it
, -1, prev_x
, MOVE_TO_X
);
7436 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7440 /* Move IT forward until it satisfies one or more of the criteria in
7441 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7443 OP is a bit-mask that specifies where to stop, and in particular,
7444 which of those four position arguments makes a difference. See the
7445 description of enum move_operation_enum.
7447 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7448 screen line, this function will set IT to the next position >
7452 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7454 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7455 int line_height
, line_start_x
= 0, reached
= 0;
7459 if (op
& MOVE_TO_VPOS
)
7461 /* If no TO_CHARPOS and no TO_X specified, stop at the
7462 start of the line TO_VPOS. */
7463 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7465 if (it
->vpos
== to_vpos
)
7471 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7475 /* TO_VPOS >= 0 means stop at TO_X in the line at
7476 TO_VPOS, or at TO_POS, whichever comes first. */
7477 if (it
->vpos
== to_vpos
)
7483 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7485 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7490 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7492 /* We have reached TO_X but not in the line we want. */
7493 skip
= move_it_in_display_line_to (it
, to_charpos
,
7495 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7503 else if (op
& MOVE_TO_Y
)
7505 struct it it_backup
;
7507 if (it
->line_wrap
== WORD_WRAP
)
7510 /* TO_Y specified means stop at TO_X in the line containing
7511 TO_Y---or at TO_CHARPOS if this is reached first. The
7512 problem is that we can't really tell whether the line
7513 contains TO_Y before we have completely scanned it, and
7514 this may skip past TO_X. What we do is to first scan to
7517 If TO_X is not specified, use a TO_X of zero. The reason
7518 is to make the outcome of this function more predictable.
7519 If we didn't use TO_X == 0, we would stop at the end of
7520 the line which is probably not what a caller would expect
7522 skip
= move_it_in_display_line_to
7523 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7524 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7526 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7527 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7529 else if (skip
== MOVE_X_REACHED
)
7531 /* If TO_X was reached, we want to know whether TO_Y is
7532 in the line. We know this is the case if the already
7533 scanned glyphs make the line tall enough. Otherwise,
7534 we must check by scanning the rest of the line. */
7535 line_height
= it
->max_ascent
+ it
->max_descent
;
7536 if (to_y
>= it
->current_y
7537 && to_y
< it
->current_y
+ line_height
)
7543 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7544 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7546 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7547 line_height
= it
->max_ascent
+ it
->max_descent
;
7548 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7550 if (to_y
>= it
->current_y
7551 && to_y
< it
->current_y
+ line_height
)
7553 /* If TO_Y is in this line and TO_X was reached
7554 above, we scanned too far. We have to restore
7555 IT's settings to the ones before skipping. */
7562 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7568 /* Check whether TO_Y is in this line. */
7569 line_height
= it
->max_ascent
+ it
->max_descent
;
7570 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7572 if (to_y
>= it
->current_y
7573 && to_y
< it
->current_y
+ line_height
)
7575 /* When word-wrap is on, TO_X may lie past the end
7576 of a wrapped line. Then it->current is the
7577 character on the next line, so backtrack to the
7578 space before the wrap point. */
7579 if (skip
== MOVE_LINE_CONTINUED
7580 && it
->line_wrap
== WORD_WRAP
)
7582 int prev_x
= max (it
->current_x
- 1, 0);
7584 skip
= move_it_in_display_line_to
7585 (it
, -1, prev_x
, MOVE_TO_X
);
7594 else if (BUFFERP (it
->object
)
7595 && (it
->method
== GET_FROM_BUFFER
7596 || it
->method
== GET_FROM_STRETCH
)
7597 && IT_CHARPOS (*it
) >= to_charpos
)
7598 skip
= MOVE_POS_MATCH_OR_ZV
;
7600 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7604 case MOVE_POS_MATCH_OR_ZV
:
7608 case MOVE_NEWLINE_OR_CR
:
7609 set_iterator_to_next (it
, 1);
7610 it
->continuation_lines_width
= 0;
7613 case MOVE_LINE_TRUNCATED
:
7614 it
->continuation_lines_width
= 0;
7615 reseat_at_next_visible_line_start (it
, 0);
7616 if ((op
& MOVE_TO_POS
) != 0
7617 && IT_CHARPOS (*it
) > to_charpos
)
7624 case MOVE_LINE_CONTINUED
:
7625 /* For continued lines ending in a tab, some of the glyphs
7626 associated with the tab are displayed on the current
7627 line. Since it->current_x does not include these glyphs,
7628 we use it->last_visible_x instead. */
7631 it
->continuation_lines_width
+= it
->last_visible_x
;
7632 /* When moving by vpos, ensure that the iterator really
7633 advances to the next line (bug#847, bug#969). Fixme:
7634 do we need to do this in other circumstances? */
7635 if (it
->current_x
!= it
->last_visible_x
7636 && (op
& MOVE_TO_VPOS
)
7637 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7639 line_start_x
= it
->current_x
+ it
->pixel_width
7640 - it
->last_visible_x
;
7641 set_iterator_to_next (it
, 0);
7645 it
->continuation_lines_width
+= it
->current_x
;
7652 /* Reset/increment for the next run. */
7653 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7654 it
->current_x
= line_start_x
;
7657 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7659 last_height
= it
->max_ascent
+ it
->max_descent
;
7660 last_max_ascent
= it
->max_ascent
;
7661 it
->max_ascent
= it
->max_descent
= 0;
7666 /* On text terminals, we may stop at the end of a line in the middle
7667 of a multi-character glyph. If the glyph itself is continued,
7668 i.e. it is actually displayed on the next line, don't treat this
7669 stopping point as valid; move to the next line instead (unless
7670 that brings us offscreen). */
7671 if (!FRAME_WINDOW_P (it
->f
)
7673 && IT_CHARPOS (*it
) == to_charpos
7674 && it
->what
== IT_CHARACTER
7676 && it
->line_wrap
== WINDOW_WRAP
7677 && it
->current_x
== it
->last_visible_x
- 1
7680 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7682 it
->continuation_lines_width
+= it
->current_x
;
7683 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7684 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7686 last_height
= it
->max_ascent
+ it
->max_descent
;
7687 last_max_ascent
= it
->max_ascent
;
7690 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7694 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7696 If DY > 0, move IT backward at least that many pixels. DY = 0
7697 means move IT backward to the preceding line start or BEGV. This
7698 function may move over more than DY pixels if IT->current_y - DY
7699 ends up in the middle of a line; in this case IT->current_y will be
7700 set to the top of the line moved to. */
7703 move_it_vertically_backward (struct it
*it
, int dy
)
7712 start_pos
= IT_CHARPOS (*it
);
7714 /* Estimate how many newlines we must move back. */
7715 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7717 /* Set the iterator's position that many lines back. */
7718 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7719 back_to_previous_visible_line_start (it
);
7721 /* Reseat the iterator here. When moving backward, we don't want
7722 reseat to skip forward over invisible text, set up the iterator
7723 to deliver from overlay strings at the new position etc. So,
7724 use reseat_1 here. */
7725 reseat_1 (it
, it
->current
.pos
, 1);
7727 /* We are now surely at a line start. */
7728 it
->current_x
= it
->hpos
= 0;
7729 it
->continuation_lines_width
= 0;
7731 /* Move forward and see what y-distance we moved. First move to the
7732 start of the next line so that we get its height. We need this
7733 height to be able to tell whether we reached the specified
7736 it2
.max_ascent
= it2
.max_descent
= 0;
7739 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7740 MOVE_TO_POS
| MOVE_TO_VPOS
);
7742 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7743 xassert (IT_CHARPOS (*it
) >= BEGV
);
7746 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7747 xassert (IT_CHARPOS (*it
) >= BEGV
);
7748 /* H is the actual vertical distance from the position in *IT
7749 and the starting position. */
7750 h
= it2
.current_y
- it
->current_y
;
7751 /* NLINES is the distance in number of lines. */
7752 nlines
= it2
.vpos
- it
->vpos
;
7754 /* Correct IT's y and vpos position
7755 so that they are relative to the starting point. */
7761 /* DY == 0 means move to the start of the screen line. The
7762 value of nlines is > 0 if continuation lines were involved. */
7764 move_it_by_lines (it
, nlines
, 1);
7768 /* The y-position we try to reach, relative to *IT.
7769 Note that H has been subtracted in front of the if-statement. */
7770 int target_y
= it
->current_y
+ h
- dy
;
7771 int y0
= it3
.current_y
;
7772 int y1
= line_bottom_y (&it3
);
7773 int line_height
= y1
- y0
;
7775 /* If we did not reach target_y, try to move further backward if
7776 we can. If we moved too far backward, try to move forward. */
7777 if (target_y
< it
->current_y
7778 /* This is heuristic. In a window that's 3 lines high, with
7779 a line height of 13 pixels each, recentering with point
7780 on the bottom line will try to move -39/2 = 19 pixels
7781 backward. Try to avoid moving into the first line. */
7782 && (it
->current_y
- target_y
7783 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7784 && IT_CHARPOS (*it
) > BEGV
)
7786 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7787 target_y
- it
->current_y
));
7788 dy
= it
->current_y
- target_y
;
7789 goto move_further_back
;
7791 else if (target_y
>= it
->current_y
+ line_height
7792 && IT_CHARPOS (*it
) < ZV
)
7794 /* Should move forward by at least one line, maybe more.
7796 Note: Calling move_it_by_lines can be expensive on
7797 terminal frames, where compute_motion is used (via
7798 vmotion) to do the job, when there are very long lines
7799 and truncate-lines is nil. That's the reason for
7800 treating terminal frames specially here. */
7802 if (!FRAME_WINDOW_P (it
->f
))
7803 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7808 move_it_by_lines (it
, 1, 1);
7810 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7817 /* Move IT by a specified amount of pixel lines DY. DY negative means
7818 move backwards. DY = 0 means move to start of screen line. At the
7819 end, IT will be on the start of a screen line. */
7822 move_it_vertically (struct it
*it
, int dy
)
7825 move_it_vertically_backward (it
, -dy
);
7828 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7829 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7830 MOVE_TO_POS
| MOVE_TO_Y
);
7831 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7833 /* If buffer ends in ZV without a newline, move to the start of
7834 the line to satisfy the post-condition. */
7835 if (IT_CHARPOS (*it
) == ZV
7837 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7838 move_it_by_lines (it
, 0, 0);
7843 /* Move iterator IT past the end of the text line it is in. */
7846 move_it_past_eol (struct it
*it
)
7848 enum move_it_result rc
;
7850 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7851 if (rc
== MOVE_NEWLINE_OR_CR
)
7852 set_iterator_to_next (it
, 0);
7856 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7857 negative means move up. DVPOS == 0 means move to the start of the
7858 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7859 NEED_Y_P is zero, IT->current_y will be left unchanged.
7861 Further optimization ideas: If we would know that IT->f doesn't use
7862 a face with proportional font, we could be faster for
7863 truncate-lines nil. */
7866 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7868 struct position pos
;
7870 /* The commented-out optimization uses vmotion on terminals. This
7871 gives bad results, because elements like it->what, on which
7872 callers such as pos_visible_p rely, aren't updated. */
7873 /* if (!FRAME_WINDOW_P (it->f))
7875 struct text_pos textpos;
7877 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7878 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7879 reseat (it, textpos, 1);
7880 it->vpos += pos.vpos;
7881 it->current_y += pos.vpos;
7887 /* DVPOS == 0 means move to the start of the screen line. */
7888 move_it_vertically_backward (it
, 0);
7889 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7890 /* Let next call to line_bottom_y calculate real line height */
7895 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7896 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7897 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7902 int start_charpos
, i
;
7904 /* Start at the beginning of the screen line containing IT's
7905 position. This may actually move vertically backwards,
7906 in case of overlays, so adjust dvpos accordingly. */
7908 move_it_vertically_backward (it
, 0);
7911 /* Go back -DVPOS visible lines and reseat the iterator there. */
7912 start_charpos
= IT_CHARPOS (*it
);
7913 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7914 back_to_previous_visible_line_start (it
);
7915 reseat (it
, it
->current
.pos
, 1);
7917 /* Move further back if we end up in a string or an image. */
7918 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7920 /* First try to move to start of display line. */
7922 move_it_vertically_backward (it
, 0);
7924 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7926 /* If start of line is still in string or image,
7927 move further back. */
7928 back_to_previous_visible_line_start (it
);
7929 reseat (it
, it
->current
.pos
, 1);
7933 it
->current_x
= it
->hpos
= 0;
7935 /* Above call may have moved too far if continuation lines
7936 are involved. Scan forward and see if it did. */
7938 it2
.vpos
= it2
.current_y
= 0;
7939 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7940 it
->vpos
-= it2
.vpos
;
7941 it
->current_y
-= it2
.current_y
;
7942 it
->current_x
= it
->hpos
= 0;
7944 /* If we moved too far back, move IT some lines forward. */
7945 if (it2
.vpos
> -dvpos
)
7947 int delta
= it2
.vpos
+ dvpos
;
7949 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7950 /* Move back again if we got too far ahead. */
7951 if (IT_CHARPOS (*it
) >= start_charpos
)
7957 /* Return 1 if IT points into the middle of a display vector. */
7960 in_display_vector_p (struct it
*it
)
7962 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7963 && it
->current
.dpvec_index
> 0
7964 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7968 /***********************************************************************
7970 ***********************************************************************/
7973 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7977 add_to_log (char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7979 Lisp_Object args
[3];
7980 Lisp_Object msg
, fmt
;
7983 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7986 /* Do nothing if called asynchronously. Inserting text into
7987 a buffer may call after-change-functions and alike and
7988 that would means running Lisp asynchronously. */
7989 if (handling_signal
)
7993 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7995 args
[0] = fmt
= build_string (format
);
7998 msg
= Fformat (3, args
);
8000 len
= SBYTES (msg
) + 1;
8001 SAFE_ALLOCA (buffer
, char *, len
);
8002 bcopy (SDATA (msg
), buffer
, len
);
8004 message_dolog (buffer
, len
- 1, 1, 0);
8011 /* Output a newline in the *Messages* buffer if "needs" one. */
8014 message_log_maybe_newline (void)
8016 if (message_log_need_newline
)
8017 message_dolog ("", 0, 1, 0);
8021 /* Add a string M of length NBYTES to the message log, optionally
8022 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8023 nonzero, means interpret the contents of M as multibyte. This
8024 function calls low-level routines in order to bypass text property
8025 hooks, etc. which might not be safe to run.
8027 This may GC (insert may run before/after change hooks),
8028 so the buffer M must NOT point to a Lisp string. */
8031 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
8033 if (!NILP (Vmemory_full
))
8036 if (!NILP (Vmessage_log_max
))
8038 struct buffer
*oldbuf
;
8039 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8040 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8041 int point_at_end
= 0;
8043 Lisp_Object old_deactivate_mark
, tem
;
8044 struct gcpro gcpro1
;
8046 old_deactivate_mark
= Vdeactivate_mark
;
8047 oldbuf
= current_buffer
;
8048 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8049 current_buffer
->undo_list
= Qt
;
8051 oldpoint
= message_dolog_marker1
;
8052 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8053 oldbegv
= message_dolog_marker2
;
8054 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8055 oldzv
= message_dolog_marker3
;
8056 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8057 GCPRO1 (old_deactivate_mark
);
8065 BEGV_BYTE
= BEG_BYTE
;
8068 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8070 /* Insert the string--maybe converting multibyte to single byte
8071 or vice versa, so that all the text fits the buffer. */
8073 && NILP (current_buffer
->enable_multibyte_characters
))
8075 int i
, c
, char_bytes
;
8076 unsigned char work
[1];
8078 /* Convert a multibyte string to single-byte
8079 for the *Message* buffer. */
8080 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8082 c
= string_char_and_length (m
+ i
, &char_bytes
);
8083 work
[0] = (ASCII_CHAR_P (c
)
8085 : multibyte_char_to_unibyte (c
, Qnil
));
8086 insert_1_both (work
, 1, 1, 1, 0, 0);
8089 else if (! multibyte
8090 && ! NILP (current_buffer
->enable_multibyte_characters
))
8092 int i
, c
, char_bytes
;
8093 unsigned char *msg
= (unsigned char *) m
;
8094 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8095 /* Convert a single-byte string to multibyte
8096 for the *Message* buffer. */
8097 for (i
= 0; i
< nbytes
; i
++)
8100 MAKE_CHAR_MULTIBYTE (c
);
8101 char_bytes
= CHAR_STRING (c
, str
);
8102 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8106 insert_1 (m
, nbytes
, 1, 0, 0);
8110 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8111 insert_1 ("\n", 1, 1, 0, 0);
8113 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8115 this_bol_byte
= PT_BYTE
;
8117 /* See if this line duplicates the previous one.
8118 If so, combine duplicates. */
8121 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8123 prev_bol_byte
= PT_BYTE
;
8125 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8126 this_bol
, this_bol_byte
);
8129 del_range_both (prev_bol
, prev_bol_byte
,
8130 this_bol
, this_bol_byte
, 0);
8136 /* If you change this format, don't forget to also
8137 change message_log_check_duplicate. */
8138 sprintf (dupstr
, " [%d times]", dup
);
8139 duplen
= strlen (dupstr
);
8140 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8141 insert_1 (dupstr
, duplen
, 1, 0, 1);
8146 /* If we have more than the desired maximum number of lines
8147 in the *Messages* buffer now, delete the oldest ones.
8148 This is safe because we don't have undo in this buffer. */
8150 if (NATNUMP (Vmessage_log_max
))
8152 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8153 -XFASTINT (Vmessage_log_max
) - 1, 0);
8154 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8157 BEGV
= XMARKER (oldbegv
)->charpos
;
8158 BEGV_BYTE
= marker_byte_position (oldbegv
);
8167 ZV
= XMARKER (oldzv
)->charpos
;
8168 ZV_BYTE
= marker_byte_position (oldzv
);
8172 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8174 /* We can't do Fgoto_char (oldpoint) because it will run some
8176 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8177 XMARKER (oldpoint
)->bytepos
);
8180 unchain_marker (XMARKER (oldpoint
));
8181 unchain_marker (XMARKER (oldbegv
));
8182 unchain_marker (XMARKER (oldzv
));
8184 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8185 set_buffer_internal (oldbuf
);
8187 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8188 message_log_need_newline
= !nlflag
;
8189 Vdeactivate_mark
= old_deactivate_mark
;
8194 /* We are at the end of the buffer after just having inserted a newline.
8195 (Note: We depend on the fact we won't be crossing the gap.)
8196 Check to see if the most recent message looks a lot like the previous one.
8197 Return 0 if different, 1 if the new one should just replace it, or a
8198 value N > 1 if we should also append " [N times]". */
8201 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8202 int this_bol
, int this_bol_byte
)
8205 int len
= Z_BYTE
- 1 - this_bol_byte
;
8207 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8208 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8210 for (i
= 0; i
< len
; i
++)
8212 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8220 if (*p1
++ == ' ' && *p1
++ == '[')
8223 while (*p1
>= '0' && *p1
<= '9')
8224 n
= n
* 10 + *p1
++ - '0';
8225 if (strncmp (p1
, " times]\n", 8) == 0)
8232 /* Display an echo area message M with a specified length of NBYTES
8233 bytes. The string may include null characters. If M is 0, clear
8234 out any existing message, and let the mini-buffer text show
8237 This may GC, so the buffer M must NOT point to a Lisp string. */
8240 message2 (const char *m
, int nbytes
, int multibyte
)
8242 /* First flush out any partial line written with print. */
8243 message_log_maybe_newline ();
8245 message_dolog (m
, nbytes
, 1, multibyte
);
8246 message2_nolog (m
, nbytes
, multibyte
);
8250 /* The non-logging counterpart of message2. */
8253 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8255 struct frame
*sf
= SELECTED_FRAME ();
8256 message_enable_multibyte
= multibyte
;
8258 if (FRAME_INITIAL_P (sf
))
8260 if (noninteractive_need_newline
)
8261 putc ('\n', stderr
);
8262 noninteractive_need_newline
= 0;
8264 fwrite (m
, nbytes
, 1, stderr
);
8265 if (cursor_in_echo_area
== 0)
8266 fprintf (stderr
, "\n");
8269 /* A null message buffer means that the frame hasn't really been
8270 initialized yet. Error messages get reported properly by
8271 cmd_error, so this must be just an informative message; toss it. */
8272 else if (INTERACTIVE
8273 && sf
->glyphs_initialized_p
8274 && FRAME_MESSAGE_BUF (sf
))
8276 Lisp_Object mini_window
;
8279 /* Get the frame containing the mini-buffer
8280 that the selected frame is using. */
8281 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8282 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8284 FRAME_SAMPLE_VISIBILITY (f
);
8285 if (FRAME_VISIBLE_P (sf
)
8286 && ! FRAME_VISIBLE_P (f
))
8287 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8291 set_message (m
, Qnil
, nbytes
, multibyte
);
8292 if (minibuffer_auto_raise
)
8293 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8296 clear_message (1, 1);
8298 do_pending_window_change (0);
8299 echo_area_display (1);
8300 do_pending_window_change (0);
8301 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8302 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8307 /* Display an echo area message M with a specified length of NBYTES
8308 bytes. The string may include null characters. If M is not a
8309 string, clear out any existing message, and let the mini-buffer
8312 This function cancels echoing. */
8315 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8317 struct gcpro gcpro1
;
8320 clear_message (1,1);
8323 /* First flush out any partial line written with print. */
8324 message_log_maybe_newline ();
8330 SAFE_ALLOCA (buffer
, char *, nbytes
);
8331 bcopy (SDATA (m
), buffer
, nbytes
);
8332 message_dolog (buffer
, nbytes
, 1, multibyte
);
8335 message3_nolog (m
, nbytes
, multibyte
);
8341 /* The non-logging version of message3.
8342 This does not cancel echoing, because it is used for echoing.
8343 Perhaps we need to make a separate function for echoing
8344 and make this cancel echoing. */
8347 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8349 struct frame
*sf
= SELECTED_FRAME ();
8350 message_enable_multibyte
= multibyte
;
8352 if (FRAME_INITIAL_P (sf
))
8354 if (noninteractive_need_newline
)
8355 putc ('\n', stderr
);
8356 noninteractive_need_newline
= 0;
8358 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8359 if (cursor_in_echo_area
== 0)
8360 fprintf (stderr
, "\n");
8363 /* A null message buffer means that the frame hasn't really been
8364 initialized yet. Error messages get reported properly by
8365 cmd_error, so this must be just an informative message; toss it. */
8366 else if (INTERACTIVE
8367 && sf
->glyphs_initialized_p
8368 && FRAME_MESSAGE_BUF (sf
))
8370 Lisp_Object mini_window
;
8374 /* Get the frame containing the mini-buffer
8375 that the selected frame is using. */
8376 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8377 frame
= XWINDOW (mini_window
)->frame
;
8380 FRAME_SAMPLE_VISIBILITY (f
);
8381 if (FRAME_VISIBLE_P (sf
)
8382 && !FRAME_VISIBLE_P (f
))
8383 Fmake_frame_visible (frame
);
8385 if (STRINGP (m
) && SCHARS (m
) > 0)
8387 set_message (NULL
, m
, nbytes
, multibyte
);
8388 if (minibuffer_auto_raise
)
8389 Fraise_frame (frame
);
8390 /* Assume we are not echoing.
8391 (If we are, echo_now will override this.) */
8392 echo_message_buffer
= Qnil
;
8395 clear_message (1, 1);
8397 do_pending_window_change (0);
8398 echo_area_display (1);
8399 do_pending_window_change (0);
8400 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8401 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8406 /* Display a null-terminated echo area message M. If M is 0, clear
8407 out any existing message, and let the mini-buffer text show through.
8409 The buffer M must continue to exist until after the echo area gets
8410 cleared or some other message gets displayed there. Do not pass
8411 text that is stored in a Lisp string. Do not pass text in a buffer
8412 that was alloca'd. */
8417 message2 (m
, (m
? strlen (m
) : 0), 0);
8421 /* The non-logging counterpart of message1. */
8424 message1_nolog (char *m
)
8426 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8429 /* Display a message M which contains a single %s
8430 which gets replaced with STRING. */
8433 message_with_string (char *m
, Lisp_Object string
, int log
)
8435 CHECK_STRING (string
);
8441 if (noninteractive_need_newline
)
8442 putc ('\n', stderr
);
8443 noninteractive_need_newline
= 0;
8444 fprintf (stderr
, m
, SDATA (string
));
8445 if (!cursor_in_echo_area
)
8446 fprintf (stderr
, "\n");
8450 else if (INTERACTIVE
)
8452 /* The frame whose minibuffer we're going to display the message on.
8453 It may be larger than the selected frame, so we need
8454 to use its buffer, not the selected frame's buffer. */
8455 Lisp_Object mini_window
;
8456 struct frame
*f
, *sf
= SELECTED_FRAME ();
8458 /* Get the frame containing the minibuffer
8459 that the selected frame is using. */
8460 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8461 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8463 /* A null message buffer means that the frame hasn't really been
8464 initialized yet. Error messages get reported properly by
8465 cmd_error, so this must be just an informative message; toss it. */
8466 if (FRAME_MESSAGE_BUF (f
))
8468 Lisp_Object args
[2], message
;
8469 struct gcpro gcpro1
, gcpro2
;
8471 args
[0] = build_string (m
);
8472 args
[1] = message
= string
;
8473 GCPRO2 (args
[0], message
);
8476 message
= Fformat (2, args
);
8479 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8481 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8485 /* Print should start at the beginning of the message
8486 buffer next time. */
8487 message_buf_print
= 0;
8493 /* Dump an informative message to the minibuf. If M is 0, clear out
8494 any existing message, and let the mini-buffer text show through. */
8498 message (char *m
, EMACS_INT a1
, EMACS_INT a2
, EMACS_INT a3
)
8504 if (noninteractive_need_newline
)
8505 putc ('\n', stderr
);
8506 noninteractive_need_newline
= 0;
8507 fprintf (stderr
, m
, a1
, a2
, a3
);
8508 if (cursor_in_echo_area
== 0)
8509 fprintf (stderr
, "\n");
8513 else if (INTERACTIVE
)
8515 /* The frame whose mini-buffer we're going to display the message
8516 on. It may be larger than the selected frame, so we need to
8517 use its buffer, not the selected frame's buffer. */
8518 Lisp_Object mini_window
;
8519 struct frame
*f
, *sf
= SELECTED_FRAME ();
8521 /* Get the frame containing the mini-buffer
8522 that the selected frame is using. */
8523 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8524 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8526 /* A null message buffer means that the frame hasn't really been
8527 initialized yet. Error messages get reported properly by
8528 cmd_error, so this must be just an informative message; toss
8530 if (FRAME_MESSAGE_BUF (f
))
8540 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8541 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8543 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8548 /* Print should start at the beginning of the message
8549 buffer next time. */
8550 message_buf_print
= 0;
8556 /* The non-logging version of message. */
8559 message_nolog (char *m
, EMACS_INT a1
, EMACS_INT a2
, EMACS_INT a3
)
8561 Lisp_Object old_log_max
;
8562 old_log_max
= Vmessage_log_max
;
8563 Vmessage_log_max
= Qnil
;
8564 message (m
, a1
, a2
, a3
);
8565 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. */
9634 store_mode_line_noprop_char (char c
)
9636 store_mode_line_noprop_char (c
)
9640 /* If output position has reached the end of the allocated buffer,
9641 double the buffer's size. */
9642 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9644 int len
= MODE_LINE_NOPROP_LEN (0);
9645 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9646 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9647 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9648 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9651 *mode_line_noprop_ptr
++ = c
;
9655 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9656 mode_line_noprop_ptr. STR is the string to store. Do not copy
9657 characters that yield more columns than PRECISION; PRECISION <= 0
9658 means copy the whole string. Pad with spaces until FIELD_WIDTH
9659 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9660 pad. Called from display_mode_element when it is used to build a
9664 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9669 /* Copy at most PRECISION chars from STR. */
9670 nbytes
= strlen (str
);
9671 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9673 store_mode_line_noprop_char (*str
++);
9675 /* Fill up with spaces until FIELD_WIDTH reached. */
9676 while (field_width
> 0
9679 store_mode_line_noprop_char (' ');
9686 /***********************************************************************
9688 ***********************************************************************/
9690 #ifdef HAVE_WINDOW_SYSTEM
9692 /* Set the title of FRAME, if it has changed. The title format is
9693 Vicon_title_format if FRAME is iconified, otherwise it is
9694 frame_title_format. */
9697 x_consider_frame_title (Lisp_Object frame
)
9699 struct frame
*f
= XFRAME (frame
);
9701 if (FRAME_WINDOW_P (f
)
9702 || FRAME_MINIBUF_ONLY_P (f
)
9703 || f
->explicit_name
)
9705 /* Do we have more than one visible frame on this X display? */
9712 int count
= SPECPDL_INDEX ();
9714 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9716 Lisp_Object other_frame
= XCAR (tail
);
9717 struct frame
*tf
= XFRAME (other_frame
);
9720 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9721 && !FRAME_MINIBUF_ONLY_P (tf
)
9722 && !EQ (other_frame
, tip_frame
)
9723 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9727 /* Set global variable indicating that multiple frames exist. */
9728 multiple_frames
= CONSP (tail
);
9730 /* Switch to the buffer of selected window of the frame. Set up
9731 mode_line_target so that display_mode_element will output into
9732 mode_line_noprop_buf; then display the title. */
9733 record_unwind_protect (unwind_format_mode_line
,
9734 format_mode_line_unwind_data
9735 (current_buffer
, selected_window
, 0));
9737 Fselect_window (f
->selected_window
, Qt
);
9738 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9739 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9741 mode_line_target
= MODE_LINE_TITLE
;
9742 title_start
= MODE_LINE_NOPROP_LEN (0);
9743 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9744 NULL
, DEFAULT_FACE_ID
);
9745 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9746 len
= MODE_LINE_NOPROP_LEN (title_start
);
9747 title
= mode_line_noprop_buf
+ title_start
;
9748 unbind_to (count
, Qnil
);
9750 /* Set the title only if it's changed. This avoids consing in
9751 the common case where it hasn't. (If it turns out that we've
9752 already wasted too much time by walking through the list with
9753 display_mode_element, then we might need to optimize at a
9754 higher level than this.) */
9755 if (! STRINGP (f
->name
)
9756 || SBYTES (f
->name
) != len
9757 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9758 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9762 #endif /* not HAVE_WINDOW_SYSTEM */
9767 /***********************************************************************
9769 ***********************************************************************/
9772 /* Prepare for redisplay by updating menu-bar item lists when
9773 appropriate. This can call eval. */
9776 prepare_menu_bars (void)
9779 struct gcpro gcpro1
, gcpro2
;
9781 Lisp_Object tooltip_frame
;
9783 #ifdef HAVE_WINDOW_SYSTEM
9784 tooltip_frame
= tip_frame
;
9786 tooltip_frame
= Qnil
;
9789 /* Update all frame titles based on their buffer names, etc. We do
9790 this before the menu bars so that the buffer-menu will show the
9791 up-to-date frame titles. */
9792 #ifdef HAVE_WINDOW_SYSTEM
9793 if (windows_or_buffers_changed
|| update_mode_lines
)
9795 Lisp_Object tail
, frame
;
9797 FOR_EACH_FRAME (tail
, frame
)
9800 if (!EQ (frame
, tooltip_frame
)
9801 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9802 x_consider_frame_title (frame
);
9805 #endif /* HAVE_WINDOW_SYSTEM */
9807 /* Update the menu bar item lists, if appropriate. This has to be
9808 done before any actual redisplay or generation of display lines. */
9809 all_windows
= (update_mode_lines
9810 || buffer_shared
> 1
9811 || windows_or_buffers_changed
);
9814 Lisp_Object tail
, frame
;
9815 int count
= SPECPDL_INDEX ();
9816 /* 1 means that update_menu_bar has run its hooks
9817 so any further calls to update_menu_bar shouldn't do so again. */
9818 int menu_bar_hooks_run
= 0;
9820 record_unwind_save_match_data ();
9822 FOR_EACH_FRAME (tail
, frame
)
9826 /* Ignore tooltip frame. */
9827 if (EQ (frame
, tooltip_frame
))
9830 /* If a window on this frame changed size, report that to
9831 the user and clear the size-change flag. */
9832 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9834 Lisp_Object functions
;
9836 /* Clear flag first in case we get an error below. */
9837 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9838 functions
= Vwindow_size_change_functions
;
9839 GCPRO2 (tail
, functions
);
9841 while (CONSP (functions
))
9843 if (!EQ (XCAR (functions
), Qt
))
9844 call1 (XCAR (functions
), frame
);
9845 functions
= XCDR (functions
);
9851 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9852 #ifdef HAVE_WINDOW_SYSTEM
9853 update_tool_bar (f
, 0);
9856 if (windows_or_buffers_changed
9858 ns_set_doc_edited (f
, Fbuffer_modified_p
9859 (XWINDOW (f
->selected_window
)->buffer
));
9864 unbind_to (count
, Qnil
);
9868 struct frame
*sf
= SELECTED_FRAME ();
9869 update_menu_bar (sf
, 1, 0);
9870 #ifdef HAVE_WINDOW_SYSTEM
9871 update_tool_bar (sf
, 1);
9875 /* Motif needs this. See comment in xmenu.c. Turn it off when
9876 pending_menu_activation is not defined. */
9877 #ifdef USE_X_TOOLKIT
9878 pending_menu_activation
= 0;
9883 /* Update the menu bar item list for frame F. This has to be done
9884 before we start to fill in any display lines, because it can call
9887 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9889 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9890 already ran the menu bar hooks for this redisplay, so there
9891 is no need to run them again. The return value is the
9892 updated value of this flag, to pass to the next call. */
9895 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9898 register struct window
*w
;
9900 /* If called recursively during a menu update, do nothing. This can
9901 happen when, for instance, an activate-menubar-hook causes a
9903 if (inhibit_menubar_update
)
9906 window
= FRAME_SELECTED_WINDOW (f
);
9907 w
= XWINDOW (window
);
9909 if (FRAME_WINDOW_P (f
)
9911 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9912 || defined (HAVE_NS) || defined (USE_GTK)
9913 FRAME_EXTERNAL_MENU_BAR (f
)
9915 FRAME_MENU_BAR_LINES (f
) > 0
9917 : FRAME_MENU_BAR_LINES (f
) > 0)
9919 /* If the user has switched buffers or windows, we need to
9920 recompute to reflect the new bindings. But we'll
9921 recompute when update_mode_lines is set too; that means
9922 that people can use force-mode-line-update to request
9923 that the menu bar be recomputed. The adverse effect on
9924 the rest of the redisplay algorithm is about the same as
9925 windows_or_buffers_changed anyway. */
9926 if (windows_or_buffers_changed
9927 /* This used to test w->update_mode_line, but we believe
9928 there is no need to recompute the menu in that case. */
9929 || update_mode_lines
9930 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9931 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9932 != !NILP (w
->last_had_star
))
9933 || ((!NILP (Vtransient_mark_mode
)
9934 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9935 != !NILP (w
->region_showing
)))
9937 struct buffer
*prev
= current_buffer
;
9938 int count
= SPECPDL_INDEX ();
9940 specbind (Qinhibit_menubar_update
, Qt
);
9942 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9943 if (save_match_data
)
9944 record_unwind_save_match_data ();
9945 if (NILP (Voverriding_local_map_menu_flag
))
9947 specbind (Qoverriding_terminal_local_map
, Qnil
);
9948 specbind (Qoverriding_local_map
, Qnil
);
9953 /* Run the Lucid hook. */
9954 safe_run_hooks (Qactivate_menubar_hook
);
9956 /* If it has changed current-menubar from previous value,
9957 really recompute the menu-bar from the value. */
9958 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9959 call0 (Qrecompute_lucid_menubar
);
9961 safe_run_hooks (Qmenu_bar_update_hook
);
9966 XSETFRAME (Vmenu_updating_frame
, f
);
9967 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9969 /* Redisplay the menu bar in case we changed it. */
9970 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9971 || defined (HAVE_NS) || defined (USE_GTK)
9972 if (FRAME_WINDOW_P (f
))
9974 #if defined (HAVE_NS)
9975 /* All frames on Mac OS share the same menubar. So only
9976 the selected frame should be allowed to set it. */
9977 if (f
== SELECTED_FRAME ())
9979 set_frame_menubar (f
, 0, 0);
9982 /* On a terminal screen, the menu bar is an ordinary screen
9983 line, and this makes it get updated. */
9984 w
->update_mode_line
= Qt
;
9985 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9986 /* In the non-toolkit version, the menu bar is an ordinary screen
9987 line, and this makes it get updated. */
9988 w
->update_mode_line
= Qt
;
9989 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9991 unbind_to (count
, Qnil
);
9992 set_buffer_internal_1 (prev
);
10001 /***********************************************************************
10003 ***********************************************************************/
10005 #ifdef HAVE_WINDOW_SYSTEM
10008 Nominal cursor position -- where to draw output.
10009 HPOS and VPOS are window relative glyph matrix coordinates.
10010 X and Y are window relative pixel coordinates. */
10012 struct cursor_pos output_cursor
;
10016 Set the global variable output_cursor to CURSOR. All cursor
10017 positions are relative to updated_window. */
10020 set_output_cursor (struct cursor_pos
*cursor
)
10022 output_cursor
.hpos
= cursor
->hpos
;
10023 output_cursor
.vpos
= cursor
->vpos
;
10024 output_cursor
.x
= cursor
->x
;
10025 output_cursor
.y
= cursor
->y
;
10030 Set a nominal cursor position.
10032 HPOS and VPOS are column/row positions in a window glyph matrix. X
10033 and Y are window text area relative pixel positions.
10035 If this is done during an update, updated_window will contain the
10036 window that is being updated and the position is the future output
10037 cursor position for that window. If updated_window is null, use
10038 selected_window and display the cursor at the given position. */
10041 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10045 /* If updated_window is not set, work on selected_window. */
10046 if (updated_window
)
10047 w
= updated_window
;
10049 w
= XWINDOW (selected_window
);
10051 /* Set the output cursor. */
10052 output_cursor
.hpos
= hpos
;
10053 output_cursor
.vpos
= vpos
;
10054 output_cursor
.x
= x
;
10055 output_cursor
.y
= y
;
10057 /* If not called as part of an update, really display the cursor.
10058 This will also set the cursor position of W. */
10059 if (updated_window
== NULL
)
10062 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10063 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10064 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10069 #endif /* HAVE_WINDOW_SYSTEM */
10072 /***********************************************************************
10074 ***********************************************************************/
10076 #ifdef HAVE_WINDOW_SYSTEM
10078 /* Where the mouse was last time we reported a mouse event. */
10080 FRAME_PTR last_mouse_frame
;
10082 /* Tool-bar item index of the item on which a mouse button was pressed
10085 int last_tool_bar_item
;
10089 update_tool_bar_unwind (Lisp_Object frame
)
10091 selected_frame
= frame
;
10095 /* Update the tool-bar item list for frame F. This has to be done
10096 before we start to fill in any display lines. Called from
10097 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10098 and restore it here. */
10101 update_tool_bar (struct frame
*f
, int save_match_data
)
10103 #if defined (USE_GTK) || defined (HAVE_NS)
10104 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10106 int do_update
= WINDOWP (f
->tool_bar_window
)
10107 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10112 Lisp_Object window
;
10115 window
= FRAME_SELECTED_WINDOW (f
);
10116 w
= XWINDOW (window
);
10118 /* If the user has switched buffers or windows, we need to
10119 recompute to reflect the new bindings. But we'll
10120 recompute when update_mode_lines is set too; that means
10121 that people can use force-mode-line-update to request
10122 that the menu bar be recomputed. The adverse effect on
10123 the rest of the redisplay algorithm is about the same as
10124 windows_or_buffers_changed anyway. */
10125 if (windows_or_buffers_changed
10126 || !NILP (w
->update_mode_line
)
10127 || update_mode_lines
10128 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10129 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10130 != !NILP (w
->last_had_star
))
10131 || ((!NILP (Vtransient_mark_mode
)
10132 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10133 != !NILP (w
->region_showing
)))
10135 struct buffer
*prev
= current_buffer
;
10136 int count
= SPECPDL_INDEX ();
10137 Lisp_Object frame
, new_tool_bar
;
10138 int new_n_tool_bar
;
10139 struct gcpro gcpro1
;
10141 /* Set current_buffer to the buffer of the selected
10142 window of the frame, so that we get the right local
10144 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10146 /* Save match data, if we must. */
10147 if (save_match_data
)
10148 record_unwind_save_match_data ();
10150 /* Make sure that we don't accidentally use bogus keymaps. */
10151 if (NILP (Voverriding_local_map_menu_flag
))
10153 specbind (Qoverriding_terminal_local_map
, Qnil
);
10154 specbind (Qoverriding_local_map
, Qnil
);
10157 GCPRO1 (new_tool_bar
);
10159 /* We must temporarily set the selected frame to this frame
10160 before calling tool_bar_items, because the calculation of
10161 the tool-bar keymap uses the selected frame (see
10162 `tool-bar-make-keymap' in tool-bar.el). */
10163 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10164 XSETFRAME (frame
, f
);
10165 selected_frame
= frame
;
10167 /* Build desired tool-bar items from keymaps. */
10168 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10171 /* Redisplay the tool-bar if we changed it. */
10172 if (new_n_tool_bar
!= f
->n_tool_bar_items
10173 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10175 /* Redisplay that happens asynchronously due to an expose event
10176 may access f->tool_bar_items. Make sure we update both
10177 variables within BLOCK_INPUT so no such event interrupts. */
10179 f
->tool_bar_items
= new_tool_bar
;
10180 f
->n_tool_bar_items
= new_n_tool_bar
;
10181 w
->update_mode_line
= Qt
;
10187 unbind_to (count
, Qnil
);
10188 set_buffer_internal_1 (prev
);
10194 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10195 F's desired tool-bar contents. F->tool_bar_items must have
10196 been set up previously by calling prepare_menu_bars. */
10199 build_desired_tool_bar_string (struct frame
*f
)
10201 int i
, size
, size_needed
;
10202 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10203 Lisp_Object image
, plist
, props
;
10205 image
= plist
= props
= Qnil
;
10206 GCPRO3 (image
, plist
, props
);
10208 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10209 Otherwise, make a new string. */
10211 /* The size of the string we might be able to reuse. */
10212 size
= (STRINGP (f
->desired_tool_bar_string
)
10213 ? SCHARS (f
->desired_tool_bar_string
)
10216 /* We need one space in the string for each image. */
10217 size_needed
= f
->n_tool_bar_items
;
10219 /* Reuse f->desired_tool_bar_string, if possible. */
10220 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10221 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10222 make_number (' '));
10225 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10226 Fremove_text_properties (make_number (0), make_number (size
),
10227 props
, f
->desired_tool_bar_string
);
10230 /* Put a `display' property on the string for the images to display,
10231 put a `menu_item' property on tool-bar items with a value that
10232 is the index of the item in F's tool-bar item vector. */
10233 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10235 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10237 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10238 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10239 int hmargin
, vmargin
, relief
, idx
, end
;
10240 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10242 /* If image is a vector, choose the image according to the
10244 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10245 if (VECTORP (image
))
10249 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10250 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10253 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10254 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10256 xassert (ASIZE (image
) >= idx
);
10257 image
= AREF (image
, idx
);
10262 /* Ignore invalid image specifications. */
10263 if (!valid_image_p (image
))
10266 /* Display the tool-bar button pressed, or depressed. */
10267 plist
= Fcopy_sequence (XCDR (image
));
10269 /* Compute margin and relief to draw. */
10270 relief
= (tool_bar_button_relief
>= 0
10271 ? tool_bar_button_relief
10272 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10273 hmargin
= vmargin
= relief
;
10275 if (INTEGERP (Vtool_bar_button_margin
)
10276 && XINT (Vtool_bar_button_margin
) > 0)
10278 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10279 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10281 else if (CONSP (Vtool_bar_button_margin
))
10283 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10284 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10285 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10287 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10288 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10289 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10292 if (auto_raise_tool_bar_buttons_p
)
10294 /* Add a `:relief' property to the image spec if the item is
10298 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10305 /* If image is selected, display it pressed, i.e. with a
10306 negative relief. If it's not selected, display it with a
10308 plist
= Fplist_put (plist
, QCrelief
,
10310 ? make_number (-relief
)
10311 : make_number (relief
)));
10316 /* Put a margin around the image. */
10317 if (hmargin
|| vmargin
)
10319 if (hmargin
== vmargin
)
10320 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10322 plist
= Fplist_put (plist
, QCmargin
,
10323 Fcons (make_number (hmargin
),
10324 make_number (vmargin
)));
10327 /* If button is not enabled, and we don't have special images
10328 for the disabled state, make the image appear disabled by
10329 applying an appropriate algorithm to it. */
10330 if (!enabled_p
&& idx
< 0)
10331 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10333 /* Put a `display' text property on the string for the image to
10334 display. Put a `menu-item' property on the string that gives
10335 the start of this item's properties in the tool-bar items
10337 image
= Fcons (Qimage
, plist
);
10338 props
= list4 (Qdisplay
, image
,
10339 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10341 /* Let the last image hide all remaining spaces in the tool bar
10342 string. The string can be longer than needed when we reuse a
10343 previous string. */
10344 if (i
+ 1 == f
->n_tool_bar_items
)
10345 end
= SCHARS (f
->desired_tool_bar_string
);
10348 Fadd_text_properties (make_number (i
), make_number (end
),
10349 props
, f
->desired_tool_bar_string
);
10357 /* Display one line of the tool-bar of frame IT->f.
10359 HEIGHT specifies the desired height of the tool-bar line.
10360 If the actual height of the glyph row is less than HEIGHT, the
10361 row's height is increased to HEIGHT, and the icons are centered
10362 vertically in the new height.
10364 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10365 count a final empty row in case the tool-bar width exactly matches
10370 display_tool_bar_line (struct it
*it
, int height
)
10372 struct glyph_row
*row
= it
->glyph_row
;
10373 int max_x
= it
->last_visible_x
;
10374 struct glyph
*last
;
10376 prepare_desired_row (row
);
10377 row
->y
= it
->current_y
;
10379 /* Note that this isn't made use of if the face hasn't a box,
10380 so there's no need to check the face here. */
10381 it
->start_of_box_run_p
= 1;
10383 while (it
->current_x
< max_x
)
10385 int x
, n_glyphs_before
, i
, nglyphs
;
10386 struct it it_before
;
10388 /* Get the next display element. */
10389 if (!get_next_display_element (it
))
10391 /* Don't count empty row if we are counting needed tool-bar lines. */
10392 if (height
< 0 && !it
->hpos
)
10397 /* Produce glyphs. */
10398 n_glyphs_before
= row
->used
[TEXT_AREA
];
10401 PRODUCE_GLYPHS (it
);
10403 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10405 x
= it_before
.current_x
;
10406 while (i
< nglyphs
)
10408 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10410 if (x
+ glyph
->pixel_width
> max_x
)
10412 /* Glyph doesn't fit on line. Backtrack. */
10413 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10415 /* If this is the only glyph on this line, it will never fit on the
10416 toolbar, so skip it. But ensure there is at least one glyph,
10417 so we don't accidentally disable the tool-bar. */
10418 if (n_glyphs_before
== 0
10419 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10425 x
+= glyph
->pixel_width
;
10429 /* Stop at line ends. */
10430 if (ITERATOR_AT_END_OF_LINE_P (it
))
10433 set_iterator_to_next (it
, 1);
10438 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10440 /* Use default face for the border below the tool bar.
10442 FIXME: When auto-resize-tool-bars is grow-only, there is
10443 no additional border below the possibly empty tool-bar lines.
10444 So to make the extra empty lines look "normal", we have to
10445 use the tool-bar face for the border too. */
10446 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10447 it
->face_id
= DEFAULT_FACE_ID
;
10449 extend_face_to_end_of_line (it
);
10450 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10451 last
->right_box_line_p
= 1;
10452 if (last
== row
->glyphs
[TEXT_AREA
])
10453 last
->left_box_line_p
= 1;
10455 /* Make line the desired height and center it vertically. */
10456 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10458 /* Don't add more than one line height. */
10459 height
%= FRAME_LINE_HEIGHT (it
->f
);
10460 it
->max_ascent
+= height
/ 2;
10461 it
->max_descent
+= (height
+ 1) / 2;
10464 compute_line_metrics (it
);
10466 /* If line is empty, make it occupy the rest of the tool-bar. */
10467 if (!row
->displays_text_p
)
10469 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10470 row
->visible_height
= row
->height
;
10471 row
->ascent
= row
->phys_ascent
= 0;
10472 row
->extra_line_spacing
= 0;
10475 row
->full_width_p
= 1;
10476 row
->continued_p
= 0;
10477 row
->truncated_on_left_p
= 0;
10478 row
->truncated_on_right_p
= 0;
10480 it
->current_x
= it
->hpos
= 0;
10481 it
->current_y
+= row
->height
;
10487 /* Max tool-bar height. */
10489 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10490 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10492 /* Value is the number of screen lines needed to make all tool-bar
10493 items of frame F visible. The number of actual rows needed is
10494 returned in *N_ROWS if non-NULL. */
10497 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10499 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10501 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10502 the desired matrix, so use (unused) mode-line row as temporary row to
10503 avoid destroying the first tool-bar row. */
10504 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10506 /* Initialize an iterator for iteration over
10507 F->desired_tool_bar_string in the tool-bar window of frame F. */
10508 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10509 it
.first_visible_x
= 0;
10510 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10511 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10513 while (!ITERATOR_AT_END_P (&it
))
10515 clear_glyph_row (temp_row
);
10516 it
.glyph_row
= temp_row
;
10517 display_tool_bar_line (&it
, -1);
10519 clear_glyph_row (temp_row
);
10521 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10523 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10525 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10529 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10531 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10540 frame
= selected_frame
;
10542 CHECK_FRAME (frame
);
10543 f
= XFRAME (frame
);
10545 if (WINDOWP (f
->tool_bar_window
)
10546 || (w
= XWINDOW (f
->tool_bar_window
),
10547 WINDOW_TOTAL_LINES (w
) > 0))
10549 update_tool_bar (f
, 1);
10550 if (f
->n_tool_bar_items
)
10552 build_desired_tool_bar_string (f
);
10553 nlines
= tool_bar_lines_needed (f
, NULL
);
10557 return make_number (nlines
);
10561 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10562 height should be changed. */
10565 redisplay_tool_bar (struct frame
*f
)
10569 struct glyph_row
*row
;
10571 #if defined (USE_GTK) || defined (HAVE_NS)
10572 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10573 update_frame_tool_bar (f
);
10577 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10578 do anything. This means you must start with tool-bar-lines
10579 non-zero to get the auto-sizing effect. Or in other words, you
10580 can turn off tool-bars by specifying tool-bar-lines zero. */
10581 if (!WINDOWP (f
->tool_bar_window
)
10582 || (w
= XWINDOW (f
->tool_bar_window
),
10583 WINDOW_TOTAL_LINES (w
) == 0))
10586 /* Set up an iterator for the tool-bar window. */
10587 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10588 it
.first_visible_x
= 0;
10589 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10590 row
= it
.glyph_row
;
10592 /* Build a string that represents the contents of the tool-bar. */
10593 build_desired_tool_bar_string (f
);
10594 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10596 if (f
->n_tool_bar_rows
== 0)
10600 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10601 nlines
!= WINDOW_TOTAL_LINES (w
)))
10603 extern Lisp_Object Qtool_bar_lines
;
10605 int old_height
= WINDOW_TOTAL_LINES (w
);
10607 XSETFRAME (frame
, f
);
10608 Fmodify_frame_parameters (frame
,
10609 Fcons (Fcons (Qtool_bar_lines
,
10610 make_number (nlines
)),
10612 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10614 clear_glyph_matrix (w
->desired_matrix
);
10615 fonts_changed_p
= 1;
10621 /* Display as many lines as needed to display all tool-bar items. */
10623 if (f
->n_tool_bar_rows
> 0)
10625 int border
, rows
, height
, extra
;
10627 if (INTEGERP (Vtool_bar_border
))
10628 border
= XINT (Vtool_bar_border
);
10629 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10630 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10631 else if (EQ (Vtool_bar_border
, Qborder_width
))
10632 border
= f
->border_width
;
10638 rows
= f
->n_tool_bar_rows
;
10639 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10640 extra
= it
.last_visible_y
- border
- height
* rows
;
10642 while (it
.current_y
< it
.last_visible_y
)
10645 if (extra
> 0 && rows
-- > 0)
10647 h
= (extra
+ rows
- 1) / rows
;
10650 display_tool_bar_line (&it
, height
+ h
);
10655 while (it
.current_y
< it
.last_visible_y
)
10656 display_tool_bar_line (&it
, 0);
10659 /* It doesn't make much sense to try scrolling in the tool-bar
10660 window, so don't do it. */
10661 w
->desired_matrix
->no_scrolling_p
= 1;
10662 w
->must_be_updated_p
= 1;
10664 if (!NILP (Vauto_resize_tool_bars
))
10666 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10667 int change_height_p
= 0;
10669 /* If we couldn't display everything, change the tool-bar's
10670 height if there is room for more. */
10671 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10672 && it
.current_y
< max_tool_bar_height
)
10673 change_height_p
= 1;
10675 row
= it
.glyph_row
- 1;
10677 /* If there are blank lines at the end, except for a partially
10678 visible blank line at the end that is smaller than
10679 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10680 if (!row
->displays_text_p
10681 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10682 change_height_p
= 1;
10684 /* If row displays tool-bar items, but is partially visible,
10685 change the tool-bar's height. */
10686 if (row
->displays_text_p
10687 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10688 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10689 change_height_p
= 1;
10691 /* Resize windows as needed by changing the `tool-bar-lines'
10692 frame parameter. */
10693 if (change_height_p
)
10695 extern Lisp_Object Qtool_bar_lines
;
10697 int old_height
= WINDOW_TOTAL_LINES (w
);
10699 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10701 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10702 && !f
->minimize_tool_bar_window_p
)
10703 ? (nlines
> old_height
)
10704 : (nlines
!= old_height
));
10705 f
->minimize_tool_bar_window_p
= 0;
10707 if (change_height_p
)
10709 XSETFRAME (frame
, f
);
10710 Fmodify_frame_parameters (frame
,
10711 Fcons (Fcons (Qtool_bar_lines
,
10712 make_number (nlines
)),
10714 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10716 clear_glyph_matrix (w
->desired_matrix
);
10717 f
->n_tool_bar_rows
= nrows
;
10718 fonts_changed_p
= 1;
10725 f
->minimize_tool_bar_window_p
= 0;
10730 /* Get information about the tool-bar item which is displayed in GLYPH
10731 on frame F. Return in *PROP_IDX the index where tool-bar item
10732 properties start in F->tool_bar_items. Value is zero if
10733 GLYPH doesn't display a tool-bar item. */
10736 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10742 /* This function can be called asynchronously, which means we must
10743 exclude any possibility that Fget_text_property signals an
10745 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10746 charpos
= max (0, charpos
);
10748 /* Get the text property `menu-item' at pos. The value of that
10749 property is the start index of this item's properties in
10750 F->tool_bar_items. */
10751 prop
= Fget_text_property (make_number (charpos
),
10752 Qmenu_item
, f
->current_tool_bar_string
);
10753 if (INTEGERP (prop
))
10755 *prop_idx
= XINT (prop
);
10765 /* Get information about the tool-bar item at position X/Y on frame F.
10766 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10767 the current matrix of the tool-bar window of F, or NULL if not
10768 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10769 item in F->tool_bar_items. Value is
10771 -1 if X/Y is not on a tool-bar item
10772 0 if X/Y is on the same item that was highlighted before.
10776 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10777 int *hpos
, int *vpos
, int *prop_idx
)
10779 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10780 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10783 /* Find the glyph under X/Y. */
10784 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10785 if (*glyph
== NULL
)
10788 /* Get the start of this tool-bar item's properties in
10789 f->tool_bar_items. */
10790 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10793 /* Is mouse on the highlighted item? */
10794 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10795 && *vpos
>= dpyinfo
->mouse_face_beg_row
10796 && *vpos
<= dpyinfo
->mouse_face_end_row
10797 && (*vpos
> dpyinfo
->mouse_face_beg_row
10798 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10799 && (*vpos
< dpyinfo
->mouse_face_end_row
10800 || *hpos
< dpyinfo
->mouse_face_end_col
10801 || dpyinfo
->mouse_face_past_end
))
10809 Handle mouse button event on the tool-bar of frame F, at
10810 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10811 0 for button release. MODIFIERS is event modifiers for button
10815 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10816 unsigned int modifiers
)
10818 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10819 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10820 int hpos
, vpos
, prop_idx
;
10821 struct glyph
*glyph
;
10822 Lisp_Object enabled_p
;
10824 /* If not on the highlighted tool-bar item, return. */
10825 frame_to_window_pixel_xy (w
, &x
, &y
);
10826 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10829 /* If item is disabled, do nothing. */
10830 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10831 if (NILP (enabled_p
))
10836 /* Show item in pressed state. */
10837 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10838 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10839 last_tool_bar_item
= prop_idx
;
10843 Lisp_Object key
, frame
;
10844 struct input_event event
;
10845 EVENT_INIT (event
);
10847 /* Show item in released state. */
10848 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10849 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10851 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10853 XSETFRAME (frame
, f
);
10854 event
.kind
= TOOL_BAR_EVENT
;
10855 event
.frame_or_window
= frame
;
10857 kbd_buffer_store_event (&event
);
10859 event
.kind
= TOOL_BAR_EVENT
;
10860 event
.frame_or_window
= frame
;
10862 event
.modifiers
= modifiers
;
10863 kbd_buffer_store_event (&event
);
10864 last_tool_bar_item
= -1;
10869 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10870 tool-bar window-relative coordinates X/Y. Called from
10871 note_mouse_highlight. */
10874 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10876 Lisp_Object window
= f
->tool_bar_window
;
10877 struct window
*w
= XWINDOW (window
);
10878 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10880 struct glyph
*glyph
;
10881 struct glyph_row
*row
;
10883 Lisp_Object enabled_p
;
10885 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10886 int mouse_down_p
, rc
;
10888 /* Function note_mouse_highlight is called with negative x(y
10889 values when mouse moves outside of the frame. */
10890 if (x
<= 0 || y
<= 0)
10892 clear_mouse_face (dpyinfo
);
10896 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10899 /* Not on tool-bar item. */
10900 clear_mouse_face (dpyinfo
);
10904 /* On same tool-bar item as before. */
10905 goto set_help_echo
;
10907 clear_mouse_face (dpyinfo
);
10909 /* Mouse is down, but on different tool-bar item? */
10910 mouse_down_p
= (dpyinfo
->grabbed
10911 && f
== last_mouse_frame
10912 && FRAME_LIVE_P (f
));
10914 && last_tool_bar_item
!= prop_idx
)
10917 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10918 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10920 /* If tool-bar item is not enabled, don't highlight it. */
10921 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10922 if (!NILP (enabled_p
))
10924 /* Compute the x-position of the glyph. In front and past the
10925 image is a space. We include this in the highlighted area. */
10926 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10927 for (i
= x
= 0; i
< hpos
; ++i
)
10928 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10930 /* Record this as the current active region. */
10931 dpyinfo
->mouse_face_beg_col
= hpos
;
10932 dpyinfo
->mouse_face_beg_row
= vpos
;
10933 dpyinfo
->mouse_face_beg_x
= x
;
10934 dpyinfo
->mouse_face_beg_y
= row
->y
;
10935 dpyinfo
->mouse_face_past_end
= 0;
10937 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10938 dpyinfo
->mouse_face_end_row
= vpos
;
10939 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10940 dpyinfo
->mouse_face_end_y
= row
->y
;
10941 dpyinfo
->mouse_face_window
= window
;
10942 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10944 /* Display it as active. */
10945 show_mouse_face (dpyinfo
, draw
);
10946 dpyinfo
->mouse_face_image_state
= draw
;
10951 /* Set help_echo_string to a help string to display for this tool-bar item.
10952 XTread_socket does the rest. */
10953 help_echo_object
= help_echo_window
= Qnil
;
10954 help_echo_pos
= -1;
10955 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10956 if (NILP (help_echo_string
))
10957 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10960 #endif /* HAVE_WINDOW_SYSTEM */
10964 /************************************************************************
10965 Horizontal scrolling
10966 ************************************************************************/
10968 static int hscroll_window_tree (Lisp_Object
);
10969 static int hscroll_windows (Lisp_Object
);
10971 /* For all leaf windows in the window tree rooted at WINDOW, set their
10972 hscroll value so that PT is (i) visible in the window, and (ii) so
10973 that it is not within a certain margin at the window's left and
10974 right border. Value is non-zero if any window's hscroll has been
10978 hscroll_window_tree (Lisp_Object window
)
10980 int hscrolled_p
= 0;
10981 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10982 int hscroll_step_abs
= 0;
10983 double hscroll_step_rel
= 0;
10985 if (hscroll_relative_p
)
10987 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10988 if (hscroll_step_rel
< 0)
10990 hscroll_relative_p
= 0;
10991 hscroll_step_abs
= 0;
10994 else if (INTEGERP (Vhscroll_step
))
10996 hscroll_step_abs
= XINT (Vhscroll_step
);
10997 if (hscroll_step_abs
< 0)
10998 hscroll_step_abs
= 0;
11001 hscroll_step_abs
= 0;
11003 while (WINDOWP (window
))
11005 struct window
*w
= XWINDOW (window
);
11007 if (WINDOWP (w
->hchild
))
11008 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11009 else if (WINDOWP (w
->vchild
))
11010 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11011 else if (w
->cursor
.vpos
>= 0)
11014 int text_area_width
;
11015 struct glyph_row
*current_cursor_row
11016 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11017 struct glyph_row
*desired_cursor_row
11018 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11019 struct glyph_row
*cursor_row
11020 = (desired_cursor_row
->enabled_p
11021 ? desired_cursor_row
11022 : current_cursor_row
);
11024 text_area_width
= window_box_width (w
, TEXT_AREA
);
11026 /* Scroll when cursor is inside this scroll margin. */
11027 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11029 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11030 && ((XFASTINT (w
->hscroll
)
11031 && w
->cursor
.x
<= h_margin
)
11032 || (cursor_row
->enabled_p
11033 && cursor_row
->truncated_on_right_p
11034 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11038 struct buffer
*saved_current_buffer
;
11042 /* Find point in a display of infinite width. */
11043 saved_current_buffer
= current_buffer
;
11044 current_buffer
= XBUFFER (w
->buffer
);
11046 if (w
== XWINDOW (selected_window
))
11047 pt
= BUF_PT (current_buffer
);
11050 pt
= marker_position (w
->pointm
);
11051 pt
= max (BEGV
, pt
);
11055 /* Move iterator to pt starting at cursor_row->start in
11056 a line with infinite width. */
11057 init_to_row_start (&it
, w
, cursor_row
);
11058 it
.last_visible_x
= INFINITY
;
11059 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11060 current_buffer
= saved_current_buffer
;
11062 /* Position cursor in window. */
11063 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11064 hscroll
= max (0, (it
.current_x
11065 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11066 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11067 : (text_area_width
/ 2))))
11068 / FRAME_COLUMN_WIDTH (it
.f
);
11069 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11071 if (hscroll_relative_p
)
11072 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11075 wanted_x
= text_area_width
11076 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11079 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11083 if (hscroll_relative_p
)
11084 wanted_x
= text_area_width
* hscroll_step_rel
11087 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11090 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11092 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11094 /* Don't call Fset_window_hscroll if value hasn't
11095 changed because it will prevent redisplay
11097 if (XFASTINT (w
->hscroll
) != hscroll
)
11099 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11100 w
->hscroll
= make_number (hscroll
);
11109 /* Value is non-zero if hscroll of any leaf window has been changed. */
11110 return hscrolled_p
;
11114 /* Set hscroll so that cursor is visible and not inside horizontal
11115 scroll margins for all windows in the tree rooted at WINDOW. See
11116 also hscroll_window_tree above. Value is non-zero if any window's
11117 hscroll has been changed. If it has, desired matrices on the frame
11118 of WINDOW are cleared. */
11121 hscroll_windows (Lisp_Object window
)
11123 int hscrolled_p
= hscroll_window_tree (window
);
11125 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11126 return hscrolled_p
;
11131 /************************************************************************
11133 ************************************************************************/
11135 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11136 to a non-zero value. This is sometimes handy to have in a debugger
11141 /* First and last unchanged row for try_window_id. */
11143 int debug_first_unchanged_at_end_vpos
;
11144 int debug_last_unchanged_at_beg_vpos
;
11146 /* Delta vpos and y. */
11148 int debug_dvpos
, debug_dy
;
11150 /* Delta in characters and bytes for try_window_id. */
11152 int debug_delta
, debug_delta_bytes
;
11154 /* Values of window_end_pos and window_end_vpos at the end of
11157 EMACS_INT debug_end_pos
, debug_end_vpos
;
11159 /* Append a string to W->desired_matrix->method. FMT is a printf
11160 format string. A1...A9 are a supplement for a variable-length
11161 argument list. If trace_redisplay_p is non-zero also printf the
11162 resulting string to stderr. */
11165 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11168 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11171 char *method
= w
->desired_matrix
->method
;
11172 int len
= strlen (method
);
11173 int size
= sizeof w
->desired_matrix
->method
;
11174 int remaining
= size
- len
- 1;
11176 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11177 if (len
&& remaining
)
11180 --remaining
, ++len
;
11183 strncpy (method
+ len
, buffer
, remaining
);
11185 if (trace_redisplay_p
)
11186 fprintf (stderr
, "%p (%s): %s\n",
11188 ((BUFFERP (w
->buffer
)
11189 && STRINGP (XBUFFER (w
->buffer
)->name
))
11190 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11195 #endif /* GLYPH_DEBUG */
11198 /* Value is non-zero if all changes in window W, which displays
11199 current_buffer, are in the text between START and END. START is a
11200 buffer position, END is given as a distance from Z. Used in
11201 redisplay_internal for display optimization. */
11204 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11206 int unchanged_p
= 1;
11208 /* If text or overlays have changed, see where. */
11209 if (XFASTINT (w
->last_modified
) < MODIFF
11210 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11212 /* Gap in the line? */
11213 if (GPT
< start
|| Z
- GPT
< end
)
11216 /* Changes start in front of the line, or end after it? */
11218 && (BEG_UNCHANGED
< start
- 1
11219 || END_UNCHANGED
< end
))
11222 /* If selective display, can't optimize if changes start at the
11223 beginning of the line. */
11225 && INTEGERP (current_buffer
->selective_display
)
11226 && XINT (current_buffer
->selective_display
) > 0
11227 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11230 /* If there are overlays at the start or end of the line, these
11231 may have overlay strings with newlines in them. A change at
11232 START, for instance, may actually concern the display of such
11233 overlay strings as well, and they are displayed on different
11234 lines. So, quickly rule out this case. (For the future, it
11235 might be desirable to implement something more telling than
11236 just BEG/END_UNCHANGED.) */
11239 if (BEG
+ BEG_UNCHANGED
== start
11240 && overlay_touches_p (start
))
11242 if (END_UNCHANGED
== end
11243 && overlay_touches_p (Z
- end
))
11247 /* Under bidi reordering, adding or deleting a character in the
11248 beginning of a paragraph, before the first strong directional
11249 character, can change the base direction of the paragraph (unless
11250 the buffer specifies a fixed paragraph direction), which will
11251 require to redisplay the whole paragraph. It might be worthwhile
11252 to find the paragraph limits and widen the range of redisplayed
11253 lines to that, but for now just give up this optimization. */
11254 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11255 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11259 return unchanged_p
;
11263 /* Do a frame update, taking possible shortcuts into account. This is
11264 the main external entry point for redisplay.
11266 If the last redisplay displayed an echo area message and that message
11267 is no longer requested, we clear the echo area or bring back the
11268 mini-buffer if that is in use. */
11273 redisplay_internal (0);
11278 overlay_arrow_string_or_property (Lisp_Object var
)
11282 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11285 return Voverlay_arrow_string
;
11288 /* Return 1 if there are any overlay-arrows in current_buffer. */
11290 overlay_arrow_in_current_buffer_p (void)
11294 for (vlist
= Voverlay_arrow_variable_list
;
11296 vlist
= XCDR (vlist
))
11298 Lisp_Object var
= XCAR (vlist
);
11301 if (!SYMBOLP (var
))
11303 val
= find_symbol_value (var
);
11305 && current_buffer
== XMARKER (val
)->buffer
)
11312 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11316 overlay_arrows_changed_p (void)
11320 for (vlist
= Voverlay_arrow_variable_list
;
11322 vlist
= XCDR (vlist
))
11324 Lisp_Object var
= XCAR (vlist
);
11325 Lisp_Object val
, pstr
;
11327 if (!SYMBOLP (var
))
11329 val
= find_symbol_value (var
);
11330 if (!MARKERP (val
))
11332 if (! EQ (COERCE_MARKER (val
),
11333 Fget (var
, Qlast_arrow_position
))
11334 || ! (pstr
= overlay_arrow_string_or_property (var
),
11335 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11341 /* Mark overlay arrows to be updated on next redisplay. */
11344 update_overlay_arrows (int up_to_date
)
11348 for (vlist
= Voverlay_arrow_variable_list
;
11350 vlist
= XCDR (vlist
))
11352 Lisp_Object var
= XCAR (vlist
);
11354 if (!SYMBOLP (var
))
11357 if (up_to_date
> 0)
11359 Lisp_Object val
= find_symbol_value (var
);
11360 Fput (var
, Qlast_arrow_position
,
11361 COERCE_MARKER (val
));
11362 Fput (var
, Qlast_arrow_string
,
11363 overlay_arrow_string_or_property (var
));
11365 else if (up_to_date
< 0
11366 || !NILP (Fget (var
, Qlast_arrow_position
)))
11368 Fput (var
, Qlast_arrow_position
, Qt
);
11369 Fput (var
, Qlast_arrow_string
, Qt
);
11375 /* Return overlay arrow string to display at row.
11376 Return integer (bitmap number) for arrow bitmap in left fringe.
11377 Return nil if no overlay arrow. */
11380 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11384 for (vlist
= Voverlay_arrow_variable_list
;
11386 vlist
= XCDR (vlist
))
11388 Lisp_Object var
= XCAR (vlist
);
11391 if (!SYMBOLP (var
))
11394 val
= find_symbol_value (var
);
11397 && current_buffer
== XMARKER (val
)->buffer
11398 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11400 if (FRAME_WINDOW_P (it
->f
)
11401 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11403 #ifdef HAVE_WINDOW_SYSTEM
11404 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11407 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11408 return make_number (fringe_bitmap
);
11411 return make_number (-1); /* Use default arrow bitmap */
11413 return overlay_arrow_string_or_property (var
);
11420 /* Return 1 if point moved out of or into a composition. Otherwise
11421 return 0. PREV_BUF and PREV_PT are the last point buffer and
11422 position. BUF and PT are the current point buffer and position. */
11425 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11426 struct buffer
*buf
, int pt
)
11428 EMACS_INT start
, end
;
11430 Lisp_Object buffer
;
11432 XSETBUFFER (buffer
, buf
);
11433 /* Check a composition at the last point if point moved within the
11435 if (prev_buf
== buf
)
11438 /* Point didn't move. */
11441 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11442 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11443 && COMPOSITION_VALID_P (start
, end
, prop
)
11444 && start
< prev_pt
&& end
> prev_pt
)
11445 /* The last point was within the composition. Return 1 iff
11446 point moved out of the composition. */
11447 return (pt
<= start
|| pt
>= end
);
11450 /* Check a composition at the current point. */
11451 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11452 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11453 && COMPOSITION_VALID_P (start
, end
, prop
)
11454 && start
< pt
&& end
> pt
);
11458 /* Reconsider the setting of B->clip_changed which is displayed
11462 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11464 if (b
->clip_changed
11465 && !NILP (w
->window_end_valid
)
11466 && w
->current_matrix
->buffer
== b
11467 && w
->current_matrix
->zv
== BUF_ZV (b
)
11468 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11469 b
->clip_changed
= 0;
11471 /* If display wasn't paused, and W is not a tool bar window, see if
11472 point has been moved into or out of a composition. In that case,
11473 we set b->clip_changed to 1 to force updating the screen. If
11474 b->clip_changed has already been set to 1, we can skip this
11476 if (!b
->clip_changed
11477 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11481 if (w
== XWINDOW (selected_window
))
11482 pt
= BUF_PT (current_buffer
);
11484 pt
= marker_position (w
->pointm
);
11486 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11487 || pt
!= XINT (w
->last_point
))
11488 && check_point_in_composition (w
->current_matrix
->buffer
,
11489 XINT (w
->last_point
),
11490 XBUFFER (w
->buffer
), pt
))
11491 b
->clip_changed
= 1;
11496 /* Select FRAME to forward the values of frame-local variables into C
11497 variables so that the redisplay routines can access those values
11501 select_frame_for_redisplay (Lisp_Object frame
)
11503 Lisp_Object tail
, tem
;
11504 Lisp_Object old
= selected_frame
;
11505 struct Lisp_Symbol
*sym
;
11507 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11509 selected_frame
= frame
;
11512 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11513 if (CONSP (XCAR (tail
))
11514 && (tem
= XCAR (XCAR (tail
)),
11516 && (sym
= indirect_variable (XSYMBOL (tem
)),
11517 sym
->redirect
== SYMBOL_LOCALIZED
)
11518 && sym
->val
.blv
->frame_local
)
11519 /* Use find_symbol_value rather than Fsymbol_value
11520 to avoid an error if it is void. */
11521 find_symbol_value (tem
);
11522 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11526 #define STOP_POLLING \
11527 do { if (! polling_stopped_here) stop_polling (); \
11528 polling_stopped_here = 1; } while (0)
11530 #define RESUME_POLLING \
11531 do { if (polling_stopped_here) start_polling (); \
11532 polling_stopped_here = 0; } while (0)
11535 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11536 response to any user action; therefore, we should preserve the echo
11537 area. (Actually, our caller does that job.) Perhaps in the future
11538 avoid recentering windows if it is not necessary; currently that
11539 causes some problems. */
11542 redisplay_internal (int preserve_echo_area
)
11544 struct window
*w
= XWINDOW (selected_window
);
11547 int must_finish
= 0;
11548 struct text_pos tlbufpos
, tlendpos
;
11549 int number_of_visible_frames
;
11552 int polling_stopped_here
= 0;
11553 Lisp_Object old_frame
= selected_frame
;
11555 /* Non-zero means redisplay has to consider all windows on all
11556 frames. Zero means, only selected_window is considered. */
11557 int consider_all_windows_p
;
11559 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11561 /* No redisplay if running in batch mode or frame is not yet fully
11562 initialized, or redisplay is explicitly turned off by setting
11563 Vinhibit_redisplay. */
11564 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11565 || !NILP (Vinhibit_redisplay
))
11568 /* Don't examine these until after testing Vinhibit_redisplay.
11569 When Emacs is shutting down, perhaps because its connection to
11570 X has dropped, we should not look at them at all. */
11571 f
= XFRAME (w
->frame
);
11572 sf
= SELECTED_FRAME ();
11574 if (!f
->glyphs_initialized_p
)
11577 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11578 if (popup_activated ())
11582 /* I don't think this happens but let's be paranoid. */
11583 if (redisplaying_p
)
11586 /* Record a function that resets redisplaying_p to its old value
11587 when we leave this function. */
11588 count
= SPECPDL_INDEX ();
11589 record_unwind_protect (unwind_redisplay
,
11590 Fcons (make_number (redisplaying_p
), selected_frame
));
11592 specbind (Qinhibit_free_realized_faces
, Qnil
);
11595 Lisp_Object tail
, frame
;
11597 FOR_EACH_FRAME (tail
, frame
)
11599 struct frame
*f
= XFRAME (frame
);
11600 f
->already_hscrolled_p
= 0;
11605 if (!EQ (old_frame
, selected_frame
)
11606 && FRAME_LIVE_P (XFRAME (old_frame
)))
11607 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11608 selected_frame and selected_window to be temporarily out-of-sync so
11609 when we come back here via `goto retry', we need to resync because we
11610 may need to run Elisp code (via prepare_menu_bars). */
11611 select_frame_for_redisplay (old_frame
);
11614 reconsider_clip_changes (w
, current_buffer
);
11615 last_escape_glyph_frame
= NULL
;
11616 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11618 /* If new fonts have been loaded that make a glyph matrix adjustment
11619 necessary, do it. */
11620 if (fonts_changed_p
)
11622 adjust_glyphs (NULL
);
11623 ++windows_or_buffers_changed
;
11624 fonts_changed_p
= 0;
11627 /* If face_change_count is non-zero, init_iterator will free all
11628 realized faces, which includes the faces referenced from current
11629 matrices. So, we can't reuse current matrices in this case. */
11630 if (face_change_count
)
11631 ++windows_or_buffers_changed
;
11633 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11634 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11636 /* Since frames on a single ASCII terminal share the same
11637 display area, displaying a different frame means redisplay
11638 the whole thing. */
11639 windows_or_buffers_changed
++;
11640 SET_FRAME_GARBAGED (sf
);
11642 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11644 FRAME_TTY (sf
)->previous_frame
= sf
;
11647 /* Set the visible flags for all frames. Do this before checking
11648 for resized or garbaged frames; they want to know if their frames
11649 are visible. See the comment in frame.h for
11650 FRAME_SAMPLE_VISIBILITY. */
11652 Lisp_Object tail
, frame
;
11654 number_of_visible_frames
= 0;
11656 FOR_EACH_FRAME (tail
, frame
)
11658 struct frame
*f
= XFRAME (frame
);
11660 FRAME_SAMPLE_VISIBILITY (f
);
11661 if (FRAME_VISIBLE_P (f
))
11662 ++number_of_visible_frames
;
11663 clear_desired_matrices (f
);
11667 /* Notice any pending interrupt request to change frame size. */
11668 do_pending_window_change (1);
11670 /* Clear frames marked as garbaged. */
11671 if (frame_garbaged
)
11672 clear_garbaged_frames ();
11674 /* Build menubar and tool-bar items. */
11675 if (NILP (Vmemory_full
))
11676 prepare_menu_bars ();
11678 if (windows_or_buffers_changed
)
11679 update_mode_lines
++;
11681 /* Detect case that we need to write or remove a star in the mode line. */
11682 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11684 w
->update_mode_line
= Qt
;
11685 if (buffer_shared
> 1)
11686 update_mode_lines
++;
11689 /* Avoid invocation of point motion hooks by `current_column' below. */
11690 count1
= SPECPDL_INDEX ();
11691 specbind (Qinhibit_point_motion_hooks
, Qt
);
11693 /* If %c is in the mode line, update it if needed. */
11694 if (!NILP (w
->column_number_displayed
)
11695 /* This alternative quickly identifies a common case
11696 where no change is needed. */
11697 && !(PT
== XFASTINT (w
->last_point
)
11698 && XFASTINT (w
->last_modified
) >= MODIFF
11699 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11700 && (XFASTINT (w
->column_number_displayed
)
11701 != (int) current_column ())) /* iftc */
11702 w
->update_mode_line
= Qt
;
11704 unbind_to (count1
, Qnil
);
11706 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11708 /* The variable buffer_shared is set in redisplay_window and
11709 indicates that we redisplay a buffer in different windows. See
11711 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11712 || cursor_type_changed
);
11714 /* If specs for an arrow have changed, do thorough redisplay
11715 to ensure we remove any arrow that should no longer exist. */
11716 if (overlay_arrows_changed_p ())
11717 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11719 /* Normally the message* functions will have already displayed and
11720 updated the echo area, but the frame may have been trashed, or
11721 the update may have been preempted, so display the echo area
11722 again here. Checking message_cleared_p captures the case that
11723 the echo area should be cleared. */
11724 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11725 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11726 || (message_cleared_p
11727 && minibuf_level
== 0
11728 /* If the mini-window is currently selected, this means the
11729 echo-area doesn't show through. */
11730 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11732 int window_height_changed_p
= echo_area_display (0);
11735 /* If we don't display the current message, don't clear the
11736 message_cleared_p flag, because, if we did, we wouldn't clear
11737 the echo area in the next redisplay which doesn't preserve
11739 if (!display_last_displayed_message_p
)
11740 message_cleared_p
= 0;
11742 if (fonts_changed_p
)
11744 else if (window_height_changed_p
)
11746 consider_all_windows_p
= 1;
11747 ++update_mode_lines
;
11748 ++windows_or_buffers_changed
;
11750 /* If window configuration was changed, frames may have been
11751 marked garbaged. Clear them or we will experience
11752 surprises wrt scrolling. */
11753 if (frame_garbaged
)
11754 clear_garbaged_frames ();
11757 else if (EQ (selected_window
, minibuf_window
)
11758 && (current_buffer
->clip_changed
11759 || XFASTINT (w
->last_modified
) < MODIFF
11760 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11761 && resize_mini_window (w
, 0))
11763 /* Resized active mini-window to fit the size of what it is
11764 showing if its contents might have changed. */
11766 /* FIXME: this causes all frames to be updated, which seems unnecessary
11767 since only the current frame needs to be considered. This function needs
11768 to be rewritten with two variables, consider_all_windows and
11769 consider_all_frames. */
11770 consider_all_windows_p
= 1;
11771 ++windows_or_buffers_changed
;
11772 ++update_mode_lines
;
11774 /* If window configuration was changed, frames may have been
11775 marked garbaged. Clear them or we will experience
11776 surprises wrt scrolling. */
11777 if (frame_garbaged
)
11778 clear_garbaged_frames ();
11782 /* If showing the region, and mark has changed, we must redisplay
11783 the whole window. The assignment to this_line_start_pos prevents
11784 the optimization directly below this if-statement. */
11785 if (((!NILP (Vtransient_mark_mode
)
11786 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11787 != !NILP (w
->region_showing
))
11788 || (!NILP (w
->region_showing
)
11789 && !EQ (w
->region_showing
,
11790 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11791 CHARPOS (this_line_start_pos
) = 0;
11793 /* Optimize the case that only the line containing the cursor in the
11794 selected window has changed. Variables starting with this_ are
11795 set in display_line and record information about the line
11796 containing the cursor. */
11797 tlbufpos
= this_line_start_pos
;
11798 tlendpos
= this_line_end_pos
;
11799 if (!consider_all_windows_p
11800 && CHARPOS (tlbufpos
) > 0
11801 && NILP (w
->update_mode_line
)
11802 && !current_buffer
->clip_changed
11803 && !current_buffer
->prevent_redisplay_optimizations_p
11804 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11805 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11806 /* Make sure recorded data applies to current buffer, etc. */
11807 && this_line_buffer
== current_buffer
11808 && current_buffer
== XBUFFER (w
->buffer
)
11809 && NILP (w
->force_start
)
11810 && NILP (w
->optional_new_start
)
11811 /* Point must be on the line that we have info recorded about. */
11812 && PT
>= CHARPOS (tlbufpos
)
11813 && PT
<= Z
- CHARPOS (tlendpos
)
11814 /* All text outside that line, including its final newline,
11815 must be unchanged. */
11816 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11817 CHARPOS (tlendpos
)))
11819 if (CHARPOS (tlbufpos
) > BEGV
11820 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11821 && (CHARPOS (tlbufpos
) == ZV
11822 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11823 /* Former continuation line has disappeared by becoming empty. */
11825 else if (XFASTINT (w
->last_modified
) < MODIFF
11826 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11827 || MINI_WINDOW_P (w
))
11829 /* We have to handle the case of continuation around a
11830 wide-column character (see the comment in indent.c around
11833 For instance, in the following case:
11835 -------- Insert --------
11836 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11837 J_I_ ==> J_I_ `^^' are cursors.
11841 As we have to redraw the line above, we cannot use this
11845 int line_height_before
= this_line_pixel_height
;
11847 /* Note that start_display will handle the case that the
11848 line starting at tlbufpos is a continuation line. */
11849 start_display (&it
, w
, tlbufpos
);
11851 /* Implementation note: It this still necessary? */
11852 if (it
.current_x
!= this_line_start_x
)
11855 TRACE ((stderr
, "trying display optimization 1\n"));
11856 w
->cursor
.vpos
= -1;
11857 overlay_arrow_seen
= 0;
11858 it
.vpos
= this_line_vpos
;
11859 it
.current_y
= this_line_y
;
11860 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11861 display_line (&it
);
11863 /* If line contains point, is not continued,
11864 and ends at same distance from eob as before, we win. */
11865 if (w
->cursor
.vpos
>= 0
11866 /* Line is not continued, otherwise this_line_start_pos
11867 would have been set to 0 in display_line. */
11868 && CHARPOS (this_line_start_pos
)
11869 /* Line ends as before. */
11870 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11871 /* Line has same height as before. Otherwise other lines
11872 would have to be shifted up or down. */
11873 && this_line_pixel_height
== line_height_before
)
11875 /* If this is not the window's last line, we must adjust
11876 the charstarts of the lines below. */
11877 if (it
.current_y
< it
.last_visible_y
)
11879 struct glyph_row
*row
11880 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11881 int delta
, delta_bytes
;
11883 /* We used to distinguish between two cases here,
11884 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11885 when the line ends in a newline or the end of the
11886 buffer's accessible portion. But both cases did
11887 the same, so they were collapsed. */
11889 - CHARPOS (tlendpos
)
11890 - MATRIX_ROW_START_CHARPOS (row
));
11891 delta_bytes
= (Z_BYTE
11892 - BYTEPOS (tlendpos
)
11893 - MATRIX_ROW_START_BYTEPOS (row
));
11895 increment_matrix_positions (w
->current_matrix
,
11896 this_line_vpos
+ 1,
11897 w
->current_matrix
->nrows
,
11898 delta
, delta_bytes
);
11901 /* If this row displays text now but previously didn't,
11902 or vice versa, w->window_end_vpos may have to be
11904 if ((it
.glyph_row
- 1)->displays_text_p
)
11906 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11907 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11909 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11910 && this_line_vpos
> 0)
11911 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11912 w
->window_end_valid
= Qnil
;
11914 /* Update hint: No need to try to scroll in update_window. */
11915 w
->desired_matrix
->no_scrolling_p
= 1;
11918 *w
->desired_matrix
->method
= 0;
11919 debug_method_add (w
, "optimization 1");
11921 #ifdef HAVE_WINDOW_SYSTEM
11922 update_window_fringes (w
, 0);
11929 else if (/* Cursor position hasn't changed. */
11930 PT
== XFASTINT (w
->last_point
)
11931 /* Make sure the cursor was last displayed
11932 in this window. Otherwise we have to reposition it. */
11933 && 0 <= w
->cursor
.vpos
11934 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11938 do_pending_window_change (1);
11940 /* We used to always goto end_of_redisplay here, but this
11941 isn't enough if we have a blinking cursor. */
11942 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11943 goto end_of_redisplay
;
11947 /* If highlighting the region, or if the cursor is in the echo area,
11948 then we can't just move the cursor. */
11949 else if (! (!NILP (Vtransient_mark_mode
)
11950 && !NILP (current_buffer
->mark_active
))
11951 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11952 || highlight_nonselected_windows
)
11953 && NILP (w
->region_showing
)
11954 && NILP (Vshow_trailing_whitespace
)
11955 && !cursor_in_echo_area
)
11958 struct glyph_row
*row
;
11960 /* Skip from tlbufpos to PT and see where it is. Note that
11961 PT may be in invisible text. If so, we will end at the
11962 next visible position. */
11963 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11964 NULL
, DEFAULT_FACE_ID
);
11965 it
.current_x
= this_line_start_x
;
11966 it
.current_y
= this_line_y
;
11967 it
.vpos
= this_line_vpos
;
11969 /* The call to move_it_to stops in front of PT, but
11970 moves over before-strings. */
11971 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11973 if (it
.vpos
== this_line_vpos
11974 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11977 xassert (this_line_vpos
== it
.vpos
);
11978 xassert (this_line_y
== it
.current_y
);
11979 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11981 *w
->desired_matrix
->method
= 0;
11982 debug_method_add (w
, "optimization 3");
11991 /* Text changed drastically or point moved off of line. */
11992 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11995 CHARPOS (this_line_start_pos
) = 0;
11996 consider_all_windows_p
|= buffer_shared
> 1;
11997 ++clear_face_cache_count
;
11998 #ifdef HAVE_WINDOW_SYSTEM
11999 ++clear_image_cache_count
;
12002 /* Build desired matrices, and update the display. If
12003 consider_all_windows_p is non-zero, do it for all windows on all
12004 frames. Otherwise do it for selected_window, only. */
12006 if (consider_all_windows_p
)
12008 Lisp_Object tail
, frame
;
12010 FOR_EACH_FRAME (tail
, frame
)
12011 XFRAME (frame
)->updated_p
= 0;
12013 /* Recompute # windows showing selected buffer. This will be
12014 incremented each time such a window is displayed. */
12017 FOR_EACH_FRAME (tail
, frame
)
12019 struct frame
*f
= XFRAME (frame
);
12021 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12023 if (! EQ (frame
, selected_frame
))
12024 /* Select the frame, for the sake of frame-local
12026 select_frame_for_redisplay (frame
);
12028 /* Mark all the scroll bars to be removed; we'll redeem
12029 the ones we want when we redisplay their windows. */
12030 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12031 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12033 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12034 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12036 /* The X error handler may have deleted that frame. */
12037 if (!FRAME_LIVE_P (f
))
12040 /* Any scroll bars which redisplay_windows should have
12041 nuked should now go away. */
12042 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12043 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12045 /* If fonts changed, display again. */
12046 /* ??? rms: I suspect it is a mistake to jump all the way
12047 back to retry here. It should just retry this frame. */
12048 if (fonts_changed_p
)
12051 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12053 /* See if we have to hscroll. */
12054 if (!f
->already_hscrolled_p
)
12056 f
->already_hscrolled_p
= 1;
12057 if (hscroll_windows (f
->root_window
))
12061 /* Prevent various kinds of signals during display
12062 update. stdio is not robust about handling
12063 signals, which can cause an apparent I/O
12065 if (interrupt_input
)
12066 unrequest_sigio ();
12069 /* Update the display. */
12070 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12071 pause
|= update_frame (f
, 0, 0);
12077 if (!EQ (old_frame
, selected_frame
)
12078 && FRAME_LIVE_P (XFRAME (old_frame
)))
12079 /* We played a bit fast-and-loose above and allowed selected_frame
12080 and selected_window to be temporarily out-of-sync but let's make
12081 sure this stays contained. */
12082 select_frame_for_redisplay (old_frame
);
12083 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12087 /* Do the mark_window_display_accurate after all windows have
12088 been redisplayed because this call resets flags in buffers
12089 which are needed for proper redisplay. */
12090 FOR_EACH_FRAME (tail
, frame
)
12092 struct frame
*f
= XFRAME (frame
);
12095 mark_window_display_accurate (f
->root_window
, 1);
12096 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12097 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12102 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12104 Lisp_Object mini_window
;
12105 struct frame
*mini_frame
;
12107 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12108 /* Use list_of_error, not Qerror, so that
12109 we catch only errors and don't run the debugger. */
12110 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12112 redisplay_window_error
);
12114 /* Compare desired and current matrices, perform output. */
12117 /* If fonts changed, display again. */
12118 if (fonts_changed_p
)
12121 /* Prevent various kinds of signals during display update.
12122 stdio is not robust about handling signals,
12123 which can cause an apparent I/O error. */
12124 if (interrupt_input
)
12125 unrequest_sigio ();
12128 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12130 if (hscroll_windows (selected_window
))
12133 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12134 pause
= update_frame (sf
, 0, 0);
12137 /* We may have called echo_area_display at the top of this
12138 function. If the echo area is on another frame, that may
12139 have put text on a frame other than the selected one, so the
12140 above call to update_frame would not have caught it. Catch
12142 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12143 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12145 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12147 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12148 pause
|= update_frame (mini_frame
, 0, 0);
12149 if (!pause
&& hscroll_windows (mini_window
))
12154 /* If display was paused because of pending input, make sure we do a
12155 thorough update the next time. */
12158 /* Prevent the optimization at the beginning of
12159 redisplay_internal that tries a single-line update of the
12160 line containing the cursor in the selected window. */
12161 CHARPOS (this_line_start_pos
) = 0;
12163 /* Let the overlay arrow be updated the next time. */
12164 update_overlay_arrows (0);
12166 /* If we pause after scrolling, some rows in the current
12167 matrices of some windows are not valid. */
12168 if (!WINDOW_FULL_WIDTH_P (w
)
12169 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12170 update_mode_lines
= 1;
12174 if (!consider_all_windows_p
)
12176 /* This has already been done above if
12177 consider_all_windows_p is set. */
12178 mark_window_display_accurate_1 (w
, 1);
12180 /* Say overlay arrows are up to date. */
12181 update_overlay_arrows (1);
12183 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12184 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12187 update_mode_lines
= 0;
12188 windows_or_buffers_changed
= 0;
12189 cursor_type_changed
= 0;
12192 /* Start SIGIO interrupts coming again. Having them off during the
12193 code above makes it less likely one will discard output, but not
12194 impossible, since there might be stuff in the system buffer here.
12195 But it is much hairier to try to do anything about that. */
12196 if (interrupt_input
)
12200 /* If a frame has become visible which was not before, redisplay
12201 again, so that we display it. Expose events for such a frame
12202 (which it gets when becoming visible) don't call the parts of
12203 redisplay constructing glyphs, so simply exposing a frame won't
12204 display anything in this case. So, we have to display these
12205 frames here explicitly. */
12208 Lisp_Object tail
, frame
;
12211 FOR_EACH_FRAME (tail
, frame
)
12213 int this_is_visible
= 0;
12215 if (XFRAME (frame
)->visible
)
12216 this_is_visible
= 1;
12217 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12218 if (XFRAME (frame
)->visible
)
12219 this_is_visible
= 1;
12221 if (this_is_visible
)
12225 if (new_count
!= number_of_visible_frames
)
12226 windows_or_buffers_changed
++;
12229 /* Change frame size now if a change is pending. */
12230 do_pending_window_change (1);
12232 /* If we just did a pending size change, or have additional
12233 visible frames, redisplay again. */
12234 if (windows_or_buffers_changed
&& !pause
)
12237 /* Clear the face and image caches.
12239 We used to do this only if consider_all_windows_p. But the cache
12240 needs to be cleared if a timer creates images in the current
12241 buffer (e.g. the test case in Bug#6230). */
12243 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12245 clear_face_cache (0);
12246 clear_face_cache_count
= 0;
12249 #ifdef HAVE_WINDOW_SYSTEM
12250 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12252 clear_image_caches (Qnil
);
12253 clear_image_cache_count
= 0;
12255 #endif /* HAVE_WINDOW_SYSTEM */
12258 unbind_to (count
, Qnil
);
12263 /* Redisplay, but leave alone any recent echo area message unless
12264 another message has been requested in its place.
12266 This is useful in situations where you need to redisplay but no
12267 user action has occurred, making it inappropriate for the message
12268 area to be cleared. See tracking_off and
12269 wait_reading_process_output for examples of these situations.
12271 FROM_WHERE is an integer saying from where this function was
12272 called. This is useful for debugging. */
12275 redisplay_preserve_echo_area (int from_where
)
12277 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12279 if (!NILP (echo_area_buffer
[1]))
12281 /* We have a previously displayed message, but no current
12282 message. Redisplay the previous message. */
12283 display_last_displayed_message_p
= 1;
12284 redisplay_internal (1);
12285 display_last_displayed_message_p
= 0;
12288 redisplay_internal (1);
12290 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12291 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12292 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12296 /* Function registered with record_unwind_protect in
12297 redisplay_internal. Reset redisplaying_p to the value it had
12298 before redisplay_internal was called, and clear
12299 prevent_freeing_realized_faces_p. It also selects the previously
12300 selected frame, unless it has been deleted (by an X connection
12301 failure during redisplay, for example). */
12304 unwind_redisplay (Lisp_Object val
)
12306 Lisp_Object old_redisplaying_p
, old_frame
;
12308 old_redisplaying_p
= XCAR (val
);
12309 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12310 old_frame
= XCDR (val
);
12311 if (! EQ (old_frame
, selected_frame
)
12312 && FRAME_LIVE_P (XFRAME (old_frame
)))
12313 select_frame_for_redisplay (old_frame
);
12318 /* Mark the display of window W as accurate or inaccurate. If
12319 ACCURATE_P is non-zero mark display of W as accurate. If
12320 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12321 redisplay_internal is called. */
12324 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12326 if (BUFFERP (w
->buffer
))
12328 struct buffer
*b
= XBUFFER (w
->buffer
);
12331 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12332 w
->last_overlay_modified
12333 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12335 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12339 b
->clip_changed
= 0;
12340 b
->prevent_redisplay_optimizations_p
= 0;
12342 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12343 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12344 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12345 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12347 w
->current_matrix
->buffer
= b
;
12348 w
->current_matrix
->begv
= BUF_BEGV (b
);
12349 w
->current_matrix
->zv
= BUF_ZV (b
);
12351 w
->last_cursor
= w
->cursor
;
12352 w
->last_cursor_off_p
= w
->cursor_off_p
;
12354 if (w
== XWINDOW (selected_window
))
12355 w
->last_point
= make_number (BUF_PT (b
));
12357 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12363 w
->window_end_valid
= w
->buffer
;
12364 w
->update_mode_line
= Qnil
;
12369 /* Mark the display of windows in the window tree rooted at WINDOW as
12370 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12371 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12372 be redisplayed the next time redisplay_internal is called. */
12375 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12379 for (; !NILP (window
); window
= w
->next
)
12381 w
= XWINDOW (window
);
12382 mark_window_display_accurate_1 (w
, accurate_p
);
12384 if (!NILP (w
->vchild
))
12385 mark_window_display_accurate (w
->vchild
, accurate_p
);
12386 if (!NILP (w
->hchild
))
12387 mark_window_display_accurate (w
->hchild
, accurate_p
);
12392 update_overlay_arrows (1);
12396 /* Force a thorough redisplay the next time by setting
12397 last_arrow_position and last_arrow_string to t, which is
12398 unequal to any useful value of Voverlay_arrow_... */
12399 update_overlay_arrows (-1);
12404 /* Return value in display table DP (Lisp_Char_Table *) for character
12405 C. Since a display table doesn't have any parent, we don't have to
12406 follow parent. Do not call this function directly but use the
12407 macro DISP_CHAR_VECTOR. */
12410 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12414 if (ASCII_CHAR_P (c
))
12417 if (SUB_CHAR_TABLE_P (val
))
12418 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12424 XSETCHAR_TABLE (table
, dp
);
12425 val
= char_table_ref (table
, c
);
12434 /***********************************************************************
12436 ***********************************************************************/
12438 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12441 redisplay_windows (Lisp_Object window
)
12443 while (!NILP (window
))
12445 struct window
*w
= XWINDOW (window
);
12447 if (!NILP (w
->hchild
))
12448 redisplay_windows (w
->hchild
);
12449 else if (!NILP (w
->vchild
))
12450 redisplay_windows (w
->vchild
);
12451 else if (!NILP (w
->buffer
))
12453 displayed_buffer
= XBUFFER (w
->buffer
);
12454 /* Use list_of_error, not Qerror, so that
12455 we catch only errors and don't run the debugger. */
12456 internal_condition_case_1 (redisplay_window_0
, window
,
12458 redisplay_window_error
);
12466 redisplay_window_error (Lisp_Object ignore
)
12468 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12473 redisplay_window_0 (Lisp_Object window
)
12475 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12476 redisplay_window (window
, 0);
12481 redisplay_window_1 (Lisp_Object window
)
12483 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12484 redisplay_window (window
, 1);
12489 /* Increment GLYPH until it reaches END or CONDITION fails while
12490 adding (GLYPH)->pixel_width to X. */
12492 #define SKIP_GLYPHS(glyph, end, x, condition) \
12495 (x) += (glyph)->pixel_width; \
12498 while ((glyph) < (end) && (condition))
12501 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12502 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12503 which positions recorded in ROW differ from current buffer
12506 Return 0 if cursor is not on this row, 1 otherwise. */
12509 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12510 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12513 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12514 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12515 struct glyph
*cursor
= NULL
;
12516 /* The last known character position in row. */
12517 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12519 EMACS_INT pt_old
= PT
- delta
;
12520 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12521 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12522 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12523 /* A glyph beyond the edge of TEXT_AREA which we should never
12525 struct glyph
*glyphs_end
= end
;
12526 /* Non-zero means we've found a match for cursor position, but that
12527 glyph has the avoid_cursor_p flag set. */
12528 int match_with_avoid_cursor
= 0;
12529 /* Non-zero means we've seen at least one glyph that came from a
12531 int string_seen
= 0;
12532 /* Largest buffer position seen so far during scan of glyph row. */
12533 EMACS_INT bpos_max
= last_pos
;
12534 /* Last buffer position covered by an overlay string with an integer
12535 `cursor' property. */
12536 EMACS_INT bpos_covered
= 0;
12538 /* Skip over glyphs not having an object at the start and the end of
12539 the row. These are special glyphs like truncation marks on
12540 terminal frames. */
12541 if (row
->displays_text_p
)
12543 if (!row
->reversed_p
)
12546 && INTEGERP (glyph
->object
)
12547 && glyph
->charpos
< 0)
12549 x
+= glyph
->pixel_width
;
12553 && INTEGERP ((end
- 1)->object
)
12554 /* CHARPOS is zero for blanks and stretch glyphs
12555 inserted by extend_face_to_end_of_line. */
12556 && (end
- 1)->charpos
<= 0)
12558 glyph_before
= glyph
- 1;
12565 /* If the glyph row is reversed, we need to process it from back
12566 to front, so swap the edge pointers. */
12567 glyphs_end
= end
= glyph
- 1;
12568 glyph
+= row
->used
[TEXT_AREA
] - 1;
12570 while (glyph
> end
+ 1
12571 && INTEGERP (glyph
->object
)
12572 && glyph
->charpos
< 0)
12575 x
-= glyph
->pixel_width
;
12577 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12579 /* By default, in reversed rows we put the cursor on the
12580 rightmost (first in the reading order) glyph. */
12581 for (g
= end
+ 1; g
< glyph
; g
++)
12582 x
+= g
->pixel_width
;
12584 && INTEGERP ((end
+ 1)->object
)
12585 && (end
+ 1)->charpos
<= 0)
12587 glyph_before
= glyph
+ 1;
12591 else if (row
->reversed_p
)
12593 /* In R2L rows that don't display text, put the cursor on the
12594 rightmost glyph. Case in point: an empty last line that is
12595 part of an R2L paragraph. */
12597 /* Avoid placing the cursor on the last glyph of the row, where
12598 on terminal frames we hold the vertical border between
12599 adjacent windows. */
12600 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12601 && !WINDOW_RIGHTMOST_P (w
)
12602 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12604 x
= -1; /* will be computed below, at label compute_x */
12607 /* Step 1: Try to find the glyph whose character position
12608 corresponds to point. If that's not possible, find 2 glyphs
12609 whose character positions are the closest to point, one before
12610 point, the other after it. */
12611 if (!row
->reversed_p
)
12612 while (/* not marched to end of glyph row */
12614 /* glyph was not inserted by redisplay for internal purposes */
12615 && !INTEGERP (glyph
->object
))
12617 if (BUFFERP (glyph
->object
))
12619 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12621 if (glyph
->charpos
> bpos_max
)
12622 bpos_max
= glyph
->charpos
;
12623 if (!glyph
->avoid_cursor_p
)
12625 /* If we hit point, we've found the glyph on which to
12626 display the cursor. */
12629 match_with_avoid_cursor
= 0;
12632 /* See if we've found a better approximation to
12633 POS_BEFORE or to POS_AFTER. Note that we want the
12634 first (leftmost) glyph of all those that are the
12635 closest from below, and the last (rightmost) of all
12636 those from above. */
12637 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12639 pos_before
= glyph
->charpos
;
12640 glyph_before
= glyph
;
12642 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12644 pos_after
= glyph
->charpos
;
12645 glyph_after
= glyph
;
12648 else if (dpos
== 0)
12649 match_with_avoid_cursor
= 1;
12651 else if (STRINGP (glyph
->object
))
12653 Lisp_Object chprop
;
12654 int glyph_pos
= glyph
->charpos
;
12656 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12658 if (INTEGERP (chprop
))
12660 bpos_covered
= bpos_max
+ XINT (chprop
);
12661 /* If the `cursor' property covers buffer positions up
12662 to and including point, we should display cursor on
12663 this glyph. Note that overlays and text properties
12664 with string values stop bidi reordering, so every
12665 buffer position to the left of the string is always
12666 smaller than any position to the right of the
12667 string. Therefore, if a `cursor' property on one
12668 of the string's characters has an integer value, we
12669 will break out of the loop below _before_ we get to
12670 the position match above. IOW, integer values of
12671 the `cursor' property override the "exact match for
12672 point" strategy of positioning the cursor. */
12673 /* Implementation note: bpos_max == pt_old when, e.g.,
12674 we are in an empty line, where bpos_max is set to
12675 MATRIX_ROW_START_CHARPOS, see above. */
12676 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12685 x
+= glyph
->pixel_width
;
12688 else if (glyph
> end
) /* row is reversed */
12689 while (!INTEGERP (glyph
->object
))
12691 if (BUFFERP (glyph
->object
))
12693 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12695 if (glyph
->charpos
> bpos_max
)
12696 bpos_max
= glyph
->charpos
;
12697 if (!glyph
->avoid_cursor_p
)
12701 match_with_avoid_cursor
= 0;
12704 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12706 pos_before
= glyph
->charpos
;
12707 glyph_before
= glyph
;
12709 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12711 pos_after
= glyph
->charpos
;
12712 glyph_after
= glyph
;
12715 else if (dpos
== 0)
12716 match_with_avoid_cursor
= 1;
12718 else if (STRINGP (glyph
->object
))
12720 Lisp_Object chprop
;
12721 int glyph_pos
= glyph
->charpos
;
12723 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12725 if (INTEGERP (chprop
))
12727 bpos_covered
= bpos_max
+ XINT (chprop
);
12728 /* If the `cursor' property covers buffer positions up
12729 to and including point, we should display cursor on
12731 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12740 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12742 x
--; /* can't use any pixel_width */
12745 x
-= glyph
->pixel_width
;
12748 /* Step 2: If we didn't find an exact match for point, we need to
12749 look for a proper place to put the cursor among glyphs between
12750 GLYPH_BEFORE and GLYPH_AFTER. */
12751 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12752 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12753 && bpos_covered
< pt_old
)
12755 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12757 EMACS_INT ellipsis_pos
;
12759 /* Scan back over the ellipsis glyphs. */
12760 if (!row
->reversed_p
)
12762 ellipsis_pos
= (glyph
- 1)->charpos
;
12763 while (glyph
> row
->glyphs
[TEXT_AREA
]
12764 && (glyph
- 1)->charpos
== ellipsis_pos
)
12765 glyph
--, x
-= glyph
->pixel_width
;
12766 /* That loop always goes one position too far, including
12767 the glyph before the ellipsis. So scan forward over
12769 x
+= glyph
->pixel_width
;
12772 else /* row is reversed */
12774 ellipsis_pos
= (glyph
+ 1)->charpos
;
12775 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12776 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12777 glyph
++, x
+= glyph
->pixel_width
;
12778 x
-= glyph
->pixel_width
;
12782 else if (match_with_avoid_cursor
12783 /* zero-width characters produce no glyphs */
12784 || ((row
->reversed_p
12785 ? glyph_after
> glyphs_end
12786 : glyph_after
< glyphs_end
)
12787 && eabs (glyph_after
- glyph_before
) == 1))
12789 cursor
= glyph_after
;
12792 else if (string_seen
)
12794 int incr
= row
->reversed_p
? -1 : +1;
12796 /* Need to find the glyph that came out of a string which is
12797 present at point. That glyph is somewhere between
12798 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12799 positioned between POS_BEFORE and POS_AFTER in the
12801 struct glyph
*stop
= glyph_after
;
12802 EMACS_INT pos
= pos_before
;
12805 for (glyph
= glyph_before
+ incr
;
12806 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12809 /* Any glyphs that come from the buffer are here because
12810 of bidi reordering. Skip them, and only pay
12811 attention to glyphs that came from some string. */
12812 if (STRINGP (glyph
->object
))
12817 str
= glyph
->object
;
12818 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12819 if (tem
== 0 /* from overlay */
12822 /* If the string from which this glyph came is
12823 found in the buffer at point, then we've
12824 found the glyph we've been looking for. If
12825 it comes from an overlay (tem == 0), and it
12826 has the `cursor' property on one of its
12827 glyphs, record that glyph as a candidate for
12828 displaying the cursor. (As in the
12829 unidirectional version, we will display the
12830 cursor on the last candidate we find.) */
12831 if (tem
== 0 || tem
== pt_old
)
12833 /* The glyphs from this string could have
12834 been reordered. Find the one with the
12835 smallest string position. Or there could
12836 be a character in the string with the
12837 `cursor' property, which means display
12838 cursor on that character's glyph. */
12839 int strpos
= glyph
->charpos
;
12842 for (glyph
+= incr
;
12843 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12844 && EQ (glyph
->object
, str
);
12848 int gpos
= glyph
->charpos
;
12850 cprop
= Fget_char_property (make_number (gpos
),
12858 if (glyph
->charpos
< strpos
)
12860 strpos
= glyph
->charpos
;
12869 pos
= tem
+ 1; /* don't find previous instances */
12871 /* This string is not what we want; skip all of the
12872 glyphs that came from it. */
12875 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12876 && EQ (glyph
->object
, str
));
12882 /* If we reached the end of the line, and END was from a string,
12883 the cursor is not on this line. */
12885 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12886 && STRINGP (end
->object
)
12887 && row
->continued_p
)
12893 if (cursor
!= NULL
)
12899 /* Need to compute x that corresponds to GLYPH. */
12900 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12902 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12904 x
+= g
->pixel_width
;
12908 /* ROW could be part of a continued line, which, under bidi
12909 reordering, might have other rows whose start and end charpos
12910 occlude point. Only set w->cursor if we found a better
12911 approximation to the cursor position than we have from previously
12912 examined candidate rows belonging to the same continued line. */
12913 if (/* we already have a candidate row */
12914 w
->cursor
.vpos
>= 0
12915 /* that candidate is not the row we are processing */
12916 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12917 /* the row we are processing is part of a continued line */
12918 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12919 /* Make sure cursor.vpos specifies a row whose start and end
12920 charpos occlude point. This is because some callers of this
12921 function leave cursor.vpos at the row where the cursor was
12922 displayed during the last redisplay cycle. */
12923 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12924 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12927 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12929 /* Don't consider glyphs that are outside TEXT_AREA. */
12930 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12932 /* Keep the candidate whose buffer position is the closest to
12934 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12935 w
->cursor
.hpos
>= 0
12936 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12937 && BUFFERP (g1
->object
)
12938 && (g1
->charpos
== pt_old
/* an exact match always wins */
12939 || (BUFFERP (glyph
->object
)
12940 && eabs (g1
->charpos
- pt_old
)
12941 < eabs (glyph
->charpos
- pt_old
))))
12943 /* If this candidate gives an exact match, use that. */
12944 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12945 /* Otherwise, keep the candidate that comes from a row
12946 spanning less buffer positions. This may win when one or
12947 both candidate positions are on glyphs that came from
12948 display strings, for which we cannot compare buffer
12950 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12951 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12952 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12955 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12957 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12958 w
->cursor
.y
= row
->y
+ dy
;
12960 if (w
== XWINDOW (selected_window
))
12962 if (!row
->continued_p
12963 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12966 this_line_buffer
= XBUFFER (w
->buffer
);
12968 CHARPOS (this_line_start_pos
)
12969 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12970 BYTEPOS (this_line_start_pos
)
12971 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12973 CHARPOS (this_line_end_pos
)
12974 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12975 BYTEPOS (this_line_end_pos
)
12976 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12978 this_line_y
= w
->cursor
.y
;
12979 this_line_pixel_height
= row
->height
;
12980 this_line_vpos
= w
->cursor
.vpos
;
12981 this_line_start_x
= row
->x
;
12984 CHARPOS (this_line_start_pos
) = 0;
12991 /* Run window scroll functions, if any, for WINDOW with new window
12992 start STARTP. Sets the window start of WINDOW to that position.
12994 We assume that the window's buffer is really current. */
12996 static INLINE
struct text_pos
12997 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12999 struct window
*w
= XWINDOW (window
);
13000 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13002 if (current_buffer
!= XBUFFER (w
->buffer
))
13005 if (!NILP (Vwindow_scroll_functions
))
13007 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13008 make_number (CHARPOS (startp
)));
13009 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13010 /* In case the hook functions switch buffers. */
13011 if (current_buffer
!= XBUFFER (w
->buffer
))
13012 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13019 /* Make sure the line containing the cursor is fully visible.
13020 A value of 1 means there is nothing to be done.
13021 (Either the line is fully visible, or it cannot be made so,
13022 or we cannot tell.)
13024 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13025 is higher than window.
13027 A value of 0 means the caller should do scrolling
13028 as if point had gone off the screen. */
13031 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13033 struct glyph_matrix
*matrix
;
13034 struct glyph_row
*row
;
13037 if (!make_cursor_line_fully_visible_p
)
13040 /* It's not always possible to find the cursor, e.g, when a window
13041 is full of overlay strings. Don't do anything in that case. */
13042 if (w
->cursor
.vpos
< 0)
13045 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13046 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13048 /* If the cursor row is not partially visible, there's nothing to do. */
13049 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13052 /* If the row the cursor is in is taller than the window's height,
13053 it's not clear what to do, so do nothing. */
13054 window_height
= window_box_height (w
);
13055 if (row
->height
>= window_height
)
13057 if (!force_p
|| MINI_WINDOW_P (w
)
13058 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13065 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13066 non-zero means only WINDOW is redisplayed in redisplay_internal.
13067 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13068 in redisplay_window to bring a partially visible line into view in
13069 the case that only the cursor has moved.
13071 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13072 last screen line's vertical height extends past the end of the screen.
13076 1 if scrolling succeeded
13078 0 if scrolling didn't find point.
13080 -1 if new fonts have been loaded so that we must interrupt
13081 redisplay, adjust glyph matrices, and try again. */
13087 SCROLLING_NEED_LARGER_MATRICES
13091 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13092 scroll_step
, temp_scroll_step
, last_line_misfit
)
13093 Lisp_Object window
;
13094 int just_this_one_p
;
13095 EMACS_INT scroll_conservatively
, scroll_step
;
13096 int temp_scroll_step
;
13097 int last_line_misfit
;
13099 struct window
*w
= XWINDOW (window
);
13100 struct frame
*f
= XFRAME (w
->frame
);
13101 struct text_pos pos
, startp
;
13103 int this_scroll_margin
, scroll_max
, rc
, height
;
13104 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13105 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13106 Lisp_Object aggressive
;
13107 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13110 debug_method_add (w
, "try_scrolling");
13113 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13115 /* Compute scroll margin height in pixels. We scroll when point is
13116 within this distance from the top or bottom of the window. */
13117 if (scroll_margin
> 0)
13118 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13119 * FRAME_LINE_HEIGHT (f
);
13121 this_scroll_margin
= 0;
13123 /* Force scroll_conservatively to have a reasonable value, to avoid
13124 overflow while computing how much to scroll. Note that the user
13125 can supply scroll-conservatively equal to `most-positive-fixnum',
13126 which can be larger than INT_MAX. */
13127 if (scroll_conservatively
> scroll_limit
)
13129 scroll_conservatively
= scroll_limit
;
13130 scroll_max
= INT_MAX
;
13132 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13133 /* Compute how much we should try to scroll maximally to bring
13134 point into view. */
13135 scroll_max
= (max (scroll_step
,
13136 max (scroll_conservatively
, temp_scroll_step
))
13137 * FRAME_LINE_HEIGHT (f
));
13138 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13139 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13140 /* We're trying to scroll because of aggressive scrolling but no
13141 scroll_step is set. Choose an arbitrary one. */
13142 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13148 /* Decide whether to scroll down. */
13149 if (PT
> CHARPOS (startp
))
13151 int scroll_margin_y
;
13153 /* Compute the pixel ypos of the scroll margin, then move it to
13154 either that ypos or PT, whichever comes first. */
13155 start_display (&it
, w
, startp
);
13156 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13157 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13158 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13159 (MOVE_TO_POS
| MOVE_TO_Y
));
13161 if (PT
> CHARPOS (it
.current
.pos
))
13163 int y0
= line_bottom_y (&it
);
13164 /* Compute how many pixels below window bottom to stop searching
13165 for PT. This avoids costly search for PT that is far away if
13166 the user limited scrolling by a small number of lines, but
13167 always finds PT if scroll_conservatively is set to a large
13168 number, such as most-positive-fixnum. */
13169 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13171 slack
>= INT_MAX
- it
.last_visible_y
13173 : it
.last_visible_y
+ slack
;
13175 /* Compute the distance from the scroll margin to PT or to
13176 the scroll limit, whichever comes first. This should
13177 include the height of the cursor line, to make that line
13179 move_it_to (&it
, PT
, -1, y_to_move
,
13180 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13181 dy
= line_bottom_y (&it
) - y0
;
13183 if (dy
> scroll_max
)
13184 return SCROLLING_FAILED
;
13192 /* Point is in or below the bottom scroll margin, so move the
13193 window start down. If scrolling conservatively, move it just
13194 enough down to make point visible. If scroll_step is set,
13195 move it down by scroll_step. */
13196 if (scroll_conservatively
)
13198 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13199 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13200 else if (scroll_step
|| temp_scroll_step
)
13201 amount_to_scroll
= scroll_max
;
13204 aggressive
= current_buffer
->scroll_up_aggressively
;
13205 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13206 if (NUMBERP (aggressive
))
13208 double float_amount
= XFLOATINT (aggressive
) * height
;
13209 amount_to_scroll
= float_amount
;
13210 if (amount_to_scroll
== 0 && float_amount
> 0)
13211 amount_to_scroll
= 1;
13215 if (amount_to_scroll
<= 0)
13216 return SCROLLING_FAILED
;
13218 start_display (&it
, w
, startp
);
13219 if (scroll_max
< INT_MAX
)
13220 move_it_vertically (&it
, amount_to_scroll
);
13223 /* Extra precision for users who set scroll-conservatively
13224 to most-positive-fixnum: make sure the amount we scroll
13225 the window start is never less than amount_to_scroll,
13226 which was computed as distance from window bottom to
13227 point. This matters when lines at window top and lines
13228 below window bottom have different height. */
13229 struct it it1
= it
;
13230 /* We use a temporary it1 because line_bottom_y can modify
13231 its argument, if it moves one line down; see there. */
13232 int start_y
= line_bottom_y (&it1
);
13235 move_it_by_lines (&it
, 1, 1);
13237 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13240 /* If STARTP is unchanged, move it down another screen line. */
13241 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13242 move_it_by_lines (&it
, 1, 1);
13243 startp
= it
.current
.pos
;
13247 struct text_pos scroll_margin_pos
= startp
;
13249 /* See if point is inside the scroll margin at the top of the
13251 if (this_scroll_margin
)
13253 start_display (&it
, w
, startp
);
13254 move_it_vertically (&it
, this_scroll_margin
);
13255 scroll_margin_pos
= it
.current
.pos
;
13258 if (PT
< CHARPOS (scroll_margin_pos
))
13260 /* Point is in the scroll margin at the top of the window or
13261 above what is displayed in the window. */
13264 /* Compute the vertical distance from PT to the scroll
13265 margin position. Give up if distance is greater than
13267 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13268 start_display (&it
, w
, pos
);
13270 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13271 it
.last_visible_y
, -1,
13272 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13273 dy
= it
.current_y
- y0
;
13274 if (dy
> scroll_max
)
13275 return SCROLLING_FAILED
;
13277 /* Compute new window start. */
13278 start_display (&it
, w
, startp
);
13280 if (scroll_conservatively
)
13282 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13283 else if (scroll_step
|| temp_scroll_step
)
13284 amount_to_scroll
= scroll_max
;
13287 aggressive
= current_buffer
->scroll_down_aggressively
;
13288 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13289 if (NUMBERP (aggressive
))
13291 double float_amount
= XFLOATINT (aggressive
) * height
;
13292 amount_to_scroll
= float_amount
;
13293 if (amount_to_scroll
== 0 && float_amount
> 0)
13294 amount_to_scroll
= 1;
13298 if (amount_to_scroll
<= 0)
13299 return SCROLLING_FAILED
;
13301 move_it_vertically_backward (&it
, amount_to_scroll
);
13302 startp
= it
.current
.pos
;
13306 /* Run window scroll functions. */
13307 startp
= run_window_scroll_functions (window
, startp
);
13309 /* Display the window. Give up if new fonts are loaded, or if point
13311 if (!try_window (window
, startp
, 0))
13312 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13313 else if (w
->cursor
.vpos
< 0)
13315 clear_glyph_matrix (w
->desired_matrix
);
13316 rc
= SCROLLING_FAILED
;
13320 /* Maybe forget recorded base line for line number display. */
13321 if (!just_this_one_p
13322 || current_buffer
->clip_changed
13323 || BEG_UNCHANGED
< CHARPOS (startp
))
13324 w
->base_line_number
= Qnil
;
13326 /* If cursor ends up on a partially visible line,
13327 treat that as being off the bottom of the screen. */
13328 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13330 clear_glyph_matrix (w
->desired_matrix
);
13331 ++extra_scroll_margin_lines
;
13334 rc
= SCROLLING_SUCCESS
;
13341 /* Compute a suitable window start for window W if display of W starts
13342 on a continuation line. Value is non-zero if a new window start
13345 The new window start will be computed, based on W's width, starting
13346 from the start of the continued line. It is the start of the
13347 screen line with the minimum distance from the old start W->start. */
13350 compute_window_start_on_continuation_line (struct window
*w
)
13352 struct text_pos pos
, start_pos
;
13353 int window_start_changed_p
= 0;
13355 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13357 /* If window start is on a continuation line... Window start may be
13358 < BEGV in case there's invisible text at the start of the
13359 buffer (M-x rmail, for example). */
13360 if (CHARPOS (start_pos
) > BEGV
13361 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13364 struct glyph_row
*row
;
13366 /* Handle the case that the window start is out of range. */
13367 if (CHARPOS (start_pos
) < BEGV
)
13368 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13369 else if (CHARPOS (start_pos
) > ZV
)
13370 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13372 /* Find the start of the continued line. This should be fast
13373 because scan_buffer is fast (newline cache). */
13374 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13375 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13376 row
, DEFAULT_FACE_ID
);
13377 reseat_at_previous_visible_line_start (&it
);
13379 /* If the line start is "too far" away from the window start,
13380 say it takes too much time to compute a new window start. */
13381 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13382 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13384 int min_distance
, distance
;
13386 /* Move forward by display lines to find the new window
13387 start. If window width was enlarged, the new start can
13388 be expected to be > the old start. If window width was
13389 decreased, the new window start will be < the old start.
13390 So, we're looking for the display line start with the
13391 minimum distance from the old window start. */
13392 pos
= it
.current
.pos
;
13393 min_distance
= INFINITY
;
13394 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13395 distance
< min_distance
)
13397 min_distance
= distance
;
13398 pos
= it
.current
.pos
;
13399 move_it_by_lines (&it
, 1, 0);
13402 /* Set the window start there. */
13403 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13404 window_start_changed_p
= 1;
13408 return window_start_changed_p
;
13412 /* Try cursor movement in case text has not changed in window WINDOW,
13413 with window start STARTP. Value is
13415 CURSOR_MOVEMENT_SUCCESS if successful
13417 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13419 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13420 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13421 we want to scroll as if scroll-step were set to 1. See the code.
13423 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13424 which case we have to abort this redisplay, and adjust matrices
13429 CURSOR_MOVEMENT_SUCCESS
,
13430 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13431 CURSOR_MOVEMENT_MUST_SCROLL
,
13432 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13436 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13438 struct window
*w
= XWINDOW (window
);
13439 struct frame
*f
= XFRAME (w
->frame
);
13440 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13443 if (inhibit_try_cursor_movement
)
13447 /* Handle case where text has not changed, only point, and it has
13448 not moved off the frame. */
13449 if (/* Point may be in this window. */
13450 PT
>= CHARPOS (startp
)
13451 /* Selective display hasn't changed. */
13452 && !current_buffer
->clip_changed
13453 /* Function force-mode-line-update is used to force a thorough
13454 redisplay. It sets either windows_or_buffers_changed or
13455 update_mode_lines. So don't take a shortcut here for these
13457 && !update_mode_lines
13458 && !windows_or_buffers_changed
13459 && !cursor_type_changed
13460 /* Can't use this case if highlighting a region. When a
13461 region exists, cursor movement has to do more than just
13463 && !(!NILP (Vtransient_mark_mode
)
13464 && !NILP (current_buffer
->mark_active
))
13465 && NILP (w
->region_showing
)
13466 && NILP (Vshow_trailing_whitespace
)
13467 /* Right after splitting windows, last_point may be nil. */
13468 && INTEGERP (w
->last_point
)
13469 /* This code is not used for mini-buffer for the sake of the case
13470 of redisplaying to replace an echo area message; since in
13471 that case the mini-buffer contents per se are usually
13472 unchanged. This code is of no real use in the mini-buffer
13473 since the handling of this_line_start_pos, etc., in redisplay
13474 handles the same cases. */
13475 && !EQ (window
, minibuf_window
)
13476 /* When splitting windows or for new windows, it happens that
13477 redisplay is called with a nil window_end_vpos or one being
13478 larger than the window. This should really be fixed in
13479 window.c. I don't have this on my list, now, so we do
13480 approximately the same as the old redisplay code. --gerd. */
13481 && INTEGERP (w
->window_end_vpos
)
13482 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13483 && (FRAME_WINDOW_P (f
)
13484 || !overlay_arrow_in_current_buffer_p ()))
13486 int this_scroll_margin
, top_scroll_margin
;
13487 struct glyph_row
*row
= NULL
;
13490 debug_method_add (w
, "cursor movement");
13493 /* Scroll if point within this distance from the top or bottom
13494 of the window. This is a pixel value. */
13495 if (scroll_margin
> 0)
13497 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13498 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13501 this_scroll_margin
= 0;
13503 top_scroll_margin
= this_scroll_margin
;
13504 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13505 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13507 /* Start with the row the cursor was displayed during the last
13508 not paused redisplay. Give up if that row is not valid. */
13509 if (w
->last_cursor
.vpos
< 0
13510 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13511 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13514 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13515 if (row
->mode_line_p
)
13517 if (!row
->enabled_p
)
13518 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13521 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13523 int scroll_p
= 0, must_scroll
= 0;
13524 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13526 if (PT
> XFASTINT (w
->last_point
))
13528 /* Point has moved forward. */
13529 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13530 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13532 xassert (row
->enabled_p
);
13536 /* If the end position of a row equals the start
13537 position of the next row, and PT is at that position,
13538 we would rather display cursor in the next line. */
13539 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13540 && MATRIX_ROW_END_CHARPOS (row
) == PT
13541 && row
< w
->current_matrix
->rows
13542 + w
->current_matrix
->nrows
- 1
13543 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13544 && !cursor_row_p (w
, row
))
13547 /* If within the scroll margin, scroll. Note that
13548 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13549 the next line would be drawn, and that
13550 this_scroll_margin can be zero. */
13551 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13552 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13553 /* Line is completely visible last line in window
13554 and PT is to be set in the next line. */
13555 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13556 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13557 && !row
->ends_at_zv_p
13558 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13561 else if (PT
< XFASTINT (w
->last_point
))
13563 /* Cursor has to be moved backward. Note that PT >=
13564 CHARPOS (startp) because of the outer if-statement. */
13565 while (!row
->mode_line_p
13566 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13567 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13568 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13569 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13570 row
> w
->current_matrix
->rows
13571 && (row
-1)->ends_in_newline_from_string_p
))))
13572 && (row
->y
> top_scroll_margin
13573 || CHARPOS (startp
) == BEGV
))
13575 xassert (row
->enabled_p
);
13579 /* Consider the following case: Window starts at BEGV,
13580 there is invisible, intangible text at BEGV, so that
13581 display starts at some point START > BEGV. It can
13582 happen that we are called with PT somewhere between
13583 BEGV and START. Try to handle that case. */
13584 if (row
< w
->current_matrix
->rows
13585 || row
->mode_line_p
)
13587 row
= w
->current_matrix
->rows
;
13588 if (row
->mode_line_p
)
13592 /* Due to newlines in overlay strings, we may have to
13593 skip forward over overlay strings. */
13594 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13595 && MATRIX_ROW_END_CHARPOS (row
) == PT
13596 && !cursor_row_p (w
, row
))
13599 /* If within the scroll margin, scroll. */
13600 if (row
->y
< top_scroll_margin
13601 && CHARPOS (startp
) != BEGV
)
13606 /* Cursor did not move. So don't scroll even if cursor line
13607 is partially visible, as it was so before. */
13608 rc
= CURSOR_MOVEMENT_SUCCESS
;
13611 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13612 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13614 /* if PT is not in the glyph row, give up. */
13615 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13618 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13619 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13621 /* If rows are bidi-reordered and point moved, back up
13622 until we find a row that does not belong to a
13623 continuation line. This is because we must consider
13624 all rows of a continued line as candidates for the
13625 new cursor positioning, since row start and end
13626 positions change non-linearly with vertical position
13628 /* FIXME: Revisit this when glyph ``spilling'' in
13629 continuation lines' rows is implemented for
13630 bidi-reordered rows. */
13631 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13633 xassert (row
->enabled_p
);
13635 /* If we hit the beginning of the displayed portion
13636 without finding the first row of a continued
13638 if (row
<= w
->current_matrix
->rows
)
13640 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13648 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13649 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13650 && make_cursor_line_fully_visible_p
)
13652 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13653 && !row
->ends_at_zv_p
13654 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13655 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13656 else if (row
->height
> window_box_height (w
))
13658 /* If we end up in a partially visible line, let's
13659 make it fully visible, except when it's taller
13660 than the window, in which case we can't do much
13663 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13667 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13668 if (!cursor_row_fully_visible_p (w
, 0, 1))
13669 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13671 rc
= CURSOR_MOVEMENT_SUCCESS
;
13675 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13676 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13677 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13679 /* With bidi-reordered rows, there could be more than
13680 one candidate row whose start and end positions
13681 occlude point. We need to let set_cursor_from_row
13682 find the best candidate. */
13683 /* FIXME: Revisit this when glyph ``spilling'' in
13684 continuation lines' rows is implemented for
13685 bidi-reordered rows. */
13690 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13691 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13692 && cursor_row_p (w
, row
))
13693 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13695 /* As soon as we've found the first suitable row
13696 whose ends_at_zv_p flag is set, we are done. */
13698 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13700 rc
= CURSOR_MOVEMENT_SUCCESS
;
13705 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13706 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13707 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13708 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13709 /* If we didn't find any candidate rows, or exited the
13710 loop before all the candidates were examined, signal
13711 to the caller that this method failed. */
13712 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13713 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13714 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13716 rc
= CURSOR_MOVEMENT_SUCCESS
;
13722 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13724 rc
= CURSOR_MOVEMENT_SUCCESS
;
13729 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13730 && MATRIX_ROW_START_CHARPOS (row
) == PT
13731 && cursor_row_p (w
, row
));
13740 set_vertical_scroll_bar (struct window
*w
)
13742 int start
, end
, whole
;
13744 /* Calculate the start and end positions for the current window.
13745 At some point, it would be nice to choose between scrollbars
13746 which reflect the whole buffer size, with special markers
13747 indicating narrowing, and scrollbars which reflect only the
13750 Note that mini-buffers sometimes aren't displaying any text. */
13751 if (!MINI_WINDOW_P (w
)
13752 || (w
== XWINDOW (minibuf_window
)
13753 && NILP (echo_area_buffer
[0])))
13755 struct buffer
*buf
= XBUFFER (w
->buffer
);
13756 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13757 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13758 /* I don't think this is guaranteed to be right. For the
13759 moment, we'll pretend it is. */
13760 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13764 if (whole
< (end
- start
))
13765 whole
= end
- start
;
13768 start
= end
= whole
= 0;
13770 /* Indicate what this scroll bar ought to be displaying now. */
13771 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13772 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13773 (w
, end
- start
, whole
, start
);
13777 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13778 selected_window is redisplayed.
13780 We can return without actually redisplaying the window if
13781 fonts_changed_p is nonzero. In that case, redisplay_internal will
13785 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13787 struct window
*w
= XWINDOW (window
);
13788 struct frame
*f
= XFRAME (w
->frame
);
13789 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13790 struct buffer
*old
= current_buffer
;
13791 struct text_pos lpoint
, opoint
, startp
;
13792 int update_mode_line
;
13795 /* Record it now because it's overwritten. */
13796 int current_matrix_up_to_date_p
= 0;
13797 int used_current_matrix_p
= 0;
13798 /* This is less strict than current_matrix_up_to_date_p.
13799 It indictes that the buffer contents and narrowing are unchanged. */
13800 int buffer_unchanged_p
= 0;
13801 int temp_scroll_step
= 0;
13802 int count
= SPECPDL_INDEX ();
13804 int centering_position
= -1;
13805 int last_line_misfit
= 0;
13806 int beg_unchanged
, end_unchanged
;
13808 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13811 /* W must be a leaf window here. */
13812 xassert (!NILP (w
->buffer
));
13814 *w
->desired_matrix
->method
= 0;
13818 reconsider_clip_changes (w
, buffer
);
13820 /* Has the mode line to be updated? */
13821 update_mode_line
= (!NILP (w
->update_mode_line
)
13822 || update_mode_lines
13823 || buffer
->clip_changed
13824 || buffer
->prevent_redisplay_optimizations_p
);
13826 if (MINI_WINDOW_P (w
))
13828 if (w
== XWINDOW (echo_area_window
)
13829 && !NILP (echo_area_buffer
[0]))
13831 if (update_mode_line
)
13832 /* We may have to update a tty frame's menu bar or a
13833 tool-bar. Example `M-x C-h C-h C-g'. */
13834 goto finish_menu_bars
;
13836 /* We've already displayed the echo area glyphs in this window. */
13837 goto finish_scroll_bars
;
13839 else if ((w
!= XWINDOW (minibuf_window
)
13840 || minibuf_level
== 0)
13841 /* When buffer is nonempty, redisplay window normally. */
13842 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13843 /* Quail displays non-mini buffers in minibuffer window.
13844 In that case, redisplay the window normally. */
13845 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13847 /* W is a mini-buffer window, but it's not active, so clear
13849 int yb
= window_text_bottom_y (w
);
13850 struct glyph_row
*row
;
13853 for (y
= 0, row
= w
->desired_matrix
->rows
;
13855 y
+= row
->height
, ++row
)
13856 blank_row (w
, row
, y
);
13857 goto finish_scroll_bars
;
13860 clear_glyph_matrix (w
->desired_matrix
);
13863 /* Otherwise set up data on this window; select its buffer and point
13865 /* Really select the buffer, for the sake of buffer-local
13867 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13869 current_matrix_up_to_date_p
13870 = (!NILP (w
->window_end_valid
)
13871 && !current_buffer
->clip_changed
13872 && !current_buffer
->prevent_redisplay_optimizations_p
13873 && XFASTINT (w
->last_modified
) >= MODIFF
13874 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13876 /* Run the window-bottom-change-functions
13877 if it is possible that the text on the screen has changed
13878 (either due to modification of the text, or any other reason). */
13879 if (!current_matrix_up_to_date_p
13880 && !NILP (Vwindow_text_change_functions
))
13882 safe_run_hooks (Qwindow_text_change_functions
);
13886 beg_unchanged
= BEG_UNCHANGED
;
13887 end_unchanged
= END_UNCHANGED
;
13889 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13891 specbind (Qinhibit_point_motion_hooks
, Qt
);
13894 = (!NILP (w
->window_end_valid
)
13895 && !current_buffer
->clip_changed
13896 && XFASTINT (w
->last_modified
) >= MODIFF
13897 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13899 /* When windows_or_buffers_changed is non-zero, we can't rely on
13900 the window end being valid, so set it to nil there. */
13901 if (windows_or_buffers_changed
)
13903 /* If window starts on a continuation line, maybe adjust the
13904 window start in case the window's width changed. */
13905 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13906 compute_window_start_on_continuation_line (w
);
13908 w
->window_end_valid
= Qnil
;
13911 /* Some sanity checks. */
13912 CHECK_WINDOW_END (w
);
13913 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13915 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13918 /* If %c is in mode line, update it if needed. */
13919 if (!NILP (w
->column_number_displayed
)
13920 /* This alternative quickly identifies a common case
13921 where no change is needed. */
13922 && !(PT
== XFASTINT (w
->last_point
)
13923 && XFASTINT (w
->last_modified
) >= MODIFF
13924 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13925 && (XFASTINT (w
->column_number_displayed
)
13926 != (int) current_column ())) /* iftc */
13927 update_mode_line
= 1;
13929 /* Count number of windows showing the selected buffer. An indirect
13930 buffer counts as its base buffer. */
13931 if (!just_this_one_p
)
13933 struct buffer
*current_base
, *window_base
;
13934 current_base
= current_buffer
;
13935 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13936 if (current_base
->base_buffer
)
13937 current_base
= current_base
->base_buffer
;
13938 if (window_base
->base_buffer
)
13939 window_base
= window_base
->base_buffer
;
13940 if (current_base
== window_base
)
13944 /* Point refers normally to the selected window. For any other
13945 window, set up appropriate value. */
13946 if (!EQ (window
, selected_window
))
13948 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13949 int new_pt_byte
= marker_byte_position (w
->pointm
);
13953 new_pt_byte
= BEGV_BYTE
;
13954 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13956 else if (new_pt
> (ZV
- 1))
13959 new_pt_byte
= ZV_BYTE
;
13960 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13963 /* We don't use SET_PT so that the point-motion hooks don't run. */
13964 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13967 /* If any of the character widths specified in the display table
13968 have changed, invalidate the width run cache. It's true that
13969 this may be a bit late to catch such changes, but the rest of
13970 redisplay goes (non-fatally) haywire when the display table is
13971 changed, so why should we worry about doing any better? */
13972 if (current_buffer
->width_run_cache
)
13974 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13976 if (! disptab_matches_widthtab (disptab
,
13977 XVECTOR (current_buffer
->width_table
)))
13979 invalidate_region_cache (current_buffer
,
13980 current_buffer
->width_run_cache
,
13982 recompute_width_table (current_buffer
, disptab
);
13986 /* If window-start is screwed up, choose a new one. */
13987 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13990 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13992 /* If someone specified a new starting point but did not insist,
13993 check whether it can be used. */
13994 if (!NILP (w
->optional_new_start
)
13995 && CHARPOS (startp
) >= BEGV
13996 && CHARPOS (startp
) <= ZV
)
13998 w
->optional_new_start
= Qnil
;
13999 start_display (&it
, w
, startp
);
14000 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14001 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14002 if (IT_CHARPOS (it
) == PT
)
14003 w
->force_start
= Qt
;
14004 /* IT may overshoot PT if text at PT is invisible. */
14005 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14006 w
->force_start
= Qt
;
14011 /* Handle case where place to start displaying has been specified,
14012 unless the specified location is outside the accessible range. */
14013 if (!NILP (w
->force_start
)
14014 || w
->frozen_window_start_p
)
14016 /* We set this later on if we have to adjust point. */
14019 w
->force_start
= Qnil
;
14021 w
->window_end_valid
= Qnil
;
14023 /* Forget any recorded base line for line number display. */
14024 if (!buffer_unchanged_p
)
14025 w
->base_line_number
= Qnil
;
14027 /* Redisplay the mode line. Select the buffer properly for that.
14028 Also, run the hook window-scroll-functions
14029 because we have scrolled. */
14030 /* Note, we do this after clearing force_start because
14031 if there's an error, it is better to forget about force_start
14032 than to get into an infinite loop calling the hook functions
14033 and having them get more errors. */
14034 if (!update_mode_line
14035 || ! NILP (Vwindow_scroll_functions
))
14037 update_mode_line
= 1;
14038 w
->update_mode_line
= Qt
;
14039 startp
= run_window_scroll_functions (window
, startp
);
14042 w
->last_modified
= make_number (0);
14043 w
->last_overlay_modified
= make_number (0);
14044 if (CHARPOS (startp
) < BEGV
)
14045 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14046 else if (CHARPOS (startp
) > ZV
)
14047 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14049 /* Redisplay, then check if cursor has been set during the
14050 redisplay. Give up if new fonts were loaded. */
14051 /* We used to issue a CHECK_MARGINS argument to try_window here,
14052 but this causes scrolling to fail when point begins inside
14053 the scroll margin (bug#148) -- cyd */
14054 if (!try_window (window
, startp
, 0))
14056 w
->force_start
= Qt
;
14057 clear_glyph_matrix (w
->desired_matrix
);
14058 goto need_larger_matrices
;
14061 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14063 /* If point does not appear, try to move point so it does
14064 appear. The desired matrix has been built above, so we
14065 can use it here. */
14066 new_vpos
= window_box_height (w
) / 2;
14069 if (!cursor_row_fully_visible_p (w
, 0, 0))
14071 /* Point does appear, but on a line partly visible at end of window.
14072 Move it back to a fully-visible line. */
14073 new_vpos
= window_box_height (w
);
14076 /* If we need to move point for either of the above reasons,
14077 now actually do it. */
14080 struct glyph_row
*row
;
14082 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14083 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14086 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14087 MATRIX_ROW_START_BYTEPOS (row
));
14089 if (w
!= XWINDOW (selected_window
))
14090 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14091 else if (current_buffer
== old
)
14092 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14094 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14096 /* If we are highlighting the region, then we just changed
14097 the region, so redisplay to show it. */
14098 if (!NILP (Vtransient_mark_mode
)
14099 && !NILP (current_buffer
->mark_active
))
14101 clear_glyph_matrix (w
->desired_matrix
);
14102 if (!try_window (window
, startp
, 0))
14103 goto need_larger_matrices
;
14108 debug_method_add (w
, "forced window start");
14113 /* Handle case where text has not changed, only point, and it has
14114 not moved off the frame, and we are not retrying after hscroll.
14115 (current_matrix_up_to_date_p is nonzero when retrying.) */
14116 if (current_matrix_up_to_date_p
14117 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14118 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14122 case CURSOR_MOVEMENT_SUCCESS
:
14123 used_current_matrix_p
= 1;
14126 case CURSOR_MOVEMENT_MUST_SCROLL
:
14127 goto try_to_scroll
;
14133 /* If current starting point was originally the beginning of a line
14134 but no longer is, find a new starting point. */
14135 else if (!NILP (w
->start_at_line_beg
)
14136 && !(CHARPOS (startp
) <= BEGV
14137 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14140 debug_method_add (w
, "recenter 1");
14145 /* Try scrolling with try_window_id. Value is > 0 if update has
14146 been done, it is -1 if we know that the same window start will
14147 not work. It is 0 if unsuccessful for some other reason. */
14148 else if ((tem
= try_window_id (w
)) != 0)
14151 debug_method_add (w
, "try_window_id %d", tem
);
14154 if (fonts_changed_p
)
14155 goto need_larger_matrices
;
14159 /* Otherwise try_window_id has returned -1 which means that we
14160 don't want the alternative below this comment to execute. */
14162 else if (CHARPOS (startp
) >= BEGV
14163 && CHARPOS (startp
) <= ZV
14164 && PT
>= CHARPOS (startp
)
14165 && (CHARPOS (startp
) < ZV
14166 /* Avoid starting at end of buffer. */
14167 || CHARPOS (startp
) == BEGV
14168 || (XFASTINT (w
->last_modified
) >= MODIFF
14169 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14172 /* If first window line is a continuation line, and window start
14173 is inside the modified region, but the first change is before
14174 current window start, we must select a new window start.
14176 However, if this is the result of a down-mouse event (e.g. by
14177 extending the mouse-drag-overlay), we don't want to select a
14178 new window start, since that would change the position under
14179 the mouse, resulting in an unwanted mouse-movement rather
14180 than a simple mouse-click. */
14181 if (NILP (w
->start_at_line_beg
)
14182 && NILP (do_mouse_tracking
)
14183 && CHARPOS (startp
) > BEGV
14184 && CHARPOS (startp
) > BEG
+ beg_unchanged
14185 && CHARPOS (startp
) <= Z
- end_unchanged
14186 /* Even if w->start_at_line_beg is nil, a new window may
14187 start at a line_beg, since that's how set_buffer_window
14188 sets it. So, we need to check the return value of
14189 compute_window_start_on_continuation_line. (See also
14191 && XMARKER (w
->start
)->buffer
== current_buffer
14192 && compute_window_start_on_continuation_line (w
))
14194 w
->force_start
= Qt
;
14195 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14200 debug_method_add (w
, "same window start");
14203 /* Try to redisplay starting at same place as before.
14204 If point has not moved off frame, accept the results. */
14205 if (!current_matrix_up_to_date_p
14206 /* Don't use try_window_reusing_current_matrix in this case
14207 because a window scroll function can have changed the
14209 || !NILP (Vwindow_scroll_functions
)
14210 || MINI_WINDOW_P (w
)
14211 || !(used_current_matrix_p
14212 = try_window_reusing_current_matrix (w
)))
14214 IF_DEBUG (debug_method_add (w
, "1"));
14215 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14216 /* -1 means we need to scroll.
14217 0 means we need new matrices, but fonts_changed_p
14218 is set in that case, so we will detect it below. */
14219 goto try_to_scroll
;
14222 if (fonts_changed_p
)
14223 goto need_larger_matrices
;
14225 if (w
->cursor
.vpos
>= 0)
14227 if (!just_this_one_p
14228 || current_buffer
->clip_changed
14229 || BEG_UNCHANGED
< CHARPOS (startp
))
14230 /* Forget any recorded base line for line number display. */
14231 w
->base_line_number
= Qnil
;
14233 if (!cursor_row_fully_visible_p (w
, 1, 0))
14235 clear_glyph_matrix (w
->desired_matrix
);
14236 last_line_misfit
= 1;
14238 /* Drop through and scroll. */
14243 clear_glyph_matrix (w
->desired_matrix
);
14248 w
->last_modified
= make_number (0);
14249 w
->last_overlay_modified
= make_number (0);
14251 /* Redisplay the mode line. Select the buffer properly for that. */
14252 if (!update_mode_line
)
14254 update_mode_line
= 1;
14255 w
->update_mode_line
= Qt
;
14258 /* Try to scroll by specified few lines. */
14259 if ((scroll_conservatively
14261 || temp_scroll_step
14262 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14263 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14264 && !current_buffer
->clip_changed
14265 && CHARPOS (startp
) >= BEGV
14266 && CHARPOS (startp
) <= ZV
)
14268 /* The function returns -1 if new fonts were loaded, 1 if
14269 successful, 0 if not successful. */
14270 int rc
= try_scrolling (window
, just_this_one_p
,
14271 scroll_conservatively
,
14273 temp_scroll_step
, last_line_misfit
);
14276 case SCROLLING_SUCCESS
:
14279 case SCROLLING_NEED_LARGER_MATRICES
:
14280 goto need_larger_matrices
;
14282 case SCROLLING_FAILED
:
14290 /* Finally, just choose place to start which centers point */
14293 if (centering_position
< 0)
14294 centering_position
= window_box_height (w
) / 2;
14297 debug_method_add (w
, "recenter");
14300 /* w->vscroll = 0; */
14302 /* Forget any previously recorded base line for line number display. */
14303 if (!buffer_unchanged_p
)
14304 w
->base_line_number
= Qnil
;
14306 /* Move backward half the height of the window. */
14307 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14308 it
.current_y
= it
.last_visible_y
;
14309 move_it_vertically_backward (&it
, centering_position
);
14310 xassert (IT_CHARPOS (it
) >= BEGV
);
14312 /* The function move_it_vertically_backward may move over more
14313 than the specified y-distance. If it->w is small, e.g. a
14314 mini-buffer window, we may end up in front of the window's
14315 display area. Start displaying at the start of the line
14316 containing PT in this case. */
14317 if (it
.current_y
<= 0)
14319 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14320 move_it_vertically_backward (&it
, 0);
14324 it
.current_x
= it
.hpos
= 0;
14326 /* Set startp here explicitly in case that helps avoid an infinite loop
14327 in case the window-scroll-functions functions get errors. */
14328 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14330 /* Run scroll hooks. */
14331 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14333 /* Redisplay the window. */
14334 if (!current_matrix_up_to_date_p
14335 || windows_or_buffers_changed
14336 || cursor_type_changed
14337 /* Don't use try_window_reusing_current_matrix in this case
14338 because it can have changed the buffer. */
14339 || !NILP (Vwindow_scroll_functions
)
14340 || !just_this_one_p
14341 || MINI_WINDOW_P (w
)
14342 || !(used_current_matrix_p
14343 = try_window_reusing_current_matrix (w
)))
14344 try_window (window
, startp
, 0);
14346 /* If new fonts have been loaded (due to fontsets), give up. We
14347 have to start a new redisplay since we need to re-adjust glyph
14349 if (fonts_changed_p
)
14350 goto need_larger_matrices
;
14352 /* If cursor did not appear assume that the middle of the window is
14353 in the first line of the window. Do it again with the next line.
14354 (Imagine a window of height 100, displaying two lines of height
14355 60. Moving back 50 from it->last_visible_y will end in the first
14357 if (w
->cursor
.vpos
< 0)
14359 if (!NILP (w
->window_end_valid
)
14360 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14362 clear_glyph_matrix (w
->desired_matrix
);
14363 move_it_by_lines (&it
, 1, 0);
14364 try_window (window
, it
.current
.pos
, 0);
14366 else if (PT
< IT_CHARPOS (it
))
14368 clear_glyph_matrix (w
->desired_matrix
);
14369 move_it_by_lines (&it
, -1, 0);
14370 try_window (window
, it
.current
.pos
, 0);
14374 /* Not much we can do about it. */
14378 /* Consider the following case: Window starts at BEGV, there is
14379 invisible, intangible text at BEGV, so that display starts at
14380 some point START > BEGV. It can happen that we are called with
14381 PT somewhere between BEGV and START. Try to handle that case. */
14382 if (w
->cursor
.vpos
< 0)
14384 struct glyph_row
*row
= w
->current_matrix
->rows
;
14385 if (row
->mode_line_p
)
14387 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14390 if (!cursor_row_fully_visible_p (w
, 0, 0))
14392 /* If vscroll is enabled, disable it and try again. */
14396 clear_glyph_matrix (w
->desired_matrix
);
14400 /* If centering point failed to make the whole line visible,
14401 put point at the top instead. That has to make the whole line
14402 visible, if it can be done. */
14403 if (centering_position
== 0)
14406 clear_glyph_matrix (w
->desired_matrix
);
14407 centering_position
= 0;
14413 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14414 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14415 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14418 /* Display the mode line, if we must. */
14419 if ((update_mode_line
14420 /* If window not full width, must redo its mode line
14421 if (a) the window to its side is being redone and
14422 (b) we do a frame-based redisplay. This is a consequence
14423 of how inverted lines are drawn in frame-based redisplay. */
14424 || (!just_this_one_p
14425 && !FRAME_WINDOW_P (f
)
14426 && !WINDOW_FULL_WIDTH_P (w
))
14427 /* Line number to display. */
14428 || INTEGERP (w
->base_line_pos
)
14429 /* Column number is displayed and different from the one displayed. */
14430 || (!NILP (w
->column_number_displayed
)
14431 && (XFASTINT (w
->column_number_displayed
)
14432 != (int) current_column ()))) /* iftc */
14433 /* This means that the window has a mode line. */
14434 && (WINDOW_WANTS_MODELINE_P (w
)
14435 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14437 display_mode_lines (w
);
14439 /* If mode line height has changed, arrange for a thorough
14440 immediate redisplay using the correct mode line height. */
14441 if (WINDOW_WANTS_MODELINE_P (w
)
14442 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14444 fonts_changed_p
= 1;
14445 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14446 = DESIRED_MODE_LINE_HEIGHT (w
);
14449 /* If header line height has changed, arrange for a thorough
14450 immediate redisplay using the correct header line height. */
14451 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14452 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14454 fonts_changed_p
= 1;
14455 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14456 = DESIRED_HEADER_LINE_HEIGHT (w
);
14459 if (fonts_changed_p
)
14460 goto need_larger_matrices
;
14463 if (!line_number_displayed
14464 && !BUFFERP (w
->base_line_pos
))
14466 w
->base_line_pos
= Qnil
;
14467 w
->base_line_number
= Qnil
;
14472 /* When we reach a frame's selected window, redo the frame's menu bar. */
14473 if (update_mode_line
14474 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14476 int redisplay_menu_p
= 0;
14477 int redisplay_tool_bar_p
= 0;
14479 if (FRAME_WINDOW_P (f
))
14481 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14482 || defined (HAVE_NS) || defined (USE_GTK)
14483 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14485 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14489 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14491 if (redisplay_menu_p
)
14492 display_menu_bar (w
);
14494 #ifdef HAVE_WINDOW_SYSTEM
14495 if (FRAME_WINDOW_P (f
))
14497 #if defined (USE_GTK) || defined (HAVE_NS)
14498 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14500 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14501 && (FRAME_TOOL_BAR_LINES (f
) > 0
14502 || !NILP (Vauto_resize_tool_bars
));
14505 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14507 extern int ignore_mouse_drag_p
;
14508 ignore_mouse_drag_p
= 1;
14514 #ifdef HAVE_WINDOW_SYSTEM
14515 if (FRAME_WINDOW_P (f
)
14516 && update_window_fringes (w
, (just_this_one_p
14517 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14518 || w
->pseudo_window_p
)))
14522 if (draw_window_fringes (w
, 1))
14523 x_draw_vertical_border (w
);
14527 #endif /* HAVE_WINDOW_SYSTEM */
14529 /* We go to this label, with fonts_changed_p nonzero,
14530 if it is necessary to try again using larger glyph matrices.
14531 We have to redeem the scroll bar even in this case,
14532 because the loop in redisplay_internal expects that. */
14533 need_larger_matrices
:
14535 finish_scroll_bars
:
14537 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14539 /* Set the thumb's position and size. */
14540 set_vertical_scroll_bar (w
);
14542 /* Note that we actually used the scroll bar attached to this
14543 window, so it shouldn't be deleted at the end of redisplay. */
14544 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14545 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14548 /* Restore current_buffer and value of point in it. The window
14549 update may have changed the buffer, so first make sure `opoint'
14550 is still valid (Bug#6177). */
14551 if (CHARPOS (opoint
) < BEGV
)
14552 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14553 else if (CHARPOS (opoint
) > ZV
)
14554 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14556 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14558 set_buffer_internal_1 (old
);
14559 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14560 shorter. This can be caused by log truncation in *Messages*. */
14561 if (CHARPOS (lpoint
) <= ZV
)
14562 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14564 unbind_to (count
, Qnil
);
14568 /* Build the complete desired matrix of WINDOW with a window start
14569 buffer position POS.
14571 Value is 1 if successful. It is zero if fonts were loaded during
14572 redisplay which makes re-adjusting glyph matrices necessary, and -1
14573 if point would appear in the scroll margins.
14574 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14575 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14579 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14581 struct window
*w
= XWINDOW (window
);
14583 struct glyph_row
*last_text_row
= NULL
;
14584 struct frame
*f
= XFRAME (w
->frame
);
14586 /* Make POS the new window start. */
14587 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14589 /* Mark cursor position as unknown. No overlay arrow seen. */
14590 w
->cursor
.vpos
= -1;
14591 overlay_arrow_seen
= 0;
14593 /* Initialize iterator and info to start at POS. */
14594 start_display (&it
, w
, pos
);
14596 /* Display all lines of W. */
14597 while (it
.current_y
< it
.last_visible_y
)
14599 if (display_line (&it
))
14600 last_text_row
= it
.glyph_row
- 1;
14601 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14605 /* Don't let the cursor end in the scroll margins. */
14606 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14607 && !MINI_WINDOW_P (w
))
14609 int this_scroll_margin
;
14611 if (scroll_margin
> 0)
14613 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14614 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14617 this_scroll_margin
= 0;
14619 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14620 && w
->cursor
.y
< this_scroll_margin
14621 && CHARPOS (pos
) > BEGV
14622 && IT_CHARPOS (it
) < ZV
)
14623 /* rms: considering make_cursor_line_fully_visible_p here
14624 seems to give wrong results. We don't want to recenter
14625 when the last line is partly visible, we want to allow
14626 that case to be handled in the usual way. */
14627 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14629 w
->cursor
.vpos
= -1;
14630 clear_glyph_matrix (w
->desired_matrix
);
14635 /* If bottom moved off end of frame, change mode line percentage. */
14636 if (XFASTINT (w
->window_end_pos
) <= 0
14637 && Z
!= IT_CHARPOS (it
))
14638 w
->update_mode_line
= Qt
;
14640 /* Set window_end_pos to the offset of the last character displayed
14641 on the window from the end of current_buffer. Set
14642 window_end_vpos to its row number. */
14645 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14646 w
->window_end_bytepos
14647 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14649 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14651 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14652 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14653 ->displays_text_p
);
14657 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14658 w
->window_end_pos
= make_number (Z
- ZV
);
14659 w
->window_end_vpos
= make_number (0);
14662 /* But that is not valid info until redisplay finishes. */
14663 w
->window_end_valid
= Qnil
;
14669 /************************************************************************
14670 Window redisplay reusing current matrix when buffer has not changed
14671 ************************************************************************/
14673 /* Try redisplay of window W showing an unchanged buffer with a
14674 different window start than the last time it was displayed by
14675 reusing its current matrix. Value is non-zero if successful.
14676 W->start is the new window start. */
14679 try_window_reusing_current_matrix (struct window
*w
)
14681 struct frame
*f
= XFRAME (w
->frame
);
14682 struct glyph_row
*row
, *bottom_row
;
14685 struct text_pos start
, new_start
;
14686 int nrows_scrolled
, i
;
14687 struct glyph_row
*last_text_row
;
14688 struct glyph_row
*last_reused_text_row
;
14689 struct glyph_row
*start_row
;
14690 int start_vpos
, min_y
, max_y
;
14693 if (inhibit_try_window_reusing
)
14697 if (/* This function doesn't handle terminal frames. */
14698 !FRAME_WINDOW_P (f
)
14699 /* Don't try to reuse the display if windows have been split
14701 || windows_or_buffers_changed
14702 || cursor_type_changed
)
14705 /* Can't do this if region may have changed. */
14706 if ((!NILP (Vtransient_mark_mode
)
14707 && !NILP (current_buffer
->mark_active
))
14708 || !NILP (w
->region_showing
)
14709 || !NILP (Vshow_trailing_whitespace
))
14712 /* If top-line visibility has changed, give up. */
14713 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14714 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14717 /* Give up if old or new display is scrolled vertically. We could
14718 make this function handle this, but right now it doesn't. */
14719 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14720 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14723 /* The variable new_start now holds the new window start. The old
14724 start `start' can be determined from the current matrix. */
14725 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14726 start
= start_row
->minpos
;
14727 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14729 /* Clear the desired matrix for the display below. */
14730 clear_glyph_matrix (w
->desired_matrix
);
14732 if (CHARPOS (new_start
) <= CHARPOS (start
))
14736 /* Don't use this method if the display starts with an ellipsis
14737 displayed for invisible text. It's not easy to handle that case
14738 below, and it's certainly not worth the effort since this is
14739 not a frequent case. */
14740 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14743 IF_DEBUG (debug_method_add (w
, "twu1"));
14745 /* Display up to a row that can be reused. The variable
14746 last_text_row is set to the last row displayed that displays
14747 text. Note that it.vpos == 0 if or if not there is a
14748 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14749 start_display (&it
, w
, new_start
);
14750 first_row_y
= it
.current_y
;
14751 w
->cursor
.vpos
= -1;
14752 last_text_row
= last_reused_text_row
= NULL
;
14754 while (it
.current_y
< it
.last_visible_y
14755 && !fonts_changed_p
)
14757 /* If we have reached into the characters in the START row,
14758 that means the line boundaries have changed. So we
14759 can't start copying with the row START. Maybe it will
14760 work to start copying with the following row. */
14761 while (IT_CHARPOS (it
) > CHARPOS (start
))
14763 /* Advance to the next row as the "start". */
14765 start
= start_row
->minpos
;
14766 /* If there are no more rows to try, or just one, give up. */
14767 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14768 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14769 || CHARPOS (start
) == ZV
)
14771 clear_glyph_matrix (w
->desired_matrix
);
14775 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14777 /* If we have reached alignment,
14778 we can copy the rest of the rows. */
14779 if (IT_CHARPOS (it
) == CHARPOS (start
))
14782 if (display_line (&it
))
14783 last_text_row
= it
.glyph_row
- 1;
14786 /* A value of current_y < last_visible_y means that we stopped
14787 at the previous window start, which in turn means that we
14788 have at least one reusable row. */
14789 if (it
.current_y
< it
.last_visible_y
)
14791 /* IT.vpos always starts from 0; it counts text lines. */
14792 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14794 /* Find PT if not already found in the lines displayed. */
14795 if (w
->cursor
.vpos
< 0)
14797 int dy
= it
.current_y
- start_row
->y
;
14799 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14800 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14802 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14803 dy
, nrows_scrolled
);
14806 clear_glyph_matrix (w
->desired_matrix
);
14811 /* Scroll the display. Do it before the current matrix is
14812 changed. The problem here is that update has not yet
14813 run, i.e. part of the current matrix is not up to date.
14814 scroll_run_hook will clear the cursor, and use the
14815 current matrix to get the height of the row the cursor is
14817 run
.current_y
= start_row
->y
;
14818 run
.desired_y
= it
.current_y
;
14819 run
.height
= it
.last_visible_y
- it
.current_y
;
14821 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14824 FRAME_RIF (f
)->update_window_begin_hook (w
);
14825 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14826 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14827 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14831 /* Shift current matrix down by nrows_scrolled lines. */
14832 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14833 rotate_matrix (w
->current_matrix
,
14835 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14838 /* Disable lines that must be updated. */
14839 for (i
= 0; i
< nrows_scrolled
; ++i
)
14840 (start_row
+ i
)->enabled_p
= 0;
14842 /* Re-compute Y positions. */
14843 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14844 max_y
= it
.last_visible_y
;
14845 for (row
= start_row
+ nrows_scrolled
;
14849 row
->y
= it
.current_y
;
14850 row
->visible_height
= row
->height
;
14852 if (row
->y
< min_y
)
14853 row
->visible_height
-= min_y
- row
->y
;
14854 if (row
->y
+ row
->height
> max_y
)
14855 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14856 row
->redraw_fringe_bitmaps_p
= 1;
14858 it
.current_y
+= row
->height
;
14860 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14861 last_reused_text_row
= row
;
14862 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14866 /* Disable lines in the current matrix which are now
14867 below the window. */
14868 for (++row
; row
< bottom_row
; ++row
)
14869 row
->enabled_p
= row
->mode_line_p
= 0;
14872 /* Update window_end_pos etc.; last_reused_text_row is the last
14873 reused row from the current matrix containing text, if any.
14874 The value of last_text_row is the last displayed line
14875 containing text. */
14876 if (last_reused_text_row
)
14878 w
->window_end_bytepos
14879 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14881 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14883 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14884 w
->current_matrix
));
14886 else if (last_text_row
)
14888 w
->window_end_bytepos
14889 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14891 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14893 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14897 /* This window must be completely empty. */
14898 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14899 w
->window_end_pos
= make_number (Z
- ZV
);
14900 w
->window_end_vpos
= make_number (0);
14902 w
->window_end_valid
= Qnil
;
14904 /* Update hint: don't try scrolling again in update_window. */
14905 w
->desired_matrix
->no_scrolling_p
= 1;
14908 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14912 else if (CHARPOS (new_start
) > CHARPOS (start
))
14914 struct glyph_row
*pt_row
, *row
;
14915 struct glyph_row
*first_reusable_row
;
14916 struct glyph_row
*first_row_to_display
;
14918 int yb
= window_text_bottom_y (w
);
14920 /* Find the row starting at new_start, if there is one. Don't
14921 reuse a partially visible line at the end. */
14922 first_reusable_row
= start_row
;
14923 while (first_reusable_row
->enabled_p
14924 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14925 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14926 < CHARPOS (new_start
)))
14927 ++first_reusable_row
;
14929 /* Give up if there is no row to reuse. */
14930 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14931 || !first_reusable_row
->enabled_p
14932 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14933 != CHARPOS (new_start
)))
14936 /* We can reuse fully visible rows beginning with
14937 first_reusable_row to the end of the window. Set
14938 first_row_to_display to the first row that cannot be reused.
14939 Set pt_row to the row containing point, if there is any. */
14941 for (first_row_to_display
= first_reusable_row
;
14942 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14943 ++first_row_to_display
)
14945 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14946 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14947 pt_row
= first_row_to_display
;
14950 /* Start displaying at the start of first_row_to_display. */
14951 xassert (first_row_to_display
->y
< yb
);
14952 init_to_row_start (&it
, w
, first_row_to_display
);
14954 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14956 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14958 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14959 + WINDOW_HEADER_LINE_HEIGHT (w
));
14961 /* Display lines beginning with first_row_to_display in the
14962 desired matrix. Set last_text_row to the last row displayed
14963 that displays text. */
14964 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14965 if (pt_row
== NULL
)
14966 w
->cursor
.vpos
= -1;
14967 last_text_row
= NULL
;
14968 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14969 if (display_line (&it
))
14970 last_text_row
= it
.glyph_row
- 1;
14972 /* If point is in a reused row, adjust y and vpos of the cursor
14976 w
->cursor
.vpos
-= nrows_scrolled
;
14977 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14980 /* Give up if point isn't in a row displayed or reused. (This
14981 also handles the case where w->cursor.vpos < nrows_scrolled
14982 after the calls to display_line, which can happen with scroll
14983 margins. See bug#1295.) */
14984 if (w
->cursor
.vpos
< 0)
14986 clear_glyph_matrix (w
->desired_matrix
);
14990 /* Scroll the display. */
14991 run
.current_y
= first_reusable_row
->y
;
14992 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14993 run
.height
= it
.last_visible_y
- run
.current_y
;
14994 dy
= run
.current_y
- run
.desired_y
;
14999 FRAME_RIF (f
)->update_window_begin_hook (w
);
15000 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15001 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15002 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15006 /* Adjust Y positions of reused rows. */
15007 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15008 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15009 max_y
= it
.last_visible_y
;
15010 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15013 row
->visible_height
= row
->height
;
15014 if (row
->y
< min_y
)
15015 row
->visible_height
-= min_y
- row
->y
;
15016 if (row
->y
+ row
->height
> max_y
)
15017 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15018 row
->redraw_fringe_bitmaps_p
= 1;
15021 /* Scroll the current matrix. */
15022 xassert (nrows_scrolled
> 0);
15023 rotate_matrix (w
->current_matrix
,
15025 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15028 /* Disable rows not reused. */
15029 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15030 row
->enabled_p
= 0;
15032 /* Point may have moved to a different line, so we cannot assume that
15033 the previous cursor position is valid; locate the correct row. */
15036 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15037 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15041 w
->cursor
.y
= row
->y
;
15043 if (row
< bottom_row
)
15045 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15046 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15048 /* Can't use this optimization with bidi-reordered glyph
15049 rows, unless cursor is already at point. */
15050 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15052 if (!(w
->cursor
.hpos
>= 0
15053 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15054 && BUFFERP (glyph
->object
)
15055 && glyph
->charpos
== PT
))
15060 && (!BUFFERP (glyph
->object
)
15061 || glyph
->charpos
< PT
);
15065 w
->cursor
.x
+= glyph
->pixel_width
;
15070 /* Adjust window end. A null value of last_text_row means that
15071 the window end is in reused rows which in turn means that
15072 only its vpos can have changed. */
15075 w
->window_end_bytepos
15076 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15078 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15080 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15085 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15088 w
->window_end_valid
= Qnil
;
15089 w
->desired_matrix
->no_scrolling_p
= 1;
15092 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15102 /************************************************************************
15103 Window redisplay reusing current matrix when buffer has changed
15104 ************************************************************************/
15106 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15107 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15109 static struct glyph_row
*
15110 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15111 struct glyph_row
*);
15114 /* Return the last row in MATRIX displaying text. If row START is
15115 non-null, start searching with that row. IT gives the dimensions
15116 of the display. Value is null if matrix is empty; otherwise it is
15117 a pointer to the row found. */
15119 static struct glyph_row
*
15120 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15121 struct glyph_row
*start
)
15123 struct glyph_row
*row
, *row_found
;
15125 /* Set row_found to the last row in IT->w's current matrix
15126 displaying text. The loop looks funny but think of partially
15129 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15130 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15132 xassert (row
->enabled_p
);
15134 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15143 /* Return the last row in the current matrix of W that is not affected
15144 by changes at the start of current_buffer that occurred since W's
15145 current matrix was built. Value is null if no such row exists.
15147 BEG_UNCHANGED us the number of characters unchanged at the start of
15148 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15149 first changed character in current_buffer. Characters at positions <
15150 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15151 when the current matrix was built. */
15153 static struct glyph_row
*
15154 find_last_unchanged_at_beg_row (struct window
*w
)
15156 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15157 struct glyph_row
*row
;
15158 struct glyph_row
*row_found
= NULL
;
15159 int yb
= window_text_bottom_y (w
);
15161 /* Find the last row displaying unchanged text. */
15162 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15163 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15164 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15167 if (/* If row ends before first_changed_pos, it is unchanged,
15168 except in some case. */
15169 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15170 /* When row ends in ZV and we write at ZV it is not
15172 && !row
->ends_at_zv_p
15173 /* When first_changed_pos is the end of a continued line,
15174 row is not unchanged because it may be no longer
15176 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15177 && (row
->continued_p
15178 || row
->exact_window_width_line_p
)))
15181 /* Stop if last visible row. */
15182 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15190 /* Find the first glyph row in the current matrix of W that is not
15191 affected by changes at the end of current_buffer since the
15192 time W's current matrix was built.
15194 Return in *DELTA the number of chars by which buffer positions in
15195 unchanged text at the end of current_buffer must be adjusted.
15197 Return in *DELTA_BYTES the corresponding number of bytes.
15199 Value is null if no such row exists, i.e. all rows are affected by
15202 static struct glyph_row
*
15203 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15205 struct glyph_row
*row
;
15206 struct glyph_row
*row_found
= NULL
;
15208 *delta
= *delta_bytes
= 0;
15210 /* Display must not have been paused, otherwise the current matrix
15211 is not up to date. */
15212 eassert (!NILP (w
->window_end_valid
));
15214 /* A value of window_end_pos >= END_UNCHANGED means that the window
15215 end is in the range of changed text. If so, there is no
15216 unchanged row at the end of W's current matrix. */
15217 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15220 /* Set row to the last row in W's current matrix displaying text. */
15221 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15223 /* If matrix is entirely empty, no unchanged row exists. */
15224 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15226 /* The value of row is the last glyph row in the matrix having a
15227 meaningful buffer position in it. The end position of row
15228 corresponds to window_end_pos. This allows us to translate
15229 buffer positions in the current matrix to current buffer
15230 positions for characters not in changed text. */
15231 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15232 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15233 int last_unchanged_pos
, last_unchanged_pos_old
;
15234 struct glyph_row
*first_text_row
15235 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15237 *delta
= Z
- Z_old
;
15238 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15240 /* Set last_unchanged_pos to the buffer position of the last
15241 character in the buffer that has not been changed. Z is the
15242 index + 1 of the last character in current_buffer, i.e. by
15243 subtracting END_UNCHANGED we get the index of the last
15244 unchanged character, and we have to add BEG to get its buffer
15246 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15247 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15249 /* Search backward from ROW for a row displaying a line that
15250 starts at a minimum position >= last_unchanged_pos_old. */
15251 for (; row
> first_text_row
; --row
)
15253 /* This used to abort, but it can happen.
15254 It is ok to just stop the search instead here. KFS. */
15255 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15258 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15263 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15269 /* Make sure that glyph rows in the current matrix of window W
15270 reference the same glyph memory as corresponding rows in the
15271 frame's frame matrix. This function is called after scrolling W's
15272 current matrix on a terminal frame in try_window_id and
15273 try_window_reusing_current_matrix. */
15276 sync_frame_with_window_matrix_rows (struct window
*w
)
15278 struct frame
*f
= XFRAME (w
->frame
);
15279 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15281 /* Preconditions: W must be a leaf window and full-width. Its frame
15282 must have a frame matrix. */
15283 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15284 xassert (WINDOW_FULL_WIDTH_P (w
));
15285 xassert (!FRAME_WINDOW_P (f
));
15287 /* If W is a full-width window, glyph pointers in W's current matrix
15288 have, by definition, to be the same as glyph pointers in the
15289 corresponding frame matrix. Note that frame matrices have no
15290 marginal areas (see build_frame_matrix). */
15291 window_row
= w
->current_matrix
->rows
;
15292 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15293 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15294 while (window_row
< window_row_end
)
15296 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15297 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15299 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15300 frame_row
->glyphs
[TEXT_AREA
] = start
;
15301 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15302 frame_row
->glyphs
[LAST_AREA
] = end
;
15304 /* Disable frame rows whose corresponding window rows have
15305 been disabled in try_window_id. */
15306 if (!window_row
->enabled_p
)
15307 frame_row
->enabled_p
= 0;
15309 ++window_row
, ++frame_row
;
15314 /* Find the glyph row in window W containing CHARPOS. Consider all
15315 rows between START and END (not inclusive). END null means search
15316 all rows to the end of the display area of W. Value is the row
15317 containing CHARPOS or null. */
15320 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15321 struct glyph_row
*end
, int dy
)
15323 struct glyph_row
*row
= start
;
15324 struct glyph_row
*best_row
= NULL
;
15325 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15328 /* If we happen to start on a header-line, skip that. */
15329 if (row
->mode_line_p
)
15332 if ((end
&& row
>= end
) || !row
->enabled_p
)
15335 last_y
= window_text_bottom_y (w
) - dy
;
15339 /* Give up if we have gone too far. */
15340 if (end
&& row
>= end
)
15342 /* This formerly returned if they were equal.
15343 I think that both quantities are of a "last plus one" type;
15344 if so, when they are equal, the row is within the screen. -- rms. */
15345 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15348 /* If it is in this row, return this row. */
15349 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15350 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15351 /* The end position of a row equals the start
15352 position of the next row. If CHARPOS is there, we
15353 would rather display it in the next line, except
15354 when this line ends in ZV. */
15355 && !row
->ends_at_zv_p
15356 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15357 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15361 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15363 /* In bidi-reordered rows, there could be several rows
15364 occluding point. We need to find the one which fits
15365 CHARPOS the best. */
15366 for (g
= row
->glyphs
[TEXT_AREA
];
15367 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15370 if (!STRINGP (g
->object
))
15372 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15374 mindif
= eabs (g
->charpos
- charpos
);
15387 /* Try to redisplay window W by reusing its existing display. W's
15388 current matrix must be up to date when this function is called,
15389 i.e. window_end_valid must not be nil.
15393 1 if display has been updated
15394 0 if otherwise unsuccessful
15395 -1 if redisplay with same window start is known not to succeed
15397 The following steps are performed:
15399 1. Find the last row in the current matrix of W that is not
15400 affected by changes at the start of current_buffer. If no such row
15403 2. Find the first row in W's current matrix that is not affected by
15404 changes at the end of current_buffer. Maybe there is no such row.
15406 3. Display lines beginning with the row + 1 found in step 1 to the
15407 row found in step 2 or, if step 2 didn't find a row, to the end of
15410 4. If cursor is not known to appear on the window, give up.
15412 5. If display stopped at the row found in step 2, scroll the
15413 display and current matrix as needed.
15415 6. Maybe display some lines at the end of W, if we must. This can
15416 happen under various circumstances, like a partially visible line
15417 becoming fully visible, or because newly displayed lines are displayed
15418 in smaller font sizes.
15420 7. Update W's window end information. */
15423 try_window_id (struct window
*w
)
15425 struct frame
*f
= XFRAME (w
->frame
);
15426 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15427 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15428 struct glyph_row
*last_unchanged_at_beg_row
;
15429 struct glyph_row
*first_unchanged_at_end_row
;
15430 struct glyph_row
*row
;
15431 struct glyph_row
*bottom_row
;
15434 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15435 struct text_pos start_pos
;
15437 int first_unchanged_at_end_vpos
= 0;
15438 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15439 struct text_pos start
;
15440 int first_changed_charpos
, last_changed_charpos
;
15443 if (inhibit_try_window_id
)
15447 /* This is handy for debugging. */
15449 #define GIVE_UP(X) \
15451 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15455 #define GIVE_UP(X) return 0
15458 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15460 /* Don't use this for mini-windows because these can show
15461 messages and mini-buffers, and we don't handle that here. */
15462 if (MINI_WINDOW_P (w
))
15465 /* This flag is used to prevent redisplay optimizations. */
15466 if (windows_or_buffers_changed
|| cursor_type_changed
)
15469 /* Verify that narrowing has not changed.
15470 Also verify that we were not told to prevent redisplay optimizations.
15471 It would be nice to further
15472 reduce the number of cases where this prevents try_window_id. */
15473 if (current_buffer
->clip_changed
15474 || current_buffer
->prevent_redisplay_optimizations_p
)
15477 /* Window must either use window-based redisplay or be full width. */
15478 if (!FRAME_WINDOW_P (f
)
15479 && (!FRAME_LINE_INS_DEL_OK (f
)
15480 || !WINDOW_FULL_WIDTH_P (w
)))
15483 /* Give up if point is known NOT to appear in W. */
15484 if (PT
< CHARPOS (start
))
15487 /* Another way to prevent redisplay optimizations. */
15488 if (XFASTINT (w
->last_modified
) == 0)
15491 /* Verify that window is not hscrolled. */
15492 if (XFASTINT (w
->hscroll
) != 0)
15495 /* Verify that display wasn't paused. */
15496 if (NILP (w
->window_end_valid
))
15499 /* Can't use this if highlighting a region because a cursor movement
15500 will do more than just set the cursor. */
15501 if (!NILP (Vtransient_mark_mode
)
15502 && !NILP (current_buffer
->mark_active
))
15505 /* Likewise if highlighting trailing whitespace. */
15506 if (!NILP (Vshow_trailing_whitespace
))
15509 /* Likewise if showing a region. */
15510 if (!NILP (w
->region_showing
))
15513 /* Can't use this if overlay arrow position and/or string have
15515 if (overlay_arrows_changed_p ())
15518 /* When word-wrap is on, adding a space to the first word of a
15519 wrapped line can change the wrap position, altering the line
15520 above it. It might be worthwhile to handle this more
15521 intelligently, but for now just redisplay from scratch. */
15522 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15525 /* Under bidi reordering, adding or deleting a character in the
15526 beginning of a paragraph, before the first strong directional
15527 character, can change the base direction of the paragraph (unless
15528 the buffer specifies a fixed paragraph direction), which will
15529 require to redisplay the whole paragraph. It might be worthwhile
15530 to find the paragraph limits and widen the range of redisplayed
15531 lines to that, but for now just give up this optimization and
15532 redisplay from scratch. */
15533 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15534 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15537 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15538 only if buffer has really changed. The reason is that the gap is
15539 initially at Z for freshly visited files. The code below would
15540 set end_unchanged to 0 in that case. */
15541 if (MODIFF
> SAVE_MODIFF
15542 /* This seems to happen sometimes after saving a buffer. */
15543 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15545 if (GPT
- BEG
< BEG_UNCHANGED
)
15546 BEG_UNCHANGED
= GPT
- BEG
;
15547 if (Z
- GPT
< END_UNCHANGED
)
15548 END_UNCHANGED
= Z
- GPT
;
15551 /* The position of the first and last character that has been changed. */
15552 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15553 last_changed_charpos
= Z
- END_UNCHANGED
;
15555 /* If window starts after a line end, and the last change is in
15556 front of that newline, then changes don't affect the display.
15557 This case happens with stealth-fontification. Note that although
15558 the display is unchanged, glyph positions in the matrix have to
15559 be adjusted, of course. */
15560 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15561 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15562 && ((last_changed_charpos
< CHARPOS (start
)
15563 && CHARPOS (start
) == BEGV
)
15564 || (last_changed_charpos
< CHARPOS (start
) - 1
15565 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15567 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15568 struct glyph_row
*r0
;
15570 /* Compute how many chars/bytes have been added to or removed
15571 from the buffer. */
15572 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15573 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15575 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15577 /* Give up if PT is not in the window. Note that it already has
15578 been checked at the start of try_window_id that PT is not in
15579 front of the window start. */
15580 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15583 /* If window start is unchanged, we can reuse the whole matrix
15584 as is, after adjusting glyph positions. No need to compute
15585 the window end again, since its offset from Z hasn't changed. */
15586 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15587 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15588 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15589 /* PT must not be in a partially visible line. */
15590 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15591 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15593 /* Adjust positions in the glyph matrix. */
15594 if (delta
|| delta_bytes
)
15596 struct glyph_row
*r1
15597 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15598 increment_matrix_positions (w
->current_matrix
,
15599 MATRIX_ROW_VPOS (r0
, current_matrix
),
15600 MATRIX_ROW_VPOS (r1
, current_matrix
),
15601 delta
, delta_bytes
);
15604 /* Set the cursor. */
15605 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15607 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15614 /* Handle the case that changes are all below what is displayed in
15615 the window, and that PT is in the window. This shortcut cannot
15616 be taken if ZV is visible in the window, and text has been added
15617 there that is visible in the window. */
15618 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15619 /* ZV is not visible in the window, or there are no
15620 changes at ZV, actually. */
15621 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15622 || first_changed_charpos
== last_changed_charpos
))
15624 struct glyph_row
*r0
;
15626 /* Give up if PT is not in the window. Note that it already has
15627 been checked at the start of try_window_id that PT is not in
15628 front of the window start. */
15629 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15632 /* If window start is unchanged, we can reuse the whole matrix
15633 as is, without changing glyph positions since no text has
15634 been added/removed in front of the window end. */
15635 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15636 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15637 /* PT must not be in a partially visible line. */
15638 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15639 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15641 /* We have to compute the window end anew since text
15642 could have been added/removed after it. */
15644 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15645 w
->window_end_bytepos
15646 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15648 /* Set the cursor. */
15649 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15651 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15658 /* Give up if window start is in the changed area.
15660 The condition used to read
15662 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15664 but why that was tested escapes me at the moment. */
15665 if (CHARPOS (start
) >= first_changed_charpos
15666 && CHARPOS (start
) <= last_changed_charpos
)
15669 /* Check that window start agrees with the start of the first glyph
15670 row in its current matrix. Check this after we know the window
15671 start is not in changed text, otherwise positions would not be
15673 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15674 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15677 /* Give up if the window ends in strings. Overlay strings
15678 at the end are difficult to handle, so don't try. */
15679 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15680 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15683 /* Compute the position at which we have to start displaying new
15684 lines. Some of the lines at the top of the window might be
15685 reusable because they are not displaying changed text. Find the
15686 last row in W's current matrix not affected by changes at the
15687 start of current_buffer. Value is null if changes start in the
15688 first line of window. */
15689 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15690 if (last_unchanged_at_beg_row
)
15692 /* Avoid starting to display in the moddle of a character, a TAB
15693 for instance. This is easier than to set up the iterator
15694 exactly, and it's not a frequent case, so the additional
15695 effort wouldn't really pay off. */
15696 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15697 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15698 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15699 --last_unchanged_at_beg_row
;
15701 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15704 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15706 start_pos
= it
.current
.pos
;
15708 /* Start displaying new lines in the desired matrix at the same
15709 vpos we would use in the current matrix, i.e. below
15710 last_unchanged_at_beg_row. */
15711 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15713 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15714 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15716 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15720 /* There are no reusable lines at the start of the window.
15721 Start displaying in the first text line. */
15722 start_display (&it
, w
, start
);
15723 it
.vpos
= it
.first_vpos
;
15724 start_pos
= it
.current
.pos
;
15727 /* Find the first row that is not affected by changes at the end of
15728 the buffer. Value will be null if there is no unchanged row, in
15729 which case we must redisplay to the end of the window. delta
15730 will be set to the value by which buffer positions beginning with
15731 first_unchanged_at_end_row have to be adjusted due to text
15733 first_unchanged_at_end_row
15734 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15735 IF_DEBUG (debug_delta
= delta
);
15736 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15738 /* Set stop_pos to the buffer position up to which we will have to
15739 display new lines. If first_unchanged_at_end_row != NULL, this
15740 is the buffer position of the start of the line displayed in that
15741 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15742 that we don't stop at a buffer position. */
15744 if (first_unchanged_at_end_row
)
15746 xassert (last_unchanged_at_beg_row
== NULL
15747 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15749 /* If this is a continuation line, move forward to the next one
15750 that isn't. Changes in lines above affect this line.
15751 Caution: this may move first_unchanged_at_end_row to a row
15752 not displaying text. */
15753 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15754 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15755 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15756 < it
.last_visible_y
))
15757 ++first_unchanged_at_end_row
;
15759 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15760 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15761 >= it
.last_visible_y
))
15762 first_unchanged_at_end_row
= NULL
;
15765 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15767 first_unchanged_at_end_vpos
15768 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15769 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15772 else if (last_unchanged_at_beg_row
== NULL
)
15778 /* Either there is no unchanged row at the end, or the one we have
15779 now displays text. This is a necessary condition for the window
15780 end pos calculation at the end of this function. */
15781 xassert (first_unchanged_at_end_row
== NULL
15782 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15784 debug_last_unchanged_at_beg_vpos
15785 = (last_unchanged_at_beg_row
15786 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15788 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15790 #endif /* GLYPH_DEBUG != 0 */
15793 /* Display new lines. Set last_text_row to the last new line
15794 displayed which has text on it, i.e. might end up as being the
15795 line where the window_end_vpos is. */
15796 w
->cursor
.vpos
= -1;
15797 last_text_row
= NULL
;
15798 overlay_arrow_seen
= 0;
15799 while (it
.current_y
< it
.last_visible_y
15800 && !fonts_changed_p
15801 && (first_unchanged_at_end_row
== NULL
15802 || IT_CHARPOS (it
) < stop_pos
))
15804 if (display_line (&it
))
15805 last_text_row
= it
.glyph_row
- 1;
15808 if (fonts_changed_p
)
15812 /* Compute differences in buffer positions, y-positions etc. for
15813 lines reused at the bottom of the window. Compute what we can
15815 if (first_unchanged_at_end_row
15816 /* No lines reused because we displayed everything up to the
15817 bottom of the window. */
15818 && it
.current_y
< it
.last_visible_y
)
15821 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15823 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15824 run
.current_y
= first_unchanged_at_end_row
->y
;
15825 run
.desired_y
= run
.current_y
+ dy
;
15826 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15830 delta
= delta_bytes
= dvpos
= dy
15831 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15832 first_unchanged_at_end_row
= NULL
;
15834 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15837 /* Find the cursor if not already found. We have to decide whether
15838 PT will appear on this window (it sometimes doesn't, but this is
15839 not a very frequent case.) This decision has to be made before
15840 the current matrix is altered. A value of cursor.vpos < 0 means
15841 that PT is either in one of the lines beginning at
15842 first_unchanged_at_end_row or below the window. Don't care for
15843 lines that might be displayed later at the window end; as
15844 mentioned, this is not a frequent case. */
15845 if (w
->cursor
.vpos
< 0)
15847 /* Cursor in unchanged rows at the top? */
15848 if (PT
< CHARPOS (start_pos
)
15849 && last_unchanged_at_beg_row
)
15851 row
= row_containing_pos (w
, PT
,
15852 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15853 last_unchanged_at_beg_row
+ 1, 0);
15855 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15858 /* Start from first_unchanged_at_end_row looking for PT. */
15859 else if (first_unchanged_at_end_row
)
15861 row
= row_containing_pos (w
, PT
- delta
,
15862 first_unchanged_at_end_row
, NULL
, 0);
15864 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15865 delta_bytes
, dy
, dvpos
);
15868 /* Give up if cursor was not found. */
15869 if (w
->cursor
.vpos
< 0)
15871 clear_glyph_matrix (w
->desired_matrix
);
15876 /* Don't let the cursor end in the scroll margins. */
15878 int this_scroll_margin
, cursor_height
;
15880 this_scroll_margin
= max (0, scroll_margin
);
15881 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15882 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15883 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15885 if ((w
->cursor
.y
< this_scroll_margin
15886 && CHARPOS (start
) > BEGV
)
15887 /* Old redisplay didn't take scroll margin into account at the bottom,
15888 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15889 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15890 ? cursor_height
+ this_scroll_margin
15891 : 1)) > it
.last_visible_y
)
15893 w
->cursor
.vpos
= -1;
15894 clear_glyph_matrix (w
->desired_matrix
);
15899 /* Scroll the display. Do it before changing the current matrix so
15900 that xterm.c doesn't get confused about where the cursor glyph is
15902 if (dy
&& run
.height
)
15906 if (FRAME_WINDOW_P (f
))
15908 FRAME_RIF (f
)->update_window_begin_hook (w
);
15909 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15910 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15911 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15915 /* Terminal frame. In this case, dvpos gives the number of
15916 lines to scroll by; dvpos < 0 means scroll up. */
15917 int first_unchanged_at_end_vpos
15918 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15919 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15920 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15921 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15922 + window_internal_height (w
));
15924 /* Perform the operation on the screen. */
15927 /* Scroll last_unchanged_at_beg_row to the end of the
15928 window down dvpos lines. */
15929 set_terminal_window (f
, end
);
15931 /* On dumb terminals delete dvpos lines at the end
15932 before inserting dvpos empty lines. */
15933 if (!FRAME_SCROLL_REGION_OK (f
))
15934 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15936 /* Insert dvpos empty lines in front of
15937 last_unchanged_at_beg_row. */
15938 ins_del_lines (f
, from
, dvpos
);
15940 else if (dvpos
< 0)
15942 /* Scroll up last_unchanged_at_beg_vpos to the end of
15943 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15944 set_terminal_window (f
, end
);
15946 /* Delete dvpos lines in front of
15947 last_unchanged_at_beg_vpos. ins_del_lines will set
15948 the cursor to the given vpos and emit |dvpos| delete
15950 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15952 /* On a dumb terminal insert dvpos empty lines at the
15954 if (!FRAME_SCROLL_REGION_OK (f
))
15955 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15958 set_terminal_window (f
, 0);
15964 /* Shift reused rows of the current matrix to the right position.
15965 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15967 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15968 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15971 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15972 bottom_vpos
, dvpos
);
15973 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15976 else if (dvpos
> 0)
15978 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15979 bottom_vpos
, dvpos
);
15980 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15981 first_unchanged_at_end_vpos
+ dvpos
, 0);
15984 /* For frame-based redisplay, make sure that current frame and window
15985 matrix are in sync with respect to glyph memory. */
15986 if (!FRAME_WINDOW_P (f
))
15987 sync_frame_with_window_matrix_rows (w
);
15989 /* Adjust buffer positions in reused rows. */
15990 if (delta
|| delta_bytes
)
15991 increment_matrix_positions (current_matrix
,
15992 first_unchanged_at_end_vpos
+ dvpos
,
15993 bottom_vpos
, delta
, delta_bytes
);
15995 /* Adjust Y positions. */
15997 shift_glyph_matrix (w
, current_matrix
,
15998 first_unchanged_at_end_vpos
+ dvpos
,
16001 if (first_unchanged_at_end_row
)
16003 first_unchanged_at_end_row
+= dvpos
;
16004 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16005 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16006 first_unchanged_at_end_row
= NULL
;
16009 /* If scrolling up, there may be some lines to display at the end of
16011 last_text_row_at_end
= NULL
;
16014 /* Scrolling up can leave for example a partially visible line
16015 at the end of the window to be redisplayed. */
16016 /* Set last_row to the glyph row in the current matrix where the
16017 window end line is found. It has been moved up or down in
16018 the matrix by dvpos. */
16019 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16020 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16022 /* If last_row is the window end line, it should display text. */
16023 xassert (last_row
->displays_text_p
);
16025 /* If window end line was partially visible before, begin
16026 displaying at that line. Otherwise begin displaying with the
16027 line following it. */
16028 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16030 init_to_row_start (&it
, w
, last_row
);
16031 it
.vpos
= last_vpos
;
16032 it
.current_y
= last_row
->y
;
16036 init_to_row_end (&it
, w
, last_row
);
16037 it
.vpos
= 1 + last_vpos
;
16038 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16042 /* We may start in a continuation line. If so, we have to
16043 get the right continuation_lines_width and current_x. */
16044 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16045 it
.hpos
= it
.current_x
= 0;
16047 /* Display the rest of the lines at the window end. */
16048 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16049 while (it
.current_y
< it
.last_visible_y
16050 && !fonts_changed_p
)
16052 /* Is it always sure that the display agrees with lines in
16053 the current matrix? I don't think so, so we mark rows
16054 displayed invalid in the current matrix by setting their
16055 enabled_p flag to zero. */
16056 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16057 if (display_line (&it
))
16058 last_text_row_at_end
= it
.glyph_row
- 1;
16062 /* Update window_end_pos and window_end_vpos. */
16063 if (first_unchanged_at_end_row
16064 && !last_text_row_at_end
)
16066 /* Window end line if one of the preserved rows from the current
16067 matrix. Set row to the last row displaying text in current
16068 matrix starting at first_unchanged_at_end_row, after
16070 xassert (first_unchanged_at_end_row
->displays_text_p
);
16071 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16072 first_unchanged_at_end_row
);
16073 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16075 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16076 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16078 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16079 xassert (w
->window_end_bytepos
>= 0);
16080 IF_DEBUG (debug_method_add (w
, "A"));
16082 else if (last_text_row_at_end
)
16085 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16086 w
->window_end_bytepos
16087 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16089 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16090 xassert (w
->window_end_bytepos
>= 0);
16091 IF_DEBUG (debug_method_add (w
, "B"));
16093 else if (last_text_row
)
16095 /* We have displayed either to the end of the window or at the
16096 end of the window, i.e. the last row with text is to be found
16097 in the desired matrix. */
16099 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16100 w
->window_end_bytepos
16101 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16103 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16104 xassert (w
->window_end_bytepos
>= 0);
16106 else if (first_unchanged_at_end_row
== NULL
16107 && last_text_row
== NULL
16108 && last_text_row_at_end
== NULL
)
16110 /* Displayed to end of window, but no line containing text was
16111 displayed. Lines were deleted at the end of the window. */
16112 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16113 int vpos
= XFASTINT (w
->window_end_vpos
);
16114 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16115 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16118 row
== NULL
&& vpos
>= first_vpos
;
16119 --vpos
, --current_row
, --desired_row
)
16121 if (desired_row
->enabled_p
)
16123 if (desired_row
->displays_text_p
)
16126 else if (current_row
->displays_text_p
)
16130 xassert (row
!= NULL
);
16131 w
->window_end_vpos
= make_number (vpos
+ 1);
16132 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16133 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16134 xassert (w
->window_end_bytepos
>= 0);
16135 IF_DEBUG (debug_method_add (w
, "C"));
16140 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16141 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16143 /* Record that display has not been completed. */
16144 w
->window_end_valid
= Qnil
;
16145 w
->desired_matrix
->no_scrolling_p
= 1;
16153 /***********************************************************************
16154 More debugging support
16155 ***********************************************************************/
16159 void dump_glyph_row (struct glyph_row
*, int, int);
16160 void dump_glyph_matrix (struct glyph_matrix
*, int);
16161 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16164 /* Dump the contents of glyph matrix MATRIX on stderr.
16166 GLYPHS 0 means don't show glyph contents.
16167 GLYPHS 1 means show glyphs in short form
16168 GLYPHS > 1 means show glyphs in long form. */
16171 dump_glyph_matrix (matrix
, glyphs
)
16172 struct glyph_matrix
*matrix
;
16176 for (i
= 0; i
< matrix
->nrows
; ++i
)
16177 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16181 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16182 the glyph row and area where the glyph comes from. */
16185 dump_glyph (row
, glyph
, area
)
16186 struct glyph_row
*row
;
16187 struct glyph
*glyph
;
16190 if (glyph
->type
== CHAR_GLYPH
)
16193 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16194 glyph
- row
->glyphs
[TEXT_AREA
],
16197 (BUFFERP (glyph
->object
)
16199 : (STRINGP (glyph
->object
)
16202 glyph
->pixel_width
,
16204 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16208 glyph
->left_box_line_p
,
16209 glyph
->right_box_line_p
);
16211 else if (glyph
->type
== STRETCH_GLYPH
)
16214 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16215 glyph
- row
->glyphs
[TEXT_AREA
],
16218 (BUFFERP (glyph
->object
)
16220 : (STRINGP (glyph
->object
)
16223 glyph
->pixel_width
,
16227 glyph
->left_box_line_p
,
16228 glyph
->right_box_line_p
);
16230 else if (glyph
->type
== IMAGE_GLYPH
)
16233 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16234 glyph
- row
->glyphs
[TEXT_AREA
],
16237 (BUFFERP (glyph
->object
)
16239 : (STRINGP (glyph
->object
)
16242 glyph
->pixel_width
,
16246 glyph
->left_box_line_p
,
16247 glyph
->right_box_line_p
);
16249 else if (glyph
->type
== COMPOSITE_GLYPH
)
16252 " %5d %4c %6d %c %3d 0x%05x",
16253 glyph
- row
->glyphs
[TEXT_AREA
],
16256 (BUFFERP (glyph
->object
)
16258 : (STRINGP (glyph
->object
)
16261 glyph
->pixel_width
,
16263 if (glyph
->u
.cmp
.automatic
)
16266 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16267 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16269 glyph
->left_box_line_p
,
16270 glyph
->right_box_line_p
);
16275 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16276 GLYPHS 0 means don't show glyph contents.
16277 GLYPHS 1 means show glyphs in short form
16278 GLYPHS > 1 means show glyphs in long form. */
16281 dump_glyph_row (row
, vpos
, glyphs
)
16282 struct glyph_row
*row
;
16287 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16288 fprintf (stderr
, "======================================================================\n");
16290 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16291 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16293 MATRIX_ROW_START_CHARPOS (row
),
16294 MATRIX_ROW_END_CHARPOS (row
),
16295 row
->used
[TEXT_AREA
],
16296 row
->contains_overlapping_glyphs_p
,
16298 row
->truncated_on_left_p
,
16299 row
->truncated_on_right_p
,
16301 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16302 row
->displays_text_p
,
16305 row
->ends_in_middle_of_char_p
,
16306 row
->starts_in_middle_of_char_p
,
16312 row
->visible_height
,
16315 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16316 row
->end
.overlay_string_index
,
16317 row
->continuation_lines_width
);
16318 fprintf (stderr
, "%9d %5d\n",
16319 CHARPOS (row
->start
.string_pos
),
16320 CHARPOS (row
->end
.string_pos
));
16321 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16322 row
->end
.dpvec_index
);
16329 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16331 struct glyph
*glyph
= row
->glyphs
[area
];
16332 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16334 /* Glyph for a line end in text. */
16335 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16338 if (glyph
< glyph_end
)
16339 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16341 for (; glyph
< glyph_end
; ++glyph
)
16342 dump_glyph (row
, glyph
, area
);
16345 else if (glyphs
== 1)
16349 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16351 char *s
= (char *) alloca (row
->used
[area
] + 1);
16354 for (i
= 0; i
< row
->used
[area
]; ++i
)
16356 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16357 if (glyph
->type
== CHAR_GLYPH
16358 && glyph
->u
.ch
< 0x80
16359 && glyph
->u
.ch
>= ' ')
16360 s
[i
] = glyph
->u
.ch
;
16366 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16372 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16373 Sdump_glyph_matrix
, 0, 1, "p",
16374 doc
: /* Dump the current matrix of the selected window to stderr.
16375 Shows contents of glyph row structures. With non-nil
16376 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16377 glyphs in short form, otherwise show glyphs in long form. */)
16379 Lisp_Object glyphs
;
16381 struct window
*w
= XWINDOW (selected_window
);
16382 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16384 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16385 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16386 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16387 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16388 fprintf (stderr
, "=============================================\n");
16389 dump_glyph_matrix (w
->current_matrix
,
16390 NILP (glyphs
) ? 0 : XINT (glyphs
));
16395 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16396 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16399 struct frame
*f
= XFRAME (selected_frame
);
16400 dump_glyph_matrix (f
->current_matrix
, 1);
16405 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16406 doc
: /* Dump glyph row ROW to stderr.
16407 GLYPH 0 means don't dump glyphs.
16408 GLYPH 1 means dump glyphs in short form.
16409 GLYPH > 1 or omitted means dump glyphs in long form. */)
16411 Lisp_Object row
, glyphs
;
16413 struct glyph_matrix
*matrix
;
16416 CHECK_NUMBER (row
);
16417 matrix
= XWINDOW (selected_window
)->current_matrix
;
16419 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16420 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16422 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16427 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16428 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16429 GLYPH 0 means don't dump glyphs.
16430 GLYPH 1 means dump glyphs in short form.
16431 GLYPH > 1 or omitted means dump glyphs in long form. */)
16433 Lisp_Object row
, glyphs
;
16435 struct frame
*sf
= SELECTED_FRAME ();
16436 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16439 CHECK_NUMBER (row
);
16441 if (vpos
>= 0 && vpos
< m
->nrows
)
16442 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16443 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16448 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16449 doc
: /* Toggle tracing of redisplay.
16450 With ARG, turn tracing on if and only if ARG is positive. */)
16455 trace_redisplay_p
= !trace_redisplay_p
;
16458 arg
= Fprefix_numeric_value (arg
);
16459 trace_redisplay_p
= XINT (arg
) > 0;
16466 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16467 doc
: /* Like `format', but print result to stderr.
16468 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16473 Lisp_Object s
= Fformat (nargs
, args
);
16474 fprintf (stderr
, "%s", SDATA (s
));
16478 #endif /* GLYPH_DEBUG */
16482 /***********************************************************************
16483 Building Desired Matrix Rows
16484 ***********************************************************************/
16486 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16487 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16489 static struct glyph_row
*
16490 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16492 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16493 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16494 struct buffer
*old
= current_buffer
;
16495 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16496 int arrow_len
= SCHARS (overlay_arrow_string
);
16497 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16498 const unsigned char *p
;
16501 int n_glyphs_before
;
16503 set_buffer_temp (buffer
);
16504 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16505 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16506 SET_TEXT_POS (it
.position
, 0, 0);
16508 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16510 while (p
< arrow_end
)
16512 Lisp_Object face
, ilisp
;
16514 /* Get the next character. */
16516 it
.c
= string_char_and_length (p
, &it
.len
);
16518 it
.c
= *p
, it
.len
= 1;
16521 /* Get its face. */
16522 ilisp
= make_number (p
- arrow_string
);
16523 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16524 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16526 /* Compute its width, get its glyphs. */
16527 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16528 SET_TEXT_POS (it
.position
, -1, -1);
16529 PRODUCE_GLYPHS (&it
);
16531 /* If this character doesn't fit any more in the line, we have
16532 to remove some glyphs. */
16533 if (it
.current_x
> it
.last_visible_x
)
16535 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16540 set_buffer_temp (old
);
16541 return it
.glyph_row
;
16545 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16546 glyphs are only inserted for terminal frames since we can't really
16547 win with truncation glyphs when partially visible glyphs are
16548 involved. Which glyphs to insert is determined by
16549 produce_special_glyphs. */
16552 insert_left_trunc_glyphs (struct it
*it
)
16554 struct it truncate_it
;
16555 struct glyph
*from
, *end
, *to
, *toend
;
16557 xassert (!FRAME_WINDOW_P (it
->f
));
16559 /* Get the truncation glyphs. */
16561 truncate_it
.current_x
= 0;
16562 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16563 truncate_it
.glyph_row
= &scratch_glyph_row
;
16564 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16565 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16566 truncate_it
.object
= make_number (0);
16567 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16569 /* Overwrite glyphs from IT with truncation glyphs. */
16570 if (!it
->glyph_row
->reversed_p
)
16572 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16573 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16574 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16575 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16580 /* There may be padding glyphs left over. Overwrite them too. */
16581 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16583 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16589 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16593 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16594 that back to front. */
16595 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16596 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16597 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16598 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16600 while (from
>= end
&& to
>= toend
)
16602 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16605 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16606 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16607 while (from
>= end
&& to
>= toend
)
16612 /* Need to free some room before prepending additional
16614 int move_by
= from
- end
+ 1;
16615 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16616 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16618 for ( ; g
>= g0
; g
--)
16620 while (from
>= end
)
16622 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16628 /* Compute the pixel height and width of IT->glyph_row.
16630 Most of the time, ascent and height of a display line will be equal
16631 to the max_ascent and max_height values of the display iterator
16632 structure. This is not the case if
16634 1. We hit ZV without displaying anything. In this case, max_ascent
16635 and max_height will be zero.
16637 2. We have some glyphs that don't contribute to the line height.
16638 (The glyph row flag contributes_to_line_height_p is for future
16639 pixmap extensions).
16641 The first case is easily covered by using default values because in
16642 these cases, the line height does not really matter, except that it
16643 must not be zero. */
16646 compute_line_metrics (struct it
*it
)
16648 struct glyph_row
*row
= it
->glyph_row
;
16651 if (FRAME_WINDOW_P (it
->f
))
16653 int i
, min_y
, max_y
;
16655 /* The line may consist of one space only, that was added to
16656 place the cursor on it. If so, the row's height hasn't been
16658 if (row
->height
== 0)
16660 if (it
->max_ascent
+ it
->max_descent
== 0)
16661 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16662 row
->ascent
= it
->max_ascent
;
16663 row
->height
= it
->max_ascent
+ it
->max_descent
;
16664 row
->phys_ascent
= it
->max_phys_ascent
;
16665 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16666 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16669 /* Compute the width of this line. */
16670 row
->pixel_width
= row
->x
;
16671 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16672 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16674 xassert (row
->pixel_width
>= 0);
16675 xassert (row
->ascent
>= 0 && row
->height
> 0);
16677 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16678 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16680 /* If first line's physical ascent is larger than its logical
16681 ascent, use the physical ascent, and make the row taller.
16682 This makes accented characters fully visible. */
16683 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16684 && row
->phys_ascent
> row
->ascent
)
16686 row
->height
+= row
->phys_ascent
- row
->ascent
;
16687 row
->ascent
= row
->phys_ascent
;
16690 /* Compute how much of the line is visible. */
16691 row
->visible_height
= row
->height
;
16693 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16694 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16696 if (row
->y
< min_y
)
16697 row
->visible_height
-= min_y
- row
->y
;
16698 if (row
->y
+ row
->height
> max_y
)
16699 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16703 row
->pixel_width
= row
->used
[TEXT_AREA
];
16704 if (row
->continued_p
)
16705 row
->pixel_width
-= it
->continuation_pixel_width
;
16706 else if (row
->truncated_on_right_p
)
16707 row
->pixel_width
-= it
->truncation_pixel_width
;
16708 row
->ascent
= row
->phys_ascent
= 0;
16709 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16710 row
->extra_line_spacing
= 0;
16713 /* Compute a hash code for this row. */
16715 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16716 for (i
= 0; i
< row
->used
[area
]; ++i
)
16717 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16718 + row
->glyphs
[area
][i
].u
.val
16719 + row
->glyphs
[area
][i
].face_id
16720 + row
->glyphs
[area
][i
].padding_p
16721 + (row
->glyphs
[area
][i
].type
<< 2));
16723 it
->max_ascent
= it
->max_descent
= 0;
16724 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16728 /* Append one space to the glyph row of iterator IT if doing a
16729 window-based redisplay. The space has the same face as
16730 IT->face_id. Value is non-zero if a space was added.
16732 This function is called to make sure that there is always one glyph
16733 at the end of a glyph row that the cursor can be set on under
16734 window-systems. (If there weren't such a glyph we would not know
16735 how wide and tall a box cursor should be displayed).
16737 At the same time this space let's a nicely handle clearing to the
16738 end of the line if the row ends in italic text. */
16741 append_space_for_newline (struct it
*it
, int default_face_p
)
16743 if (FRAME_WINDOW_P (it
->f
))
16745 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16747 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16748 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16750 /* Save some values that must not be changed.
16751 Must save IT->c and IT->len because otherwise
16752 ITERATOR_AT_END_P wouldn't work anymore after
16753 append_space_for_newline has been called. */
16754 enum display_element_type saved_what
= it
->what
;
16755 int saved_c
= it
->c
, saved_len
= it
->len
;
16756 int saved_x
= it
->current_x
;
16757 int saved_face_id
= it
->face_id
;
16758 struct text_pos saved_pos
;
16759 Lisp_Object saved_object
;
16762 saved_object
= it
->object
;
16763 saved_pos
= it
->position
;
16765 it
->what
= IT_CHARACTER
;
16766 bzero (&it
->position
, sizeof it
->position
);
16767 it
->object
= make_number (0);
16771 if (default_face_p
)
16772 it
->face_id
= DEFAULT_FACE_ID
;
16773 else if (it
->face_before_selective_p
)
16774 it
->face_id
= it
->saved_face_id
;
16775 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16776 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16778 PRODUCE_GLYPHS (it
);
16780 it
->override_ascent
= -1;
16781 it
->constrain_row_ascent_descent_p
= 0;
16782 it
->current_x
= saved_x
;
16783 it
->object
= saved_object
;
16784 it
->position
= saved_pos
;
16785 it
->what
= saved_what
;
16786 it
->face_id
= saved_face_id
;
16787 it
->len
= saved_len
;
16797 /* Extend the face of the last glyph in the text area of IT->glyph_row
16798 to the end of the display line. Called from display_line. If the
16799 glyph row is empty, add a space glyph to it so that we know the
16800 face to draw. Set the glyph row flag fill_line_p. If the glyph
16801 row is R2L, prepend a stretch glyph to cover the empty space to the
16802 left of the leftmost glyph. */
16805 extend_face_to_end_of_line (struct it
*it
)
16808 struct frame
*f
= it
->f
;
16810 /* If line is already filled, do nothing. Non window-system frames
16811 get a grace of one more ``pixel'' because their characters are
16812 1-``pixel'' wide, so they hit the equality too early. This grace
16813 is needed only for R2L rows that are not continued, to produce
16814 one extra blank where we could display the cursor. */
16815 if (it
->current_x
>= it
->last_visible_x
16816 + (!FRAME_WINDOW_P (f
)
16817 && it
->glyph_row
->reversed_p
16818 && !it
->glyph_row
->continued_p
))
16821 /* Face extension extends the background and box of IT->face_id
16822 to the end of the line. If the background equals the background
16823 of the frame, we don't have to do anything. */
16824 if (it
->face_before_selective_p
)
16825 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16827 face
= FACE_FROM_ID (f
, it
->face_id
);
16829 if (FRAME_WINDOW_P (f
)
16830 && it
->glyph_row
->displays_text_p
16831 && face
->box
== FACE_NO_BOX
16832 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16834 && !it
->glyph_row
->reversed_p
)
16837 /* Set the glyph row flag indicating that the face of the last glyph
16838 in the text area has to be drawn to the end of the text area. */
16839 it
->glyph_row
->fill_line_p
= 1;
16841 /* If current character of IT is not ASCII, make sure we have the
16842 ASCII face. This will be automatically undone the next time
16843 get_next_display_element returns a multibyte character. Note
16844 that the character will always be single byte in unibyte
16846 if (!ASCII_CHAR_P (it
->c
))
16848 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16851 if (FRAME_WINDOW_P (f
))
16853 /* If the row is empty, add a space with the current face of IT,
16854 so that we know which face to draw. */
16855 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16857 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16858 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16859 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16861 #ifdef HAVE_WINDOW_SYSTEM
16862 if (it
->glyph_row
->reversed_p
)
16864 /* Prepend a stretch glyph to the row, such that the
16865 rightmost glyph will be drawn flushed all the way to the
16866 right margin of the window. The stretch glyph that will
16867 occupy the empty space, if any, to the left of the
16869 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16870 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16871 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16873 int row_width
, stretch_ascent
, stretch_width
;
16874 struct text_pos saved_pos
;
16875 int saved_face_id
, saved_avoid_cursor
;
16877 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16878 row_width
+= g
->pixel_width
;
16879 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16880 if (stretch_width
> 0)
16883 (((it
->ascent
+ it
->descent
)
16884 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16885 saved_pos
= it
->position
;
16886 bzero (&it
->position
, sizeof it
->position
);
16887 saved_avoid_cursor
= it
->avoid_cursor_p
;
16888 it
->avoid_cursor_p
= 1;
16889 saved_face_id
= it
->face_id
;
16890 /* The last row's stretch glyph should get the default
16891 face, to avoid painting the rest of the window with
16892 the region face, if the region ends at ZV. */
16893 if (it
->glyph_row
->ends_at_zv_p
)
16894 it
->face_id
= DEFAULT_FACE_ID
;
16896 it
->face_id
= face
->id
;
16897 append_stretch_glyph (it
, make_number (0), stretch_width
,
16898 it
->ascent
+ it
->descent
, stretch_ascent
);
16899 it
->position
= saved_pos
;
16900 it
->avoid_cursor_p
= saved_avoid_cursor
;
16901 it
->face_id
= saved_face_id
;
16904 #endif /* HAVE_WINDOW_SYSTEM */
16908 /* Save some values that must not be changed. */
16909 int saved_x
= it
->current_x
;
16910 struct text_pos saved_pos
;
16911 Lisp_Object saved_object
;
16912 enum display_element_type saved_what
= it
->what
;
16913 int saved_face_id
= it
->face_id
;
16915 saved_object
= it
->object
;
16916 saved_pos
= it
->position
;
16918 it
->what
= IT_CHARACTER
;
16919 bzero (&it
->position
, sizeof it
->position
);
16920 it
->object
= make_number (0);
16923 /* The last row's blank glyphs should get the default face, to
16924 avoid painting the rest of the window with the region face,
16925 if the region ends at ZV. */
16926 if (it
->glyph_row
->ends_at_zv_p
)
16927 it
->face_id
= DEFAULT_FACE_ID
;
16929 it
->face_id
= face
->id
;
16931 PRODUCE_GLYPHS (it
);
16933 while (it
->current_x
<= it
->last_visible_x
)
16934 PRODUCE_GLYPHS (it
);
16936 /* Don't count these blanks really. It would let us insert a left
16937 truncation glyph below and make us set the cursor on them, maybe. */
16938 it
->current_x
= saved_x
;
16939 it
->object
= saved_object
;
16940 it
->position
= saved_pos
;
16941 it
->what
= saved_what
;
16942 it
->face_id
= saved_face_id
;
16947 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16948 trailing whitespace. */
16951 trailing_whitespace_p (int charpos
)
16953 int bytepos
= CHAR_TO_BYTE (charpos
);
16956 while (bytepos
< ZV_BYTE
16957 && (c
= FETCH_CHAR (bytepos
),
16958 c
== ' ' || c
== '\t'))
16961 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16963 if (bytepos
!= PT_BYTE
)
16970 /* Highlight trailing whitespace, if any, in ROW. */
16973 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16975 int used
= row
->used
[TEXT_AREA
];
16979 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16980 struct glyph
*glyph
= start
+ used
- 1;
16982 if (row
->reversed_p
)
16984 /* Right-to-left rows need to be processed in the opposite
16985 direction, so swap the edge pointers. */
16987 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16990 /* Skip over glyphs inserted to display the cursor at the
16991 end of a line, for extending the face of the last glyph
16992 to the end of the line on terminals, and for truncation
16993 and continuation glyphs. */
16994 if (!row
->reversed_p
)
16996 while (glyph
>= start
16997 && glyph
->type
== CHAR_GLYPH
16998 && INTEGERP (glyph
->object
))
17003 while (glyph
<= start
17004 && glyph
->type
== CHAR_GLYPH
17005 && INTEGERP (glyph
->object
))
17009 /* If last glyph is a space or stretch, and it's trailing
17010 whitespace, set the face of all trailing whitespace glyphs in
17011 IT->glyph_row to `trailing-whitespace'. */
17012 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17013 && BUFFERP (glyph
->object
)
17014 && (glyph
->type
== STRETCH_GLYPH
17015 || (glyph
->type
== CHAR_GLYPH
17016 && glyph
->u
.ch
== ' '))
17017 && trailing_whitespace_p (glyph
->charpos
))
17019 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17023 if (!row
->reversed_p
)
17025 while (glyph
>= start
17026 && BUFFERP (glyph
->object
)
17027 && (glyph
->type
== STRETCH_GLYPH
17028 || (glyph
->type
== CHAR_GLYPH
17029 && glyph
->u
.ch
== ' ')))
17030 (glyph
--)->face_id
= face_id
;
17034 while (glyph
<= start
17035 && BUFFERP (glyph
->object
)
17036 && (glyph
->type
== STRETCH_GLYPH
17037 || (glyph
->type
== CHAR_GLYPH
17038 && glyph
->u
.ch
== ' ')))
17039 (glyph
++)->face_id
= face_id
;
17046 /* Value is non-zero if glyph row ROW in window W should be
17047 used to hold the cursor. */
17050 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17052 int cursor_row_p
= 1;
17054 if (PT
== CHARPOS (row
->end
.pos
))
17056 /* Suppose the row ends on a string.
17057 Unless the row is continued, that means it ends on a newline
17058 in the string. If it's anything other than a display string
17059 (e.g. a before-string from an overlay), we don't want the
17060 cursor there. (This heuristic seems to give the optimal
17061 behavior for the various types of multi-line strings.) */
17062 if (CHARPOS (row
->end
.string_pos
) >= 0)
17064 if (row
->continued_p
)
17068 /* Check for `display' property. */
17069 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17070 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17071 struct glyph
*glyph
;
17074 for (glyph
= end
; glyph
>= beg
; --glyph
)
17075 if (STRINGP (glyph
->object
))
17078 = Fget_char_property (make_number (PT
),
17082 && display_prop_string_p (prop
, glyph
->object
));
17087 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17089 /* If the row ends in middle of a real character,
17090 and the line is continued, we want the cursor here.
17091 That's because CHARPOS (ROW->end.pos) would equal
17092 PT if PT is before the character. */
17093 if (!row
->ends_in_ellipsis_p
)
17094 cursor_row_p
= row
->continued_p
;
17096 /* If the row ends in an ellipsis, then
17097 CHARPOS (ROW->end.pos) will equal point after the
17098 invisible text. We want that position to be displayed
17099 after the ellipsis. */
17102 /* If the row ends at ZV, display the cursor at the end of that
17103 row instead of at the start of the row below. */
17104 else if (row
->ends_at_zv_p
)
17110 return cursor_row_p
;
17115 /* Push the display property PROP so that it will be rendered at the
17116 current position in IT. Return 1 if PROP was successfully pushed,
17120 push_display_prop (struct it
*it
, Lisp_Object prop
)
17124 if (STRINGP (prop
))
17126 if (SCHARS (prop
) == 0)
17133 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17134 it
->current
.overlay_string_index
= -1;
17135 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17136 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17137 it
->method
= GET_FROM_STRING
;
17138 it
->stop_charpos
= 0;
17140 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17142 it
->method
= GET_FROM_STRETCH
;
17145 #ifdef HAVE_WINDOW_SYSTEM
17146 else if (IMAGEP (prop
))
17148 it
->what
= IT_IMAGE
;
17149 it
->image_id
= lookup_image (it
->f
, prop
);
17150 it
->method
= GET_FROM_IMAGE
;
17152 #endif /* HAVE_WINDOW_SYSTEM */
17155 pop_it (it
); /* bogus display property, give up */
17162 /* Return the character-property PROP at the current position in IT. */
17165 get_it_property (struct it
*it
, Lisp_Object prop
)
17167 Lisp_Object position
;
17169 if (STRINGP (it
->object
))
17170 position
= make_number (IT_STRING_CHARPOS (*it
));
17171 else if (BUFFERP (it
->object
))
17172 position
= make_number (IT_CHARPOS (*it
));
17176 return Fget_char_property (position
, prop
, it
->object
);
17179 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17182 handle_line_prefix (struct it
*it
)
17184 Lisp_Object prefix
;
17185 if (it
->continuation_lines_width
> 0)
17187 prefix
= get_it_property (it
, Qwrap_prefix
);
17189 prefix
= Vwrap_prefix
;
17193 prefix
= get_it_property (it
, Qline_prefix
);
17195 prefix
= Vline_prefix
;
17197 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17199 /* If the prefix is wider than the window, and we try to wrap
17200 it, it would acquire its own wrap prefix, and so on till the
17201 iterator stack overflows. So, don't wrap the prefix. */
17202 it
->line_wrap
= TRUNCATE
;
17203 it
->avoid_cursor_p
= 1;
17209 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17210 only for R2L lines from display_line, when it decides that too many
17211 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17214 unproduce_glyphs (struct it
*it
, int n
)
17216 struct glyph
*glyph
, *end
;
17218 xassert (it
->glyph_row
);
17219 xassert (it
->glyph_row
->reversed_p
);
17220 xassert (it
->area
== TEXT_AREA
);
17221 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17223 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17224 n
= it
->glyph_row
->used
[TEXT_AREA
];
17225 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17226 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17227 for ( ; glyph
< end
; glyph
++)
17228 glyph
[-n
] = *glyph
;
17231 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17232 and ROW->maxpos. */
17234 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17235 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17236 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17238 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17239 lines' rows is implemented for bidi-reordered rows. */
17241 /* ROW->minpos is the value of min_pos, the minimal buffer position
17244 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17247 /* We didn't find _any_ valid buffer positions in any of the
17248 glyphs, so we must trust the iterator's computed
17250 row
->minpos
= row
->start
.pos
;
17251 max_pos
= CHARPOS (it
->current
.pos
);
17252 max_bpos
= BYTEPOS (it
->current
.pos
);
17258 /* Here are the various use-cases for ending the row, and the
17259 corresponding values for ROW->maxpos:
17261 Line ends in a newline from buffer eol_pos + 1
17262 Line is continued from buffer max_pos + 1
17263 Line is truncated on right it->current.pos
17264 Line ends in a newline from string max_pos
17265 Line is continued from string max_pos
17266 Line is continued from display vector max_pos
17267 Line is entirely from a string min_pos == max_pos
17268 Line is entirely from a display vector min_pos == max_pos
17269 Line that ends at ZV ZV
17271 If you discover other use-cases, please add them here as
17273 if (row
->ends_at_zv_p
)
17274 row
->maxpos
= it
->current
.pos
;
17275 else if (row
->used
[TEXT_AREA
])
17277 if (row
->ends_in_newline_from_string_p
)
17278 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17279 else if (CHARPOS (it
->eol_pos
) > 0)
17280 SET_TEXT_POS (row
->maxpos
,
17281 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17282 else if (row
->continued_p
)
17284 /* If max_pos is different from IT's current position, it
17285 means IT->method does not belong to the display element
17286 at max_pos. However, it also means that the display
17287 element at max_pos was displayed in its entirety on this
17288 line, which is equivalent to saying that the next line
17289 starts at the next buffer position. */
17290 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17291 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17294 INC_BOTH (max_pos
, max_bpos
);
17295 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17298 else if (row
->truncated_on_right_p
)
17299 /* display_line already called reseat_at_next_visible_line_start,
17300 which puts the iterator at the beginning of the next line, in
17301 the logical order. */
17302 row
->maxpos
= it
->current
.pos
;
17303 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17304 /* A line that is entirely from a string/image/stretch... */
17305 row
->maxpos
= row
->minpos
;
17310 row
->maxpos
= it
->current
.pos
;
17313 /* Construct the glyph row IT->glyph_row in the desired matrix of
17314 IT->w from text at the current position of IT. See dispextern.h
17315 for an overview of struct it. Value is non-zero if
17316 IT->glyph_row displays text, as opposed to a line displaying ZV
17320 display_line (struct it
*it
)
17322 struct glyph_row
*row
= it
->glyph_row
;
17323 Lisp_Object overlay_arrow_string
;
17325 int may_wrap
= 0, wrap_x
;
17326 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17327 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17328 int wrap_row_extra_line_spacing
;
17329 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17330 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17332 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17334 /* We always start displaying at hpos zero even if hscrolled. */
17335 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17337 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17338 >= it
->w
->desired_matrix
->nrows
)
17340 it
->w
->nrows_scale_factor
++;
17341 fonts_changed_p
= 1;
17345 /* Is IT->w showing the region? */
17346 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17348 /* Clear the result glyph row and enable it. */
17349 prepare_desired_row (row
);
17351 row
->y
= it
->current_y
;
17352 row
->start
= it
->start
;
17353 row
->continuation_lines_width
= it
->continuation_lines_width
;
17354 row
->displays_text_p
= 1;
17355 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17356 it
->starts_in_middle_of_char_p
= 0;
17358 /* Arrange the overlays nicely for our purposes. Usually, we call
17359 display_line on only one line at a time, in which case this
17360 can't really hurt too much, or we call it on lines which appear
17361 one after another in the buffer, in which case all calls to
17362 recenter_overlay_lists but the first will be pretty cheap. */
17363 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17365 /* Move over display elements that are not visible because we are
17366 hscrolled. This may stop at an x-position < IT->first_visible_x
17367 if the first glyph is partially visible or if we hit a line end. */
17368 if (it
->current_x
< it
->first_visible_x
)
17370 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17371 MOVE_TO_POS
| MOVE_TO_X
);
17375 /* We only do this when not calling `move_it_in_display_line_to'
17376 above, because move_it_in_display_line_to calls
17377 handle_line_prefix itself. */
17378 handle_line_prefix (it
);
17381 /* Get the initial row height. This is either the height of the
17382 text hscrolled, if there is any, or zero. */
17383 row
->ascent
= it
->max_ascent
;
17384 row
->height
= it
->max_ascent
+ it
->max_descent
;
17385 row
->phys_ascent
= it
->max_phys_ascent
;
17386 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17387 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17389 /* Utility macro to record max and min buffer positions seen until now. */
17390 #define RECORD_MAX_MIN_POS(IT) \
17393 if (IT_CHARPOS (*(IT)) < min_pos) \
17395 min_pos = IT_CHARPOS (*(IT)); \
17396 min_bpos = IT_BYTEPOS (*(IT)); \
17398 if (IT_CHARPOS (*(IT)) > max_pos) \
17400 max_pos = IT_CHARPOS (*(IT)); \
17401 max_bpos = IT_BYTEPOS (*(IT)); \
17406 /* Loop generating characters. The loop is left with IT on the next
17407 character to display. */
17410 int n_glyphs_before
, hpos_before
, x_before
;
17412 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17414 /* Retrieve the next thing to display. Value is zero if end of
17416 if (!get_next_display_element (it
))
17418 /* Maybe add a space at the end of this line that is used to
17419 display the cursor there under X. Set the charpos of the
17420 first glyph of blank lines not corresponding to any text
17422 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17423 row
->exact_window_width_line_p
= 1;
17424 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17425 || row
->used
[TEXT_AREA
] == 0)
17427 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17428 row
->displays_text_p
= 0;
17430 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17431 && (!MINI_WINDOW_P (it
->w
)
17432 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17433 row
->indicate_empty_line_p
= 1;
17436 it
->continuation_lines_width
= 0;
17437 row
->ends_at_zv_p
= 1;
17438 /* A row that displays right-to-left text must always have
17439 its last face extended all the way to the end of line,
17440 even if this row ends in ZV, because we still write to th
17441 screen left to right. */
17442 if (row
->reversed_p
)
17443 extend_face_to_end_of_line (it
);
17447 /* Now, get the metrics of what we want to display. This also
17448 generates glyphs in `row' (which is IT->glyph_row). */
17449 n_glyphs_before
= row
->used
[TEXT_AREA
];
17452 /* Remember the line height so far in case the next element doesn't
17453 fit on the line. */
17454 if (it
->line_wrap
!= TRUNCATE
)
17456 ascent
= it
->max_ascent
;
17457 descent
= it
->max_descent
;
17458 phys_ascent
= it
->max_phys_ascent
;
17459 phys_descent
= it
->max_phys_descent
;
17461 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17463 if (IT_DISPLAYING_WHITESPACE (it
))
17469 wrap_row_used
= row
->used
[TEXT_AREA
];
17470 wrap_row_ascent
= row
->ascent
;
17471 wrap_row_height
= row
->height
;
17472 wrap_row_phys_ascent
= row
->phys_ascent
;
17473 wrap_row_phys_height
= row
->phys_height
;
17474 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17475 wrap_row_min_pos
= min_pos
;
17476 wrap_row_min_bpos
= min_bpos
;
17477 wrap_row_max_pos
= max_pos
;
17478 wrap_row_max_bpos
= max_bpos
;
17484 PRODUCE_GLYPHS (it
);
17486 /* If this display element was in marginal areas, continue with
17488 if (it
->area
!= TEXT_AREA
)
17490 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17491 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17492 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17493 row
->phys_height
= max (row
->phys_height
,
17494 it
->max_phys_ascent
+ it
->max_phys_descent
);
17495 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17496 it
->max_extra_line_spacing
);
17497 set_iterator_to_next (it
, 1);
17501 /* Does the display element fit on the line? If we truncate
17502 lines, we should draw past the right edge of the window. If
17503 we don't truncate, we want to stop so that we can display the
17504 continuation glyph before the right margin. If lines are
17505 continued, there are two possible strategies for characters
17506 resulting in more than 1 glyph (e.g. tabs): Display as many
17507 glyphs as possible in this line and leave the rest for the
17508 continuation line, or display the whole element in the next
17509 line. Original redisplay did the former, so we do it also. */
17510 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17511 hpos_before
= it
->hpos
;
17514 if (/* Not a newline. */
17516 /* Glyphs produced fit entirely in the line. */
17517 && it
->current_x
< it
->last_visible_x
)
17519 it
->hpos
+= nglyphs
;
17520 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17521 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17522 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17523 row
->phys_height
= max (row
->phys_height
,
17524 it
->max_phys_ascent
+ it
->max_phys_descent
);
17525 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17526 it
->max_extra_line_spacing
);
17527 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17528 row
->x
= x
- it
->first_visible_x
;
17529 /* Record the maximum and minimum buffer positions seen so
17530 far in glyphs that will be displayed by this row. */
17532 RECORD_MAX_MIN_POS (it
);
17537 struct glyph
*glyph
;
17539 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17541 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17542 new_x
= x
+ glyph
->pixel_width
;
17544 if (/* Lines are continued. */
17545 it
->line_wrap
!= TRUNCATE
17546 && (/* Glyph doesn't fit on the line. */
17547 new_x
> it
->last_visible_x
17548 /* Or it fits exactly on a window system frame. */
17549 || (new_x
== it
->last_visible_x
17550 && FRAME_WINDOW_P (it
->f
))))
17552 /* End of a continued line. */
17555 || (new_x
== it
->last_visible_x
17556 && FRAME_WINDOW_P (it
->f
)))
17558 /* Current glyph is the only one on the line or
17559 fits exactly on the line. We must continue
17560 the line because we can't draw the cursor
17561 after the glyph. */
17562 row
->continued_p
= 1;
17563 it
->current_x
= new_x
;
17564 it
->continuation_lines_width
+= new_x
;
17566 /* Record the maximum and minimum buffer
17567 positions seen so far in glyphs that will be
17568 displayed by this row. */
17570 RECORD_MAX_MIN_POS (it
);
17571 if (i
== nglyphs
- 1)
17573 /* If line-wrap is on, check if a previous
17574 wrap point was found. */
17575 if (wrap_row_used
> 0
17576 /* Even if there is a previous wrap
17577 point, continue the line here as
17578 usual, if (i) the previous character
17579 was a space or tab AND (ii) the
17580 current character is not. */
17582 || IT_DISPLAYING_WHITESPACE (it
)))
17585 set_iterator_to_next (it
, 1);
17586 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17588 if (!get_next_display_element (it
))
17590 row
->exact_window_width_line_p
= 1;
17591 it
->continuation_lines_width
= 0;
17592 row
->continued_p
= 0;
17593 row
->ends_at_zv_p
= 1;
17595 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17597 row
->continued_p
= 0;
17598 row
->exact_window_width_line_p
= 1;
17603 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17604 && !FRAME_WINDOW_P (it
->f
))
17606 /* A padding glyph that doesn't fit on this line.
17607 This means the whole character doesn't fit
17609 if (row
->reversed_p
)
17610 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17611 - n_glyphs_before
);
17612 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17614 /* Fill the rest of the row with continuation
17615 glyphs like in 20.x. */
17616 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17617 < row
->glyphs
[1 + TEXT_AREA
])
17618 produce_special_glyphs (it
, IT_CONTINUATION
);
17620 row
->continued_p
= 1;
17621 it
->current_x
= x_before
;
17622 it
->continuation_lines_width
+= x_before
;
17624 /* Restore the height to what it was before the
17625 element not fitting on the line. */
17626 it
->max_ascent
= ascent
;
17627 it
->max_descent
= descent
;
17628 it
->max_phys_ascent
= phys_ascent
;
17629 it
->max_phys_descent
= phys_descent
;
17631 else if (wrap_row_used
> 0)
17634 if (row
->reversed_p
)
17635 unproduce_glyphs (it
,
17636 row
->used
[TEXT_AREA
] - wrap_row_used
);
17638 it
->continuation_lines_width
+= wrap_x
;
17639 row
->used
[TEXT_AREA
] = wrap_row_used
;
17640 row
->ascent
= wrap_row_ascent
;
17641 row
->height
= wrap_row_height
;
17642 row
->phys_ascent
= wrap_row_phys_ascent
;
17643 row
->phys_height
= wrap_row_phys_height
;
17644 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17645 min_pos
= wrap_row_min_pos
;
17646 min_bpos
= wrap_row_min_bpos
;
17647 max_pos
= wrap_row_max_pos
;
17648 max_bpos
= wrap_row_max_bpos
;
17649 row
->continued_p
= 1;
17650 row
->ends_at_zv_p
= 0;
17651 row
->exact_window_width_line_p
= 0;
17652 it
->continuation_lines_width
+= x
;
17654 /* Make sure that a non-default face is extended
17655 up to the right margin of the window. */
17656 extend_face_to_end_of_line (it
);
17658 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17660 /* A TAB that extends past the right edge of the
17661 window. This produces a single glyph on
17662 window system frames. We leave the glyph in
17663 this row and let it fill the row, but don't
17664 consume the TAB. */
17665 it
->continuation_lines_width
+= it
->last_visible_x
;
17666 row
->ends_in_middle_of_char_p
= 1;
17667 row
->continued_p
= 1;
17668 glyph
->pixel_width
= it
->last_visible_x
- x
;
17669 it
->starts_in_middle_of_char_p
= 1;
17673 /* Something other than a TAB that draws past
17674 the right edge of the window. Restore
17675 positions to values before the element. */
17676 if (row
->reversed_p
)
17677 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17678 - (n_glyphs_before
+ i
));
17679 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17681 /* Display continuation glyphs. */
17682 if (!FRAME_WINDOW_P (it
->f
))
17683 produce_special_glyphs (it
, IT_CONTINUATION
);
17684 row
->continued_p
= 1;
17686 it
->current_x
= x_before
;
17687 it
->continuation_lines_width
+= x
;
17688 extend_face_to_end_of_line (it
);
17690 if (nglyphs
> 1 && i
> 0)
17692 row
->ends_in_middle_of_char_p
= 1;
17693 it
->starts_in_middle_of_char_p
= 1;
17696 /* Restore the height to what it was before the
17697 element not fitting on the line. */
17698 it
->max_ascent
= ascent
;
17699 it
->max_descent
= descent
;
17700 it
->max_phys_ascent
= phys_ascent
;
17701 it
->max_phys_descent
= phys_descent
;
17706 else if (new_x
> it
->first_visible_x
)
17708 /* Increment number of glyphs actually displayed. */
17711 /* Record the maximum and minimum buffer positions
17712 seen so far in glyphs that will be displayed by
17715 RECORD_MAX_MIN_POS (it
);
17717 if (x
< it
->first_visible_x
)
17718 /* Glyph is partially visible, i.e. row starts at
17719 negative X position. */
17720 row
->x
= x
- it
->first_visible_x
;
17724 /* Glyph is completely off the left margin of the
17725 window. This should not happen because of the
17726 move_it_in_display_line at the start of this
17727 function, unless the text display area of the
17728 window is empty. */
17729 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17733 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17734 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17735 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17736 row
->phys_height
= max (row
->phys_height
,
17737 it
->max_phys_ascent
+ it
->max_phys_descent
);
17738 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17739 it
->max_extra_line_spacing
);
17741 /* End of this display line if row is continued. */
17742 if (row
->continued_p
|| row
->ends_at_zv_p
)
17747 /* Is this a line end? If yes, we're also done, after making
17748 sure that a non-default face is extended up to the right
17749 margin of the window. */
17750 if (ITERATOR_AT_END_OF_LINE_P (it
))
17752 int used_before
= row
->used
[TEXT_AREA
];
17754 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17756 /* Add a space at the end of the line that is used to
17757 display the cursor there. */
17758 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17759 append_space_for_newline (it
, 0);
17761 /* Extend the face to the end of the line. */
17762 extend_face_to_end_of_line (it
);
17764 /* Make sure we have the position. */
17765 if (used_before
== 0)
17766 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17768 /* Record the position of the newline, for use in
17770 it
->eol_pos
= it
->current
.pos
;
17772 /* Consume the line end. This skips over invisible lines. */
17773 set_iterator_to_next (it
, 1);
17774 it
->continuation_lines_width
= 0;
17778 /* Proceed with next display element. Note that this skips
17779 over lines invisible because of selective display. */
17780 set_iterator_to_next (it
, 1);
17782 /* If we truncate lines, we are done when the last displayed
17783 glyphs reach past the right margin of the window. */
17784 if (it
->line_wrap
== TRUNCATE
17785 && (FRAME_WINDOW_P (it
->f
)
17786 ? (it
->current_x
>= it
->last_visible_x
)
17787 : (it
->current_x
> it
->last_visible_x
)))
17789 /* Maybe add truncation glyphs. */
17790 if (!FRAME_WINDOW_P (it
->f
))
17794 if (!row
->reversed_p
)
17796 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17797 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17802 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17803 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17805 /* Remove any padding glyphs at the front of ROW, to
17806 make room for the truncation glyphs we will be
17807 adding below. The loop below always inserts at
17808 least one truncation glyph, so also remove the
17809 last glyph added to ROW. */
17810 unproduce_glyphs (it
, i
+ 1);
17811 /* Adjust i for the loop below. */
17812 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17815 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17817 row
->used
[TEXT_AREA
] = i
;
17818 produce_special_glyphs (it
, IT_TRUNCATION
);
17821 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17823 /* Don't truncate if we can overflow newline into fringe. */
17824 if (!get_next_display_element (it
))
17826 it
->continuation_lines_width
= 0;
17827 row
->ends_at_zv_p
= 1;
17828 row
->exact_window_width_line_p
= 1;
17831 if (ITERATOR_AT_END_OF_LINE_P (it
))
17833 row
->exact_window_width_line_p
= 1;
17834 goto at_end_of_line
;
17838 row
->truncated_on_right_p
= 1;
17839 it
->continuation_lines_width
= 0;
17840 reseat_at_next_visible_line_start (it
, 0);
17841 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17842 it
->hpos
= hpos_before
;
17843 it
->current_x
= x_before
;
17848 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17849 at the left window margin. */
17850 if (it
->first_visible_x
17851 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17853 if (!FRAME_WINDOW_P (it
->f
))
17854 insert_left_trunc_glyphs (it
);
17855 row
->truncated_on_left_p
= 1;
17858 /* If the start of this line is the overlay arrow-position, then
17859 mark this glyph row as the one containing the overlay arrow.
17860 This is clearly a mess with variable size fonts. It would be
17861 better to let it be displayed like cursors under X. */
17862 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17863 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17864 !NILP (overlay_arrow_string
)))
17866 /* Overlay arrow in window redisplay is a fringe bitmap. */
17867 if (STRINGP (overlay_arrow_string
))
17869 struct glyph_row
*arrow_row
17870 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17871 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17872 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17873 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17874 struct glyph
*p2
, *end
;
17876 /* Copy the arrow glyphs. */
17877 while (glyph
< arrow_end
)
17880 /* Throw away padding glyphs. */
17882 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17883 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17889 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17894 xassert (INTEGERP (overlay_arrow_string
));
17895 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17897 overlay_arrow_seen
= 1;
17900 /* Compute pixel dimensions of this line. */
17901 compute_line_metrics (it
);
17903 /* Remember the position at which this line ends. */
17904 row
->end
= it
->current
;
17907 row
->minpos
= row
->start
.pos
;
17908 row
->maxpos
= row
->end
.pos
;
17912 /* ROW->minpos and ROW->maxpos must be the smallest and
17913 `1 + the largest' buffer positions in ROW. But if ROW was
17914 bidi-reordered, these two positions can be anywhere in the
17915 row, so we must determine them now. */
17916 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17919 /* Record whether this row ends inside an ellipsis. */
17920 row
->ends_in_ellipsis_p
17921 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17922 && it
->ellipsis_p
);
17924 /* Save fringe bitmaps in this row. */
17925 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17926 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17927 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17928 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17930 it
->left_user_fringe_bitmap
= 0;
17931 it
->left_user_fringe_face_id
= 0;
17932 it
->right_user_fringe_bitmap
= 0;
17933 it
->right_user_fringe_face_id
= 0;
17935 /* Maybe set the cursor. */
17936 cvpos
= it
->w
->cursor
.vpos
;
17938 /* In bidi-reordered rows, keep checking for proper cursor
17939 position even if one has been found already, because buffer
17940 positions in such rows change non-linearly with ROW->VPOS,
17941 when a line is continued. One exception: when we are at ZV,
17942 display cursor on the first suitable glyph row, since all
17943 the empty rows after that also have their position set to ZV. */
17944 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17945 lines' rows is implemented for bidi-reordered rows. */
17947 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17948 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17949 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17950 && cursor_row_p (it
->w
, row
))
17951 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17953 /* Highlight trailing whitespace. */
17954 if (!NILP (Vshow_trailing_whitespace
))
17955 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17957 /* Prepare for the next line. This line starts horizontally at (X
17958 HPOS) = (0 0). Vertical positions are incremented. As a
17959 convenience for the caller, IT->glyph_row is set to the next
17961 it
->current_x
= it
->hpos
= 0;
17962 it
->current_y
+= row
->height
;
17963 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17966 /* The next row should by default use the same value of the
17967 reversed_p flag as this one. set_iterator_to_next decides when
17968 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17969 the flag accordingly. */
17970 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17971 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17972 it
->start
= row
->end
;
17973 return row
->displays_text_p
;
17975 #undef RECORD_MAX_MIN_POS
17978 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17979 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17980 doc
: /* Return paragraph direction at point in BUFFER.
17981 Value is either `left-to-right' or `right-to-left'.
17982 If BUFFER is omitted or nil, it defaults to the current buffer.
17984 Paragraph direction determines how the text in the paragraph is displayed.
17985 In left-to-right paragraphs, text begins at the left margin of the window
17986 and the reading direction is generally left to right. In right-to-left
17987 paragraphs, text begins at the right margin and is read from right to left.
17989 See also `bidi-paragraph-direction'. */)
17991 Lisp_Object buffer
;
17993 struct buffer
*buf
;
17994 struct buffer
*old
;
17997 buf
= current_buffer
;
18000 CHECK_BUFFER (buffer
);
18001 buf
= XBUFFER (buffer
);
18002 old
= current_buffer
;
18005 if (NILP (buf
->bidi_display_reordering
))
18006 return Qleft_to_right
;
18007 else if (!NILP (buf
->bidi_paragraph_direction
))
18008 return buf
->bidi_paragraph_direction
;
18011 /* Determine the direction from buffer text. We could try to
18012 use current_matrix if it is up to date, but this seems fast
18013 enough as it is. */
18014 struct bidi_it itb
;
18015 EMACS_INT pos
= BUF_PT (buf
);
18016 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18018 if (buf
!= current_buffer
)
18019 set_buffer_temp (buf
);
18020 /* Find previous non-empty line. */
18021 if (pos
>= ZV
&& pos
> BEGV
)
18024 bytepos
= CHAR_TO_BYTE (pos
);
18026 while (FETCH_BYTE (bytepos
) == '\n')
18028 if (bytepos
<= BEGV_BYTE
)
18033 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18036 itb
.bytepos
= bytepos
;
18039 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
18040 if (buf
!= current_buffer
)
18041 set_buffer_temp (old
);
18042 switch (itb
.paragraph_dir
)
18045 return Qleft_to_right
;
18048 return Qright_to_left
;
18058 /***********************************************************************
18060 ***********************************************************************/
18062 /* Redisplay the menu bar in the frame for window W.
18064 The menu bar of X frames that don't have X toolkit support is
18065 displayed in a special window W->frame->menu_bar_window.
18067 The menu bar of terminal frames is treated specially as far as
18068 glyph matrices are concerned. Menu bar lines are not part of
18069 windows, so the update is done directly on the frame matrix rows
18070 for the menu bar. */
18073 display_menu_bar (struct window
*w
)
18075 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18080 /* Don't do all this for graphical frames. */
18082 if (FRAME_W32_P (f
))
18085 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18091 if (FRAME_NS_P (f
))
18093 #endif /* HAVE_NS */
18095 #ifdef USE_X_TOOLKIT
18096 xassert (!FRAME_WINDOW_P (f
));
18097 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18098 it
.first_visible_x
= 0;
18099 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18100 #else /* not USE_X_TOOLKIT */
18101 if (FRAME_WINDOW_P (f
))
18103 /* Menu bar lines are displayed in the desired matrix of the
18104 dummy window menu_bar_window. */
18105 struct window
*menu_w
;
18106 xassert (WINDOWP (f
->menu_bar_window
));
18107 menu_w
= XWINDOW (f
->menu_bar_window
);
18108 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18110 it
.first_visible_x
= 0;
18111 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18115 /* This is a TTY frame, i.e. character hpos/vpos are used as
18117 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18119 it
.first_visible_x
= 0;
18120 it
.last_visible_x
= FRAME_COLS (f
);
18122 #endif /* not USE_X_TOOLKIT */
18124 if (! mode_line_inverse_video
)
18125 /* Force the menu-bar to be displayed in the default face. */
18126 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18128 /* Clear all rows of the menu bar. */
18129 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18131 struct glyph_row
*row
= it
.glyph_row
+ i
;
18132 clear_glyph_row (row
);
18133 row
->enabled_p
= 1;
18134 row
->full_width_p
= 1;
18137 /* Display all items of the menu bar. */
18138 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18139 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18141 Lisp_Object string
;
18143 /* Stop at nil string. */
18144 string
= AREF (items
, i
+ 1);
18148 /* Remember where item was displayed. */
18149 ASET (items
, i
+ 3, make_number (it
.hpos
));
18151 /* Display the item, pad with one space. */
18152 if (it
.current_x
< it
.last_visible_x
)
18153 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18154 SCHARS (string
) + 1, 0, 0, -1);
18157 /* Fill out the line with spaces. */
18158 if (it
.current_x
< it
.last_visible_x
)
18159 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18161 /* Compute the total height of the lines. */
18162 compute_line_metrics (&it
);
18167 /***********************************************************************
18169 ***********************************************************************/
18171 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18172 FORCE is non-zero, redisplay mode lines unconditionally.
18173 Otherwise, redisplay only mode lines that are garbaged. Value is
18174 the number of windows whose mode lines were redisplayed. */
18177 redisplay_mode_lines (Lisp_Object window
, int force
)
18181 while (!NILP (window
))
18183 struct window
*w
= XWINDOW (window
);
18185 if (WINDOWP (w
->hchild
))
18186 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18187 else if (WINDOWP (w
->vchild
))
18188 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18190 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18191 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18193 struct text_pos lpoint
;
18194 struct buffer
*old
= current_buffer
;
18196 /* Set the window's buffer for the mode line display. */
18197 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18198 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18200 /* Point refers normally to the selected window. For any
18201 other window, set up appropriate value. */
18202 if (!EQ (window
, selected_window
))
18204 struct text_pos pt
;
18206 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18207 if (CHARPOS (pt
) < BEGV
)
18208 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18209 else if (CHARPOS (pt
) > (ZV
- 1))
18210 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18212 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18215 /* Display mode lines. */
18216 clear_glyph_matrix (w
->desired_matrix
);
18217 if (display_mode_lines (w
))
18220 w
->must_be_updated_p
= 1;
18223 /* Restore old settings. */
18224 set_buffer_internal_1 (old
);
18225 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18235 /* Display the mode and/or header line of window W. Value is the
18236 sum number of mode lines and header lines displayed. */
18239 display_mode_lines (struct window
*w
)
18241 Lisp_Object old_selected_window
, old_selected_frame
;
18244 old_selected_frame
= selected_frame
;
18245 selected_frame
= w
->frame
;
18246 old_selected_window
= selected_window
;
18247 XSETWINDOW (selected_window
, w
);
18249 /* These will be set while the mode line specs are processed. */
18250 line_number_displayed
= 0;
18251 w
->column_number_displayed
= Qnil
;
18253 if (WINDOW_WANTS_MODELINE_P (w
))
18255 struct window
*sel_w
= XWINDOW (old_selected_window
);
18257 /* Select mode line face based on the real selected window. */
18258 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18259 current_buffer
->mode_line_format
);
18263 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18265 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18266 current_buffer
->header_line_format
);
18270 selected_frame
= old_selected_frame
;
18271 selected_window
= old_selected_window
;
18276 /* Display mode or header line of window W. FACE_ID specifies which
18277 line to display; it is either MODE_LINE_FACE_ID or
18278 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18279 display. Value is the pixel height of the mode/header line
18283 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18287 int count
= SPECPDL_INDEX ();
18289 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18290 /* Don't extend on a previously drawn mode-line.
18291 This may happen if called from pos_visible_p. */
18292 it
.glyph_row
->enabled_p
= 0;
18293 prepare_desired_row (it
.glyph_row
);
18295 it
.glyph_row
->mode_line_p
= 1;
18297 if (! mode_line_inverse_video
)
18298 /* Force the mode-line to be displayed in the default face. */
18299 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18301 record_unwind_protect (unwind_format_mode_line
,
18302 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18304 mode_line_target
= MODE_LINE_DISPLAY
;
18306 /* Temporarily make frame's keyboard the current kboard so that
18307 kboard-local variables in the mode_line_format will get the right
18309 push_kboard (FRAME_KBOARD (it
.f
));
18310 record_unwind_save_match_data ();
18311 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18314 unbind_to (count
, Qnil
);
18316 /* Fill up with spaces. */
18317 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18319 compute_line_metrics (&it
);
18320 it
.glyph_row
->full_width_p
= 1;
18321 it
.glyph_row
->continued_p
= 0;
18322 it
.glyph_row
->truncated_on_left_p
= 0;
18323 it
.glyph_row
->truncated_on_right_p
= 0;
18325 /* Make a 3D mode-line have a shadow at its right end. */
18326 face
= FACE_FROM_ID (it
.f
, face_id
);
18327 extend_face_to_end_of_line (&it
);
18328 if (face
->box
!= FACE_NO_BOX
)
18330 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18331 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18332 last
->right_box_line_p
= 1;
18335 return it
.glyph_row
->height
;
18338 /* Move element ELT in LIST to the front of LIST.
18339 Return the updated list. */
18342 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18344 register Lisp_Object tail
, prev
;
18345 register Lisp_Object tem
;
18349 while (CONSP (tail
))
18355 /* Splice out the link TAIL. */
18357 list
= XCDR (tail
);
18359 Fsetcdr (prev
, XCDR (tail
));
18361 /* Now make it the first. */
18362 Fsetcdr (tail
, list
);
18367 tail
= XCDR (tail
);
18371 /* Not found--return unchanged LIST. */
18375 /* Contribute ELT to the mode line for window IT->w. How it
18376 translates into text depends on its data type.
18378 IT describes the display environment in which we display, as usual.
18380 DEPTH is the depth in recursion. It is used to prevent
18381 infinite recursion here.
18383 FIELD_WIDTH is the number of characters the display of ELT should
18384 occupy in the mode line, and PRECISION is the maximum number of
18385 characters to display from ELT's representation. See
18386 display_string for details.
18388 Returns the hpos of the end of the text generated by ELT.
18390 PROPS is a property list to add to any string we encounter.
18392 If RISKY is nonzero, remove (disregard) any properties in any string
18393 we encounter, and ignore :eval and :propertize.
18395 The global variable `mode_line_target' determines whether the
18396 output is passed to `store_mode_line_noprop',
18397 `store_mode_line_string', or `display_string'. */
18400 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18401 Lisp_Object elt
, Lisp_Object props
, int risky
)
18403 int n
= 0, field
, prec
;
18408 elt
= build_string ("*too-deep*");
18412 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18416 /* A string: output it and check for %-constructs within it. */
18420 if (SCHARS (elt
) > 0
18421 && (!NILP (props
) || risky
))
18423 Lisp_Object oprops
, aelt
;
18424 oprops
= Ftext_properties_at (make_number (0), elt
);
18426 /* If the starting string's properties are not what
18427 we want, translate the string. Also, if the string
18428 is risky, do that anyway. */
18430 if (NILP (Fequal (props
, oprops
)) || risky
)
18432 /* If the starting string has properties,
18433 merge the specified ones onto the existing ones. */
18434 if (! NILP (oprops
) && !risky
)
18438 oprops
= Fcopy_sequence (oprops
);
18440 while (CONSP (tem
))
18442 oprops
= Fplist_put (oprops
, XCAR (tem
),
18443 XCAR (XCDR (tem
)));
18444 tem
= XCDR (XCDR (tem
));
18449 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18450 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18452 /* AELT is what we want. Move it to the front
18453 without consing. */
18455 mode_line_proptrans_alist
18456 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18462 /* If AELT has the wrong props, it is useless.
18463 so get rid of it. */
18465 mode_line_proptrans_alist
18466 = Fdelq (aelt
, mode_line_proptrans_alist
);
18468 elt
= Fcopy_sequence (elt
);
18469 Fset_text_properties (make_number (0), Flength (elt
),
18471 /* Add this item to mode_line_proptrans_alist. */
18472 mode_line_proptrans_alist
18473 = Fcons (Fcons (elt
, props
),
18474 mode_line_proptrans_alist
);
18475 /* Truncate mode_line_proptrans_alist
18476 to at most 50 elements. */
18477 tem
= Fnthcdr (make_number (50),
18478 mode_line_proptrans_alist
);
18480 XSETCDR (tem
, Qnil
);
18489 prec
= precision
- n
;
18490 switch (mode_line_target
)
18492 case MODE_LINE_NOPROP
:
18493 case MODE_LINE_TITLE
:
18494 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18496 case MODE_LINE_STRING
:
18497 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18499 case MODE_LINE_DISPLAY
:
18500 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18501 0, prec
, 0, STRING_MULTIBYTE (elt
));
18508 /* Handle the non-literal case. */
18510 while ((precision
<= 0 || n
< precision
)
18511 && SREF (elt
, offset
) != 0
18512 && (mode_line_target
!= MODE_LINE_DISPLAY
18513 || it
->current_x
< it
->last_visible_x
))
18515 int last_offset
= offset
;
18517 /* Advance to end of string or next format specifier. */
18518 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18521 if (offset
- 1 != last_offset
)
18523 int nchars
, nbytes
;
18525 /* Output to end of string or up to '%'. Field width
18526 is length of string. Don't output more than
18527 PRECISION allows us. */
18530 prec
= c_string_width (SDATA (elt
) + last_offset
,
18531 offset
- last_offset
, precision
- n
,
18534 switch (mode_line_target
)
18536 case MODE_LINE_NOPROP
:
18537 case MODE_LINE_TITLE
:
18538 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18540 case MODE_LINE_STRING
:
18542 int bytepos
= last_offset
;
18543 int charpos
= string_byte_to_char (elt
, bytepos
);
18544 int endpos
= (precision
<= 0
18545 ? string_byte_to_char (elt
, offset
)
18546 : charpos
+ nchars
);
18548 n
+= store_mode_line_string (NULL
,
18549 Fsubstring (elt
, make_number (charpos
),
18550 make_number (endpos
)),
18554 case MODE_LINE_DISPLAY
:
18556 int bytepos
= last_offset
;
18557 int charpos
= string_byte_to_char (elt
, bytepos
);
18559 if (precision
<= 0)
18560 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18561 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18563 STRING_MULTIBYTE (elt
));
18568 else /* c == '%' */
18570 int percent_position
= offset
;
18572 /* Get the specified minimum width. Zero means
18575 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18576 field
= field
* 10 + c
- '0';
18578 /* Don't pad beyond the total padding allowed. */
18579 if (field_width
- n
> 0 && field
> field_width
- n
)
18580 field
= field_width
- n
;
18582 /* Note that either PRECISION <= 0 or N < PRECISION. */
18583 prec
= precision
- n
;
18586 n
+= display_mode_element (it
, depth
, field
, prec
,
18587 Vglobal_mode_string
, props
,
18592 int bytepos
, charpos
;
18593 unsigned char *spec
;
18594 Lisp_Object string
;
18596 bytepos
= percent_position
;
18597 charpos
= (STRING_MULTIBYTE (elt
)
18598 ? string_byte_to_char (elt
, bytepos
)
18600 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18601 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18603 switch (mode_line_target
)
18605 case MODE_LINE_NOPROP
:
18606 case MODE_LINE_TITLE
:
18607 n
+= store_mode_line_noprop (spec
, field
, prec
);
18609 case MODE_LINE_STRING
:
18611 int len
= strlen (spec
);
18612 Lisp_Object tem
= make_string (spec
, len
);
18613 props
= Ftext_properties_at (make_number (charpos
), elt
);
18614 /* Should only keep face property in props */
18615 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18618 case MODE_LINE_DISPLAY
:
18620 int nglyphs_before
, nwritten
;
18622 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18623 nwritten
= display_string (spec
, string
, elt
,
18628 /* Assign to the glyphs written above the
18629 string where the `%x' came from, position
18633 struct glyph
*glyph
18634 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18638 for (i
= 0; i
< nwritten
; ++i
)
18640 glyph
[i
].object
= elt
;
18641 glyph
[i
].charpos
= charpos
;
18658 /* A symbol: process the value of the symbol recursively
18659 as if it appeared here directly. Avoid error if symbol void.
18660 Special case: if value of symbol is a string, output the string
18663 register Lisp_Object tem
;
18665 /* If the variable is not marked as risky to set
18666 then its contents are risky to use. */
18667 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18670 tem
= Fboundp (elt
);
18673 tem
= Fsymbol_value (elt
);
18674 /* If value is a string, output that string literally:
18675 don't check for % within it. */
18679 if (!EQ (tem
, elt
))
18681 /* Give up right away for nil or t. */
18691 register Lisp_Object car
, tem
;
18693 /* A cons cell: five distinct cases.
18694 If first element is :eval or :propertize, do something special.
18695 If first element is a string or a cons, process all the elements
18696 and effectively concatenate them.
18697 If first element is a negative number, truncate displaying cdr to
18698 at most that many characters. If positive, pad (with spaces)
18699 to at least that many characters.
18700 If first element is a symbol, process the cadr or caddr recursively
18701 according to whether the symbol's value is non-nil or nil. */
18703 if (EQ (car
, QCeval
))
18705 /* An element of the form (:eval FORM) means evaluate FORM
18706 and use the result as mode line elements. */
18711 if (CONSP (XCDR (elt
)))
18714 spec
= safe_eval (XCAR (XCDR (elt
)));
18715 n
+= display_mode_element (it
, depth
, field_width
- n
,
18716 precision
- n
, spec
, props
,
18720 else if (EQ (car
, QCpropertize
))
18722 /* An element of the form (:propertize ELT PROPS...)
18723 means display ELT but applying properties PROPS. */
18728 if (CONSP (XCDR (elt
)))
18729 n
+= display_mode_element (it
, depth
, field_width
- n
,
18730 precision
- n
, XCAR (XCDR (elt
)),
18731 XCDR (XCDR (elt
)), risky
);
18733 else if (SYMBOLP (car
))
18735 tem
= Fboundp (car
);
18739 /* elt is now the cdr, and we know it is a cons cell.
18740 Use its car if CAR has a non-nil value. */
18743 tem
= Fsymbol_value (car
);
18750 /* Symbol's value is nil (or symbol is unbound)
18751 Get the cddr of the original list
18752 and if possible find the caddr and use that. */
18756 else if (!CONSP (elt
))
18761 else if (INTEGERP (car
))
18763 register int lim
= XINT (car
);
18767 /* Negative int means reduce maximum width. */
18768 if (precision
<= 0)
18771 precision
= min (precision
, -lim
);
18775 /* Padding specified. Don't let it be more than
18776 current maximum. */
18778 lim
= min (precision
, lim
);
18780 /* If that's more padding than already wanted, queue it.
18781 But don't reduce padding already specified even if
18782 that is beyond the current truncation point. */
18783 field_width
= max (lim
, field_width
);
18787 else if (STRINGP (car
) || CONSP (car
))
18789 Lisp_Object halftail
= elt
;
18793 && (precision
<= 0 || n
< precision
))
18795 n
+= display_mode_element (it
, depth
,
18796 /* Do padding only after the last
18797 element in the list. */
18798 (! CONSP (XCDR (elt
))
18801 precision
- n
, XCAR (elt
),
18805 if ((len
& 1) == 0)
18806 halftail
= XCDR (halftail
);
18807 /* Check for cycle. */
18808 if (EQ (halftail
, elt
))
18817 elt
= build_string ("*invalid*");
18821 /* Pad to FIELD_WIDTH. */
18822 if (field_width
> 0 && n
< field_width
)
18824 switch (mode_line_target
)
18826 case MODE_LINE_NOPROP
:
18827 case MODE_LINE_TITLE
:
18828 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18830 case MODE_LINE_STRING
:
18831 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18833 case MODE_LINE_DISPLAY
:
18834 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18843 /* Store a mode-line string element in mode_line_string_list.
18845 If STRING is non-null, display that C string. Otherwise, the Lisp
18846 string LISP_STRING is displayed.
18848 FIELD_WIDTH is the minimum number of output glyphs to produce.
18849 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18850 with spaces. FIELD_WIDTH <= 0 means don't pad.
18852 PRECISION is the maximum number of characters to output from
18853 STRING. PRECISION <= 0 means don't truncate the string.
18855 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18856 properties to the string.
18858 PROPS are the properties to add to the string.
18859 The mode_line_string_face face property is always added to the string.
18863 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18864 int field_width
, int precision
, Lisp_Object props
)
18869 if (string
!= NULL
)
18871 len
= strlen (string
);
18872 if (precision
> 0 && len
> precision
)
18874 lisp_string
= make_string (string
, len
);
18876 props
= mode_line_string_face_prop
;
18877 else if (!NILP (mode_line_string_face
))
18879 Lisp_Object face
= Fplist_get (props
, Qface
);
18880 props
= Fcopy_sequence (props
);
18882 face
= mode_line_string_face
;
18884 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18885 props
= Fplist_put (props
, Qface
, face
);
18887 Fadd_text_properties (make_number (0), make_number (len
),
18888 props
, lisp_string
);
18892 len
= XFASTINT (Flength (lisp_string
));
18893 if (precision
> 0 && len
> precision
)
18896 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18899 if (!NILP (mode_line_string_face
))
18903 props
= Ftext_properties_at (make_number (0), lisp_string
);
18904 face
= Fplist_get (props
, Qface
);
18906 face
= mode_line_string_face
;
18908 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18909 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18911 lisp_string
= Fcopy_sequence (lisp_string
);
18914 Fadd_text_properties (make_number (0), make_number (len
),
18915 props
, lisp_string
);
18920 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18924 if (field_width
> len
)
18926 field_width
-= len
;
18927 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18929 Fadd_text_properties (make_number (0), make_number (field_width
),
18930 props
, lisp_string
);
18931 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18939 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18941 doc
: /* Format a string out of a mode line format specification.
18942 First arg FORMAT specifies the mode line format (see `mode-line-format'
18943 for details) to use.
18945 Optional second arg FACE specifies the face property to put
18946 on all characters for which no face is specified.
18947 The value t means whatever face the window's mode line currently uses
18948 \(either `mode-line' or `mode-line-inactive', depending).
18949 A value of nil means the default is no face property.
18950 If FACE is an integer, the value string has no text properties.
18952 Optional third and fourth args WINDOW and BUFFER specify the window
18953 and buffer to use as the context for the formatting (defaults
18954 are the selected window and the window's buffer). */)
18955 (format
, face
, window
, buffer
)
18956 Lisp_Object format
, face
, window
, buffer
;
18961 struct buffer
*old_buffer
= NULL
;
18963 int no_props
= INTEGERP (face
);
18964 int count
= SPECPDL_INDEX ();
18966 int string_start
= 0;
18969 window
= selected_window
;
18970 CHECK_WINDOW (window
);
18971 w
= XWINDOW (window
);
18974 buffer
= w
->buffer
;
18975 CHECK_BUFFER (buffer
);
18977 /* Make formatting the modeline a non-op when noninteractive, otherwise
18978 there will be problems later caused by a partially initialized frame. */
18979 if (NILP (format
) || noninteractive
)
18980 return empty_unibyte_string
;
18988 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18989 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18993 face_id
= DEFAULT_FACE_ID
;
18995 if (XBUFFER (buffer
) != current_buffer
)
18996 old_buffer
= current_buffer
;
18998 /* Save things including mode_line_proptrans_alist,
18999 and set that to nil so that we don't alter the outer value. */
19000 record_unwind_protect (unwind_format_mode_line
,
19001 format_mode_line_unwind_data
19002 (old_buffer
, selected_window
, 1));
19003 mode_line_proptrans_alist
= Qnil
;
19005 Fselect_window (window
, Qt
);
19007 set_buffer_internal_1 (XBUFFER (buffer
));
19009 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19013 mode_line_target
= MODE_LINE_NOPROP
;
19014 mode_line_string_face_prop
= Qnil
;
19015 mode_line_string_list
= Qnil
;
19016 string_start
= MODE_LINE_NOPROP_LEN (0);
19020 mode_line_target
= MODE_LINE_STRING
;
19021 mode_line_string_list
= Qnil
;
19022 mode_line_string_face
= face
;
19023 mode_line_string_face_prop
19024 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19027 push_kboard (FRAME_KBOARD (it
.f
));
19028 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19033 len
= MODE_LINE_NOPROP_LEN (string_start
);
19034 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19038 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19039 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19040 empty_unibyte_string
);
19043 unbind_to (count
, Qnil
);
19047 /* Write a null-terminated, right justified decimal representation of
19048 the positive integer D to BUF using a minimal field width WIDTH. */
19051 pint2str (register char *buf
, register int width
, register int d
)
19053 register char *p
= buf
;
19061 *p
++ = d
% 10 + '0';
19066 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19077 /* Write a null-terminated, right justified decimal and "human
19078 readable" representation of the nonnegative integer D to BUF using
19079 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19081 static const char power_letter
[] =
19095 pint2hrstr (char *buf
, int width
, int d
)
19097 /* We aim to represent the nonnegative integer D as
19098 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19101 /* -1 means: do not use TENTHS. */
19105 /* Length of QUOTIENT.TENTHS as a string. */
19111 if (1000 <= quotient
)
19113 /* Scale to the appropriate EXPONENT. */
19116 remainder
= quotient
% 1000;
19120 while (1000 <= quotient
);
19122 /* Round to nearest and decide whether to use TENTHS or not. */
19125 tenths
= remainder
/ 100;
19126 if (50 <= remainder
% 100)
19133 if (quotient
== 10)
19141 if (500 <= remainder
)
19143 if (quotient
< 999)
19154 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19155 if (tenths
== -1 && quotient
<= 99)
19162 p
= psuffix
= buf
+ max (width
, length
);
19164 /* Print EXPONENT. */
19166 *psuffix
++ = power_letter
[exponent
];
19169 /* Print TENTHS. */
19172 *--p
= '0' + tenths
;
19176 /* Print QUOTIENT. */
19179 int digit
= quotient
% 10;
19180 *--p
= '0' + digit
;
19182 while ((quotient
/= 10) != 0);
19184 /* Print leading spaces. */
19189 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19190 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19191 type of CODING_SYSTEM. Return updated pointer into BUF. */
19193 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19196 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19199 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19200 const unsigned char *eol_str
;
19202 /* The EOL conversion we are using. */
19203 Lisp_Object eoltype
;
19205 val
= CODING_SYSTEM_SPEC (coding_system
);
19208 if (!VECTORP (val
)) /* Not yet decided. */
19213 eoltype
= eol_mnemonic_undecided
;
19214 /* Don't mention EOL conversion if it isn't decided. */
19219 Lisp_Object eolvalue
;
19221 attrs
= AREF (val
, 0);
19222 eolvalue
= AREF (val
, 2);
19225 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19229 /* The EOL conversion that is normal on this system. */
19231 if (NILP (eolvalue
)) /* Not yet decided. */
19232 eoltype
= eol_mnemonic_undecided
;
19233 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19234 eoltype
= eol_mnemonic_undecided
;
19235 else /* eolvalue is Qunix, Qdos, or Qmac. */
19236 eoltype
= (EQ (eolvalue
, Qunix
)
19237 ? eol_mnemonic_unix
19238 : (EQ (eolvalue
, Qdos
) == 1
19239 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19245 /* Mention the EOL conversion if it is not the usual one. */
19246 if (STRINGP (eoltype
))
19248 eol_str
= SDATA (eoltype
);
19249 eol_str_len
= SBYTES (eoltype
);
19251 else if (CHARACTERP (eoltype
))
19253 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19254 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19259 eol_str
= invalid_eol_type
;
19260 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19262 bcopy (eol_str
, buf
, eol_str_len
);
19263 buf
+= eol_str_len
;
19269 /* Return a string for the output of a mode line %-spec for window W,
19270 generated by character C. PRECISION >= 0 means don't return a
19271 string longer than that value. FIELD_WIDTH > 0 means pad the
19272 string returned with spaces to that value. Return a Lisp string in
19273 *STRING if the resulting string is taken from that Lisp string.
19275 Note we operate on the current buffer for most purposes,
19276 the exception being w->base_line_pos. */
19278 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19281 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19282 int precision
, Lisp_Object
*string
)
19285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19286 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19287 struct buffer
*b
= current_buffer
;
19295 if (!NILP (b
->read_only
))
19297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19302 /* This differs from %* only for a modified read-only buffer. */
19303 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19305 if (!NILP (b
->read_only
))
19310 /* This differs from %* in ignoring read-only-ness. */
19311 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
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
;
19337 if (command_loop_level
> 5)
19339 p
= decode_mode_spec_buf
;
19340 for (i
= 0; i
< command_loop_level
; i
++)
19343 return decode_mode_spec_buf
;
19350 /* Let lots_of_dashes be a string of infinite length. */
19351 if (mode_line_target
== MODE_LINE_NOPROP
||
19352 mode_line_target
== MODE_LINE_STRING
)
19354 if (field_width
<= 0
19355 || field_width
> sizeof (lots_of_dashes
))
19357 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19358 decode_mode_spec_buf
[i
] = '-';
19359 decode_mode_spec_buf
[i
] = '\0';
19360 return decode_mode_spec_buf
;
19363 return lots_of_dashes
;
19371 /* %c and %l are ignored in `frame-title-format'.
19372 (In redisplay_internal, the frame title is drawn _before_ the
19373 windows are updated, so the stuff which depends on actual
19374 window contents (such as %l) may fail to render properly, or
19375 even crash emacs.) */
19376 if (mode_line_target
== MODE_LINE_TITLE
)
19380 int col
= (int) current_column (); /* iftc */
19381 w
->column_number_displayed
= make_number (col
);
19382 pint2str (decode_mode_spec_buf
, field_width
, col
);
19383 return decode_mode_spec_buf
;
19387 #ifndef SYSTEM_MALLOC
19389 if (NILP (Vmemory_full
))
19392 return "!MEM FULL! ";
19399 /* %F displays the frame name. */
19400 if (!NILP (f
->title
))
19401 return (char *) SDATA (f
->title
);
19402 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19403 return (char *) SDATA (f
->name
);
19412 int size
= ZV
- BEGV
;
19413 pint2str (decode_mode_spec_buf
, field_width
, size
);
19414 return decode_mode_spec_buf
;
19419 int size
= ZV
- BEGV
;
19420 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19421 return decode_mode_spec_buf
;
19426 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19427 int topline
, nlines
, junk
, height
;
19429 /* %c and %l are ignored in `frame-title-format'. */
19430 if (mode_line_target
== MODE_LINE_TITLE
)
19433 startpos
= XMARKER (w
->start
)->charpos
;
19434 startpos_byte
= marker_byte_position (w
->start
);
19435 height
= WINDOW_TOTAL_LINES (w
);
19437 /* If we decided that this buffer isn't suitable for line numbers,
19438 don't forget that too fast. */
19439 if (EQ (w
->base_line_pos
, w
->buffer
))
19441 /* But do forget it, if the window shows a different buffer now. */
19442 else if (BUFFERP (w
->base_line_pos
))
19443 w
->base_line_pos
= Qnil
;
19445 /* If the buffer is very big, don't waste time. */
19446 if (INTEGERP (Vline_number_display_limit
)
19447 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19449 w
->base_line_pos
= Qnil
;
19450 w
->base_line_number
= Qnil
;
19454 if (INTEGERP (w
->base_line_number
)
19455 && INTEGERP (w
->base_line_pos
)
19456 && XFASTINT (w
->base_line_pos
) <= startpos
)
19458 line
= XFASTINT (w
->base_line_number
);
19459 linepos
= XFASTINT (w
->base_line_pos
);
19460 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19465 linepos
= BUF_BEGV (b
);
19466 linepos_byte
= BUF_BEGV_BYTE (b
);
19469 /* Count lines from base line to window start position. */
19470 nlines
= display_count_lines (linepos
, linepos_byte
,
19474 topline
= nlines
+ line
;
19476 /* Determine a new base line, if the old one is too close
19477 or too far away, or if we did not have one.
19478 "Too close" means it's plausible a scroll-down would
19479 go back past it. */
19480 if (startpos
== BUF_BEGV (b
))
19482 w
->base_line_number
= make_number (topline
);
19483 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19485 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19486 || linepos
== BUF_BEGV (b
))
19488 int limit
= BUF_BEGV (b
);
19489 int limit_byte
= BUF_BEGV_BYTE (b
);
19491 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19493 if (startpos
- distance
> limit
)
19495 limit
= startpos
- distance
;
19496 limit_byte
= CHAR_TO_BYTE (limit
);
19499 nlines
= display_count_lines (startpos
, startpos_byte
,
19501 - (height
* 2 + 30),
19503 /* If we couldn't find the lines we wanted within
19504 line_number_display_limit_width chars per line,
19505 give up on line numbers for this window. */
19506 if (position
== limit_byte
&& limit
== startpos
- distance
)
19508 w
->base_line_pos
= w
->buffer
;
19509 w
->base_line_number
= Qnil
;
19513 w
->base_line_number
= make_number (topline
- nlines
);
19514 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19517 /* Now count lines from the start pos to point. */
19518 nlines
= display_count_lines (startpos
, startpos_byte
,
19519 PT_BYTE
, PT
, &junk
);
19521 /* Record that we did display the line number. */
19522 line_number_displayed
= 1;
19524 /* Make the string to show. */
19525 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19526 return decode_mode_spec_buf
;
19529 char* p
= decode_mode_spec_buf
;
19530 int pad
= field_width
- 2;
19536 return decode_mode_spec_buf
;
19542 obj
= b
->mode_name
;
19546 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19552 int pos
= marker_position (w
->start
);
19553 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19555 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19557 if (pos
<= BUF_BEGV (b
))
19562 else if (pos
<= BUF_BEGV (b
))
19566 if (total
> 1000000)
19567 /* Do it differently for a large value, to avoid overflow. */
19568 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19570 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19571 /* We can't normally display a 3-digit number,
19572 so get us a 2-digit number that is close. */
19575 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19576 return decode_mode_spec_buf
;
19580 /* Display percentage of size above the bottom of the screen. */
19583 int toppos
= marker_position (w
->start
);
19584 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19585 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19587 if (botpos
>= BUF_ZV (b
))
19589 if (toppos
<= BUF_BEGV (b
))
19596 if (total
> 1000000)
19597 /* Do it differently for a large value, to avoid overflow. */
19598 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19600 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19601 /* We can't normally display a 3-digit number,
19602 so get us a 2-digit number that is close. */
19605 if (toppos
<= BUF_BEGV (b
))
19606 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19608 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19609 return decode_mode_spec_buf
;
19614 /* status of process */
19615 obj
= Fget_buffer_process (Fcurrent_buffer ());
19617 return "no process";
19618 #ifdef subprocesses
19619 obj
= Fsymbol_name (Fprocess_status (obj
));
19625 int count
= inhibit_garbage_collection ();
19626 Lisp_Object val
= call1 (intern ("file-remote-p"),
19627 current_buffer
->directory
);
19628 unbind_to (count
, Qnil
);
19636 case 't': /* indicate TEXT or BINARY */
19637 #ifdef MODE_LINE_BINARY_TEXT
19638 return MODE_LINE_BINARY_TEXT (b
);
19644 /* coding-system (not including end-of-line format) */
19646 /* coding-system (including end-of-line type) */
19648 int eol_flag
= (c
== 'Z');
19649 char *p
= decode_mode_spec_buf
;
19651 if (! FRAME_WINDOW_P (f
))
19653 /* No need to mention EOL here--the terminal never needs
19654 to do EOL conversion. */
19655 p
= decode_mode_spec_coding (CODING_ID_NAME
19656 (FRAME_KEYBOARD_CODING (f
)->id
),
19658 p
= decode_mode_spec_coding (CODING_ID_NAME
19659 (FRAME_TERMINAL_CODING (f
)->id
),
19662 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19665 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19666 #ifdef subprocesses
19667 obj
= Fget_buffer_process (Fcurrent_buffer ());
19668 if (PROCESSP (obj
))
19670 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19672 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19675 #endif /* subprocesses */
19678 return decode_mode_spec_buf
;
19685 return (char *) SDATA (obj
);
19692 /* Count up to COUNT lines starting from START / START_BYTE.
19693 But don't go beyond LIMIT_BYTE.
19694 Return the number of lines thus found (always nonnegative).
19696 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19699 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19702 register unsigned char *cursor
;
19703 unsigned char *base
;
19705 register int ceiling
;
19706 register unsigned char *ceiling_addr
;
19707 int orig_count
= count
;
19709 /* If we are not in selective display mode,
19710 check only for newlines. */
19711 int selective_display
= (!NILP (current_buffer
->selective_display
)
19712 && !INTEGERP (current_buffer
->selective_display
));
19716 while (start_byte
< limit_byte
)
19718 ceiling
= BUFFER_CEILING_OF (start_byte
);
19719 ceiling
= min (limit_byte
- 1, ceiling
);
19720 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19721 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19724 if (selective_display
)
19725 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19728 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19731 if (cursor
!= ceiling_addr
)
19735 start_byte
+= cursor
- base
+ 1;
19736 *byte_pos_ptr
= start_byte
;
19740 if (++cursor
== ceiling_addr
)
19746 start_byte
+= cursor
- base
;
19751 while (start_byte
> limit_byte
)
19753 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19754 ceiling
= max (limit_byte
, ceiling
);
19755 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19756 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19759 if (selective_display
)
19760 while (--cursor
!= ceiling_addr
19761 && *cursor
!= '\n' && *cursor
!= 015)
19764 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19767 if (cursor
!= ceiling_addr
)
19771 start_byte
+= cursor
- base
+ 1;
19772 *byte_pos_ptr
= start_byte
;
19773 /* When scanning backwards, we should
19774 not count the newline posterior to which we stop. */
19775 return - orig_count
- 1;
19781 /* Here we add 1 to compensate for the last decrement
19782 of CURSOR, which took it past the valid range. */
19783 start_byte
+= cursor
- base
+ 1;
19787 *byte_pos_ptr
= limit_byte
;
19790 return - orig_count
+ count
;
19791 return orig_count
- count
;
19797 /***********************************************************************
19799 ***********************************************************************/
19801 /* Display a NUL-terminated string, starting with index START.
19803 If STRING is non-null, display that C string. Otherwise, the Lisp
19804 string LISP_STRING is displayed. There's a case that STRING is
19805 non-null and LISP_STRING is not nil. It means STRING is a string
19806 data of LISP_STRING. In that case, we display LISP_STRING while
19807 ignoring its text properties.
19809 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19810 FACE_STRING. Display STRING or LISP_STRING with the face at
19811 FACE_STRING_POS in FACE_STRING:
19813 Display the string in the environment given by IT, but use the
19814 standard display table, temporarily.
19816 FIELD_WIDTH is the minimum number of output glyphs to produce.
19817 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19818 with spaces. If STRING has more characters, more than FIELD_WIDTH
19819 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19821 PRECISION is the maximum number of characters to output from
19822 STRING. PRECISION < 0 means don't truncate the string.
19824 This is roughly equivalent to printf format specifiers:
19826 FIELD_WIDTH PRECISION PRINTF
19827 ----------------------------------------
19833 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19834 display them, and < 0 means obey the current buffer's value of
19835 enable_multibyte_characters.
19837 Value is the number of columns displayed. */
19840 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19841 start
, it
, field_width
, precision
, max_x
, multibyte
)
19842 unsigned char *string
;
19843 Lisp_Object lisp_string
;
19844 Lisp_Object face_string
;
19845 EMACS_INT face_string_pos
;
19848 int field_width
, precision
, max_x
;
19851 int hpos_at_start
= it
->hpos
;
19852 int saved_face_id
= it
->face_id
;
19853 struct glyph_row
*row
= it
->glyph_row
;
19855 /* Initialize the iterator IT for iteration over STRING beginning
19856 with index START. */
19857 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19858 precision
, field_width
, multibyte
);
19859 if (string
&& STRINGP (lisp_string
))
19860 /* LISP_STRING is the one returned by decode_mode_spec. We should
19861 ignore its text properties. */
19862 it
->stop_charpos
= -1;
19864 /* If displaying STRING, set up the face of the iterator
19865 from LISP_STRING, if that's given. */
19866 if (STRINGP (face_string
))
19872 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19873 0, it
->region_beg_charpos
,
19874 it
->region_end_charpos
,
19875 &endptr
, it
->base_face_id
, 0);
19876 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19877 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19880 /* Set max_x to the maximum allowed X position. Don't let it go
19881 beyond the right edge of the window. */
19883 max_x
= it
->last_visible_x
;
19885 max_x
= min (max_x
, it
->last_visible_x
);
19887 /* Skip over display elements that are not visible. because IT->w is
19889 if (it
->current_x
< it
->first_visible_x
)
19890 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19891 MOVE_TO_POS
| MOVE_TO_X
);
19893 row
->ascent
= it
->max_ascent
;
19894 row
->height
= it
->max_ascent
+ it
->max_descent
;
19895 row
->phys_ascent
= it
->max_phys_ascent
;
19896 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19897 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19899 /* This condition is for the case that we are called with current_x
19900 past last_visible_x. */
19901 while (it
->current_x
< max_x
)
19903 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19905 /* Get the next display element. */
19906 if (!get_next_display_element (it
))
19909 /* Produce glyphs. */
19910 x_before
= it
->current_x
;
19911 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19912 PRODUCE_GLYPHS (it
);
19914 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19917 while (i
< nglyphs
)
19919 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19921 if (it
->line_wrap
!= TRUNCATE
19922 && x
+ glyph
->pixel_width
> max_x
)
19924 /* End of continued line or max_x reached. */
19925 if (CHAR_GLYPH_PADDING_P (*glyph
))
19927 /* A wide character is unbreakable. */
19928 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19929 it
->current_x
= x_before
;
19933 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19938 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19940 /* Glyph is at least partially visible. */
19942 if (x
< it
->first_visible_x
)
19943 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19947 /* Glyph is off the left margin of the display area.
19948 Should not happen. */
19952 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19953 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19954 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19955 row
->phys_height
= max (row
->phys_height
,
19956 it
->max_phys_ascent
+ it
->max_phys_descent
);
19957 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19958 it
->max_extra_line_spacing
);
19959 x
+= glyph
->pixel_width
;
19963 /* Stop if max_x reached. */
19967 /* Stop at line ends. */
19968 if (ITERATOR_AT_END_OF_LINE_P (it
))
19970 it
->continuation_lines_width
= 0;
19974 set_iterator_to_next (it
, 1);
19976 /* Stop if truncating at the right edge. */
19977 if (it
->line_wrap
== TRUNCATE
19978 && it
->current_x
>= it
->last_visible_x
)
19980 /* Add truncation mark, but don't do it if the line is
19981 truncated at a padding space. */
19982 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19984 if (!FRAME_WINDOW_P (it
->f
))
19988 if (it
->current_x
> it
->last_visible_x
)
19990 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19991 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19993 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19995 row
->used
[TEXT_AREA
] = i
;
19996 produce_special_glyphs (it
, IT_TRUNCATION
);
19999 produce_special_glyphs (it
, IT_TRUNCATION
);
20001 it
->glyph_row
->truncated_on_right_p
= 1;
20007 /* Maybe insert a truncation at the left. */
20008 if (it
->first_visible_x
20009 && IT_CHARPOS (*it
) > 0)
20011 if (!FRAME_WINDOW_P (it
->f
))
20012 insert_left_trunc_glyphs (it
);
20013 it
->glyph_row
->truncated_on_left_p
= 1;
20016 it
->face_id
= saved_face_id
;
20018 /* Value is number of columns displayed. */
20019 return it
->hpos
- hpos_at_start
;
20024 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20025 appears as an element of LIST or as the car of an element of LIST.
20026 If PROPVAL is a list, compare each element against LIST in that
20027 way, and return 1/2 if any element of PROPVAL is found in LIST.
20028 Otherwise return 0. This function cannot quit.
20029 The return value is 2 if the text is invisible but with an ellipsis
20030 and 1 if it's invisible and without an ellipsis. */
20033 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20035 register Lisp_Object tail
, proptail
;
20037 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20039 register Lisp_Object tem
;
20041 if (EQ (propval
, tem
))
20043 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20044 return NILP (XCDR (tem
)) ? 1 : 2;
20047 if (CONSP (propval
))
20049 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20051 Lisp_Object propelt
;
20052 propelt
= XCAR (proptail
);
20053 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20055 register Lisp_Object tem
;
20057 if (EQ (propelt
, tem
))
20059 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20060 return NILP (XCDR (tem
)) ? 1 : 2;
20068 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20069 doc
: /* Non-nil if the property makes the text invisible.
20070 POS-OR-PROP can be a marker or number, in which case it is taken to be
20071 a position in the current buffer and the value of the `invisible' property
20072 is checked; or it can be some other value, which is then presumed to be the
20073 value of the `invisible' property of the text of interest.
20074 The non-nil value returned can be t for truly invisible text or something
20075 else if the text is replaced by an ellipsis. */)
20077 Lisp_Object pos_or_prop
;
20080 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20081 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20083 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20084 return (invis
== 0 ? Qnil
20086 : make_number (invis
));
20089 /* Calculate a width or height in pixels from a specification using
20090 the following elements:
20093 NUM - a (fractional) multiple of the default font width/height
20094 (NUM) - specifies exactly NUM pixels
20095 UNIT - a fixed number of pixels, see below.
20096 ELEMENT - size of a display element in pixels, see below.
20097 (NUM . SPEC) - equals NUM * SPEC
20098 (+ SPEC SPEC ...) - add pixel values
20099 (- SPEC SPEC ...) - subtract pixel values
20100 (- SPEC) - negate pixel value
20103 INT or FLOAT - a number constant
20104 SYMBOL - use symbol's (buffer local) variable binding.
20107 in - pixels per inch *)
20108 mm - pixels per 1/1000 meter *)
20109 cm - pixels per 1/100 meter *)
20110 width - width of current font in pixels.
20111 height - height of current font in pixels.
20113 *) using the ratio(s) defined in display-pixels-per-inch.
20117 left-fringe - left fringe width in pixels
20118 right-fringe - right fringe width in pixels
20120 left-margin - left margin width in pixels
20121 right-margin - right margin width in pixels
20123 scroll-bar - scroll-bar area width in pixels
20127 Pixels corresponding to 5 inches:
20130 Total width of non-text areas on left side of window (if scroll-bar is on left):
20131 '(space :width (+ left-fringe left-margin scroll-bar))
20133 Align to first text column (in header line):
20134 '(space :align-to 0)
20136 Align to middle of text area minus half the width of variable `my-image'
20137 containing a loaded image:
20138 '(space :align-to (0.5 . (- text my-image)))
20140 Width of left margin minus width of 1 character in the default font:
20141 '(space :width (- left-margin 1))
20143 Width of left margin minus width of 2 characters in the current font:
20144 '(space :width (- left-margin (2 . width)))
20146 Center 1 character over left-margin (in header line):
20147 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20149 Different ways to express width of left fringe plus left margin minus one pixel:
20150 '(space :width (- (+ left-fringe left-margin) (1)))
20151 '(space :width (+ left-fringe left-margin (- (1))))
20152 '(space :width (+ left-fringe left-margin (-1)))
20156 #define NUMVAL(X) \
20157 ((INTEGERP (X) || FLOATP (X)) \
20162 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20163 struct font
*font
, int width_p
, int *align_to
)
20167 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20168 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20171 return OK_PIXELS (0);
20173 xassert (FRAME_LIVE_P (it
->f
));
20175 if (SYMBOLP (prop
))
20177 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20179 char *unit
= SDATA (SYMBOL_NAME (prop
));
20181 if (unit
[0] == 'i' && unit
[1] == 'n')
20183 else if (unit
[0] == 'm' && unit
[1] == 'm')
20185 else if (unit
[0] == 'c' && unit
[1] == 'm')
20192 #ifdef HAVE_WINDOW_SYSTEM
20193 if (FRAME_WINDOW_P (it
->f
)
20195 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20196 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20198 return OK_PIXELS (ppi
/ pixels
);
20201 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20202 || (CONSP (Vdisplay_pixels_per_inch
)
20204 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20205 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20207 return OK_PIXELS (ppi
/ pixels
);
20213 #ifdef HAVE_WINDOW_SYSTEM
20214 if (EQ (prop
, Qheight
))
20215 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20216 if (EQ (prop
, Qwidth
))
20217 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20219 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20220 return OK_PIXELS (1);
20223 if (EQ (prop
, Qtext
))
20224 return OK_PIXELS (width_p
20225 ? window_box_width (it
->w
, TEXT_AREA
)
20226 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20228 if (align_to
&& *align_to
< 0)
20231 if (EQ (prop
, Qleft
))
20232 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20233 if (EQ (prop
, Qright
))
20234 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20235 if (EQ (prop
, Qcenter
))
20236 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20237 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20238 if (EQ (prop
, Qleft_fringe
))
20239 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20240 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20241 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20242 if (EQ (prop
, Qright_fringe
))
20243 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20244 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20245 : window_box_right_offset (it
->w
, TEXT_AREA
));
20246 if (EQ (prop
, Qleft_margin
))
20247 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20248 if (EQ (prop
, Qright_margin
))
20249 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20250 if (EQ (prop
, Qscroll_bar
))
20251 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20253 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20254 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20255 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20260 if (EQ (prop
, Qleft_fringe
))
20261 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20262 if (EQ (prop
, Qright_fringe
))
20263 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20264 if (EQ (prop
, Qleft_margin
))
20265 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20266 if (EQ (prop
, Qright_margin
))
20267 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20268 if (EQ (prop
, Qscroll_bar
))
20269 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20272 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20275 if (INTEGERP (prop
) || FLOATP (prop
))
20277 int base_unit
= (width_p
20278 ? FRAME_COLUMN_WIDTH (it
->f
)
20279 : FRAME_LINE_HEIGHT (it
->f
));
20280 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20285 Lisp_Object car
= XCAR (prop
);
20286 Lisp_Object cdr
= XCDR (prop
);
20290 #ifdef HAVE_WINDOW_SYSTEM
20291 if (FRAME_WINDOW_P (it
->f
)
20292 && valid_image_p (prop
))
20294 int id
= lookup_image (it
->f
, prop
);
20295 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20297 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20300 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20306 while (CONSP (cdr
))
20308 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20309 font
, width_p
, align_to
))
20312 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20317 if (EQ (car
, Qminus
))
20319 return OK_PIXELS (pixels
);
20322 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20325 if (INTEGERP (car
) || FLOATP (car
))
20328 pixels
= XFLOATINT (car
);
20330 return OK_PIXELS (pixels
);
20331 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20332 font
, width_p
, align_to
))
20333 return OK_PIXELS (pixels
* fact
);
20344 /***********************************************************************
20346 ***********************************************************************/
20348 #ifdef HAVE_WINDOW_SYSTEM
20353 dump_glyph_string (s
)
20354 struct glyph_string
*s
;
20356 fprintf (stderr
, "glyph string\n");
20357 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20358 s
->x
, s
->y
, s
->width
, s
->height
);
20359 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20360 fprintf (stderr
, " hl = %d\n", s
->hl
);
20361 fprintf (stderr
, " left overhang = %d, right = %d\n",
20362 s
->left_overhang
, s
->right_overhang
);
20363 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20364 fprintf (stderr
, " extends to end of line = %d\n",
20365 s
->extends_to_end_of_line_p
);
20366 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20367 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20370 #endif /* GLYPH_DEBUG */
20372 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20373 of XChar2b structures for S; it can't be allocated in
20374 init_glyph_string because it must be allocated via `alloca'. W
20375 is the window on which S is drawn. ROW and AREA are the glyph row
20376 and area within the row from which S is constructed. START is the
20377 index of the first glyph structure covered by S. HL is a
20378 face-override for drawing S. */
20381 #define OPTIONAL_HDC(hdc) HDC hdc,
20382 #define DECLARE_HDC(hdc) HDC hdc;
20383 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20384 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20387 #ifndef OPTIONAL_HDC
20388 #define OPTIONAL_HDC(hdc)
20389 #define DECLARE_HDC(hdc)
20390 #define ALLOCATE_HDC(hdc, f)
20391 #define RELEASE_HDC(hdc, f)
20395 init_glyph_string (struct glyph_string
*s
,
20397 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20398 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20400 bzero (s
, sizeof *s
);
20402 s
->f
= XFRAME (w
->frame
);
20406 s
->display
= FRAME_X_DISPLAY (s
->f
);
20407 s
->window
= FRAME_X_WINDOW (s
->f
);
20408 s
->char2b
= char2b
;
20412 s
->first_glyph
= row
->glyphs
[area
] + start
;
20413 s
->height
= row
->height
;
20414 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20415 s
->ybase
= s
->y
+ row
->ascent
;
20419 /* Append the list of glyph strings with head H and tail T to the list
20420 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20423 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20424 struct glyph_string
*h
, struct glyph_string
*t
)
20438 /* Prepend the list of glyph strings with head H and tail T to the
20439 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20443 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20444 struct glyph_string
*h
, struct glyph_string
*t
)
20458 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20459 Set *HEAD and *TAIL to the resulting list. */
20462 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20463 struct glyph_string
*s
)
20465 s
->next
= s
->prev
= NULL
;
20466 append_glyph_string_lists (head
, tail
, s
, s
);
20470 /* Get face and two-byte form of character C in face FACE_ID on frame
20471 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20472 means we want to display multibyte text. DISPLAY_P non-zero means
20473 make sure that X resources for the face returned are allocated.
20474 Value is a pointer to a realized face that is ready for display if
20475 DISPLAY_P is non-zero. */
20477 static INLINE
struct face
*
20478 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20479 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20481 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20485 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20487 if (code
!= FONT_INVALID_CODE
)
20488 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20490 STORE_XCHAR2B (char2b
, 0, 0);
20493 /* Make sure X resources of the face are allocated. */
20494 #ifdef HAVE_X_WINDOWS
20498 xassert (face
!= NULL
);
20499 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20506 /* Get face and two-byte form of character glyph GLYPH on frame F.
20507 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20508 a pointer to a realized face that is ready for display. */
20510 static INLINE
struct face
*
20511 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20512 XChar2b
*char2b
, int *two_byte_p
)
20516 xassert (glyph
->type
== CHAR_GLYPH
);
20517 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20524 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20526 if (code
!= FONT_INVALID_CODE
)
20527 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20529 STORE_XCHAR2B (char2b
, 0, 0);
20532 /* Make sure X resources of the face are allocated. */
20533 xassert (face
!= NULL
);
20534 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20539 /* Fill glyph string S with composition components specified by S->cmp.
20541 BASE_FACE is the base face of the composition.
20542 S->cmp_from is the index of the first component for S.
20544 OVERLAPS non-zero means S should draw the foreground only, and use
20545 its physical height for clipping. See also draw_glyphs.
20547 Value is the index of a component not in S. */
20550 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20554 /* For all glyphs of this composition, starting at the offset
20555 S->cmp_from, until we reach the end of the definition or encounter a
20556 glyph that requires the different face, add it to S. */
20561 s
->for_overlaps
= overlaps
;
20564 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20566 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20570 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20573 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20574 s
->char2b
+ i
, 1, 1);
20580 s
->font
= s
->face
->font
;
20582 else if (s
->face
!= face
)
20590 /* All glyph strings for the same composition has the same width,
20591 i.e. the width set for the first component of the composition. */
20592 s
->width
= s
->first_glyph
->pixel_width
;
20594 /* If the specified font could not be loaded, use the frame's
20595 default font, but record the fact that we couldn't load it in
20596 the glyph string so that we can draw rectangles for the
20597 characters of the glyph string. */
20598 if (s
->font
== NULL
)
20600 s
->font_not_found_p
= 1;
20601 s
->font
= FRAME_FONT (s
->f
);
20604 /* Adjust base line for subscript/superscript text. */
20605 s
->ybase
+= s
->first_glyph
->voffset
;
20607 /* This glyph string must always be drawn with 16-bit functions. */
20614 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20615 int start
, int end
, int overlaps
)
20617 struct glyph
*glyph
, *last
;
20618 Lisp_Object lgstring
;
20621 s
->for_overlaps
= overlaps
;
20622 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20623 last
= s
->row
->glyphs
[s
->area
] + end
;
20624 s
->cmp_id
= glyph
->u
.cmp
.id
;
20625 s
->cmp_from
= glyph
->u
.cmp
.from
;
20626 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20627 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20628 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20629 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20631 while (glyph
< last
20632 && glyph
->u
.cmp
.automatic
20633 && glyph
->u
.cmp
.id
== s
->cmp_id
20634 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20635 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20637 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20639 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20640 unsigned code
= LGLYPH_CODE (lglyph
);
20642 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20644 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20645 return glyph
- s
->row
->glyphs
[s
->area
];
20649 /* Fill glyph string S from a sequence of character glyphs.
20651 FACE_ID is the face id of the string. START is the index of the
20652 first glyph to consider, END is the index of the last + 1.
20653 OVERLAPS non-zero means S should draw the foreground only, and use
20654 its physical height for clipping. See also draw_glyphs.
20656 Value is the index of the first glyph not in S. */
20659 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20660 int start
, int end
, int overlaps
)
20662 struct glyph
*glyph
, *last
;
20664 int glyph_not_available_p
;
20666 xassert (s
->f
== XFRAME (s
->w
->frame
));
20667 xassert (s
->nchars
== 0);
20668 xassert (start
>= 0 && end
> start
);
20670 s
->for_overlaps
= overlaps
;
20671 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20672 last
= s
->row
->glyphs
[s
->area
] + end
;
20673 voffset
= glyph
->voffset
;
20674 s
->padding_p
= glyph
->padding_p
;
20675 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20677 while (glyph
< last
20678 && glyph
->type
== CHAR_GLYPH
20679 && glyph
->voffset
== voffset
20680 /* Same face id implies same font, nowadays. */
20681 && glyph
->face_id
== face_id
20682 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20686 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20687 s
->char2b
+ s
->nchars
,
20689 s
->two_byte_p
= two_byte_p
;
20691 xassert (s
->nchars
<= end
- start
);
20692 s
->width
+= glyph
->pixel_width
;
20693 if (glyph
++->padding_p
!= s
->padding_p
)
20697 s
->font
= s
->face
->font
;
20699 /* If the specified font could not be loaded, use the frame's font,
20700 but record the fact that we couldn't load it in
20701 S->font_not_found_p so that we can draw rectangles for the
20702 characters of the glyph string. */
20703 if (s
->font
== NULL
|| glyph_not_available_p
)
20705 s
->font_not_found_p
= 1;
20706 s
->font
= FRAME_FONT (s
->f
);
20709 /* Adjust base line for subscript/superscript text. */
20710 s
->ybase
+= voffset
;
20712 xassert (s
->face
&& s
->face
->gc
);
20713 return glyph
- s
->row
->glyphs
[s
->area
];
20717 /* Fill glyph string S from image glyph S->first_glyph. */
20720 fill_image_glyph_string (struct glyph_string
*s
)
20722 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20723 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20725 s
->slice
= s
->first_glyph
->slice
;
20726 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20727 s
->font
= s
->face
->font
;
20728 s
->width
= s
->first_glyph
->pixel_width
;
20730 /* Adjust base line for subscript/superscript text. */
20731 s
->ybase
+= s
->first_glyph
->voffset
;
20735 /* Fill glyph string S from a sequence of stretch glyphs.
20737 ROW is the glyph row in which the glyphs are found, AREA is the
20738 area within the row. START is the index of the first glyph to
20739 consider, END is the index of the last + 1.
20741 Value is the index of the first glyph not in S. */
20744 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20745 enum glyph_row_area area
, int start
, int end
)
20747 struct glyph
*glyph
, *last
;
20748 int voffset
, face_id
;
20750 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20752 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20753 last
= s
->row
->glyphs
[s
->area
] + end
;
20754 face_id
= glyph
->face_id
;
20755 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20756 s
->font
= s
->face
->font
;
20757 s
->width
= glyph
->pixel_width
;
20759 voffset
= glyph
->voffset
;
20763 && glyph
->type
== STRETCH_GLYPH
20764 && glyph
->voffset
== voffset
20765 && glyph
->face_id
== face_id
);
20767 s
->width
+= glyph
->pixel_width
;
20769 /* Adjust base line for subscript/superscript text. */
20770 s
->ybase
+= voffset
;
20772 /* The case that face->gc == 0 is handled when drawing the glyph
20773 string by calling PREPARE_FACE_FOR_DISPLAY. */
20775 return glyph
- s
->row
->glyphs
[s
->area
];
20778 static struct font_metrics
*
20779 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20781 static struct font_metrics metrics
;
20782 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20784 if (! font
|| code
== FONT_INVALID_CODE
)
20786 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20791 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20792 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20793 assumed to be zero. */
20796 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20798 *left
= *right
= 0;
20800 if (glyph
->type
== CHAR_GLYPH
)
20804 struct font_metrics
*pcm
;
20806 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20807 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20809 if (pcm
->rbearing
> pcm
->width
)
20810 *right
= pcm
->rbearing
- pcm
->width
;
20811 if (pcm
->lbearing
< 0)
20812 *left
= -pcm
->lbearing
;
20815 else if (glyph
->type
== COMPOSITE_GLYPH
)
20817 if (! glyph
->u
.cmp
.automatic
)
20819 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20821 if (cmp
->rbearing
> cmp
->pixel_width
)
20822 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20823 if (cmp
->lbearing
< 0)
20824 *left
= - cmp
->lbearing
;
20828 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20829 struct font_metrics metrics
;
20831 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20832 glyph
->u
.cmp
.to
+ 1, &metrics
);
20833 if (metrics
.rbearing
> metrics
.width
)
20834 *right
= metrics
.rbearing
- metrics
.width
;
20835 if (metrics
.lbearing
< 0)
20836 *left
= - metrics
.lbearing
;
20842 /* Return the index of the first glyph preceding glyph string S that
20843 is overwritten by S because of S's left overhang. Value is -1
20844 if no glyphs are overwritten. */
20847 left_overwritten (struct glyph_string
*s
)
20851 if (s
->left_overhang
)
20854 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20855 int first
= s
->first_glyph
- glyphs
;
20857 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20858 x
-= glyphs
[i
].pixel_width
;
20869 /* Return the index of the first glyph preceding glyph string S that
20870 is overwriting S because of its right overhang. Value is -1 if no
20871 glyph in front of S overwrites S. */
20874 left_overwriting (struct glyph_string
*s
)
20877 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20878 int first
= s
->first_glyph
- glyphs
;
20882 for (i
= first
- 1; i
>= 0; --i
)
20885 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20888 x
-= glyphs
[i
].pixel_width
;
20895 /* Return the index of the last glyph following glyph string S that is
20896 overwritten by S because of S's right overhang. Value is -1 if
20897 no such glyph is found. */
20900 right_overwritten (struct glyph_string
*s
)
20904 if (s
->right_overhang
)
20907 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20908 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20909 int end
= s
->row
->used
[s
->area
];
20911 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20912 x
+= glyphs
[i
].pixel_width
;
20921 /* Return the index of the last glyph following glyph string S that
20922 overwrites S because of its left overhang. Value is negative
20923 if no such glyph is found. */
20926 right_overwriting (struct glyph_string
*s
)
20929 int end
= s
->row
->used
[s
->area
];
20930 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20931 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20935 for (i
= first
; i
< end
; ++i
)
20938 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20941 x
+= glyphs
[i
].pixel_width
;
20948 /* Set background width of glyph string S. START is the index of the
20949 first glyph following S. LAST_X is the right-most x-position + 1
20950 in the drawing area. */
20953 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20955 /* If the face of this glyph string has to be drawn to the end of
20956 the drawing area, set S->extends_to_end_of_line_p. */
20958 if (start
== s
->row
->used
[s
->area
]
20959 && s
->area
== TEXT_AREA
20960 && ((s
->row
->fill_line_p
20961 && (s
->hl
== DRAW_NORMAL_TEXT
20962 || s
->hl
== DRAW_IMAGE_RAISED
20963 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20964 || s
->hl
== DRAW_MOUSE_FACE
))
20965 s
->extends_to_end_of_line_p
= 1;
20967 /* If S extends its face to the end of the line, set its
20968 background_width to the distance to the right edge of the drawing
20970 if (s
->extends_to_end_of_line_p
)
20971 s
->background_width
= last_x
- s
->x
+ 1;
20973 s
->background_width
= s
->width
;
20977 /* Compute overhangs and x-positions for glyph string S and its
20978 predecessors, or successors. X is the starting x-position for S.
20979 BACKWARD_P non-zero means process predecessors. */
20982 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20988 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20989 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20999 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21000 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21010 /* The following macros are only called from draw_glyphs below.
21011 They reference the following parameters of that function directly:
21012 `w', `row', `area', and `overlap_p'
21013 as well as the following local variables:
21014 `s', `f', and `hdc' (in W32) */
21017 /* On W32, silently add local `hdc' variable to argument list of
21018 init_glyph_string. */
21019 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21020 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21022 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21023 init_glyph_string (s, char2b, w, row, area, start, hl)
21026 /* Add a glyph string for a stretch glyph to the list of strings
21027 between HEAD and TAIL. START is the index of the stretch 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 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21035 and below -- keep them on one line. */
21036 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21039 s = (struct glyph_string *) alloca (sizeof *s); \
21040 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21041 START = fill_stretch_glyph_string (s, row, area, START, END); \
21042 append_glyph_string (&HEAD, &TAIL, s); \
21048 /* Add a glyph string for an image glyph to the list of strings
21049 between HEAD and TAIL. START is the index of the image glyph in
21050 row area AREA of glyph row ROW. END is the index of the last glyph
21051 in that glyph row area. X is the current output position assigned
21052 to the new glyph string constructed. HL overrides that face of the
21053 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21054 is the right-most x-position of the drawing area. */
21056 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21059 s = (struct glyph_string *) alloca (sizeof *s); \
21060 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21061 fill_image_glyph_string (s); \
21062 append_glyph_string (&HEAD, &TAIL, s); \
21069 /* Add a glyph string for a sequence of character glyphs to the list
21070 of strings between HEAD and TAIL. START is the index of the first
21071 glyph in row area AREA of glyph row ROW that is part of the new
21072 glyph string. END is the index of the last glyph in that glyph row
21073 area. X is the current output position assigned to the new glyph
21074 string constructed. HL overrides that face of the glyph; e.g. it
21075 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21076 right-most x-position of the drawing area. */
21078 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21084 face_id = (row)->glyphs[area][START].face_id; \
21086 s = (struct glyph_string *) alloca (sizeof *s); \
21087 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21088 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21089 append_glyph_string (&HEAD, &TAIL, s); \
21091 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21096 /* Add a glyph string for a composite sequence to the list of strings
21097 between HEAD and TAIL. START is the index of the first glyph in
21098 row area AREA of glyph row ROW that is part of the new glyph
21099 string. END is the index of the last glyph in that glyph row area.
21100 X is the current output position assigned to the new glyph string
21101 constructed. HL overrides that face of the glyph; e.g. it is
21102 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21103 x-position of the drawing area. */
21105 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21107 int face_id = (row)->glyphs[area][START].face_id; \
21108 struct face *base_face = FACE_FROM_ID (f, face_id); \
21109 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21110 struct composition *cmp = composition_table[cmp_id]; \
21112 struct glyph_string *first_s; \
21115 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21117 /* Make glyph_strings for each glyph sequence that is drawable by \
21118 the same face, and append them to HEAD/TAIL. */ \
21119 for (n = 0; n < cmp->glyph_len;) \
21121 s = (struct glyph_string *) alloca (sizeof *s); \
21122 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21123 append_glyph_string (&(HEAD), &(TAIL), s); \
21129 n = fill_composite_glyph_string (s, base_face, overlaps); \
21137 /* Add a glyph string for a glyph-string sequence to the list of strings
21138 between HEAD and TAIL. */
21140 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21144 Lisp_Object gstring; \
21146 face_id = (row)->glyphs[area][START].face_id; \
21147 gstring = (composition_gstring_from_id \
21148 ((row)->glyphs[area][START].u.cmp.id)); \
21149 s = (struct glyph_string *) alloca (sizeof *s); \
21150 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21151 * LGSTRING_GLYPH_LEN (gstring)); \
21152 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21153 append_glyph_string (&(HEAD), &(TAIL), s); \
21155 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21159 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21160 of AREA of glyph row ROW on window W between indices START and END.
21161 HL overrides the face for drawing glyph strings, e.g. it is
21162 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21163 x-positions of the drawing area.
21165 This is an ugly monster macro construct because we must use alloca
21166 to allocate glyph strings (because draw_glyphs can be called
21167 asynchronously). */
21169 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21172 HEAD = TAIL = NULL; \
21173 while (START < END) \
21175 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21176 switch (first_glyph->type) \
21179 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21183 case COMPOSITE_GLYPH: \
21184 if (first_glyph->u.cmp.automatic) \
21185 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21188 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21192 case STRETCH_GLYPH: \
21193 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21197 case IMAGE_GLYPH: \
21198 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21208 set_glyph_string_background_width (s, START, LAST_X); \
21215 /* Draw glyphs between START and END in AREA of ROW on window W,
21216 starting at x-position X. X is relative to AREA in W. HL is a
21217 face-override with the following meaning:
21219 DRAW_NORMAL_TEXT draw normally
21220 DRAW_CURSOR draw in cursor face
21221 DRAW_MOUSE_FACE draw in mouse face.
21222 DRAW_INVERSE_VIDEO draw in mode line face
21223 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21224 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21226 If OVERLAPS is non-zero, draw only the foreground of characters and
21227 clip to the physical height of ROW. Non-zero value also defines
21228 the overlapping part to be drawn:
21230 OVERLAPS_PRED overlap with preceding rows
21231 OVERLAPS_SUCC overlap with succeeding rows
21232 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21233 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21235 Value is the x-position reached, relative to AREA of W. */
21238 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21239 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21240 enum draw_glyphs_face hl
, int overlaps
)
21242 struct glyph_string
*head
, *tail
;
21243 struct glyph_string
*s
;
21244 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21245 int i
, j
, x_reached
, last_x
, area_left
= 0;
21246 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21249 ALLOCATE_HDC (hdc
, f
);
21251 /* Let's rather be paranoid than getting a SEGV. */
21252 end
= min (end
, row
->used
[area
]);
21253 start
= max (0, start
);
21254 start
= min (end
, start
);
21256 /* Translate X to frame coordinates. Set last_x to the right
21257 end of the drawing area. */
21258 if (row
->full_width_p
)
21260 /* X is relative to the left edge of W, without scroll bars
21262 area_left
= WINDOW_LEFT_EDGE_X (w
);
21263 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21267 area_left
= window_box_left (w
, area
);
21268 last_x
= area_left
+ window_box_width (w
, area
);
21272 /* Build a doubly-linked list of glyph_string structures between
21273 head and tail from what we have to draw. Note that the macro
21274 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21275 the reason we use a separate variable `i'. */
21277 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21279 x_reached
= tail
->x
+ tail
->background_width
;
21283 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21284 the row, redraw some glyphs in front or following the glyph
21285 strings built above. */
21286 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21288 struct glyph_string
*h
, *t
;
21289 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21290 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21293 /* If mouse highlighting is on, we may need to draw adjacent
21294 glyphs using mouse-face highlighting. */
21295 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21297 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21299 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21300 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21302 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21304 check_mouse_face
= 1;
21305 mouse_beg_col
= (row
== mouse_beg_row
)
21306 ? dpyinfo
->mouse_face_beg_col
: 0;
21307 mouse_end_col
= (row
== mouse_end_row
)
21308 ? dpyinfo
->mouse_face_end_col
21309 : row
->used
[TEXT_AREA
];
21313 /* Compute overhangs for all glyph strings. */
21314 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21315 for (s
= head
; s
; s
= s
->next
)
21316 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21318 /* Prepend glyph strings for glyphs in front of the first glyph
21319 string that are overwritten because of the first glyph
21320 string's left overhang. The background of all strings
21321 prepended must be drawn because the first glyph string
21323 i
= left_overwritten (head
);
21326 enum draw_glyphs_face overlap_hl
;
21328 /* If this row contains mouse highlighting, attempt to draw
21329 the overlapped glyphs with the correct highlight. This
21330 code fails if the overlap encompasses more than one glyph
21331 and mouse-highlight spans only some of these glyphs.
21332 However, making it work perfectly involves a lot more
21333 code, and I don't know if the pathological case occurs in
21334 practice, so we'll stick to this for now. --- cyd */
21335 if (check_mouse_face
21336 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21337 overlap_hl
= DRAW_MOUSE_FACE
;
21339 overlap_hl
= DRAW_NORMAL_TEXT
;
21342 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21343 overlap_hl
, dummy_x
, last_x
);
21345 compute_overhangs_and_x (t
, head
->x
, 1);
21346 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21350 /* Prepend glyph strings for glyphs in front of the first glyph
21351 string that overwrite that glyph string because of their
21352 right overhang. For these strings, only the foreground must
21353 be drawn, because it draws over the glyph string at `head'.
21354 The background must not be drawn because this would overwrite
21355 right overhangs of preceding glyphs for which no glyph
21357 i
= left_overwriting (head
);
21360 enum draw_glyphs_face overlap_hl
;
21362 if (check_mouse_face
21363 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21364 overlap_hl
= DRAW_MOUSE_FACE
;
21366 overlap_hl
= DRAW_NORMAL_TEXT
;
21369 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21370 overlap_hl
, dummy_x
, last_x
);
21371 for (s
= h
; s
; s
= s
->next
)
21372 s
->background_filled_p
= 1;
21373 compute_overhangs_and_x (t
, head
->x
, 1);
21374 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21377 /* Append glyphs strings for glyphs following the last glyph
21378 string tail that are overwritten by tail. The background of
21379 these strings has to be drawn because tail's foreground draws
21381 i
= right_overwritten (tail
);
21384 enum draw_glyphs_face overlap_hl
;
21386 if (check_mouse_face
21387 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21388 overlap_hl
= DRAW_MOUSE_FACE
;
21390 overlap_hl
= DRAW_NORMAL_TEXT
;
21392 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21393 overlap_hl
, x
, last_x
);
21394 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21395 we don't have `end = i;' here. */
21396 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21397 append_glyph_string_lists (&head
, &tail
, h
, t
);
21401 /* Append glyph strings for glyphs following the last glyph
21402 string tail that overwrite tail. The foreground of such
21403 glyphs has to be drawn because it writes into the background
21404 of tail. The background must not be drawn because it could
21405 paint over the foreground of following glyphs. */
21406 i
= right_overwriting (tail
);
21409 enum draw_glyphs_face overlap_hl
;
21410 if (check_mouse_face
21411 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21412 overlap_hl
= DRAW_MOUSE_FACE
;
21414 overlap_hl
= DRAW_NORMAL_TEXT
;
21417 i
++; /* We must include the Ith glyph. */
21418 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21419 overlap_hl
, x
, last_x
);
21420 for (s
= h
; s
; s
= s
->next
)
21421 s
->background_filled_p
= 1;
21422 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21423 append_glyph_string_lists (&head
, &tail
, h
, t
);
21425 if (clip_head
|| clip_tail
)
21426 for (s
= head
; s
; s
= s
->next
)
21428 s
->clip_head
= clip_head
;
21429 s
->clip_tail
= clip_tail
;
21433 /* Draw all strings. */
21434 for (s
= head
; s
; s
= s
->next
)
21435 FRAME_RIF (f
)->draw_glyph_string (s
);
21438 /* When focus a sole frame and move horizontally, this sets on_p to 0
21439 causing a failure to erase prev cursor position. */
21440 if (area
== TEXT_AREA
21441 && !row
->full_width_p
21442 /* When drawing overlapping rows, only the glyph strings'
21443 foreground is drawn, which doesn't erase a cursor
21447 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21448 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21449 : (tail
? tail
->x
+ tail
->background_width
: x
));
21453 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21454 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21458 /* Value is the x-position up to which drawn, relative to AREA of W.
21459 This doesn't include parts drawn because of overhangs. */
21460 if (row
->full_width_p
)
21461 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21463 x_reached
-= area_left
;
21465 RELEASE_HDC (hdc
, f
);
21470 /* Expand row matrix if too narrow. Don't expand if area
21473 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21475 if (!fonts_changed_p \
21476 && (it->glyph_row->glyphs[area] \
21477 < it->glyph_row->glyphs[area + 1])) \
21479 it->w->ncols_scale_factor++; \
21480 fonts_changed_p = 1; \
21484 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21485 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21488 append_glyph (struct it
*it
)
21490 struct glyph
*glyph
;
21491 enum glyph_row_area area
= it
->area
;
21493 xassert (it
->glyph_row
);
21494 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21496 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21497 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21499 /* If the glyph row is reversed, we need to prepend the glyph
21500 rather than append it. */
21501 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21505 /* Make room for the additional glyph. */
21506 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21508 glyph
= it
->glyph_row
->glyphs
[area
];
21510 glyph
->charpos
= CHARPOS (it
->position
);
21511 glyph
->object
= it
->object
;
21512 if (it
->pixel_width
> 0)
21514 glyph
->pixel_width
= it
->pixel_width
;
21515 glyph
->padding_p
= 0;
21519 /* Assure at least 1-pixel width. Otherwise, cursor can't
21520 be displayed correctly. */
21521 glyph
->pixel_width
= 1;
21522 glyph
->padding_p
= 1;
21524 glyph
->ascent
= it
->ascent
;
21525 glyph
->descent
= it
->descent
;
21526 glyph
->voffset
= it
->voffset
;
21527 glyph
->type
= CHAR_GLYPH
;
21528 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21529 glyph
->multibyte_p
= it
->multibyte_p
;
21530 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21531 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21532 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21533 || it
->phys_descent
> it
->descent
);
21534 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21535 glyph
->face_id
= it
->face_id
;
21536 glyph
->u
.ch
= it
->char_to_display
;
21537 glyph
->slice
= null_glyph_slice
;
21538 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21541 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21542 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21544 glyph
->bidi_type
= it
->bidi_it
.type
;
21548 glyph
->resolved_level
= 0;
21549 glyph
->bidi_type
= UNKNOWN_BT
;
21551 ++it
->glyph_row
->used
[area
];
21554 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21557 /* Store one glyph for the composition IT->cmp_it.id in
21558 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21562 append_composite_glyph (struct it
*it
)
21564 struct glyph
*glyph
;
21565 enum glyph_row_area area
= it
->area
;
21567 xassert (it
->glyph_row
);
21569 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21570 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21572 /* If the glyph row is reversed, we need to prepend the glyph
21573 rather than append it. */
21574 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21578 /* Make room for the new glyph. */
21579 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21581 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21583 glyph
->charpos
= it
->cmp_it
.charpos
;
21584 glyph
->object
= it
->object
;
21585 glyph
->pixel_width
= it
->pixel_width
;
21586 glyph
->ascent
= it
->ascent
;
21587 glyph
->descent
= it
->descent
;
21588 glyph
->voffset
= it
->voffset
;
21589 glyph
->type
= COMPOSITE_GLYPH
;
21590 if (it
->cmp_it
.ch
< 0)
21592 glyph
->u
.cmp
.automatic
= 0;
21593 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21597 glyph
->u
.cmp
.automatic
= 1;
21598 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21599 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21600 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21602 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21603 glyph
->multibyte_p
= it
->multibyte_p
;
21604 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21605 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21606 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21607 || it
->phys_descent
> it
->descent
);
21608 glyph
->padding_p
= 0;
21609 glyph
->glyph_not_available_p
= 0;
21610 glyph
->face_id
= it
->face_id
;
21611 glyph
->slice
= null_glyph_slice
;
21612 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21615 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21616 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21618 glyph
->bidi_type
= it
->bidi_it
.type
;
21620 ++it
->glyph_row
->used
[area
];
21623 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21627 /* Change IT->ascent and IT->height according to the setting of
21631 take_vertical_position_into_account (struct it
*it
)
21635 if (it
->voffset
< 0)
21636 /* Increase the ascent so that we can display the text higher
21638 it
->ascent
-= it
->voffset
;
21640 /* Increase the descent so that we can display the text lower
21642 it
->descent
+= it
->voffset
;
21647 /* Produce glyphs/get display metrics for the image IT is loaded with.
21648 See the description of struct display_iterator in dispextern.h for
21649 an overview of struct display_iterator. */
21652 produce_image_glyph (struct it
*it
)
21656 int glyph_ascent
, crop
;
21657 struct glyph_slice slice
;
21659 xassert (it
->what
== IT_IMAGE
);
21661 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21663 /* Make sure X resources of the face is loaded. */
21664 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21666 if (it
->image_id
< 0)
21668 /* Fringe bitmap. */
21669 it
->ascent
= it
->phys_ascent
= 0;
21670 it
->descent
= it
->phys_descent
= 0;
21671 it
->pixel_width
= 0;
21676 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21678 /* Make sure X resources of the image is loaded. */
21679 prepare_image_for_display (it
->f
, img
);
21681 slice
.x
= slice
.y
= 0;
21682 slice
.width
= img
->width
;
21683 slice
.height
= img
->height
;
21685 if (INTEGERP (it
->slice
.x
))
21686 slice
.x
= XINT (it
->slice
.x
);
21687 else if (FLOATP (it
->slice
.x
))
21688 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21690 if (INTEGERP (it
->slice
.y
))
21691 slice
.y
= XINT (it
->slice
.y
);
21692 else if (FLOATP (it
->slice
.y
))
21693 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21695 if (INTEGERP (it
->slice
.width
))
21696 slice
.width
= XINT (it
->slice
.width
);
21697 else if (FLOATP (it
->slice
.width
))
21698 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21700 if (INTEGERP (it
->slice
.height
))
21701 slice
.height
= XINT (it
->slice
.height
);
21702 else if (FLOATP (it
->slice
.height
))
21703 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21705 if (slice
.x
>= img
->width
)
21706 slice
.x
= img
->width
;
21707 if (slice
.y
>= img
->height
)
21708 slice
.y
= img
->height
;
21709 if (slice
.x
+ slice
.width
>= img
->width
)
21710 slice
.width
= img
->width
- slice
.x
;
21711 if (slice
.y
+ slice
.height
> img
->height
)
21712 slice
.height
= img
->height
- slice
.y
;
21714 if (slice
.width
== 0 || slice
.height
== 0)
21717 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21719 it
->descent
= slice
.height
- glyph_ascent
;
21721 it
->descent
+= img
->vmargin
;
21722 if (slice
.y
+ slice
.height
== img
->height
)
21723 it
->descent
+= img
->vmargin
;
21724 it
->phys_descent
= it
->descent
;
21726 it
->pixel_width
= slice
.width
;
21728 it
->pixel_width
+= img
->hmargin
;
21729 if (slice
.x
+ slice
.width
== img
->width
)
21730 it
->pixel_width
+= img
->hmargin
;
21732 /* It's quite possible for images to have an ascent greater than
21733 their height, so don't get confused in that case. */
21734 if (it
->descent
< 0)
21739 if (face
->box
!= FACE_NO_BOX
)
21741 if (face
->box_line_width
> 0)
21744 it
->ascent
+= face
->box_line_width
;
21745 if (slice
.y
+ slice
.height
== img
->height
)
21746 it
->descent
+= face
->box_line_width
;
21749 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21750 it
->pixel_width
+= eabs (face
->box_line_width
);
21751 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21752 it
->pixel_width
+= eabs (face
->box_line_width
);
21755 take_vertical_position_into_account (it
);
21757 /* Automatically crop wide image glyphs at right edge so we can
21758 draw the cursor on same display row. */
21759 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21760 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21762 it
->pixel_width
-= crop
;
21763 slice
.width
-= crop
;
21768 struct glyph
*glyph
;
21769 enum glyph_row_area area
= it
->area
;
21771 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21772 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21774 glyph
->charpos
= CHARPOS (it
->position
);
21775 glyph
->object
= it
->object
;
21776 glyph
->pixel_width
= it
->pixel_width
;
21777 glyph
->ascent
= glyph_ascent
;
21778 glyph
->descent
= it
->descent
;
21779 glyph
->voffset
= it
->voffset
;
21780 glyph
->type
= IMAGE_GLYPH
;
21781 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21782 glyph
->multibyte_p
= it
->multibyte_p
;
21783 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21784 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21785 glyph
->overlaps_vertically_p
= 0;
21786 glyph
->padding_p
= 0;
21787 glyph
->glyph_not_available_p
= 0;
21788 glyph
->face_id
= it
->face_id
;
21789 glyph
->u
.img_id
= img
->id
;
21790 glyph
->slice
= slice
;
21791 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21794 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21795 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21797 glyph
->bidi_type
= it
->bidi_it
.type
;
21799 ++it
->glyph_row
->used
[area
];
21802 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21807 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21808 of the glyph, WIDTH and HEIGHT are the width and height of the
21809 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21812 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21813 int width
, int height
, int ascent
)
21815 struct glyph
*glyph
;
21816 enum glyph_row_area area
= it
->area
;
21818 xassert (ascent
>= 0 && ascent
<= height
);
21820 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21821 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21823 /* If the glyph row is reversed, we need to prepend the glyph
21824 rather than append it. */
21825 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21829 /* Make room for the additional glyph. */
21830 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21832 glyph
= it
->glyph_row
->glyphs
[area
];
21834 glyph
->charpos
= CHARPOS (it
->position
);
21835 glyph
->object
= object
;
21836 glyph
->pixel_width
= width
;
21837 glyph
->ascent
= ascent
;
21838 glyph
->descent
= height
- ascent
;
21839 glyph
->voffset
= it
->voffset
;
21840 glyph
->type
= STRETCH_GLYPH
;
21841 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21842 glyph
->multibyte_p
= it
->multibyte_p
;
21843 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21844 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21845 glyph
->overlaps_vertically_p
= 0;
21846 glyph
->padding_p
= 0;
21847 glyph
->glyph_not_available_p
= 0;
21848 glyph
->face_id
= it
->face_id
;
21849 glyph
->u
.stretch
.ascent
= ascent
;
21850 glyph
->u
.stretch
.height
= height
;
21851 glyph
->slice
= null_glyph_slice
;
21852 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21855 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21856 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21858 glyph
->bidi_type
= it
->bidi_it
.type
;
21862 glyph
->resolved_level
= 0;
21863 glyph
->bidi_type
= UNKNOWN_BT
;
21865 ++it
->glyph_row
->used
[area
];
21868 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21872 /* Produce a stretch glyph for iterator IT. IT->object is the value
21873 of the glyph property displayed. The value must be a list
21874 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21877 1. `:width WIDTH' specifies that the space should be WIDTH *
21878 canonical char width wide. WIDTH may be an integer or floating
21881 2. `:relative-width FACTOR' specifies that the width of the stretch
21882 should be computed from the width of the first character having the
21883 `glyph' property, and should be FACTOR times that width.
21885 3. `:align-to HPOS' specifies that the space should be wide enough
21886 to reach HPOS, a value in canonical character units.
21888 Exactly one of the above pairs must be present.
21890 4. `:height HEIGHT' specifies that the height of the stretch produced
21891 should be HEIGHT, measured in canonical character units.
21893 5. `:relative-height FACTOR' specifies that the height of the
21894 stretch should be FACTOR times the height of the characters having
21895 the glyph property.
21897 Either none or exactly one of 4 or 5 must be present.
21899 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21900 of the stretch should be used for the ascent of the stretch.
21901 ASCENT must be in the range 0 <= ASCENT <= 100. */
21904 produce_stretch_glyph (struct it
*it
)
21906 /* (space :width WIDTH :height HEIGHT ...) */
21907 Lisp_Object prop
, plist
;
21908 int width
= 0, height
= 0, align_to
= -1;
21909 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21912 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21913 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21915 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21917 /* List should start with `space'. */
21918 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21919 plist
= XCDR (it
->object
);
21921 /* Compute the width of the stretch. */
21922 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21923 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21925 /* Absolute width `:width WIDTH' specified and valid. */
21926 zero_width_ok_p
= 1;
21929 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21932 /* Relative width `:relative-width FACTOR' specified and valid.
21933 Compute the width of the characters having the `glyph'
21936 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21939 if (it
->multibyte_p
)
21941 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21942 - IT_BYTEPOS (*it
));
21943 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21946 it2
.c
= *p
, it2
.len
= 1;
21948 it2
.glyph_row
= NULL
;
21949 it2
.what
= IT_CHARACTER
;
21950 x_produce_glyphs (&it2
);
21951 width
= NUMVAL (prop
) * it2
.pixel_width
;
21953 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21954 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21956 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21957 align_to
= (align_to
< 0
21959 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21960 else if (align_to
< 0)
21961 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21962 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21963 zero_width_ok_p
= 1;
21966 /* Nothing specified -> width defaults to canonical char width. */
21967 width
= FRAME_COLUMN_WIDTH (it
->f
);
21969 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21972 /* Compute height. */
21973 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21974 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21977 zero_height_ok_p
= 1;
21979 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21981 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21983 height
= FONT_HEIGHT (font
);
21985 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21988 /* Compute percentage of height used for ascent. If
21989 `:ascent ASCENT' is present and valid, use that. Otherwise,
21990 derive the ascent from the font in use. */
21991 if (prop
= Fplist_get (plist
, QCascent
),
21992 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21993 ascent
= height
* NUMVAL (prop
) / 100.0;
21994 else if (!NILP (prop
)
21995 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21996 ascent
= min (max (0, (int)tem
), height
);
21998 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22000 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22001 && it
->current_x
+ width
> it
->last_visible_x
)
22002 width
= it
->last_visible_x
- it
->current_x
- 1;
22004 if (width
> 0 && height
> 0 && it
->glyph_row
)
22006 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22007 if (!STRINGP (object
))
22008 object
= it
->w
->buffer
;
22009 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22012 it
->pixel_width
= width
;
22013 it
->ascent
= it
->phys_ascent
= ascent
;
22014 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22015 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22017 take_vertical_position_into_account (it
);
22020 /* Calculate line-height and line-spacing properties.
22021 An integer value specifies explicit pixel value.
22022 A float value specifies relative value to current face height.
22023 A cons (float . face-name) specifies relative value to
22024 height of specified face font.
22026 Returns height in pixels, or nil. */
22030 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22031 int boff
, int override
)
22033 Lisp_Object face_name
= Qnil
;
22034 int ascent
, descent
, height
;
22036 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22041 face_name
= XCAR (val
);
22043 if (!NUMBERP (val
))
22044 val
= make_number (1);
22045 if (NILP (face_name
))
22047 height
= it
->ascent
+ it
->descent
;
22052 if (NILP (face_name
))
22054 font
= FRAME_FONT (it
->f
);
22055 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22057 else if (EQ (face_name
, Qt
))
22066 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22068 return make_number (-1);
22070 face
= FACE_FROM_ID (it
->f
, face_id
);
22073 return make_number (-1);
22074 boff
= font
->baseline_offset
;
22075 if (font
->vertical_centering
)
22076 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22079 ascent
= FONT_BASE (font
) + boff
;
22080 descent
= FONT_DESCENT (font
) - boff
;
22084 it
->override_ascent
= ascent
;
22085 it
->override_descent
= descent
;
22086 it
->override_boff
= boff
;
22089 height
= ascent
+ descent
;
22093 height
= (int)(XFLOAT_DATA (val
) * height
);
22094 else if (INTEGERP (val
))
22095 height
*= XINT (val
);
22097 return make_number (height
);
22102 Produce glyphs/get display metrics for the display element IT is
22103 loaded with. See the description of struct it in dispextern.h
22104 for an overview of struct it. */
22107 x_produce_glyphs (struct it
*it
)
22109 int extra_line_spacing
= it
->extra_line_spacing
;
22111 it
->glyph_not_available_p
= 0;
22113 if (it
->what
== IT_CHARACTER
)
22117 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22118 struct font_metrics
*pcm
;
22119 int font_not_found_p
;
22120 int boff
; /* baseline offset */
22121 /* We may change it->multibyte_p upon unibyte<->multibyte
22122 conversion. So, save the current value now and restore it
22125 Note: It seems that we don't have to record multibyte_p in
22126 struct glyph because the character code itself tells whether
22127 or not the character is multibyte. Thus, in the future, we
22128 must consider eliminating the field `multibyte_p' in the
22130 int saved_multibyte_p
= it
->multibyte_p
;
22132 /* Maybe translate single-byte characters to multibyte, or the
22134 it
->char_to_display
= it
->c
;
22135 if (!ASCII_BYTE_P (it
->c
)
22136 && ! it
->multibyte_p
)
22138 if (SINGLE_BYTE_CHAR_P (it
->c
)
22139 && unibyte_display_via_language_environment
)
22141 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22143 /* get_next_display_element assures that this decoding
22145 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22146 it
->multibyte_p
= 1;
22147 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22149 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22153 /* Get font to use. Encode IT->char_to_display. */
22154 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22155 &char2b
, it
->multibyte_p
, 0);
22158 font_not_found_p
= font
== NULL
;
22159 if (font_not_found_p
)
22161 /* When no suitable font found, display an empty box based
22162 on the metrics of the font of the default face (or what
22164 struct face
*no_font_face
22165 = FACE_FROM_ID (it
->f
,
22166 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22167 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22168 font
= no_font_face
->font
;
22169 boff
= font
->baseline_offset
;
22173 boff
= font
->baseline_offset
;
22174 if (font
->vertical_centering
)
22175 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22178 if (it
->char_to_display
>= ' '
22179 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22181 /* Either unibyte or ASCII. */
22186 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22188 if (it
->override_ascent
>= 0)
22190 it
->ascent
= it
->override_ascent
;
22191 it
->descent
= it
->override_descent
;
22192 boff
= it
->override_boff
;
22196 it
->ascent
= FONT_BASE (font
) + boff
;
22197 it
->descent
= FONT_DESCENT (font
) - boff
;
22202 it
->phys_ascent
= pcm
->ascent
+ boff
;
22203 it
->phys_descent
= pcm
->descent
- boff
;
22204 it
->pixel_width
= pcm
->width
;
22208 it
->glyph_not_available_p
= 1;
22209 it
->phys_ascent
= it
->ascent
;
22210 it
->phys_descent
= it
->descent
;
22211 it
->pixel_width
= FONT_WIDTH (font
);
22214 if (it
->constrain_row_ascent_descent_p
)
22216 if (it
->descent
> it
->max_descent
)
22218 it
->ascent
+= it
->descent
- it
->max_descent
;
22219 it
->descent
= it
->max_descent
;
22221 if (it
->ascent
> it
->max_ascent
)
22223 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22224 it
->ascent
= it
->max_ascent
;
22226 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22227 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22228 extra_line_spacing
= 0;
22231 /* If this is a space inside a region of text with
22232 `space-width' property, change its width. */
22233 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22235 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22237 /* If face has a box, add the box thickness to the character
22238 height. If character has a box line to the left and/or
22239 right, add the box line width to the character's width. */
22240 if (face
->box
!= FACE_NO_BOX
)
22242 int thick
= face
->box_line_width
;
22246 it
->ascent
+= thick
;
22247 it
->descent
+= thick
;
22252 if (it
->start_of_box_run_p
)
22253 it
->pixel_width
+= thick
;
22254 if (it
->end_of_box_run_p
)
22255 it
->pixel_width
+= thick
;
22258 /* If face has an overline, add the height of the overline
22259 (1 pixel) and a 1 pixel margin to the character height. */
22260 if (face
->overline_p
)
22261 it
->ascent
+= overline_margin
;
22263 if (it
->constrain_row_ascent_descent_p
)
22265 if (it
->ascent
> it
->max_ascent
)
22266 it
->ascent
= it
->max_ascent
;
22267 if (it
->descent
> it
->max_descent
)
22268 it
->descent
= it
->max_descent
;
22271 take_vertical_position_into_account (it
);
22273 /* If we have to actually produce glyphs, do it. */
22278 /* Translate a space with a `space-width' property
22279 into a stretch glyph. */
22280 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22281 / FONT_HEIGHT (font
));
22282 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22283 it
->ascent
+ it
->descent
, ascent
);
22288 /* If characters with lbearing or rbearing are displayed
22289 in this line, record that fact in a flag of the
22290 glyph row. This is used to optimize X output code. */
22291 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22292 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22294 if (! stretched_p
&& it
->pixel_width
== 0)
22295 /* We assure that all visible glyphs have at least 1-pixel
22297 it
->pixel_width
= 1;
22299 else if (it
->char_to_display
== '\n')
22301 /* A newline has no width, but we need the height of the
22302 line. But if previous part of the line sets a height,
22303 don't increase that height */
22305 Lisp_Object height
;
22306 Lisp_Object total_height
= Qnil
;
22308 it
->override_ascent
= -1;
22309 it
->pixel_width
= 0;
22312 height
= get_it_property (it
, Qline_height
);
22313 /* Split (line-height total-height) list */
22315 && CONSP (XCDR (height
))
22316 && NILP (XCDR (XCDR (height
))))
22318 total_height
= XCAR (XCDR (height
));
22319 height
= XCAR (height
);
22321 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22323 if (it
->override_ascent
>= 0)
22325 it
->ascent
= it
->override_ascent
;
22326 it
->descent
= it
->override_descent
;
22327 boff
= it
->override_boff
;
22331 it
->ascent
= FONT_BASE (font
) + boff
;
22332 it
->descent
= FONT_DESCENT (font
) - boff
;
22335 if (EQ (height
, Qt
))
22337 if (it
->descent
> it
->max_descent
)
22339 it
->ascent
+= it
->descent
- it
->max_descent
;
22340 it
->descent
= it
->max_descent
;
22342 if (it
->ascent
> it
->max_ascent
)
22344 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22345 it
->ascent
= it
->max_ascent
;
22347 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22348 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22349 it
->constrain_row_ascent_descent_p
= 1;
22350 extra_line_spacing
= 0;
22354 Lisp_Object spacing
;
22356 it
->phys_ascent
= it
->ascent
;
22357 it
->phys_descent
= it
->descent
;
22359 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22360 && face
->box
!= FACE_NO_BOX
22361 && face
->box_line_width
> 0)
22363 it
->ascent
+= face
->box_line_width
;
22364 it
->descent
+= face
->box_line_width
;
22367 && XINT (height
) > it
->ascent
+ it
->descent
)
22368 it
->ascent
= XINT (height
) - it
->descent
;
22370 if (!NILP (total_height
))
22371 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22374 spacing
= get_it_property (it
, Qline_spacing
);
22375 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22377 if (INTEGERP (spacing
))
22379 extra_line_spacing
= XINT (spacing
);
22380 if (!NILP (total_height
))
22381 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22385 else if (it
->char_to_display
== '\t')
22387 if (font
->space_width
> 0)
22389 int tab_width
= it
->tab_width
* font
->space_width
;
22390 int x
= it
->current_x
+ it
->continuation_lines_width
;
22391 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22393 /* If the distance from the current position to the next tab
22394 stop is less than a space character width, use the
22395 tab stop after that. */
22396 if (next_tab_x
- x
< font
->space_width
)
22397 next_tab_x
+= tab_width
;
22399 it
->pixel_width
= next_tab_x
- x
;
22401 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22402 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22406 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22407 it
->ascent
+ it
->descent
, it
->ascent
);
22412 it
->pixel_width
= 0;
22418 /* A multi-byte character. Assume that the display width of the
22419 character is the width of the character multiplied by the
22420 width of the font. */
22422 /* If we found a font, this font should give us the right
22423 metrics. If we didn't find a font, use the frame's
22424 default font and calculate the width of the character by
22425 multiplying the width of font by the width of the
22428 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22430 if (font_not_found_p
|| !pcm
)
22432 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22434 if (char_width
== 0)
22435 /* This is a non spacing character. But, as we are
22436 going to display an empty box, the box must occupy
22437 at least one column. */
22439 it
->glyph_not_available_p
= 1;
22440 it
->pixel_width
= font
->space_width
* char_width
;
22441 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22442 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22446 it
->pixel_width
= pcm
->width
;
22447 it
->phys_ascent
= pcm
->ascent
+ boff
;
22448 it
->phys_descent
= pcm
->descent
- boff
;
22450 && (pcm
->lbearing
< 0
22451 || pcm
->rbearing
> pcm
->width
))
22452 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22455 it
->ascent
= FONT_BASE (font
) + boff
;
22456 it
->descent
= FONT_DESCENT (font
) - boff
;
22457 if (face
->box
!= FACE_NO_BOX
)
22459 int thick
= face
->box_line_width
;
22463 it
->ascent
+= thick
;
22464 it
->descent
+= thick
;
22469 if (it
->start_of_box_run_p
)
22470 it
->pixel_width
+= thick
;
22471 if (it
->end_of_box_run_p
)
22472 it
->pixel_width
+= thick
;
22475 /* If face has an overline, add the height of the overline
22476 (1 pixel) and a 1 pixel margin to the character height. */
22477 if (face
->overline_p
)
22478 it
->ascent
+= overline_margin
;
22480 take_vertical_position_into_account (it
);
22482 if (it
->ascent
< 0)
22484 if (it
->descent
< 0)
22489 if (it
->pixel_width
== 0)
22490 /* We assure that all visible glyphs have at least 1-pixel
22492 it
->pixel_width
= 1;
22494 it
->multibyte_p
= saved_multibyte_p
;
22496 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22498 /* A static composition.
22500 Note: A composition is represented as one glyph in the
22501 glyph matrix. There are no padding glyphs.
22503 Important note: pixel_width, ascent, and descent are the
22504 values of what is drawn by draw_glyphs (i.e. the values of
22505 the overall glyphs composed). */
22506 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22507 int boff
; /* baseline offset */
22508 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22509 int glyph_len
= cmp
->glyph_len
;
22510 struct font
*font
= face
->font
;
22514 /* If we have not yet calculated pixel size data of glyphs of
22515 the composition for the current face font, calculate them
22516 now. Theoretically, we have to check all fonts for the
22517 glyphs, but that requires much time and memory space. So,
22518 here we check only the font of the first glyph. This may
22519 lead to incorrect display, but it's very rare, and C-l
22520 (recenter-top-bottom) can correct the display anyway. */
22521 if (! cmp
->font
|| cmp
->font
!= font
)
22523 /* Ascent and descent of the font of the first character
22524 of this composition (adjusted by baseline offset).
22525 Ascent and descent of overall glyphs should not be less
22526 than these, respectively. */
22527 int font_ascent
, font_descent
, font_height
;
22528 /* Bounding box of the overall glyphs. */
22529 int leftmost
, rightmost
, lowest
, highest
;
22530 int lbearing
, rbearing
;
22531 int i
, width
, ascent
, descent
;
22532 int left_padded
= 0, right_padded
= 0;
22535 struct font_metrics
*pcm
;
22536 int font_not_found_p
;
22539 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22540 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22542 if (glyph_len
< cmp
->glyph_len
)
22544 for (i
= 0; i
< glyph_len
; i
++)
22546 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22548 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22553 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22554 : IT_CHARPOS (*it
));
22555 /* If no suitable font is found, use the default font. */
22556 font_not_found_p
= font
== NULL
;
22557 if (font_not_found_p
)
22559 face
= face
->ascii_face
;
22562 boff
= font
->baseline_offset
;
22563 if (font
->vertical_centering
)
22564 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22565 font_ascent
= FONT_BASE (font
) + boff
;
22566 font_descent
= FONT_DESCENT (font
) - boff
;
22567 font_height
= FONT_HEIGHT (font
);
22569 cmp
->font
= (void *) font
;
22572 if (! font_not_found_p
)
22574 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22575 &char2b
, it
->multibyte_p
, 0);
22576 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22579 /* Initialize the bounding box. */
22582 width
= pcm
->width
;
22583 ascent
= pcm
->ascent
;
22584 descent
= pcm
->descent
;
22585 lbearing
= pcm
->lbearing
;
22586 rbearing
= pcm
->rbearing
;
22590 width
= FONT_WIDTH (font
);
22591 ascent
= FONT_BASE (font
);
22592 descent
= FONT_DESCENT (font
);
22599 lowest
= - descent
+ boff
;
22600 highest
= ascent
+ boff
;
22602 if (! font_not_found_p
22603 && font
->default_ascent
22604 && CHAR_TABLE_P (Vuse_default_ascent
)
22605 && !NILP (Faref (Vuse_default_ascent
,
22606 make_number (it
->char_to_display
))))
22607 highest
= font
->default_ascent
+ boff
;
22609 /* Draw the first glyph at the normal position. It may be
22610 shifted to right later if some other glyphs are drawn
22612 cmp
->offsets
[i
* 2] = 0;
22613 cmp
->offsets
[i
* 2 + 1] = boff
;
22614 cmp
->lbearing
= lbearing
;
22615 cmp
->rbearing
= rbearing
;
22617 /* Set cmp->offsets for the remaining glyphs. */
22618 for (i
++; i
< glyph_len
; i
++)
22620 int left
, right
, btm
, top
;
22621 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22623 struct face
*this_face
;
22628 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22629 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22630 font
= this_face
->font
;
22636 this_boff
= font
->baseline_offset
;
22637 if (font
->vertical_centering
)
22638 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22639 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22640 &char2b
, it
->multibyte_p
, 0);
22641 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22644 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22647 width
= pcm
->width
;
22648 ascent
= pcm
->ascent
;
22649 descent
= pcm
->descent
;
22650 lbearing
= pcm
->lbearing
;
22651 rbearing
= pcm
->rbearing
;
22652 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22654 /* Relative composition with or without
22655 alternate chars. */
22656 left
= (leftmost
+ rightmost
- width
) / 2;
22657 btm
= - descent
+ boff
;
22658 if (font
->relative_compose
22659 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22660 || NILP (Faref (Vignore_relative_composition
,
22661 make_number (ch
)))))
22664 if (- descent
>= font
->relative_compose
)
22665 /* One extra pixel between two glyphs. */
22667 else if (ascent
<= 0)
22668 /* One extra pixel between two glyphs. */
22669 btm
= lowest
- 1 - ascent
- descent
;
22674 /* A composition rule is specified by an integer
22675 value that encodes global and new reference
22676 points (GREF and NREF). GREF and NREF are
22677 specified by numbers as below:
22679 0---1---2 -- ascent
22683 9--10--11 -- center
22685 ---3---4---5--- baseline
22687 6---7---8 -- descent
22689 int rule
= COMPOSITION_RULE (cmp
, i
);
22690 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22692 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22693 grefx
= gref
% 3, nrefx
= nref
% 3;
22694 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22696 xoff
= font_height
* (xoff
- 128) / 256;
22698 yoff
= font_height
* (yoff
- 128) / 256;
22701 + grefx
* (rightmost
- leftmost
) / 2
22702 - nrefx
* width
/ 2
22705 btm
= ((grefy
== 0 ? highest
22707 : grefy
== 2 ? lowest
22708 : (highest
+ lowest
) / 2)
22709 - (nrefy
== 0 ? ascent
+ descent
22710 : nrefy
== 1 ? descent
- boff
22712 : (ascent
+ descent
) / 2)
22716 cmp
->offsets
[i
* 2] = left
;
22717 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22719 /* Update the bounding box of the overall glyphs. */
22722 right
= left
+ width
;
22723 if (left
< leftmost
)
22725 if (right
> rightmost
)
22728 top
= btm
+ descent
+ ascent
;
22734 if (cmp
->lbearing
> left
+ lbearing
)
22735 cmp
->lbearing
= left
+ lbearing
;
22736 if (cmp
->rbearing
< left
+ rbearing
)
22737 cmp
->rbearing
= left
+ rbearing
;
22741 /* If there are glyphs whose x-offsets are negative,
22742 shift all glyphs to the right and make all x-offsets
22746 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22747 cmp
->offsets
[i
* 2] -= leftmost
;
22748 rightmost
-= leftmost
;
22749 cmp
->lbearing
-= leftmost
;
22750 cmp
->rbearing
-= leftmost
;
22753 if (left_padded
&& cmp
->lbearing
< 0)
22755 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22756 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22757 rightmost
-= cmp
->lbearing
;
22758 cmp
->rbearing
-= cmp
->lbearing
;
22761 if (right_padded
&& rightmost
< cmp
->rbearing
)
22763 rightmost
= cmp
->rbearing
;
22766 cmp
->pixel_width
= rightmost
;
22767 cmp
->ascent
= highest
;
22768 cmp
->descent
= - lowest
;
22769 if (cmp
->ascent
< font_ascent
)
22770 cmp
->ascent
= font_ascent
;
22771 if (cmp
->descent
< font_descent
)
22772 cmp
->descent
= font_descent
;
22776 && (cmp
->lbearing
< 0
22777 || cmp
->rbearing
> cmp
->pixel_width
))
22778 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22780 it
->pixel_width
= cmp
->pixel_width
;
22781 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22782 it
->descent
= it
->phys_descent
= cmp
->descent
;
22783 if (face
->box
!= FACE_NO_BOX
)
22785 int thick
= face
->box_line_width
;
22789 it
->ascent
+= thick
;
22790 it
->descent
+= thick
;
22795 if (it
->start_of_box_run_p
)
22796 it
->pixel_width
+= thick
;
22797 if (it
->end_of_box_run_p
)
22798 it
->pixel_width
+= thick
;
22801 /* If face has an overline, add the height of the overline
22802 (1 pixel) and a 1 pixel margin to the character height. */
22803 if (face
->overline_p
)
22804 it
->ascent
+= overline_margin
;
22806 take_vertical_position_into_account (it
);
22807 if (it
->ascent
< 0)
22809 if (it
->descent
< 0)
22813 append_composite_glyph (it
);
22815 else if (it
->what
== IT_COMPOSITION
)
22817 /* A dynamic (automatic) composition. */
22818 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22819 Lisp_Object gstring
;
22820 struct font_metrics metrics
;
22822 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22824 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22827 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22828 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22829 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22830 it
->descent
= it
->phys_descent
= metrics
.descent
;
22831 if (face
->box
!= FACE_NO_BOX
)
22833 int thick
= face
->box_line_width
;
22837 it
->ascent
+= thick
;
22838 it
->descent
+= thick
;
22843 if (it
->start_of_box_run_p
)
22844 it
->pixel_width
+= thick
;
22845 if (it
->end_of_box_run_p
)
22846 it
->pixel_width
+= thick
;
22848 /* If face has an overline, add the height of the overline
22849 (1 pixel) and a 1 pixel margin to the character height. */
22850 if (face
->overline_p
)
22851 it
->ascent
+= overline_margin
;
22852 take_vertical_position_into_account (it
);
22853 if (it
->ascent
< 0)
22855 if (it
->descent
< 0)
22859 append_composite_glyph (it
);
22861 else if (it
->what
== IT_IMAGE
)
22862 produce_image_glyph (it
);
22863 else if (it
->what
== IT_STRETCH
)
22864 produce_stretch_glyph (it
);
22866 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22867 because this isn't true for images with `:ascent 100'. */
22868 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22869 if (it
->area
== TEXT_AREA
)
22870 it
->current_x
+= it
->pixel_width
;
22872 if (extra_line_spacing
> 0)
22874 it
->descent
+= extra_line_spacing
;
22875 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22876 it
->max_extra_line_spacing
= extra_line_spacing
;
22879 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22880 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22881 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22882 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22886 Output LEN glyphs starting at START at the nominal cursor position.
22887 Advance the nominal cursor over the text. The global variable
22888 updated_window contains the window being updated, updated_row is
22889 the glyph row being updated, and updated_area is the area of that
22890 row being updated. */
22893 x_write_glyphs (struct glyph
*start
, int len
)
22897 xassert (updated_window
&& updated_row
);
22900 /* Write glyphs. */
22902 hpos
= start
- updated_row
->glyphs
[updated_area
];
22903 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22904 updated_row
, updated_area
,
22906 DRAW_NORMAL_TEXT
, 0);
22908 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22909 if (updated_area
== TEXT_AREA
22910 && updated_window
->phys_cursor_on_p
22911 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22912 && updated_window
->phys_cursor
.hpos
>= hpos
22913 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22914 updated_window
->phys_cursor_on_p
= 0;
22918 /* Advance the output cursor. */
22919 output_cursor
.hpos
+= len
;
22920 output_cursor
.x
= x
;
22925 Insert LEN glyphs from START at the nominal cursor position. */
22928 x_insert_glyphs (struct glyph
*start
, int len
)
22932 int line_height
, shift_by_width
, shifted_region_width
;
22933 struct glyph_row
*row
;
22934 struct glyph
*glyph
;
22935 int frame_x
, frame_y
;
22938 xassert (updated_window
&& updated_row
);
22940 w
= updated_window
;
22941 f
= XFRAME (WINDOW_FRAME (w
));
22943 /* Get the height of the line we are in. */
22945 line_height
= row
->height
;
22947 /* Get the width of the glyphs to insert. */
22948 shift_by_width
= 0;
22949 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22950 shift_by_width
+= glyph
->pixel_width
;
22952 /* Get the width of the region to shift right. */
22953 shifted_region_width
= (window_box_width (w
, updated_area
)
22958 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22959 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22961 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22962 line_height
, shift_by_width
);
22964 /* Write the glyphs. */
22965 hpos
= start
- row
->glyphs
[updated_area
];
22966 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22968 DRAW_NORMAL_TEXT
, 0);
22970 /* Advance the output cursor. */
22971 output_cursor
.hpos
+= len
;
22972 output_cursor
.x
+= shift_by_width
;
22978 Erase the current text line from the nominal cursor position
22979 (inclusive) to pixel column TO_X (exclusive). The idea is that
22980 everything from TO_X onward is already erased.
22982 TO_X is a pixel position relative to updated_area of
22983 updated_window. TO_X == -1 means clear to the end of this area. */
22986 x_clear_end_of_line (int to_x
)
22989 struct window
*w
= updated_window
;
22990 int max_x
, min_y
, max_y
;
22991 int from_x
, from_y
, to_y
;
22993 xassert (updated_window
&& updated_row
);
22994 f
= XFRAME (w
->frame
);
22996 if (updated_row
->full_width_p
)
22997 max_x
= WINDOW_TOTAL_WIDTH (w
);
22999 max_x
= window_box_width (w
, updated_area
);
23000 max_y
= window_text_bottom_y (w
);
23002 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23003 of window. For TO_X > 0, truncate to end of drawing area. */
23009 to_x
= min (to_x
, max_x
);
23011 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23013 /* Notice if the cursor will be cleared by this operation. */
23014 if (!updated_row
->full_width_p
)
23015 notice_overwritten_cursor (w
, updated_area
,
23016 output_cursor
.x
, -1,
23018 MATRIX_ROW_BOTTOM_Y (updated_row
));
23020 from_x
= output_cursor
.x
;
23022 /* Translate to frame coordinates. */
23023 if (updated_row
->full_width_p
)
23025 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23026 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23030 int area_left
= window_box_left (w
, updated_area
);
23031 from_x
+= area_left
;
23035 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23036 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23037 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23039 /* Prevent inadvertently clearing to end of the X window. */
23040 if (to_x
> from_x
&& to_y
> from_y
)
23043 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23044 to_x
- from_x
, to_y
- from_y
);
23049 #endif /* HAVE_WINDOW_SYSTEM */
23053 /***********************************************************************
23055 ***********************************************************************/
23057 /* Value is the internal representation of the specified cursor type
23058 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23059 of the bar cursor. */
23061 static enum text_cursor_kinds
23062 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23064 enum text_cursor_kinds type
;
23069 if (EQ (arg
, Qbox
))
23070 return FILLED_BOX_CURSOR
;
23072 if (EQ (arg
, Qhollow
))
23073 return HOLLOW_BOX_CURSOR
;
23075 if (EQ (arg
, Qbar
))
23082 && EQ (XCAR (arg
), Qbar
)
23083 && INTEGERP (XCDR (arg
))
23084 && XINT (XCDR (arg
)) >= 0)
23086 *width
= XINT (XCDR (arg
));
23090 if (EQ (arg
, Qhbar
))
23093 return HBAR_CURSOR
;
23097 && EQ (XCAR (arg
), Qhbar
)
23098 && INTEGERP (XCDR (arg
))
23099 && XINT (XCDR (arg
)) >= 0)
23101 *width
= XINT (XCDR (arg
));
23102 return HBAR_CURSOR
;
23105 /* Treat anything unknown as "hollow box cursor".
23106 It was bad to signal an error; people have trouble fixing
23107 .Xdefaults with Emacs, when it has something bad in it. */
23108 type
= HOLLOW_BOX_CURSOR
;
23113 /* Set the default cursor types for specified frame. */
23115 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23120 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23121 FRAME_CURSOR_WIDTH (f
) = width
;
23123 /* By default, set up the blink-off state depending on the on-state. */
23125 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23128 FRAME_BLINK_OFF_CURSOR (f
)
23129 = get_specified_cursor_type (XCDR (tem
), &width
);
23130 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23133 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23137 /* Return the cursor we want to be displayed in window W. Return
23138 width of bar/hbar cursor through WIDTH arg. Return with
23139 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23140 (i.e. if the `system caret' should track this cursor).
23142 In a mini-buffer window, we want the cursor only to appear if we
23143 are reading input from this window. For the selected window, we
23144 want the cursor type given by the frame parameter or buffer local
23145 setting of cursor-type. If explicitly marked off, draw no cursor.
23146 In all other cases, we want a hollow box cursor. */
23148 static enum text_cursor_kinds
23149 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23150 int *active_cursor
)
23152 struct frame
*f
= XFRAME (w
->frame
);
23153 struct buffer
*b
= XBUFFER (w
->buffer
);
23154 int cursor_type
= DEFAULT_CURSOR
;
23155 Lisp_Object alt_cursor
;
23156 int non_selected
= 0;
23158 *active_cursor
= 1;
23161 if (cursor_in_echo_area
23162 && FRAME_HAS_MINIBUF_P (f
)
23163 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23165 if (w
== XWINDOW (echo_area_window
))
23167 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23169 *width
= FRAME_CURSOR_WIDTH (f
);
23170 return FRAME_DESIRED_CURSOR (f
);
23173 return get_specified_cursor_type (b
->cursor_type
, width
);
23176 *active_cursor
= 0;
23180 /* Detect a nonselected window or nonselected frame. */
23181 else if (w
!= XWINDOW (f
->selected_window
)
23182 #ifdef HAVE_WINDOW_SYSTEM
23183 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23187 *active_cursor
= 0;
23189 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23195 /* Never display a cursor in a window in which cursor-type is nil. */
23196 if (NILP (b
->cursor_type
))
23199 /* Get the normal cursor type for this window. */
23200 if (EQ (b
->cursor_type
, Qt
))
23202 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23203 *width
= FRAME_CURSOR_WIDTH (f
);
23206 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23208 /* Use cursor-in-non-selected-windows instead
23209 for non-selected window or frame. */
23212 alt_cursor
= b
->cursor_in_non_selected_windows
;
23213 if (!EQ (Qt
, alt_cursor
))
23214 return get_specified_cursor_type (alt_cursor
, width
);
23215 /* t means modify the normal cursor type. */
23216 if (cursor_type
== FILLED_BOX_CURSOR
)
23217 cursor_type
= HOLLOW_BOX_CURSOR
;
23218 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23220 return cursor_type
;
23223 /* Use normal cursor if not blinked off. */
23224 if (!w
->cursor_off_p
)
23226 #ifdef HAVE_WINDOW_SYSTEM
23227 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23229 if (cursor_type
== FILLED_BOX_CURSOR
)
23231 /* Using a block cursor on large images can be very annoying.
23232 So use a hollow cursor for "large" images.
23233 If image is not transparent (no mask), also use hollow cursor. */
23234 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23235 if (img
!= NULL
&& IMAGEP (img
->spec
))
23237 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23238 where N = size of default frame font size.
23239 This should cover most of the "tiny" icons people may use. */
23241 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23242 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23243 cursor_type
= HOLLOW_BOX_CURSOR
;
23246 else if (cursor_type
!= NO_CURSOR
)
23248 /* Display current only supports BOX and HOLLOW cursors for images.
23249 So for now, unconditionally use a HOLLOW cursor when cursor is
23250 not a solid box cursor. */
23251 cursor_type
= HOLLOW_BOX_CURSOR
;
23255 return cursor_type
;
23258 /* Cursor is blinked off, so determine how to "toggle" it. */
23260 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23261 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23262 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23264 /* Then see if frame has specified a specific blink off cursor type. */
23265 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23267 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23268 return FRAME_BLINK_OFF_CURSOR (f
);
23272 /* Some people liked having a permanently visible blinking cursor,
23273 while others had very strong opinions against it. So it was
23274 decided to remove it. KFS 2003-09-03 */
23276 /* Finally perform built-in cursor blinking:
23277 filled box <-> hollow box
23278 wide [h]bar <-> narrow [h]bar
23279 narrow [h]bar <-> no cursor
23280 other type <-> no cursor */
23282 if (cursor_type
== FILLED_BOX_CURSOR
)
23283 return HOLLOW_BOX_CURSOR
;
23285 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23288 return cursor_type
;
23296 #ifdef HAVE_WINDOW_SYSTEM
23298 /* Notice when the text cursor of window W has been completely
23299 overwritten by a drawing operation that outputs glyphs in AREA
23300 starting at X0 and ending at X1 in the line starting at Y0 and
23301 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23302 the rest of the line after X0 has been written. Y coordinates
23303 are window-relative. */
23306 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23307 int x0
, int x1
, int y0
, int y1
)
23309 int cx0
, cx1
, cy0
, cy1
;
23310 struct glyph_row
*row
;
23312 if (!w
->phys_cursor_on_p
)
23314 if (area
!= TEXT_AREA
)
23317 if (w
->phys_cursor
.vpos
< 0
23318 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23319 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23320 !(row
->enabled_p
&& row
->displays_text_p
)))
23323 if (row
->cursor_in_fringe_p
)
23325 row
->cursor_in_fringe_p
= 0;
23326 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23327 w
->phys_cursor_on_p
= 0;
23331 cx0
= w
->phys_cursor
.x
;
23332 cx1
= cx0
+ w
->phys_cursor_width
;
23333 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23336 /* The cursor image will be completely removed from the
23337 screen if the output area intersects the cursor area in
23338 y-direction. When we draw in [y0 y1[, and some part of
23339 the cursor is at y < y0, that part must have been drawn
23340 before. When scrolling, the cursor is erased before
23341 actually scrolling, so we don't come here. When not
23342 scrolling, the rows above the old cursor row must have
23343 changed, and in this case these rows must have written
23344 over the cursor image.
23346 Likewise if part of the cursor is below y1, with the
23347 exception of the cursor being in the first blank row at
23348 the buffer and window end because update_text_area
23349 doesn't draw that row. (Except when it does, but
23350 that's handled in update_text_area.) */
23352 cy0
= w
->phys_cursor
.y
;
23353 cy1
= cy0
+ w
->phys_cursor_height
;
23354 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23357 w
->phys_cursor_on_p
= 0;
23360 #endif /* HAVE_WINDOW_SYSTEM */
23363 /************************************************************************
23365 ************************************************************************/
23367 #ifdef HAVE_WINDOW_SYSTEM
23370 Fix the display of area AREA of overlapping row ROW in window W
23371 with respect to the overlapping part OVERLAPS. */
23374 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23375 enum glyph_row_area area
, int overlaps
)
23382 for (i
= 0; i
< row
->used
[area
];)
23384 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23386 int start
= i
, start_x
= x
;
23390 x
+= row
->glyphs
[area
][i
].pixel_width
;
23393 while (i
< row
->used
[area
]
23394 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23396 draw_glyphs (w
, start_x
, row
, area
,
23398 DRAW_NORMAL_TEXT
, overlaps
);
23402 x
+= row
->glyphs
[area
][i
].pixel_width
;
23412 Draw the cursor glyph of window W in glyph row ROW. See the
23413 comment of draw_glyphs for the meaning of HL. */
23416 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23417 enum draw_glyphs_face hl
)
23419 /* If cursor hpos is out of bounds, don't draw garbage. This can
23420 happen in mini-buffer windows when switching between echo area
23421 glyphs and mini-buffer. */
23422 if ((row
->reversed_p
23423 ? (w
->phys_cursor
.hpos
>= 0)
23424 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23426 int on_p
= w
->phys_cursor_on_p
;
23428 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23429 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23431 w
->phys_cursor_on_p
= on_p
;
23433 if (hl
== DRAW_CURSOR
)
23434 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23435 /* When we erase the cursor, and ROW is overlapped by other
23436 rows, make sure that these overlapping parts of other rows
23438 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23440 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23442 if (row
> w
->current_matrix
->rows
23443 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23444 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23445 OVERLAPS_ERASED_CURSOR
);
23447 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23448 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23449 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23450 OVERLAPS_ERASED_CURSOR
);
23457 Erase the image of a cursor of window W from the screen. */
23460 erase_phys_cursor (struct window
*w
)
23462 struct frame
*f
= XFRAME (w
->frame
);
23463 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23464 int hpos
= w
->phys_cursor
.hpos
;
23465 int vpos
= w
->phys_cursor
.vpos
;
23466 int mouse_face_here_p
= 0;
23467 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23468 struct glyph_row
*cursor_row
;
23469 struct glyph
*cursor_glyph
;
23470 enum draw_glyphs_face hl
;
23472 /* No cursor displayed or row invalidated => nothing to do on the
23474 if (w
->phys_cursor_type
== NO_CURSOR
)
23475 goto mark_cursor_off
;
23477 /* VPOS >= active_glyphs->nrows means that window has been resized.
23478 Don't bother to erase the cursor. */
23479 if (vpos
>= active_glyphs
->nrows
)
23480 goto mark_cursor_off
;
23482 /* If row containing cursor is marked invalid, there is nothing we
23484 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23485 if (!cursor_row
->enabled_p
)
23486 goto mark_cursor_off
;
23488 /* If line spacing is > 0, old cursor may only be partially visible in
23489 window after split-window. So adjust visible height. */
23490 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23491 window_text_bottom_y (w
) - cursor_row
->y
);
23493 /* If row is completely invisible, don't attempt to delete a cursor which
23494 isn't there. This can happen if cursor is at top of a window, and
23495 we switch to a buffer with a header line in that window. */
23496 if (cursor_row
->visible_height
<= 0)
23497 goto mark_cursor_off
;
23499 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23500 if (cursor_row
->cursor_in_fringe_p
)
23502 cursor_row
->cursor_in_fringe_p
= 0;
23503 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23504 goto mark_cursor_off
;
23507 /* This can happen when the new row is shorter than the old one.
23508 In this case, either draw_glyphs or clear_end_of_line
23509 should have cleared the cursor. Note that we wouldn't be
23510 able to erase the cursor in this case because we don't have a
23511 cursor glyph at hand. */
23512 if ((cursor_row
->reversed_p
23513 ? (w
->phys_cursor
.hpos
< 0)
23514 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23515 goto mark_cursor_off
;
23517 /* If the cursor is in the mouse face area, redisplay that when
23518 we clear the cursor. */
23519 if (! NILP (dpyinfo
->mouse_face_window
)
23520 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23521 && (vpos
> dpyinfo
->mouse_face_beg_row
23522 || (vpos
== dpyinfo
->mouse_face_beg_row
23523 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23524 && (vpos
< dpyinfo
->mouse_face_end_row
23525 || (vpos
== dpyinfo
->mouse_face_end_row
23526 && hpos
< dpyinfo
->mouse_face_end_col
))
23527 /* Don't redraw the cursor's spot in mouse face if it is at the
23528 end of a line (on a newline). The cursor appears there, but
23529 mouse highlighting does not. */
23530 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23531 mouse_face_here_p
= 1;
23533 /* Maybe clear the display under the cursor. */
23534 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23537 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23540 cursor_glyph
= get_phys_cursor_glyph (w
);
23541 if (cursor_glyph
== NULL
)
23542 goto mark_cursor_off
;
23544 width
= cursor_glyph
->pixel_width
;
23545 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23546 x
= w
->phys_cursor
.x
;
23548 width
-= left_x
- x
;
23549 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23550 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23551 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23554 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23557 /* Erase the cursor by redrawing the character underneath it. */
23558 if (mouse_face_here_p
)
23559 hl
= DRAW_MOUSE_FACE
;
23561 hl
= DRAW_NORMAL_TEXT
;
23562 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23565 w
->phys_cursor_on_p
= 0;
23566 w
->phys_cursor_type
= NO_CURSOR
;
23571 Display or clear cursor of window W. If ON is zero, clear the
23572 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23573 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23576 display_and_set_cursor (struct window
*w
, int on
,
23577 int hpos
, int vpos
, int x
, int y
)
23579 struct frame
*f
= XFRAME (w
->frame
);
23580 int new_cursor_type
;
23581 int new_cursor_width
;
23583 struct glyph_row
*glyph_row
;
23584 struct glyph
*glyph
;
23586 /* This is pointless on invisible frames, and dangerous on garbaged
23587 windows and frames; in the latter case, the frame or window may
23588 be in the midst of changing its size, and x and y may be off the
23590 if (! FRAME_VISIBLE_P (f
)
23591 || FRAME_GARBAGED_P (f
)
23592 || vpos
>= w
->current_matrix
->nrows
23593 || hpos
>= w
->current_matrix
->matrix_w
)
23596 /* If cursor is off and we want it off, return quickly. */
23597 if (!on
&& !w
->phys_cursor_on_p
)
23600 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23601 /* If cursor row is not enabled, we don't really know where to
23602 display the cursor. */
23603 if (!glyph_row
->enabled_p
)
23605 w
->phys_cursor_on_p
= 0;
23610 if (!glyph_row
->exact_window_width_line_p
23611 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23612 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23614 xassert (interrupt_input_blocked
);
23616 /* Set new_cursor_type to the cursor we want to be displayed. */
23617 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23618 &new_cursor_width
, &active_cursor
);
23620 /* If cursor is currently being shown and we don't want it to be or
23621 it is in the wrong place, or the cursor type is not what we want,
23623 if (w
->phys_cursor_on_p
23625 || w
->phys_cursor
.x
!= x
23626 || w
->phys_cursor
.y
!= y
23627 || new_cursor_type
!= w
->phys_cursor_type
23628 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23629 && new_cursor_width
!= w
->phys_cursor_width
)))
23630 erase_phys_cursor (w
);
23632 /* Don't check phys_cursor_on_p here because that flag is only set
23633 to zero in some cases where we know that the cursor has been
23634 completely erased, to avoid the extra work of erasing the cursor
23635 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23636 still not be visible, or it has only been partly erased. */
23639 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23640 w
->phys_cursor_height
= glyph_row
->height
;
23642 /* Set phys_cursor_.* before x_draw_.* is called because some
23643 of them may need the information. */
23644 w
->phys_cursor
.x
= x
;
23645 w
->phys_cursor
.y
= glyph_row
->y
;
23646 w
->phys_cursor
.hpos
= hpos
;
23647 w
->phys_cursor
.vpos
= vpos
;
23650 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23651 new_cursor_type
, new_cursor_width
,
23652 on
, active_cursor
);
23656 /* Switch the display of W's cursor on or off, according to the value
23660 update_window_cursor (struct window
*w
, int on
)
23662 /* Don't update cursor in windows whose frame is in the process
23663 of being deleted. */
23664 if (w
->current_matrix
)
23667 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23668 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23674 /* Call update_window_cursor with parameter ON_P on all leaf windows
23675 in the window tree rooted at W. */
23678 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23682 if (!NILP (w
->hchild
))
23683 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23684 else if (!NILP (w
->vchild
))
23685 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23687 update_window_cursor (w
, on_p
);
23689 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23695 Display the cursor on window W, or clear it, according to ON_P.
23696 Don't change the cursor's position. */
23699 x_update_cursor (struct frame
*f
, int on_p
)
23701 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23706 Clear the cursor of window W to background color, and mark the
23707 cursor as not shown. This is used when the text where the cursor
23708 is about to be rewritten. */
23711 x_clear_cursor (struct window
*w
)
23713 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23714 update_window_cursor (w
, 0);
23719 Display the active region described by mouse_face_* according to DRAW. */
23722 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23724 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23725 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23727 if (/* If window is in the process of being destroyed, don't bother
23729 w
->current_matrix
!= NULL
23730 /* Don't update mouse highlight if hidden */
23731 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23732 /* Recognize when we are called to operate on rows that don't exist
23733 anymore. This can happen when a window is split. */
23734 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23736 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23737 struct glyph_row
*row
, *first
, *last
;
23739 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23740 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23742 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23744 int start_hpos
, end_hpos
, start_x
;
23746 /* For all but the first row, the highlight starts at column 0. */
23749 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23750 start_x
= dpyinfo
->mouse_face_beg_x
;
23759 end_hpos
= dpyinfo
->mouse_face_end_col
;
23762 end_hpos
= row
->used
[TEXT_AREA
];
23763 if (draw
== DRAW_NORMAL_TEXT
)
23764 row
->fill_line_p
= 1; /* Clear to end of line */
23767 if (end_hpos
> start_hpos
)
23769 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23770 start_hpos
, end_hpos
,
23774 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23778 /* When we've written over the cursor, arrange for it to
23779 be displayed again. */
23780 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23783 display_and_set_cursor (w
, 1,
23784 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23785 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23790 /* Change the mouse cursor. */
23791 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23792 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23793 else if (draw
== DRAW_MOUSE_FACE
)
23794 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23796 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23800 Clear out the mouse-highlighted active region.
23801 Redraw it un-highlighted first. Value is non-zero if mouse
23802 face was actually drawn unhighlighted. */
23805 clear_mouse_face (Display_Info
*dpyinfo
)
23809 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23811 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23815 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23816 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23817 dpyinfo
->mouse_face_window
= Qnil
;
23818 dpyinfo
->mouse_face_overlay
= Qnil
;
23824 Non-zero if physical cursor of window W is within mouse face. */
23827 cursor_in_mouse_face_p (struct window
*w
)
23829 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23830 int in_mouse_face
= 0;
23832 if (WINDOWP (dpyinfo
->mouse_face_window
)
23833 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23835 int hpos
= w
->phys_cursor
.hpos
;
23836 int vpos
= w
->phys_cursor
.vpos
;
23838 if (vpos
>= dpyinfo
->mouse_face_beg_row
23839 && vpos
<= dpyinfo
->mouse_face_end_row
23840 && (vpos
> dpyinfo
->mouse_face_beg_row
23841 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23842 && (vpos
< dpyinfo
->mouse_face_end_row
23843 || hpos
< dpyinfo
->mouse_face_end_col
23844 || dpyinfo
->mouse_face_past_end
))
23848 return in_mouse_face
;
23854 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23855 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23856 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23857 for the overlay or run of text properties specifying the mouse
23858 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23859 before-string and after-string that must also be highlighted.
23860 DISPLAY_STRING, if non-nil, is a display string that may cover some
23861 or all of the highlighted text. */
23864 mouse_face_from_buffer_pos (Lisp_Object window
,
23865 Display_Info
*dpyinfo
,
23866 EMACS_INT mouse_charpos
,
23867 EMACS_INT start_charpos
,
23868 EMACS_INT end_charpos
,
23869 Lisp_Object before_string
,
23870 Lisp_Object after_string
,
23871 Lisp_Object display_string
)
23873 struct window
*w
= XWINDOW (window
);
23874 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23875 struct glyph_row
*row
;
23876 struct glyph
*glyph
, *end
;
23880 xassert (NILP (display_string
) || STRINGP (display_string
));
23881 xassert (NILP (before_string
) || STRINGP (before_string
));
23882 xassert (NILP (after_string
) || STRINGP (after_string
));
23884 /* Find the first highlighted glyph. */
23885 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23887 dpyinfo
->mouse_face_beg_col
= 0;
23888 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23889 dpyinfo
->mouse_face_beg_x
= first
->x
;
23890 dpyinfo
->mouse_face_beg_y
= first
->y
;
23894 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23896 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23898 /* If the before-string or display-string contains newlines,
23899 row_containing_pos skips to its last row. Move back. */
23900 if (!NILP (before_string
) || !NILP (display_string
))
23902 struct glyph_row
*prev
;
23903 while ((prev
= row
- 1, prev
>= first
)
23904 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23905 && prev
->used
[TEXT_AREA
] > 0)
23907 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23908 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23909 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23911 || !(EQ (glyph
->object
, before_string
)
23912 || EQ (glyph
->object
, display_string
)))
23918 glyph
= row
->glyphs
[TEXT_AREA
];
23919 end
= glyph
+ row
->used
[TEXT_AREA
];
23921 dpyinfo
->mouse_face_beg_y
= row
->y
;
23922 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23924 /* Skip truncation glyphs at the start of the glyph row. */
23925 if (row
->displays_text_p
)
23927 && INTEGERP (glyph
->object
)
23928 && glyph
->charpos
< 0;
23930 x
+= glyph
->pixel_width
;
23932 /* Scan the glyph row, stopping before BEFORE_STRING or
23933 DISPLAY_STRING or START_CHARPOS. */
23935 && !INTEGERP (glyph
->object
)
23936 && !EQ (glyph
->object
, before_string
)
23937 && !EQ (glyph
->object
, display_string
)
23938 && !(BUFFERP (glyph
->object
)
23939 && glyph
->charpos
>= start_charpos
);
23941 x
+= glyph
->pixel_width
;
23943 dpyinfo
->mouse_face_beg_x
= x
;
23944 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23947 /* Find the last highlighted glyph. */
23948 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23951 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23952 dpyinfo
->mouse_face_past_end
= 1;
23954 else if (!NILP (after_string
))
23956 /* If the after-string has newlines, advance to its last row. */
23957 struct glyph_row
*next
;
23958 struct glyph_row
*last
23959 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23961 for (next
= row
+ 1;
23963 && next
->used
[TEXT_AREA
] > 0
23964 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23969 glyph
= row
->glyphs
[TEXT_AREA
];
23970 end
= glyph
+ row
->used
[TEXT_AREA
];
23972 dpyinfo
->mouse_face_end_y
= row
->y
;
23973 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23975 /* Skip truncation glyphs at the start of the row. */
23976 if (row
->displays_text_p
)
23978 && INTEGERP (glyph
->object
)
23979 && glyph
->charpos
< 0;
23981 x
+= glyph
->pixel_width
;
23983 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23986 && !INTEGERP (glyph
->object
)
23987 && !EQ (glyph
->object
, after_string
)
23988 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23990 x
+= glyph
->pixel_width
;
23992 /* If we found AFTER_STRING, consume it and stop. */
23993 if (EQ (glyph
->object
, after_string
))
23995 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23996 x
+= glyph
->pixel_width
;
24000 /* If there's no after-string, we must check if we overshot,
24001 which might be the case if we stopped after a string glyph.
24002 That glyph may belong to a before-string or display-string
24003 associated with the end position, which must not be
24005 Lisp_Object prev_object
;
24008 while (glyph
> row
->glyphs
[TEXT_AREA
])
24010 prev_object
= (glyph
- 1)->object
;
24011 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
24014 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
24015 if (pos
&& pos
< end_charpos
)
24018 for (; glyph
> row
->glyphs
[TEXT_AREA
]
24019 && EQ ((glyph
- 1)->object
, prev_object
);
24021 x
-= (glyph
- 1)->pixel_width
;
24025 dpyinfo
->mouse_face_end_x
= x
;
24026 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24027 dpyinfo
->mouse_face_window
= window
;
24028 dpyinfo
->mouse_face_face_id
24029 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24031 !dpyinfo
->mouse_face_hidden
, -1);
24032 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24036 /* Find the position of the glyph for position POS in OBJECT in
24037 window W's current matrix, and return in *X, *Y the pixel
24038 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24040 RIGHT_P non-zero means return the position of the right edge of the
24041 glyph, RIGHT_P zero means return the left edge position.
24043 If no glyph for POS exists in the matrix, return the position of
24044 the glyph with the next smaller position that is in the matrix, if
24045 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24046 exists in the matrix, return the position of the glyph with the
24047 next larger position in OBJECT.
24049 Value is non-zero if a glyph was found. */
24052 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24053 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24055 int yb
= window_text_bottom_y (w
);
24056 struct glyph_row
*r
;
24057 struct glyph
*best_glyph
= NULL
;
24058 struct glyph_row
*best_row
= NULL
;
24061 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24062 r
->enabled_p
&& r
->y
< yb
;
24065 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24066 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24069 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24070 if (EQ (g
->object
, object
))
24072 if (g
->charpos
== pos
)
24079 else if (best_glyph
== NULL
24080 || ((eabs (g
->charpos
- pos
)
24081 < eabs (best_glyph
->charpos
- pos
))
24084 : g
->charpos
> pos
)))
24098 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24102 *x
+= best_glyph
->pixel_width
;
24107 *vpos
= best_row
- w
->current_matrix
->rows
;
24110 return best_glyph
!= NULL
;
24114 /* See if position X, Y is within a hot-spot of an image. */
24117 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24119 if (!CONSP (hot_spot
))
24122 if (EQ (XCAR (hot_spot
), Qrect
))
24124 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24125 Lisp_Object rect
= XCDR (hot_spot
);
24129 if (!CONSP (XCAR (rect
)))
24131 if (!CONSP (XCDR (rect
)))
24133 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24135 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24137 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24139 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24143 else if (EQ (XCAR (hot_spot
), Qcircle
))
24145 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24146 Lisp_Object circ
= XCDR (hot_spot
);
24147 Lisp_Object lr
, lx0
, ly0
;
24149 && CONSP (XCAR (circ
))
24150 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24151 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24152 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24154 double r
= XFLOATINT (lr
);
24155 double dx
= XINT (lx0
) - x
;
24156 double dy
= XINT (ly0
) - y
;
24157 return (dx
* dx
+ dy
* dy
<= r
* r
);
24160 else if (EQ (XCAR (hot_spot
), Qpoly
))
24162 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24163 if (VECTORP (XCDR (hot_spot
)))
24165 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24166 Lisp_Object
*poly
= v
->contents
;
24170 Lisp_Object lx
, ly
;
24173 /* Need an even number of coordinates, and at least 3 edges. */
24174 if (n
< 6 || n
& 1)
24177 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24178 If count is odd, we are inside polygon. Pixels on edges
24179 may or may not be included depending on actual geometry of the
24181 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24182 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24184 x0
= XINT (lx
), y0
= XINT (ly
);
24185 for (i
= 0; i
< n
; i
+= 2)
24187 int x1
= x0
, y1
= y0
;
24188 if ((lx
= poly
[i
], !INTEGERP (lx
))
24189 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24191 x0
= XINT (lx
), y0
= XINT (ly
);
24193 /* Does this segment cross the X line? */
24201 if (y
> y0
&& y
> y1
)
24203 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24213 find_hot_spot (Lisp_Object map
, int x
, int y
)
24215 while (CONSP (map
))
24217 if (CONSP (XCAR (map
))
24218 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24226 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24228 doc
: /* Lookup in image map MAP coordinates X and Y.
24229 An image map is an alist where each element has the format (AREA ID PLIST).
24230 An AREA is specified as either a rectangle, a circle, or a polygon:
24231 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24232 pixel coordinates of the upper left and bottom right corners.
24233 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24234 and the radius of the circle; r may be a float or integer.
24235 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24236 vector describes one corner in the polygon.
24237 Returns the alist element for the first matching AREA in MAP. */)
24248 return find_hot_spot (map
, XINT (x
), XINT (y
));
24252 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24254 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24256 /* Do not change cursor shape while dragging mouse. */
24257 if (!NILP (do_mouse_tracking
))
24260 if (!NILP (pointer
))
24262 if (EQ (pointer
, Qarrow
))
24263 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24264 else if (EQ (pointer
, Qhand
))
24265 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24266 else if (EQ (pointer
, Qtext
))
24267 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24268 else if (EQ (pointer
, intern ("hdrag")))
24269 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24270 #ifdef HAVE_X_WINDOWS
24271 else if (EQ (pointer
, intern ("vdrag")))
24272 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24274 else if (EQ (pointer
, intern ("hourglass")))
24275 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24276 else if (EQ (pointer
, Qmodeline
))
24277 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24279 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24282 if (cursor
!= No_Cursor
)
24283 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24286 /* Take proper action when mouse has moved to the mode or header line
24287 or marginal area AREA of window W, x-position X and y-position Y.
24288 X is relative to the start of the text display area of W, so the
24289 width of bitmap areas and scroll bars must be subtracted to get a
24290 position relative to the start of the mode line. */
24293 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24294 enum window_part area
)
24296 struct window
*w
= XWINDOW (window
);
24297 struct frame
*f
= XFRAME (w
->frame
);
24298 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24299 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24300 Lisp_Object pointer
= Qnil
;
24301 int charpos
, dx
, dy
, width
, height
;
24302 Lisp_Object string
, object
= Qnil
;
24303 Lisp_Object pos
, help
;
24305 Lisp_Object mouse_face
;
24306 int original_x_pixel
= x
;
24307 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24308 struct glyph_row
*row
;
24310 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24315 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24316 &object
, &dx
, &dy
, &width
, &height
);
24318 row
= (area
== ON_MODE_LINE
24319 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24320 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24323 if (row
->mode_line_p
&& row
->enabled_p
)
24325 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24326 end
= glyph
+ row
->used
[TEXT_AREA
];
24328 for (x0
= original_x_pixel
;
24329 glyph
< end
&& x0
>= glyph
->pixel_width
;
24331 x0
-= glyph
->pixel_width
;
24339 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24340 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24341 &object
, &dx
, &dy
, &width
, &height
);
24346 if (IMAGEP (object
))
24348 Lisp_Object image_map
, hotspot
;
24349 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24351 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24353 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24355 Lisp_Object area_id
, plist
;
24357 area_id
= XCAR (hotspot
);
24358 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24359 If so, we could look for mouse-enter, mouse-leave
24360 properties in PLIST (and do something...). */
24361 hotspot
= XCDR (hotspot
);
24362 if (CONSP (hotspot
)
24363 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24365 pointer
= Fplist_get (plist
, Qpointer
);
24366 if (NILP (pointer
))
24368 help
= Fplist_get (plist
, Qhelp_echo
);
24371 help_echo_string
= help
;
24372 /* Is this correct? ++kfs */
24373 XSETWINDOW (help_echo_window
, w
);
24374 help_echo_object
= w
->buffer
;
24375 help_echo_pos
= charpos
;
24379 if (NILP (pointer
))
24380 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24383 if (STRINGP (string
))
24385 pos
= make_number (charpos
);
24386 /* If we're on a string with `help-echo' text property, arrange
24387 for the help to be displayed. This is done by setting the
24388 global variable help_echo_string to the help string. */
24391 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24394 help_echo_string
= help
;
24395 XSETWINDOW (help_echo_window
, w
);
24396 help_echo_object
= string
;
24397 help_echo_pos
= charpos
;
24401 if (NILP (pointer
))
24402 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24404 /* Change the mouse pointer according to what is under X/Y. */
24405 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24408 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24409 if (!KEYMAPP (map
))
24410 map
= Fget_text_property (pos
, Qkeymap
, string
);
24411 if (!KEYMAPP (map
))
24412 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24415 /* Change the mouse face according to what is under X/Y. */
24416 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24417 if (!NILP (mouse_face
)
24418 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24423 struct glyph
* tmp_glyph
;
24427 int total_pixel_width
;
24432 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24433 Qmouse_face
, string
, Qnil
);
24435 b
= make_number (0);
24437 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24439 e
= make_number (SCHARS (string
));
24441 /* Calculate the position(glyph position: GPOS) of GLYPH in
24442 displayed string. GPOS is different from CHARPOS.
24444 CHARPOS is the position of glyph in internal string
24445 object. A mode line string format has structures which
24446 is converted to a flatten by emacs lisp interpreter.
24447 The internal string is an element of the structures.
24448 The displayed string is the flatten string. */
24450 if (glyph
> row_start_glyph
)
24452 tmp_glyph
= glyph
- 1;
24453 while (tmp_glyph
>= row_start_glyph
24454 && tmp_glyph
->charpos
>= XINT (b
)
24455 && EQ (tmp_glyph
->object
, glyph
->object
))
24462 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24463 displayed string holding GLYPH.
24465 GSEQ_LENGTH is different from SCHARS (STRING).
24466 SCHARS (STRING) returns the length of the internal string. */
24467 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24468 tmp_glyph
->charpos
< XINT (e
);
24469 tmp_glyph
++, gseq_length
++)
24471 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24475 total_pixel_width
= 0;
24476 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24477 total_pixel_width
+= tmp_glyph
->pixel_width
;
24479 /* Pre calculation of re-rendering position */
24481 hpos
= (area
== ON_MODE_LINE
24482 ? (w
->current_matrix
)->nrows
- 1
24485 /* If the re-rendering position is included in the last
24486 re-rendering area, we should do nothing. */
24487 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24488 && dpyinfo
->mouse_face_beg_col
<= vpos
24489 && vpos
< dpyinfo
->mouse_face_end_col
24490 && dpyinfo
->mouse_face_beg_row
== hpos
)
24493 if (clear_mouse_face (dpyinfo
))
24494 cursor
= No_Cursor
;
24496 dpyinfo
->mouse_face_beg_col
= vpos
;
24497 dpyinfo
->mouse_face_beg_row
= hpos
;
24499 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24500 dpyinfo
->mouse_face_beg_y
= 0;
24502 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24503 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24505 dpyinfo
->mouse_face_end_x
= 0;
24506 dpyinfo
->mouse_face_end_y
= 0;
24508 dpyinfo
->mouse_face_past_end
= 0;
24509 dpyinfo
->mouse_face_window
= window
;
24511 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24514 glyph
->face_id
, 1);
24515 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24517 if (NILP (pointer
))
24520 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24521 clear_mouse_face (dpyinfo
);
24523 define_frame_cursor1 (f
, cursor
, pointer
);
24528 Take proper action when the mouse has moved to position X, Y on
24529 frame F as regards highlighting characters that have mouse-face
24530 properties. Also de-highlighting chars where the mouse was before.
24531 X and Y can be negative or out of range. */
24534 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24536 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24537 enum window_part part
;
24538 Lisp_Object window
;
24540 Cursor cursor
= No_Cursor
;
24541 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24544 /* When a menu is active, don't highlight because this looks odd. */
24545 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24546 if (popup_activated ())
24550 if (NILP (Vmouse_highlight
)
24551 || !f
->glyphs_initialized_p
24552 || f
->pointer_invisible
)
24555 dpyinfo
->mouse_face_mouse_x
= x
;
24556 dpyinfo
->mouse_face_mouse_y
= y
;
24557 dpyinfo
->mouse_face_mouse_frame
= f
;
24559 if (dpyinfo
->mouse_face_defer
)
24562 if (gc_in_progress
)
24564 dpyinfo
->mouse_face_deferred_gc
= 1;
24568 /* Which window is that in? */
24569 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24571 /* If we were displaying active text in another window, clear that.
24572 Also clear if we move out of text area in same window. */
24573 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24574 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24575 && !NILP (dpyinfo
->mouse_face_window
)))
24576 clear_mouse_face (dpyinfo
);
24578 /* Not on a window -> return. */
24579 if (!WINDOWP (window
))
24582 /* Reset help_echo_string. It will get recomputed below. */
24583 help_echo_string
= Qnil
;
24585 /* Convert to window-relative pixel coordinates. */
24586 w
= XWINDOW (window
);
24587 frame_to_window_pixel_xy (w
, &x
, &y
);
24589 /* Handle tool-bar window differently since it doesn't display a
24591 if (EQ (window
, f
->tool_bar_window
))
24593 note_tool_bar_highlight (f
, x
, y
);
24597 /* Mouse is on the mode, header line or margin? */
24598 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24599 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24601 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24605 if (part
== ON_VERTICAL_BORDER
)
24607 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24608 help_echo_string
= build_string ("drag-mouse-1: resize");
24610 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24611 || part
== ON_SCROLL_BAR
)
24612 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24614 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24616 /* Are we in a window whose display is up to date?
24617 And verify the buffer's text has not changed. */
24618 b
= XBUFFER (w
->buffer
);
24619 if (part
== ON_TEXT
24620 && EQ (w
->window_end_valid
, w
->buffer
)
24621 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24622 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24624 int hpos
, vpos
, i
, dx
, dy
, area
;
24626 struct glyph
*glyph
;
24627 Lisp_Object object
;
24628 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24629 Lisp_Object
*overlay_vec
= NULL
;
24631 struct buffer
*obuf
;
24632 int obegv
, ozv
, same_region
;
24634 /* Find the glyph under X/Y. */
24635 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24637 /* Look for :pointer property on image. */
24638 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24640 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24641 if (img
!= NULL
&& IMAGEP (img
->spec
))
24643 Lisp_Object image_map
, hotspot
;
24644 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24646 && (hotspot
= find_hot_spot (image_map
,
24647 glyph
->slice
.x
+ dx
,
24648 glyph
->slice
.y
+ dy
),
24650 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24652 Lisp_Object area_id
, plist
;
24654 area_id
= XCAR (hotspot
);
24655 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24656 If so, we could look for mouse-enter, mouse-leave
24657 properties in PLIST (and do something...). */
24658 hotspot
= XCDR (hotspot
);
24659 if (CONSP (hotspot
)
24660 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24662 pointer
= Fplist_get (plist
, Qpointer
);
24663 if (NILP (pointer
))
24665 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24666 if (!NILP (help_echo_string
))
24668 help_echo_window
= window
;
24669 help_echo_object
= glyph
->object
;
24670 help_echo_pos
= glyph
->charpos
;
24674 if (NILP (pointer
))
24675 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24679 /* Clear mouse face if X/Y not over text. */
24681 || area
!= TEXT_AREA
24682 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24684 if (clear_mouse_face (dpyinfo
))
24685 cursor
= No_Cursor
;
24686 if (NILP (pointer
))
24688 if (area
!= TEXT_AREA
)
24689 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24691 pointer
= Vvoid_text_area_pointer
;
24696 pos
= glyph
->charpos
;
24697 object
= glyph
->object
;
24698 if (!STRINGP (object
) && !BUFFERP (object
))
24701 /* If we get an out-of-range value, return now; avoid an error. */
24702 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24705 /* Make the window's buffer temporarily current for
24706 overlays_at and compute_char_face. */
24707 obuf
= current_buffer
;
24708 current_buffer
= b
;
24714 /* Is this char mouse-active or does it have help-echo? */
24715 position
= make_number (pos
);
24717 if (BUFFERP (object
))
24719 /* Put all the overlays we want in a vector in overlay_vec. */
24720 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24721 /* Sort overlays into increasing priority order. */
24722 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24727 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24728 && vpos
>= dpyinfo
->mouse_face_beg_row
24729 && vpos
<= dpyinfo
->mouse_face_end_row
24730 && (vpos
> dpyinfo
->mouse_face_beg_row
24731 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24732 && (vpos
< dpyinfo
->mouse_face_end_row
24733 || hpos
< dpyinfo
->mouse_face_end_col
24734 || dpyinfo
->mouse_face_past_end
));
24737 cursor
= No_Cursor
;
24739 /* Check mouse-face highlighting. */
24741 /* If there exists an overlay with mouse-face overlapping
24742 the one we are currently highlighting, we have to
24743 check if we enter the overlapping overlay, and then
24744 highlight only that. */
24745 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24746 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24748 /* Find the highest priority overlay with a mouse-face. */
24750 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24752 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24753 if (!NILP (mouse_face
))
24754 overlay
= overlay_vec
[i
];
24757 /* If we're highlighting the same overlay as before, there's
24758 no need to do that again. */
24759 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24760 goto check_help_echo
;
24761 dpyinfo
->mouse_face_overlay
= overlay
;
24763 /* Clear the display of the old active region, if any. */
24764 if (clear_mouse_face (dpyinfo
))
24765 cursor
= No_Cursor
;
24767 /* If no overlay applies, get a text property. */
24768 if (NILP (overlay
))
24769 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24771 /* Next, compute the bounds of the mouse highlighting and
24773 if (!NILP (mouse_face
) && STRINGP (object
))
24775 /* The mouse-highlighting comes from a display string
24776 with a mouse-face. */
24780 b
= Fprevious_single_property_change
24781 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24782 e
= Fnext_single_property_change
24783 (position
, Qmouse_face
, object
, Qnil
);
24785 b
= make_number (0);
24787 e
= make_number (SCHARS (object
) - 1);
24789 fast_find_string_pos (w
, XINT (b
), object
,
24790 &dpyinfo
->mouse_face_beg_col
,
24791 &dpyinfo
->mouse_face_beg_row
,
24792 &dpyinfo
->mouse_face_beg_x
,
24793 &dpyinfo
->mouse_face_beg_y
, 0);
24794 fast_find_string_pos (w
, XINT (e
), object
,
24795 &dpyinfo
->mouse_face_end_col
,
24796 &dpyinfo
->mouse_face_end_row
,
24797 &dpyinfo
->mouse_face_end_x
,
24798 &dpyinfo
->mouse_face_end_y
, 1);
24799 dpyinfo
->mouse_face_past_end
= 0;
24800 dpyinfo
->mouse_face_window
= window
;
24801 dpyinfo
->mouse_face_face_id
24802 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24803 glyph
->face_id
, 1);
24804 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24805 cursor
= No_Cursor
;
24809 /* The mouse-highlighting, if any, comes from an overlay
24810 or text property in the buffer. */
24811 Lisp_Object buffer
, display_string
;
24813 if (STRINGP (object
))
24815 /* If we are on a display string with no mouse-face,
24816 check if the text under it has one. */
24817 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24818 int start
= MATRIX_ROW_START_CHARPOS (r
);
24819 pos
= string_buffer_position (w
, object
, start
);
24822 mouse_face
= get_char_property_and_overlay
24823 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24824 buffer
= w
->buffer
;
24825 display_string
= object
;
24831 display_string
= Qnil
;
24834 if (!NILP (mouse_face
))
24836 Lisp_Object before
, after
;
24837 Lisp_Object before_string
, after_string
;
24839 if (NILP (overlay
))
24841 /* Handle the text property case. */
24842 before
= Fprevious_single_property_change
24843 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24844 Fmarker_position (w
->start
));
24845 after
= Fnext_single_property_change
24846 (make_number (pos
), Qmouse_face
, buffer
,
24847 make_number (BUF_Z (XBUFFER (buffer
))
24848 - XFASTINT (w
->window_end_pos
)));
24849 before_string
= after_string
= Qnil
;
24853 /* Handle the overlay case. */
24854 before
= Foverlay_start (overlay
);
24855 after
= Foverlay_end (overlay
);
24856 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24857 after_string
= Foverlay_get (overlay
, Qafter_string
);
24859 if (!STRINGP (before_string
)) before_string
= Qnil
;
24860 if (!STRINGP (after_string
)) after_string
= Qnil
;
24863 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24866 before_string
, after_string
,
24868 cursor
= No_Cursor
;
24875 /* Look for a `help-echo' property. */
24876 if (NILP (help_echo_string
)) {
24877 Lisp_Object help
, overlay
;
24879 /* Check overlays first. */
24880 help
= overlay
= Qnil
;
24881 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24883 overlay
= overlay_vec
[i
];
24884 help
= Foverlay_get (overlay
, Qhelp_echo
);
24889 help_echo_string
= help
;
24890 help_echo_window
= window
;
24891 help_echo_object
= overlay
;
24892 help_echo_pos
= pos
;
24896 Lisp_Object object
= glyph
->object
;
24897 int charpos
= glyph
->charpos
;
24899 /* Try text properties. */
24900 if (STRINGP (object
)
24902 && charpos
< SCHARS (object
))
24904 help
= Fget_text_property (make_number (charpos
),
24905 Qhelp_echo
, object
);
24908 /* If the string itself doesn't specify a help-echo,
24909 see if the buffer text ``under'' it does. */
24910 struct glyph_row
*r
24911 = MATRIX_ROW (w
->current_matrix
, vpos
);
24912 int start
= MATRIX_ROW_START_CHARPOS (r
);
24913 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24916 help
= Fget_char_property (make_number (pos
),
24917 Qhelp_echo
, w
->buffer
);
24921 object
= w
->buffer
;
24926 else if (BUFFERP (object
)
24929 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24934 help_echo_string
= help
;
24935 help_echo_window
= window
;
24936 help_echo_object
= object
;
24937 help_echo_pos
= charpos
;
24942 /* Look for a `pointer' property. */
24943 if (NILP (pointer
))
24945 /* Check overlays first. */
24946 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24947 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24949 if (NILP (pointer
))
24951 Lisp_Object object
= glyph
->object
;
24952 int charpos
= glyph
->charpos
;
24954 /* Try text properties. */
24955 if (STRINGP (object
)
24957 && charpos
< SCHARS (object
))
24959 pointer
= Fget_text_property (make_number (charpos
),
24961 if (NILP (pointer
))
24963 /* If the string itself doesn't specify a pointer,
24964 see if the buffer text ``under'' it does. */
24965 struct glyph_row
*r
24966 = MATRIX_ROW (w
->current_matrix
, vpos
);
24967 int start
= MATRIX_ROW_START_CHARPOS (r
);
24968 EMACS_INT pos
= string_buffer_position (w
, object
,
24971 pointer
= Fget_char_property (make_number (pos
),
24972 Qpointer
, w
->buffer
);
24975 else if (BUFFERP (object
)
24978 pointer
= Fget_text_property (make_number (charpos
),
24985 current_buffer
= obuf
;
24990 define_frame_cursor1 (f
, cursor
, pointer
);
24995 Clear any mouse-face on window W. This function is part of the
24996 redisplay interface, and is called from try_window_id and similar
24997 functions to ensure the mouse-highlight is off. */
25000 x_clear_window_mouse_face (struct window
*w
)
25002 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
25003 Lisp_Object window
;
25006 XSETWINDOW (window
, w
);
25007 if (EQ (window
, dpyinfo
->mouse_face_window
))
25008 clear_mouse_face (dpyinfo
);
25014 Just discard the mouse face information for frame F, if any.
25015 This is used when the size of F is changed. */
25018 cancel_mouse_face (struct frame
*f
)
25020 Lisp_Object window
;
25021 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25023 window
= dpyinfo
->mouse_face_window
;
25024 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25026 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25027 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25028 dpyinfo
->mouse_face_window
= Qnil
;
25033 #endif /* HAVE_WINDOW_SYSTEM */
25036 /***********************************************************************
25038 ***********************************************************************/
25040 #ifdef HAVE_WINDOW_SYSTEM
25042 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25043 which intersects rectangle R. R is in window-relative coordinates. */
25046 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25047 enum glyph_row_area area
)
25049 struct glyph
*first
= row
->glyphs
[area
];
25050 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25051 struct glyph
*last
;
25052 int first_x
, start_x
, x
;
25054 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25055 /* If row extends face to end of line write the whole line. */
25056 draw_glyphs (w
, 0, row
, area
,
25057 0, row
->used
[area
],
25058 DRAW_NORMAL_TEXT
, 0);
25061 /* Set START_X to the window-relative start position for drawing glyphs of
25062 AREA. The first glyph of the text area can be partially visible.
25063 The first glyphs of other areas cannot. */
25064 start_x
= window_box_left_offset (w
, area
);
25066 if (area
== TEXT_AREA
)
25069 /* Find the first glyph that must be redrawn. */
25071 && x
+ first
->pixel_width
< r
->x
)
25073 x
+= first
->pixel_width
;
25077 /* Find the last one. */
25081 && x
< r
->x
+ r
->width
)
25083 x
+= last
->pixel_width
;
25089 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25090 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25091 DRAW_NORMAL_TEXT
, 0);
25096 /* Redraw the parts of the glyph row ROW on window W intersecting
25097 rectangle R. R is in window-relative coordinates. Value is
25098 non-zero if mouse-face was overwritten. */
25101 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25103 xassert (row
->enabled_p
);
25105 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25106 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25107 0, row
->used
[TEXT_AREA
],
25108 DRAW_NORMAL_TEXT
, 0);
25111 if (row
->used
[LEFT_MARGIN_AREA
])
25112 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25113 if (row
->used
[TEXT_AREA
])
25114 expose_area (w
, row
, r
, TEXT_AREA
);
25115 if (row
->used
[RIGHT_MARGIN_AREA
])
25116 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25117 draw_row_fringe_bitmaps (w
, row
);
25120 return row
->mouse_face_p
;
25124 /* Redraw those parts of glyphs rows during expose event handling that
25125 overlap other rows. Redrawing of an exposed line writes over parts
25126 of lines overlapping that exposed line; this function fixes that.
25128 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25129 row in W's current matrix that is exposed and overlaps other rows.
25130 LAST_OVERLAPPING_ROW is the last such row. */
25133 expose_overlaps (struct window
*w
,
25134 struct glyph_row
*first_overlapping_row
,
25135 struct glyph_row
*last_overlapping_row
,
25138 struct glyph_row
*row
;
25140 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25141 if (row
->overlapping_p
)
25143 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25146 if (row
->used
[LEFT_MARGIN_AREA
])
25147 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25149 if (row
->used
[TEXT_AREA
])
25150 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25152 if (row
->used
[RIGHT_MARGIN_AREA
])
25153 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25159 /* Return non-zero if W's cursor intersects rectangle R. */
25162 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25164 XRectangle cr
, result
;
25165 struct glyph
*cursor_glyph
;
25166 struct glyph_row
*row
;
25168 if (w
->phys_cursor
.vpos
>= 0
25169 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25170 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25172 && row
->cursor_in_fringe_p
)
25174 /* Cursor is in the fringe. */
25175 cr
.x
= window_box_right_offset (w
,
25176 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25177 ? RIGHT_MARGIN_AREA
25180 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25181 cr
.height
= row
->height
;
25182 return x_intersect_rectangles (&cr
, r
, &result
);
25185 cursor_glyph
= get_phys_cursor_glyph (w
);
25188 /* r is relative to W's box, but w->phys_cursor.x is relative
25189 to left edge of W's TEXT area. Adjust it. */
25190 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25191 cr
.y
= w
->phys_cursor
.y
;
25192 cr
.width
= cursor_glyph
->pixel_width
;
25193 cr
.height
= w
->phys_cursor_height
;
25194 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25195 I assume the effect is the same -- and this is portable. */
25196 return x_intersect_rectangles (&cr
, r
, &result
);
25198 /* If we don't understand the format, pretend we're not in the hot-spot. */
25204 Draw a vertical window border to the right of window W if W doesn't
25205 have vertical scroll bars. */
25208 x_draw_vertical_border (struct window
*w
)
25210 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25212 /* We could do better, if we knew what type of scroll-bar the adjacent
25213 windows (on either side) have... But we don't :-(
25214 However, I think this works ok. ++KFS 2003-04-25 */
25216 /* Redraw borders between horizontally adjacent windows. Don't
25217 do it for frames with vertical scroll bars because either the
25218 right scroll bar of a window, or the left scroll bar of its
25219 neighbor will suffice as a border. */
25220 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25223 if (!WINDOW_RIGHTMOST_P (w
)
25224 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25226 int x0
, x1
, y0
, y1
;
25228 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25231 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25234 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25236 else if (!WINDOW_LEFTMOST_P (w
)
25237 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25239 int x0
, x1
, y0
, y1
;
25241 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25244 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25247 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25252 /* Redraw the part of window W intersection rectangle FR. Pixel
25253 coordinates in FR are frame-relative. Call this function with
25254 input blocked. Value is non-zero if the exposure overwrites
25258 expose_window (struct window
*w
, XRectangle
*fr
)
25260 struct frame
*f
= XFRAME (w
->frame
);
25262 int mouse_face_overwritten_p
= 0;
25264 /* If window is not yet fully initialized, do nothing. This can
25265 happen when toolkit scroll bars are used and a window is split.
25266 Reconfiguring the scroll bar will generate an expose for a newly
25268 if (w
->current_matrix
== NULL
)
25271 /* When we're currently updating the window, display and current
25272 matrix usually don't agree. Arrange for a thorough display
25274 if (w
== updated_window
)
25276 SET_FRAME_GARBAGED (f
);
25280 /* Frame-relative pixel rectangle of W. */
25281 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25282 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25283 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25284 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25286 if (x_intersect_rectangles (fr
, &wr
, &r
))
25288 int yb
= window_text_bottom_y (w
);
25289 struct glyph_row
*row
;
25290 int cursor_cleared_p
;
25291 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25293 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25294 r
.x
, r
.y
, r
.width
, r
.height
));
25296 /* Convert to window coordinates. */
25297 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25298 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25300 /* Turn off the cursor. */
25301 if (!w
->pseudo_window_p
25302 && phys_cursor_in_rect_p (w
, &r
))
25304 x_clear_cursor (w
);
25305 cursor_cleared_p
= 1;
25308 cursor_cleared_p
= 0;
25310 /* Update lines intersecting rectangle R. */
25311 first_overlapping_row
= last_overlapping_row
= NULL
;
25312 for (row
= w
->current_matrix
->rows
;
25317 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25319 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25320 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25321 || (r
.y
>= y0
&& r
.y
< y1
)
25322 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25324 /* A header line may be overlapping, but there is no need
25325 to fix overlapping areas for them. KFS 2005-02-12 */
25326 if (row
->overlapping_p
&& !row
->mode_line_p
)
25328 if (first_overlapping_row
== NULL
)
25329 first_overlapping_row
= row
;
25330 last_overlapping_row
= row
;
25334 if (expose_line (w
, row
, &r
))
25335 mouse_face_overwritten_p
= 1;
25338 else if (row
->overlapping_p
)
25340 /* We must redraw a row overlapping the exposed area. */
25342 ? y0
+ row
->phys_height
> r
.y
25343 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25345 if (first_overlapping_row
== NULL
)
25346 first_overlapping_row
= row
;
25347 last_overlapping_row
= row
;
25355 /* Display the mode line if there is one. */
25356 if (WINDOW_WANTS_MODELINE_P (w
)
25357 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25359 && row
->y
< r
.y
+ r
.height
)
25361 if (expose_line (w
, row
, &r
))
25362 mouse_face_overwritten_p
= 1;
25365 if (!w
->pseudo_window_p
)
25367 /* Fix the display of overlapping rows. */
25368 if (first_overlapping_row
)
25369 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25372 /* Draw border between windows. */
25373 x_draw_vertical_border (w
);
25375 /* Turn the cursor on again. */
25376 if (cursor_cleared_p
)
25377 update_window_cursor (w
, 1);
25381 return mouse_face_overwritten_p
;
25386 /* Redraw (parts) of all windows in the window tree rooted at W that
25387 intersect R. R contains frame pixel coordinates. Value is
25388 non-zero if the exposure overwrites mouse-face. */
25391 expose_window_tree (struct window
*w
, XRectangle
*r
)
25393 struct frame
*f
= XFRAME (w
->frame
);
25394 int mouse_face_overwritten_p
= 0;
25396 while (w
&& !FRAME_GARBAGED_P (f
))
25398 if (!NILP (w
->hchild
))
25399 mouse_face_overwritten_p
25400 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25401 else if (!NILP (w
->vchild
))
25402 mouse_face_overwritten_p
25403 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25405 mouse_face_overwritten_p
|= expose_window (w
, r
);
25407 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25410 return mouse_face_overwritten_p
;
25415 Redisplay an exposed area of frame F. X and Y are the upper-left
25416 corner of the exposed rectangle. W and H are width and height of
25417 the exposed area. All are pixel values. W or H zero means redraw
25418 the entire frame. */
25421 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25424 int mouse_face_overwritten_p
= 0;
25426 TRACE ((stderr
, "expose_frame "));
25428 /* No need to redraw if frame will be redrawn soon. */
25429 if (FRAME_GARBAGED_P (f
))
25431 TRACE ((stderr
, " garbaged\n"));
25435 /* If basic faces haven't been realized yet, there is no point in
25436 trying to redraw anything. This can happen when we get an expose
25437 event while Emacs is starting, e.g. by moving another window. */
25438 if (FRAME_FACE_CACHE (f
) == NULL
25439 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25441 TRACE ((stderr
, " no faces\n"));
25445 if (w
== 0 || h
== 0)
25448 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25449 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25459 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25460 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25462 if (WINDOWP (f
->tool_bar_window
))
25463 mouse_face_overwritten_p
25464 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25466 #ifdef HAVE_X_WINDOWS
25468 #ifndef USE_X_TOOLKIT
25469 if (WINDOWP (f
->menu_bar_window
))
25470 mouse_face_overwritten_p
25471 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25472 #endif /* not USE_X_TOOLKIT */
25476 /* Some window managers support a focus-follows-mouse style with
25477 delayed raising of frames. Imagine a partially obscured frame,
25478 and moving the mouse into partially obscured mouse-face on that
25479 frame. The visible part of the mouse-face will be highlighted,
25480 then the WM raises the obscured frame. With at least one WM, KDE
25481 2.1, Emacs is not getting any event for the raising of the frame
25482 (even tried with SubstructureRedirectMask), only Expose events.
25483 These expose events will draw text normally, i.e. not
25484 highlighted. Which means we must redo the highlight here.
25485 Subsume it under ``we love X''. --gerd 2001-08-15 */
25486 /* Included in Windows version because Windows most likely does not
25487 do the right thing if any third party tool offers
25488 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25489 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25491 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25492 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25494 int x
= dpyinfo
->mouse_face_mouse_x
;
25495 int y
= dpyinfo
->mouse_face_mouse_y
;
25496 clear_mouse_face (dpyinfo
);
25497 note_mouse_highlight (f
, x
, y
);
25504 Determine the intersection of two rectangles R1 and R2. Return
25505 the intersection in *RESULT. Value is non-zero if RESULT is not
25509 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25511 XRectangle
*left
, *right
;
25512 XRectangle
*upper
, *lower
;
25513 int intersection_p
= 0;
25515 /* Rearrange so that R1 is the left-most rectangle. */
25517 left
= r1
, right
= r2
;
25519 left
= r2
, right
= r1
;
25521 /* X0 of the intersection is right.x0, if this is inside R1,
25522 otherwise there is no intersection. */
25523 if (right
->x
<= left
->x
+ left
->width
)
25525 result
->x
= right
->x
;
25527 /* The right end of the intersection is the minimum of the
25528 the right ends of left and right. */
25529 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25532 /* Same game for Y. */
25534 upper
= r1
, lower
= r2
;
25536 upper
= r2
, lower
= r1
;
25538 /* The upper end of the intersection is lower.y0, if this is inside
25539 of upper. Otherwise, there is no intersection. */
25540 if (lower
->y
<= upper
->y
+ upper
->height
)
25542 result
->y
= lower
->y
;
25544 /* The lower end of the intersection is the minimum of the lower
25545 ends of upper and lower. */
25546 result
->height
= (min (lower
->y
+ lower
->height
,
25547 upper
->y
+ upper
->height
)
25549 intersection_p
= 1;
25553 return intersection_p
;
25556 #endif /* HAVE_WINDOW_SYSTEM */
25559 /***********************************************************************
25561 ***********************************************************************/
25564 syms_of_xdisp (void)
25566 Vwith_echo_area_save_vector
= Qnil
;
25567 staticpro (&Vwith_echo_area_save_vector
);
25569 Vmessage_stack
= Qnil
;
25570 staticpro (&Vmessage_stack
);
25572 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25573 staticpro (&Qinhibit_redisplay
);
25575 message_dolog_marker1
= Fmake_marker ();
25576 staticpro (&message_dolog_marker1
);
25577 message_dolog_marker2
= Fmake_marker ();
25578 staticpro (&message_dolog_marker2
);
25579 message_dolog_marker3
= Fmake_marker ();
25580 staticpro (&message_dolog_marker3
);
25583 defsubr (&Sdump_frame_glyph_matrix
);
25584 defsubr (&Sdump_glyph_matrix
);
25585 defsubr (&Sdump_glyph_row
);
25586 defsubr (&Sdump_tool_bar_row
);
25587 defsubr (&Strace_redisplay
);
25588 defsubr (&Strace_to_stderr
);
25590 #ifdef HAVE_WINDOW_SYSTEM
25591 defsubr (&Stool_bar_lines_needed
);
25592 defsubr (&Slookup_image_map
);
25594 defsubr (&Sformat_mode_line
);
25595 defsubr (&Sinvisible_p
);
25596 defsubr (&Scurrent_bidi_paragraph_direction
);
25598 staticpro (&Qmenu_bar_update_hook
);
25599 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25601 staticpro (&Qoverriding_terminal_local_map
);
25602 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25604 staticpro (&Qoverriding_local_map
);
25605 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25607 staticpro (&Qwindow_scroll_functions
);
25608 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25610 staticpro (&Qwindow_text_change_functions
);
25611 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25613 staticpro (&Qredisplay_end_trigger_functions
);
25614 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25616 staticpro (&Qinhibit_point_motion_hooks
);
25617 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25619 Qeval
= intern_c_string ("eval");
25620 staticpro (&Qeval
);
25622 QCdata
= intern_c_string (":data");
25623 staticpro (&QCdata
);
25624 Qdisplay
= intern_c_string ("display");
25625 staticpro (&Qdisplay
);
25626 Qspace_width
= intern_c_string ("space-width");
25627 staticpro (&Qspace_width
);
25628 Qraise
= intern_c_string ("raise");
25629 staticpro (&Qraise
);
25630 Qslice
= intern_c_string ("slice");
25631 staticpro (&Qslice
);
25632 Qspace
= intern_c_string ("space");
25633 staticpro (&Qspace
);
25634 Qmargin
= intern_c_string ("margin");
25635 staticpro (&Qmargin
);
25636 Qpointer
= intern_c_string ("pointer");
25637 staticpro (&Qpointer
);
25638 Qleft_margin
= intern_c_string ("left-margin");
25639 staticpro (&Qleft_margin
);
25640 Qright_margin
= intern_c_string ("right-margin");
25641 staticpro (&Qright_margin
);
25642 Qcenter
= intern_c_string ("center");
25643 staticpro (&Qcenter
);
25644 Qline_height
= intern_c_string ("line-height");
25645 staticpro (&Qline_height
);
25646 QCalign_to
= intern_c_string (":align-to");
25647 staticpro (&QCalign_to
);
25648 QCrelative_width
= intern_c_string (":relative-width");
25649 staticpro (&QCrelative_width
);
25650 QCrelative_height
= intern_c_string (":relative-height");
25651 staticpro (&QCrelative_height
);
25652 QCeval
= intern_c_string (":eval");
25653 staticpro (&QCeval
);
25654 QCpropertize
= intern_c_string (":propertize");
25655 staticpro (&QCpropertize
);
25656 QCfile
= intern_c_string (":file");
25657 staticpro (&QCfile
);
25658 Qfontified
= intern_c_string ("fontified");
25659 staticpro (&Qfontified
);
25660 Qfontification_functions
= intern_c_string ("fontification-functions");
25661 staticpro (&Qfontification_functions
);
25662 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25663 staticpro (&Qtrailing_whitespace
);
25664 Qescape_glyph
= intern_c_string ("escape-glyph");
25665 staticpro (&Qescape_glyph
);
25666 Qnobreak_space
= intern_c_string ("nobreak-space");
25667 staticpro (&Qnobreak_space
);
25668 Qimage
= intern_c_string ("image");
25669 staticpro (&Qimage
);
25670 Qtext
= intern_c_string ("text");
25671 staticpro (&Qtext
);
25672 Qboth
= intern_c_string ("both");
25673 staticpro (&Qboth
);
25674 Qboth_horiz
= intern_c_string ("both-horiz");
25675 staticpro (&Qboth_horiz
);
25676 QCmap
= intern_c_string (":map");
25677 staticpro (&QCmap
);
25678 QCpointer
= intern_c_string (":pointer");
25679 staticpro (&QCpointer
);
25680 Qrect
= intern_c_string ("rect");
25681 staticpro (&Qrect
);
25682 Qcircle
= intern_c_string ("circle");
25683 staticpro (&Qcircle
);
25684 Qpoly
= intern_c_string ("poly");
25685 staticpro (&Qpoly
);
25686 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25687 staticpro (&Qmessage_truncate_lines
);
25688 Qgrow_only
= intern_c_string ("grow-only");
25689 staticpro (&Qgrow_only
);
25690 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25691 staticpro (&Qinhibit_menubar_update
);
25692 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25693 staticpro (&Qinhibit_eval_during_redisplay
);
25694 Qposition
= intern_c_string ("position");
25695 staticpro (&Qposition
);
25696 Qbuffer_position
= intern_c_string ("buffer-position");
25697 staticpro (&Qbuffer_position
);
25698 Qobject
= intern_c_string ("object");
25699 staticpro (&Qobject
);
25700 Qbar
= intern_c_string ("bar");
25702 Qhbar
= intern_c_string ("hbar");
25703 staticpro (&Qhbar
);
25704 Qbox
= intern_c_string ("box");
25706 Qhollow
= intern_c_string ("hollow");
25707 staticpro (&Qhollow
);
25708 Qhand
= intern_c_string ("hand");
25709 staticpro (&Qhand
);
25710 Qarrow
= intern_c_string ("arrow");
25711 staticpro (&Qarrow
);
25712 Qtext
= intern_c_string ("text");
25713 staticpro (&Qtext
);
25714 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25715 staticpro (&Qrisky_local_variable
);
25716 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25717 staticpro (&Qinhibit_free_realized_faces
);
25719 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25720 Fcons (intern_c_string ("void-variable"), Qnil
)),
25722 staticpro (&list_of_error
);
25724 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25725 staticpro (&Qlast_arrow_position
);
25726 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25727 staticpro (&Qlast_arrow_string
);
25729 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25730 staticpro (&Qoverlay_arrow_string
);
25731 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25732 staticpro (&Qoverlay_arrow_bitmap
);
25734 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25735 staticpro (&echo_buffer
[0]);
25736 staticpro (&echo_buffer
[1]);
25738 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25739 staticpro (&echo_area_buffer
[0]);
25740 staticpro (&echo_area_buffer
[1]);
25742 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25743 staticpro (&Vmessages_buffer_name
);
25745 mode_line_proptrans_alist
= Qnil
;
25746 staticpro (&mode_line_proptrans_alist
);
25747 mode_line_string_list
= Qnil
;
25748 staticpro (&mode_line_string_list
);
25749 mode_line_string_face
= Qnil
;
25750 staticpro (&mode_line_string_face
);
25751 mode_line_string_face_prop
= Qnil
;
25752 staticpro (&mode_line_string_face_prop
);
25753 Vmode_line_unwind_vector
= Qnil
;
25754 staticpro (&Vmode_line_unwind_vector
);
25756 help_echo_string
= Qnil
;
25757 staticpro (&help_echo_string
);
25758 help_echo_object
= Qnil
;
25759 staticpro (&help_echo_object
);
25760 help_echo_window
= Qnil
;
25761 staticpro (&help_echo_window
);
25762 previous_help_echo_string
= Qnil
;
25763 staticpro (&previous_help_echo_string
);
25764 help_echo_pos
= -1;
25766 Qright_to_left
= intern_c_string ("right-to-left");
25767 staticpro (&Qright_to_left
);
25768 Qleft_to_right
= intern_c_string ("left-to-right");
25769 staticpro (&Qleft_to_right
);
25771 #ifdef HAVE_WINDOW_SYSTEM
25772 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25773 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25774 For example, if a block cursor is over a tab, it will be drawn as
25775 wide as that tab on the display. */);
25776 x_stretch_cursor_p
= 0;
25779 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25780 doc
: /* *Non-nil means highlight trailing whitespace.
25781 The face used for trailing whitespace is `trailing-whitespace'. */);
25782 Vshow_trailing_whitespace
= Qnil
;
25784 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25785 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25786 A value of t means highlight the character itself (for nobreak space,
25787 use face `nobreak-space').
25788 A value of nil means no highlighting.
25789 Other values mean display the escape glyph followed by an ordinary
25790 space or ordinary hyphen. */);
25791 Vnobreak_char_display
= Qt
;
25793 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25794 doc
: /* *The pointer shape to show in void text areas.
25795 A value of nil means to show the text pointer. Other options are `arrow',
25796 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25797 Vvoid_text_area_pointer
= Qarrow
;
25799 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25800 doc
: /* Non-nil means don't actually do any redisplay.
25801 This is used for internal purposes. */);
25802 Vinhibit_redisplay
= Qnil
;
25804 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25805 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25806 Vglobal_mode_string
= Qnil
;
25808 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25809 doc
: /* Marker for where to display an arrow on top of the buffer text.
25810 This must be the beginning of a line in order to work.
25811 See also `overlay-arrow-string'. */);
25812 Voverlay_arrow_position
= Qnil
;
25814 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25815 doc
: /* String to display as an arrow in non-window frames.
25816 See also `overlay-arrow-position'. */);
25817 Voverlay_arrow_string
= make_pure_c_string ("=>");
25819 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25820 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25821 The symbols on this list are examined during redisplay to determine
25822 where to display overlay arrows. */);
25823 Voverlay_arrow_variable_list
25824 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25826 DEFVAR_INT ("scroll-step", &scroll_step
,
25827 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25828 If that fails to bring point back on frame, point is centered instead.
25829 If this is zero, point is always centered after it moves off frame.
25830 If you want scrolling to always be a line at a time, you should set
25831 `scroll-conservatively' to a large value rather than set this to 1. */);
25833 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25834 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25835 If point moves off-screen, redisplay will scroll by up to
25836 `scroll-conservatively' lines in order to bring point just barely
25837 onto the screen again. If that cannot be done, then redisplay
25838 recenters point as usual.
25840 A value of zero means always recenter point if it moves off screen. */);
25841 scroll_conservatively
= 0;
25843 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25844 doc
: /* *Number of lines of margin at the top and bottom of a window.
25845 Recenter the window whenever point gets within this many lines
25846 of the top or bottom of the window. */);
25849 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25850 doc
: /* Pixels per inch value for non-window system displays.
25851 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25852 Vdisplay_pixels_per_inch
= make_float (72.0);
25855 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25858 DEFVAR_LISP ("truncate-partial-width-windows",
25859 &Vtruncate_partial_width_windows
,
25860 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25861 For an integer value, truncate lines in each window narrower than the
25862 full frame width, provided the window width is less than that integer;
25863 otherwise, respect the value of `truncate-lines'.
25865 For any other non-nil value, truncate lines in all windows that do
25866 not span the full frame width.
25868 A value of nil means to respect the value of `truncate-lines'.
25870 If `word-wrap' is enabled, you might want to reduce this. */);
25871 Vtruncate_partial_width_windows
= make_number (50);
25873 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25874 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25875 Any other value means to use the appropriate face, `mode-line',
25876 `header-line', or `menu' respectively. */);
25877 mode_line_inverse_video
= 1;
25879 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25880 doc
: /* *Maximum buffer size for which line number should be displayed.
25881 If the buffer is bigger than this, the line number does not appear
25882 in the mode line. A value of nil means no limit. */);
25883 Vline_number_display_limit
= Qnil
;
25885 DEFVAR_INT ("line-number-display-limit-width",
25886 &line_number_display_limit_width
,
25887 doc
: /* *Maximum line width (in characters) for line number display.
25888 If the average length of the lines near point is bigger than this, then the
25889 line number may be omitted from the mode line. */);
25890 line_number_display_limit_width
= 200;
25892 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25893 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25894 highlight_nonselected_windows
= 0;
25896 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25897 doc
: /* Non-nil if more than one frame is visible on this display.
25898 Minibuffer-only frames don't count, but iconified frames do.
25899 This variable is not guaranteed to be accurate except while processing
25900 `frame-title-format' and `icon-title-format'. */);
25902 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25903 doc
: /* Template for displaying the title bar of visible frames.
25904 \(Assuming the window manager supports this feature.)
25906 This variable has the same structure as `mode-line-format', except that
25907 the %c and %l constructs are ignored. It is used only on frames for
25908 which no explicit name has been set \(see `modify-frame-parameters'). */);
25910 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25911 doc
: /* Template for displaying the title bar of an iconified frame.
25912 \(Assuming the window manager supports this feature.)
25913 This variable has the same structure as `mode-line-format' (which see),
25914 and is used only on frames for which no explicit name has been set
25915 \(see `modify-frame-parameters'). */);
25917 = Vframe_title_format
25918 = pure_cons (intern_c_string ("multiple-frames"),
25919 pure_cons (make_pure_c_string ("%b"),
25920 pure_cons (pure_cons (empty_unibyte_string
,
25921 pure_cons (intern_c_string ("invocation-name"),
25922 pure_cons (make_pure_c_string ("@"),
25923 pure_cons (intern_c_string ("system-name"),
25927 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25928 doc
: /* Maximum number of lines to keep in the message log buffer.
25929 If nil, disable message logging. If t, log messages but don't truncate
25930 the buffer when it becomes large. */);
25931 Vmessage_log_max
= make_number (100);
25933 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25934 doc
: /* Functions called before redisplay, if window sizes have changed.
25935 The value should be a list of functions that take one argument.
25936 Just before redisplay, for each frame, if any of its windows have changed
25937 size since the last redisplay, or have been split or deleted,
25938 all the functions in the list are called, with the frame as argument. */);
25939 Vwindow_size_change_functions
= Qnil
;
25941 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25942 doc
: /* List of functions to call before redisplaying a window with scrolling.
25943 Each function is called with two arguments, the window and its new
25944 display-start position. Note that these functions are also called by
25945 `set-window-buffer'. Also note that the value of `window-end' is not
25946 valid when these functions are called. */);
25947 Vwindow_scroll_functions
= Qnil
;
25949 DEFVAR_LISP ("window-text-change-functions",
25950 &Vwindow_text_change_functions
,
25951 doc
: /* Functions to call in redisplay when text in the window might change. */);
25952 Vwindow_text_change_functions
= Qnil
;
25954 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25955 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25956 Each function is called with two arguments, the window and the end trigger value.
25957 See `set-window-redisplay-end-trigger'. */);
25958 Vredisplay_end_trigger_functions
= Qnil
;
25960 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25961 doc
: /* *Non-nil means autoselect window with mouse pointer.
25962 If nil, do not autoselect windows.
25963 A positive number means delay autoselection by that many seconds: a
25964 window is autoselected only after the mouse has remained in that
25965 window for the duration of the delay.
25966 A negative number has a similar effect, but causes windows to be
25967 autoselected only after the mouse has stopped moving. \(Because of
25968 the way Emacs compares mouse events, you will occasionally wait twice
25969 that time before the window gets selected.\)
25970 Any other value means to autoselect window instantaneously when the
25971 mouse pointer enters it.
25973 Autoselection selects the minibuffer only if it is active, and never
25974 unselects the minibuffer if it is active.
25976 When customizing this variable make sure that the actual value of
25977 `focus-follows-mouse' matches the behavior of your window manager. */);
25978 Vmouse_autoselect_window
= Qnil
;
25980 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25981 doc
: /* *Non-nil means automatically resize tool-bars.
25982 This dynamically changes the tool-bar's height to the minimum height
25983 that is needed to make all tool-bar items visible.
25984 If value is `grow-only', the tool-bar's height is only increased
25985 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25986 Vauto_resize_tool_bars
= Qt
;
25988 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25989 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25990 auto_raise_tool_bar_buttons_p
= 1;
25992 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25993 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25994 make_cursor_line_fully_visible_p
= 1;
25996 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25997 doc
: /* *Border below tool-bar in pixels.
25998 If an integer, use it as the height of the border.
25999 If it is one of `internal-border-width' or `border-width', use the
26000 value of the corresponding frame parameter.
26001 Otherwise, no border is added below the tool-bar. */);
26002 Vtool_bar_border
= Qinternal_border_width
;
26004 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
26005 doc
: /* *Margin around tool-bar buttons in pixels.
26006 If an integer, use that for both horizontal and vertical margins.
26007 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26008 HORZ specifying the horizontal margin, and VERT specifying the
26009 vertical margin. */);
26010 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26012 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
26013 doc
: /* *Relief thickness of tool-bar buttons. */);
26014 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26016 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
26017 doc
: /* *Tool bar style to use.
26019 image - show images only
26020 text - show text only
26021 both - show both, text under image
26022 both-horiz - show text to the right of the image
26023 any other - use system default or image if no system default. */);
26024 Vtool_bar_style
= Qnil
;
26026 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26027 doc
: /* *Maximum number of characters a label can have to be shown.
26028 The tool bar style must also show labels for this to have any effect, see
26029 `tool-bar-style'. */);
26030 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26032 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26033 doc
: /* List of functions to call to fontify regions of text.
26034 Each function is called with one argument POS. Functions must
26035 fontify a region starting at POS in the current buffer, and give
26036 fontified regions the property `fontified'. */);
26037 Vfontification_functions
= Qnil
;
26038 Fmake_variable_buffer_local (Qfontification_functions
);
26040 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26041 &unibyte_display_via_language_environment
,
26042 doc
: /* *Non-nil means display unibyte text according to language environment.
26043 Specifically, this means that raw bytes in the range 160-255 decimal
26044 are displayed by converting them to the equivalent multibyte characters
26045 according to the current language environment. As a result, they are
26046 displayed according to the current fontset.
26048 Note that this variable affects only how these bytes are displayed,
26049 but does not change the fact they are interpreted as raw bytes. */);
26050 unibyte_display_via_language_environment
= 0;
26052 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26053 doc
: /* *Maximum height for resizing mini-windows.
26054 If a float, it specifies a fraction of the mini-window frame's height.
26055 If an integer, it specifies a number of lines. */);
26056 Vmax_mini_window_height
= make_float (0.25);
26058 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26059 doc
: /* *How to resize mini-windows.
26060 A value of nil means don't automatically resize mini-windows.
26061 A value of t means resize them to fit the text displayed in them.
26062 A value of `grow-only', the default, means let mini-windows grow
26063 only, until their display becomes empty, at which point the windows
26064 go back to their normal size. */);
26065 Vresize_mini_windows
= Qgrow_only
;
26067 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26068 doc
: /* Alist specifying how to blink the cursor off.
26069 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26070 `cursor-type' frame-parameter or variable equals ON-STATE,
26071 comparing using `equal', Emacs uses OFF-STATE to specify
26072 how to blink it off. ON-STATE and OFF-STATE are values for
26073 the `cursor-type' frame parameter.
26075 If a frame's ON-STATE has no entry in this list,
26076 the frame's other specifications determine how to blink the cursor off. */);
26077 Vblink_cursor_alist
= Qnil
;
26079 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26080 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26081 automatic_hscrolling_p
= 1;
26082 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26083 staticpro (&Qauto_hscroll_mode
);
26085 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26086 doc
: /* *How many columns away from the window edge point is allowed to get
26087 before automatic hscrolling will horizontally scroll the window. */);
26088 hscroll_margin
= 5;
26090 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26091 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26092 When point is less than `hscroll-margin' columns from the window
26093 edge, automatic hscrolling will scroll the window by the amount of columns
26094 determined by this variable. If its value is a positive integer, scroll that
26095 many columns. If it's a positive floating-point number, it specifies the
26096 fraction of the window's width to scroll. If it's nil or zero, point will be
26097 centered horizontally after the scroll. Any other value, including negative
26098 numbers, are treated as if the value were zero.
26100 Automatic hscrolling always moves point outside the scroll margin, so if
26101 point was more than scroll step columns inside the margin, the window will
26102 scroll more than the value given by the scroll step.
26104 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26105 and `scroll-right' overrides this variable's effect. */);
26106 Vhscroll_step
= make_number (0);
26108 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26109 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26110 Bind this around calls to `message' to let it take effect. */);
26111 message_truncate_lines
= 0;
26113 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26114 doc
: /* Normal hook run to update the menu bar definitions.
26115 Redisplay runs this hook before it redisplays the menu bar.
26116 This is used to update submenus such as Buffers,
26117 whose contents depend on various data. */);
26118 Vmenu_bar_update_hook
= Qnil
;
26120 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26121 doc
: /* Frame for which we are updating a menu.
26122 The enable predicate for a menu binding should check this variable. */);
26123 Vmenu_updating_frame
= Qnil
;
26125 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26126 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26127 inhibit_menubar_update
= 0;
26129 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26130 doc
: /* Prefix prepended to all continuation lines at display time.
26131 The value may be a string, an image, or a stretch-glyph; it is
26132 interpreted in the same way as the value of a `display' text property.
26134 This variable is overridden by any `wrap-prefix' text or overlay
26137 To add a prefix to non-continuation lines, use `line-prefix'. */);
26138 Vwrap_prefix
= Qnil
;
26139 staticpro (&Qwrap_prefix
);
26140 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26141 Fmake_variable_buffer_local (Qwrap_prefix
);
26143 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26144 doc
: /* Prefix prepended to all non-continuation lines at display time.
26145 The value may be a string, an image, or a stretch-glyph; it is
26146 interpreted in the same way as the value of a `display' text property.
26148 This variable is overridden by any `line-prefix' text or overlay
26151 To add a prefix to continuation lines, use `wrap-prefix'. */);
26152 Vline_prefix
= Qnil
;
26153 staticpro (&Qline_prefix
);
26154 Qline_prefix
= intern_c_string ("line-prefix");
26155 Fmake_variable_buffer_local (Qline_prefix
);
26157 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26158 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26159 inhibit_eval_during_redisplay
= 0;
26161 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26162 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26163 inhibit_free_realized_faces
= 0;
26166 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26167 doc
: /* Inhibit try_window_id display optimization. */);
26168 inhibit_try_window_id
= 0;
26170 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26171 doc
: /* Inhibit try_window_reusing display optimization. */);
26172 inhibit_try_window_reusing
= 0;
26174 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26175 doc
: /* Inhibit try_cursor_movement display optimization. */);
26176 inhibit_try_cursor_movement
= 0;
26177 #endif /* GLYPH_DEBUG */
26179 DEFVAR_INT ("overline-margin", &overline_margin
,
26180 doc
: /* *Space between overline and text, in pixels.
26181 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26182 margin to the caracter height. */);
26183 overline_margin
= 2;
26185 DEFVAR_INT ("underline-minimum-offset",
26186 &underline_minimum_offset
,
26187 doc
: /* Minimum distance between baseline and underline.
26188 This can improve legibility of underlined text at small font sizes,
26189 particularly when using variable `x-use-underline-position-properties'
26190 with fonts that specify an UNDERLINE_POSITION relatively close to the
26191 baseline. The default value is 1. */);
26192 underline_minimum_offset
= 1;
26194 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26195 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26196 display_hourglass_p
= 1;
26198 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26199 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26200 Value must be an integer or float. */);
26201 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26203 hourglass_atimer
= NULL
;
26204 hourglass_shown_p
= 0;
26208 /* Initialize this module when Emacs starts. */
26213 Lisp_Object root_window
;
26214 struct window
*mini_w
;
26216 current_header_line_height
= current_mode_line_height
= -1;
26218 CHARPOS (this_line_start_pos
) = 0;
26220 mini_w
= XWINDOW (minibuf_window
);
26221 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26223 if (!noninteractive
)
26225 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26228 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26229 set_window_height (root_window
,
26230 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26232 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26233 set_window_height (minibuf_window
, 1, 0);
26235 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26236 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26238 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26239 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26240 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26242 /* The default ellipsis glyphs `...'. */
26243 for (i
= 0; i
< 3; ++i
)
26244 default_invis_vector
[i
] = make_number ('.');
26248 /* Allocate the buffer for frame titles.
26249 Also used for `format-mode-line'. */
26251 mode_line_noprop_buf
= (char *) xmalloc (size
);
26252 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26253 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26254 mode_line_target
= MODE_LINE_DISPLAY
;
26257 help_echo_showing_p
= 0;
26260 /* Since w32 does not support atimers, it defines its own implementation of
26261 the following three functions in w32fns.c. */
26264 /* Platform-independent portion of hourglass implementation. */
26266 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26268 hourglass_started (void)
26270 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26273 /* Cancel a currently active hourglass timer, and start a new one. */
26275 start_hourglass (void)
26277 #if defined (HAVE_WINDOW_SYSTEM)
26279 int secs
, usecs
= 0;
26281 cancel_hourglass ();
26283 if (INTEGERP (Vhourglass_delay
)
26284 && XINT (Vhourglass_delay
) > 0)
26285 secs
= XFASTINT (Vhourglass_delay
);
26286 else if (FLOATP (Vhourglass_delay
)
26287 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26290 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26291 secs
= XFASTINT (tem
);
26292 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26295 secs
= DEFAULT_HOURGLASS_DELAY
;
26297 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26298 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26299 show_hourglass
, NULL
);
26304 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26307 cancel_hourglass (void)
26309 #if defined (HAVE_WINDOW_SYSTEM)
26310 if (hourglass_atimer
)
26312 cancel_atimer (hourglass_atimer
);
26313 hourglass_atimer
= NULL
;
26316 if (hourglass_shown_p
)
26320 #endif /* ! WINDOWSNT */
26322 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26323 (do not change this comment) */