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 memset (it
, 0, 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 memcpy (entries, old, 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 memset (&it
->current
, 0, 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
;
6628 it
->ignore_overlay_strings_at_pos_p
= 0;
6633 /* Fill iterator IT with next display element from a stretch glyph
6634 property. IT->object is the value of the text property. Value is
6638 next_element_from_stretch (struct it
*it
)
6640 it
->what
= IT_STRETCH
;
6644 /* Scan forward from CHARPOS in the current buffer, until we find a
6645 stop position > current IT's position. Then handle the stop
6646 position before that. This is called when we bump into a stop
6647 position while reordering bidirectional text. CHARPOS should be
6648 the last previously processed stop_pos (or BEGV, if none were
6649 processed yet) whose position is less that IT's current
6653 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6655 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6656 struct display_pos save_current
= it
->current
;
6657 struct text_pos save_position
= it
->position
;
6658 struct text_pos pos1
;
6659 EMACS_INT next_stop
;
6661 /* Scan in strict logical order. */
6665 it
->prev_stop
= charpos
;
6666 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6667 reseat_1 (it
, pos1
, 0);
6668 compute_stop_pos (it
);
6669 /* We must advance forward, right? */
6670 if (it
->stop_charpos
<= it
->prev_stop
)
6672 charpos
= it
->stop_charpos
;
6674 while (charpos
<= where_we_are
);
6676 next_stop
= it
->stop_charpos
;
6677 it
->stop_charpos
= it
->prev_stop
;
6679 it
->current
= save_current
;
6680 it
->position
= save_position
;
6682 it
->stop_charpos
= next_stop
;
6685 /* Load IT with the next display element from current_buffer. Value
6686 is zero if end of buffer reached. IT->stop_charpos is the next
6687 position at which to stop and check for text properties or buffer
6691 next_element_from_buffer (struct it
*it
)
6695 xassert (IT_CHARPOS (*it
) >= BEGV
);
6697 /* With bidi reordering, the character to display might not be the
6698 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6699 we were reseat()ed to a new buffer position, which is potentially
6700 a different paragraph. */
6701 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6703 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6704 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6705 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6707 /* Nothing to do, but reset the FIRST_ELT flag, like
6708 bidi_paragraph_init does, because we are not going to
6710 it
->bidi_it
.first_elt
= 0;
6712 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6713 /* FIXME: Should support all Unicode line separators. */
6714 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6715 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6717 /* If we are at the beginning of a line, we can produce the
6718 next element right away. */
6719 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6720 bidi_move_to_visually_next (&it
->bidi_it
);
6724 int orig_bytepos
= IT_BYTEPOS (*it
);
6726 /* We need to prime the bidi iterator starting at the line's
6727 beginning, before we will be able to produce the next
6729 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6730 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6731 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6732 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6733 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6736 /* Now return to buffer position where we were asked to
6737 get the next display element, and produce that. */
6738 bidi_move_to_visually_next (&it
->bidi_it
);
6740 while (it
->bidi_it
.bytepos
!= orig_bytepos
6741 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6744 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6745 /* Adjust IT's position information to where we ended up. */
6746 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6747 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6748 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6750 EMACS_INT stop
= it
->stop_charpos
;
6751 if (it
->bidi_it
.scan_dir
< 0)
6753 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6754 IT_BYTEPOS (*it
), stop
, Qnil
);
6758 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6760 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6762 int overlay_strings_follow_p
;
6764 /* End of the game, except when overlay strings follow that
6765 haven't been returned yet. */
6766 if (it
->overlay_strings_at_end_processed_p
)
6767 overlay_strings_follow_p
= 0;
6770 it
->overlay_strings_at_end_processed_p
= 1;
6771 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6774 if (overlay_strings_follow_p
)
6775 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6779 it
->position
= it
->current
.pos
;
6783 else if (!(!it
->bidi_p
6784 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6785 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6787 /* With bidi non-linear iteration, we could find ourselves
6788 far beyond the last computed stop_charpos, with several
6789 other stop positions in between that we missed. Scan
6790 them all now, in buffer's logical order, until we find
6791 and handle the last stop_charpos that precedes our
6792 current position. */
6793 handle_stop_backwards (it
, it
->stop_charpos
);
6794 return GET_NEXT_DISPLAY_ELEMENT (it
);
6800 /* Take note of the stop position we just moved across,
6801 for when we will move back across it. */
6802 it
->prev_stop
= it
->stop_charpos
;
6803 /* If we are at base paragraph embedding level, take
6804 note of the last stop position seen at this
6806 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6807 it
->base_level_stop
= it
->stop_charpos
;
6810 return GET_NEXT_DISPLAY_ELEMENT (it
);
6814 /* We can sometimes back up for reasons that have nothing
6815 to do with bidi reordering. E.g., compositions. The
6816 code below is only needed when we are above the base
6817 embedding level, so test for that explicitly. */
6818 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6819 && IT_CHARPOS (*it
) < it
->prev_stop
)
6821 if (it
->base_level_stop
<= 0)
6822 it
->base_level_stop
= BEGV
;
6823 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6825 handle_stop_backwards (it
, it
->base_level_stop
);
6826 return GET_NEXT_DISPLAY_ELEMENT (it
);
6830 /* No face changes, overlays etc. in sight, so just return a
6831 character from current_buffer. */
6835 /* Maybe run the redisplay end trigger hook. Performance note:
6836 This doesn't seem to cost measurable time. */
6837 if (it
->redisplay_end_trigger_charpos
6839 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6840 run_redisplay_end_trigger_hook (it
);
6842 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6843 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6845 && next_element_from_composition (it
))
6850 /* Get the next character, maybe multibyte. */
6851 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6852 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6853 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6855 it
->c
= *p
, it
->len
= 1;
6857 /* Record what we have and where it came from. */
6858 it
->what
= IT_CHARACTER
;
6859 it
->object
= it
->w
->buffer
;
6860 it
->position
= it
->current
.pos
;
6862 /* Normally we return the character found above, except when we
6863 really want to return an ellipsis for selective display. */
6868 /* A value of selective > 0 means hide lines indented more
6869 than that number of columns. */
6870 if (it
->selective
> 0
6871 && IT_CHARPOS (*it
) + 1 < ZV
6872 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6873 IT_BYTEPOS (*it
) + 1,
6874 (double) it
->selective
)) /* iftc */
6876 success_p
= next_element_from_ellipsis (it
);
6877 it
->dpvec_char_len
= -1;
6880 else if (it
->c
== '\r' && it
->selective
== -1)
6882 /* A value of selective == -1 means that everything from the
6883 CR to the end of the line is invisible, with maybe an
6884 ellipsis displayed for it. */
6885 success_p
= next_element_from_ellipsis (it
);
6886 it
->dpvec_char_len
= -1;
6891 /* Value is zero if end of buffer reached. */
6892 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6897 /* Run the redisplay end trigger hook for IT. */
6900 run_redisplay_end_trigger_hook (struct it
*it
)
6902 Lisp_Object args
[3];
6904 /* IT->glyph_row should be non-null, i.e. we should be actually
6905 displaying something, or otherwise we should not run the hook. */
6906 xassert (it
->glyph_row
);
6908 /* Set up hook arguments. */
6909 args
[0] = Qredisplay_end_trigger_functions
;
6910 args
[1] = it
->window
;
6911 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6912 it
->redisplay_end_trigger_charpos
= 0;
6914 /* Since we are *trying* to run these functions, don't try to run
6915 them again, even if they get an error. */
6916 it
->w
->redisplay_end_trigger
= Qnil
;
6917 Frun_hook_with_args (3, args
);
6919 /* Notice if it changed the face of the character we are on. */
6920 handle_face_prop (it
);
6924 /* Deliver a composition display element. Unlike the other
6925 next_element_from_XXX, this function is not registered in the array
6926 get_next_element[]. It is called from next_element_from_buffer and
6927 next_element_from_string when necessary. */
6930 next_element_from_composition (struct it
*it
)
6932 it
->what
= IT_COMPOSITION
;
6933 it
->len
= it
->cmp_it
.nbytes
;
6934 if (STRINGP (it
->string
))
6938 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6939 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6942 it
->position
= it
->current
.string_pos
;
6943 it
->object
= it
->string
;
6944 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6945 IT_STRING_BYTEPOS (*it
), it
->string
);
6951 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6952 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6955 if (it
->bidi_it
.new_paragraph
)
6956 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6957 /* Resync the bidi iterator with IT's new position.
6958 FIXME: this doesn't support bidirectional text. */
6959 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6960 bidi_move_to_visually_next (&it
->bidi_it
);
6964 it
->position
= it
->current
.pos
;
6965 it
->object
= it
->w
->buffer
;
6966 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6967 IT_BYTEPOS (*it
), Qnil
);
6974 /***********************************************************************
6975 Moving an iterator without producing glyphs
6976 ***********************************************************************/
6978 /* Check if iterator is at a position corresponding to a valid buffer
6979 position after some move_it_ call. */
6981 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6982 ((it)->method == GET_FROM_STRING \
6983 ? IT_STRING_CHARPOS (*it) == 0 \
6987 /* Move iterator IT to a specified buffer or X position within one
6988 line on the display without producing glyphs.
6990 OP should be a bit mask including some or all of these bits:
6991 MOVE_TO_X: Stop upon reaching x-position TO_X.
6992 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6993 Regardless of OP's value, stop upon reaching the end of the display line.
6995 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6996 This means, in particular, that TO_X includes window's horizontal
6999 The return value has several possible values that
7000 say what condition caused the scan to stop:
7002 MOVE_POS_MATCH_OR_ZV
7003 - when TO_POS or ZV was reached.
7006 -when TO_X was reached before TO_POS or ZV were reached.
7009 - when we reached the end of the display area and the line must
7013 - when we reached the end of the display area and the line is
7017 - when we stopped at a line end, i.e. a newline or a CR and selective
7020 static enum move_it_result
7021 move_it_in_display_line_to (struct it
*it
,
7022 EMACS_INT to_charpos
, int to_x
,
7023 enum move_operation_enum op
)
7025 enum move_it_result result
= MOVE_UNDEFINED
;
7026 struct glyph_row
*saved_glyph_row
;
7027 struct it wrap_it
, atpos_it
, atx_it
;
7029 enum it_method prev_method
= it
->method
;
7030 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7032 /* Don't produce glyphs in produce_glyphs. */
7033 saved_glyph_row
= it
->glyph_row
;
7034 it
->glyph_row
= NULL
;
7036 /* Use wrap_it to save a copy of IT wherever a word wrap could
7037 occur. Use atpos_it to save a copy of IT at the desired buffer
7038 position, if found, so that we can scan ahead and check if the
7039 word later overshoots the window edge. Use atx_it similarly, for
7045 #define BUFFER_POS_REACHED_P() \
7046 ((op & MOVE_TO_POS) != 0 \
7047 && BUFFERP (it->object) \
7048 && (IT_CHARPOS (*it) == to_charpos \
7049 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7050 && (it->method == GET_FROM_BUFFER \
7051 || (it->method == GET_FROM_DISPLAY_VECTOR \
7052 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7054 /* If there's a line-/wrap-prefix, handle it. */
7055 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7056 && it
->current_y
< it
->last_visible_y
)
7057 handle_line_prefix (it
);
7061 int x
, i
, ascent
= 0, descent
= 0;
7063 /* Utility macro to reset an iterator with x, ascent, and descent. */
7064 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7065 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7066 (IT)->max_descent = descent)
7068 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7070 if ((op
& MOVE_TO_POS
) != 0
7071 && BUFFERP (it
->object
)
7072 && it
->method
== GET_FROM_BUFFER
7073 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7075 && (prev_method
== GET_FROM_IMAGE
7076 || prev_method
== GET_FROM_STRETCH
)
7077 /* Passed TO_CHARPOS from left to right. */
7078 && ((prev_pos
< to_charpos
7079 && IT_CHARPOS (*it
) > to_charpos
)
7080 /* Passed TO_CHARPOS from right to left. */
7081 || (prev_pos
> to_charpos
7082 && IT_CHARPOS (*it
) < to_charpos
)))))
7084 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7086 result
= MOVE_POS_MATCH_OR_ZV
;
7089 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7090 /* If wrap_it is valid, the current position might be in a
7091 word that is wrapped. So, save the iterator in
7092 atpos_it and continue to see if wrapping happens. */
7096 prev_method
= it
->method
;
7097 if (it
->method
== GET_FROM_BUFFER
)
7098 prev_pos
= IT_CHARPOS (*it
);
7099 /* Stop when ZV reached.
7100 We used to stop here when TO_CHARPOS reached as well, but that is
7101 too soon if this glyph does not fit on this line. So we handle it
7102 explicitly below. */
7103 if (!get_next_display_element (it
))
7105 result
= MOVE_POS_MATCH_OR_ZV
;
7109 if (it
->line_wrap
== TRUNCATE
)
7111 if (BUFFER_POS_REACHED_P ())
7113 result
= MOVE_POS_MATCH_OR_ZV
;
7119 if (it
->line_wrap
== WORD_WRAP
)
7121 if (IT_DISPLAYING_WHITESPACE (it
))
7125 /* We have reached a glyph that follows one or more
7126 whitespace characters. If the position is
7127 already found, we are done. */
7128 if (atpos_it
.sp
>= 0)
7131 result
= MOVE_POS_MATCH_OR_ZV
;
7137 result
= MOVE_X_REACHED
;
7140 /* Otherwise, we can wrap here. */
7147 /* Remember the line height for the current line, in case
7148 the next element doesn't fit on the line. */
7149 ascent
= it
->max_ascent
;
7150 descent
= it
->max_descent
;
7152 /* The call to produce_glyphs will get the metrics of the
7153 display element IT is loaded with. Record the x-position
7154 before this display element, in case it doesn't fit on the
7158 PRODUCE_GLYPHS (it
);
7160 if (it
->area
!= TEXT_AREA
)
7162 set_iterator_to_next (it
, 1);
7166 /* The number of glyphs we get back in IT->nglyphs will normally
7167 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7168 character on a terminal frame, or (iii) a line end. For the
7169 second case, IT->nglyphs - 1 padding glyphs will be present.
7170 (On X frames, there is only one glyph produced for a
7171 composite character.)
7173 The behavior implemented below means, for continuation lines,
7174 that as many spaces of a TAB as fit on the current line are
7175 displayed there. For terminal frames, as many glyphs of a
7176 multi-glyph character are displayed in the current line, too.
7177 This is what the old redisplay code did, and we keep it that
7178 way. Under X, the whole shape of a complex character must
7179 fit on the line or it will be completely displayed in the
7182 Note that both for tabs and padding glyphs, all glyphs have
7186 /* More than one glyph or glyph doesn't fit on line. All
7187 glyphs have the same width. */
7188 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7190 int x_before_this_char
= x
;
7191 int hpos_before_this_char
= it
->hpos
;
7193 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7195 new_x
= x
+ single_glyph_width
;
7197 /* We want to leave anything reaching TO_X to the caller. */
7198 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7200 if (BUFFER_POS_REACHED_P ())
7202 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7203 goto buffer_pos_reached
;
7204 if (atpos_it
.sp
< 0)
7207 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7212 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7215 result
= MOVE_X_REACHED
;
7221 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7226 if (/* Lines are continued. */
7227 it
->line_wrap
!= TRUNCATE
7228 && (/* And glyph doesn't fit on the line. */
7229 new_x
> it
->last_visible_x
7230 /* Or it fits exactly and we're on a window
7232 || (new_x
== it
->last_visible_x
7233 && FRAME_WINDOW_P (it
->f
))))
7235 if (/* IT->hpos == 0 means the very first glyph
7236 doesn't fit on the line, e.g. a wide image. */
7238 || (new_x
== it
->last_visible_x
7239 && FRAME_WINDOW_P (it
->f
)))
7242 it
->current_x
= new_x
;
7244 /* The character's last glyph just barely fits
7246 if (i
== it
->nglyphs
- 1)
7248 /* If this is the destination position,
7249 return a position *before* it in this row,
7250 now that we know it fits in this row. */
7251 if (BUFFER_POS_REACHED_P ())
7253 if (it
->line_wrap
!= WORD_WRAP
7256 it
->hpos
= hpos_before_this_char
;
7257 it
->current_x
= x_before_this_char
;
7258 result
= MOVE_POS_MATCH_OR_ZV
;
7261 if (it
->line_wrap
== WORD_WRAP
7265 atpos_it
.current_x
= x_before_this_char
;
7266 atpos_it
.hpos
= hpos_before_this_char
;
7270 set_iterator_to_next (it
, 1);
7271 /* On graphical terminals, newlines may
7272 "overflow" into the fringe if
7273 overflow-newline-into-fringe is non-nil.
7274 On text-only terminals, newlines may
7275 overflow into the last glyph on the
7277 if (!FRAME_WINDOW_P (it
->f
)
7278 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7280 if (!get_next_display_element (it
))
7282 result
= MOVE_POS_MATCH_OR_ZV
;
7285 if (BUFFER_POS_REACHED_P ())
7287 if (ITERATOR_AT_END_OF_LINE_P (it
))
7288 result
= MOVE_POS_MATCH_OR_ZV
;
7290 result
= MOVE_LINE_CONTINUED
;
7293 if (ITERATOR_AT_END_OF_LINE_P (it
))
7295 result
= MOVE_NEWLINE_OR_CR
;
7302 IT_RESET_X_ASCENT_DESCENT (it
);
7304 if (wrap_it
.sp
>= 0)
7311 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7313 result
= MOVE_LINE_CONTINUED
;
7317 if (BUFFER_POS_REACHED_P ())
7319 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7320 goto buffer_pos_reached
;
7321 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7324 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7328 if (new_x
> it
->first_visible_x
)
7330 /* Glyph is visible. Increment number of glyphs that
7331 would be displayed. */
7336 if (result
!= MOVE_UNDEFINED
)
7339 else if (BUFFER_POS_REACHED_P ())
7342 IT_RESET_X_ASCENT_DESCENT (it
);
7343 result
= MOVE_POS_MATCH_OR_ZV
;
7346 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7348 /* Stop when TO_X specified and reached. This check is
7349 necessary here because of lines consisting of a line end,
7350 only. The line end will not produce any glyphs and we
7351 would never get MOVE_X_REACHED. */
7352 xassert (it
->nglyphs
== 0);
7353 result
= MOVE_X_REACHED
;
7357 /* Is this a line end? If yes, we're done. */
7358 if (ITERATOR_AT_END_OF_LINE_P (it
))
7360 result
= MOVE_NEWLINE_OR_CR
;
7364 if (it
->method
== GET_FROM_BUFFER
)
7365 prev_pos
= IT_CHARPOS (*it
);
7366 /* The current display element has been consumed. Advance
7368 set_iterator_to_next (it
, 1);
7370 /* Stop if lines are truncated and IT's current x-position is
7371 past the right edge of the window now. */
7372 if (it
->line_wrap
== TRUNCATE
7373 && it
->current_x
>= it
->last_visible_x
)
7375 if (!FRAME_WINDOW_P (it
->f
)
7376 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7378 if (!get_next_display_element (it
)
7379 || BUFFER_POS_REACHED_P ())
7381 result
= MOVE_POS_MATCH_OR_ZV
;
7384 if (ITERATOR_AT_END_OF_LINE_P (it
))
7386 result
= MOVE_NEWLINE_OR_CR
;
7390 result
= MOVE_LINE_TRUNCATED
;
7393 #undef IT_RESET_X_ASCENT_DESCENT
7396 #undef BUFFER_POS_REACHED_P
7398 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7399 restore the saved iterator. */
7400 if (atpos_it
.sp
>= 0)
7402 else if (atx_it
.sp
>= 0)
7407 /* Restore the iterator settings altered at the beginning of this
7409 it
->glyph_row
= saved_glyph_row
;
7413 /* For external use. */
7415 move_it_in_display_line (struct it
*it
,
7416 EMACS_INT to_charpos
, int to_x
,
7417 enum move_operation_enum op
)
7419 if (it
->line_wrap
== WORD_WRAP
7420 && (op
& MOVE_TO_X
))
7422 struct it save_it
= *it
;
7423 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7424 /* When word-wrap is on, TO_X may lie past the end
7425 of a wrapped line. Then it->current is the
7426 character on the next line, so backtrack to the
7427 space before the wrap point. */
7428 if (skip
== MOVE_LINE_CONTINUED
)
7430 int prev_x
= max (it
->current_x
- 1, 0);
7432 move_it_in_display_line_to
7433 (it
, -1, prev_x
, MOVE_TO_X
);
7437 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7441 /* Move IT forward until it satisfies one or more of the criteria in
7442 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7444 OP is a bit-mask that specifies where to stop, and in particular,
7445 which of those four position arguments makes a difference. See the
7446 description of enum move_operation_enum.
7448 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7449 screen line, this function will set IT to the next position >
7453 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7455 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7456 int line_height
, line_start_x
= 0, reached
= 0;
7460 if (op
& MOVE_TO_VPOS
)
7462 /* If no TO_CHARPOS and no TO_X specified, stop at the
7463 start of the line TO_VPOS. */
7464 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7466 if (it
->vpos
== to_vpos
)
7472 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7476 /* TO_VPOS >= 0 means stop at TO_X in the line at
7477 TO_VPOS, or at TO_POS, whichever comes first. */
7478 if (it
->vpos
== to_vpos
)
7484 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7486 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7491 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7493 /* We have reached TO_X but not in the line we want. */
7494 skip
= move_it_in_display_line_to (it
, to_charpos
,
7496 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7504 else if (op
& MOVE_TO_Y
)
7506 struct it it_backup
;
7508 if (it
->line_wrap
== WORD_WRAP
)
7511 /* TO_Y specified means stop at TO_X in the line containing
7512 TO_Y---or at TO_CHARPOS if this is reached first. The
7513 problem is that we can't really tell whether the line
7514 contains TO_Y before we have completely scanned it, and
7515 this may skip past TO_X. What we do is to first scan to
7518 If TO_X is not specified, use a TO_X of zero. The reason
7519 is to make the outcome of this function more predictable.
7520 If we didn't use TO_X == 0, we would stop at the end of
7521 the line which is probably not what a caller would expect
7523 skip
= move_it_in_display_line_to
7524 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7525 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7527 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7528 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7530 else if (skip
== MOVE_X_REACHED
)
7532 /* If TO_X was reached, we want to know whether TO_Y is
7533 in the line. We know this is the case if the already
7534 scanned glyphs make the line tall enough. Otherwise,
7535 we must check by scanning the rest of the line. */
7536 line_height
= it
->max_ascent
+ it
->max_descent
;
7537 if (to_y
>= it
->current_y
7538 && to_y
< it
->current_y
+ line_height
)
7544 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7545 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7547 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7548 line_height
= it
->max_ascent
+ it
->max_descent
;
7549 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7551 if (to_y
>= it
->current_y
7552 && to_y
< it
->current_y
+ line_height
)
7554 /* If TO_Y is in this line and TO_X was reached
7555 above, we scanned too far. We have to restore
7556 IT's settings to the ones before skipping. */
7563 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7569 /* Check whether TO_Y is in this line. */
7570 line_height
= it
->max_ascent
+ it
->max_descent
;
7571 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7573 if (to_y
>= it
->current_y
7574 && to_y
< it
->current_y
+ line_height
)
7576 /* When word-wrap is on, TO_X may lie past the end
7577 of a wrapped line. Then it->current is the
7578 character on the next line, so backtrack to the
7579 space before the wrap point. */
7580 if (skip
== MOVE_LINE_CONTINUED
7581 && it
->line_wrap
== WORD_WRAP
)
7583 int prev_x
= max (it
->current_x
- 1, 0);
7585 skip
= move_it_in_display_line_to
7586 (it
, -1, prev_x
, MOVE_TO_X
);
7595 else if (BUFFERP (it
->object
)
7596 && (it
->method
== GET_FROM_BUFFER
7597 || it
->method
== GET_FROM_STRETCH
)
7598 && IT_CHARPOS (*it
) >= to_charpos
)
7599 skip
= MOVE_POS_MATCH_OR_ZV
;
7601 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7605 case MOVE_POS_MATCH_OR_ZV
:
7609 case MOVE_NEWLINE_OR_CR
:
7610 set_iterator_to_next (it
, 1);
7611 it
->continuation_lines_width
= 0;
7614 case MOVE_LINE_TRUNCATED
:
7615 it
->continuation_lines_width
= 0;
7616 reseat_at_next_visible_line_start (it
, 0);
7617 if ((op
& MOVE_TO_POS
) != 0
7618 && IT_CHARPOS (*it
) > to_charpos
)
7625 case MOVE_LINE_CONTINUED
:
7626 /* For continued lines ending in a tab, some of the glyphs
7627 associated with the tab are displayed on the current
7628 line. Since it->current_x does not include these glyphs,
7629 we use it->last_visible_x instead. */
7632 it
->continuation_lines_width
+= it
->last_visible_x
;
7633 /* When moving by vpos, ensure that the iterator really
7634 advances to the next line (bug#847, bug#969). Fixme:
7635 do we need to do this in other circumstances? */
7636 if (it
->current_x
!= it
->last_visible_x
7637 && (op
& MOVE_TO_VPOS
)
7638 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7640 line_start_x
= it
->current_x
+ it
->pixel_width
7641 - it
->last_visible_x
;
7642 set_iterator_to_next (it
, 0);
7646 it
->continuation_lines_width
+= it
->current_x
;
7653 /* Reset/increment for the next run. */
7654 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7655 it
->current_x
= line_start_x
;
7658 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7660 last_height
= it
->max_ascent
+ it
->max_descent
;
7661 last_max_ascent
= it
->max_ascent
;
7662 it
->max_ascent
= it
->max_descent
= 0;
7667 /* On text terminals, we may stop at the end of a line in the middle
7668 of a multi-character glyph. If the glyph itself is continued,
7669 i.e. it is actually displayed on the next line, don't treat this
7670 stopping point as valid; move to the next line instead (unless
7671 that brings us offscreen). */
7672 if (!FRAME_WINDOW_P (it
->f
)
7674 && IT_CHARPOS (*it
) == to_charpos
7675 && it
->what
== IT_CHARACTER
7677 && it
->line_wrap
== WINDOW_WRAP
7678 && it
->current_x
== it
->last_visible_x
- 1
7681 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7683 it
->continuation_lines_width
+= it
->current_x
;
7684 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7685 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7687 last_height
= it
->max_ascent
+ it
->max_descent
;
7688 last_max_ascent
= it
->max_ascent
;
7691 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7695 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7697 If DY > 0, move IT backward at least that many pixels. DY = 0
7698 means move IT backward to the preceding line start or BEGV. This
7699 function may move over more than DY pixels if IT->current_y - DY
7700 ends up in the middle of a line; in this case IT->current_y will be
7701 set to the top of the line moved to. */
7704 move_it_vertically_backward (struct it
*it
, int dy
)
7713 start_pos
= IT_CHARPOS (*it
);
7715 /* Estimate how many newlines we must move back. */
7716 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7718 /* Set the iterator's position that many lines back. */
7719 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7720 back_to_previous_visible_line_start (it
);
7722 /* Reseat the iterator here. When moving backward, we don't want
7723 reseat to skip forward over invisible text, set up the iterator
7724 to deliver from overlay strings at the new position etc. So,
7725 use reseat_1 here. */
7726 reseat_1 (it
, it
->current
.pos
, 1);
7728 /* We are now surely at a line start. */
7729 it
->current_x
= it
->hpos
= 0;
7730 it
->continuation_lines_width
= 0;
7732 /* Move forward and see what y-distance we moved. First move to the
7733 start of the next line so that we get its height. We need this
7734 height to be able to tell whether we reached the specified
7737 it2
.max_ascent
= it2
.max_descent
= 0;
7740 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7741 MOVE_TO_POS
| MOVE_TO_VPOS
);
7743 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7744 xassert (IT_CHARPOS (*it
) >= BEGV
);
7747 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7748 xassert (IT_CHARPOS (*it
) >= BEGV
);
7749 /* H is the actual vertical distance from the position in *IT
7750 and the starting position. */
7751 h
= it2
.current_y
- it
->current_y
;
7752 /* NLINES is the distance in number of lines. */
7753 nlines
= it2
.vpos
- it
->vpos
;
7755 /* Correct IT's y and vpos position
7756 so that they are relative to the starting point. */
7762 /* DY == 0 means move to the start of the screen line. The
7763 value of nlines is > 0 if continuation lines were involved. */
7765 move_it_by_lines (it
, nlines
, 1);
7769 /* The y-position we try to reach, relative to *IT.
7770 Note that H has been subtracted in front of the if-statement. */
7771 int target_y
= it
->current_y
+ h
- dy
;
7772 int y0
= it3
.current_y
;
7773 int y1
= line_bottom_y (&it3
);
7774 int line_height
= y1
- y0
;
7776 /* If we did not reach target_y, try to move further backward if
7777 we can. If we moved too far backward, try to move forward. */
7778 if (target_y
< it
->current_y
7779 /* This is heuristic. In a window that's 3 lines high, with
7780 a line height of 13 pixels each, recentering with point
7781 on the bottom line will try to move -39/2 = 19 pixels
7782 backward. Try to avoid moving into the first line. */
7783 && (it
->current_y
- target_y
7784 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7785 && IT_CHARPOS (*it
) > BEGV
)
7787 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7788 target_y
- it
->current_y
));
7789 dy
= it
->current_y
- target_y
;
7790 goto move_further_back
;
7792 else if (target_y
>= it
->current_y
+ line_height
7793 && IT_CHARPOS (*it
) < ZV
)
7795 /* Should move forward by at least one line, maybe more.
7797 Note: Calling move_it_by_lines can be expensive on
7798 terminal frames, where compute_motion is used (via
7799 vmotion) to do the job, when there are very long lines
7800 and truncate-lines is nil. That's the reason for
7801 treating terminal frames specially here. */
7803 if (!FRAME_WINDOW_P (it
->f
))
7804 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7809 move_it_by_lines (it
, 1, 1);
7811 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7818 /* Move IT by a specified amount of pixel lines DY. DY negative means
7819 move backwards. DY = 0 means move to start of screen line. At the
7820 end, IT will be on the start of a screen line. */
7823 move_it_vertically (struct it
*it
, int dy
)
7826 move_it_vertically_backward (it
, -dy
);
7829 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7830 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7831 MOVE_TO_POS
| MOVE_TO_Y
);
7832 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7834 /* If buffer ends in ZV without a newline, move to the start of
7835 the line to satisfy the post-condition. */
7836 if (IT_CHARPOS (*it
) == ZV
7838 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7839 move_it_by_lines (it
, 0, 0);
7844 /* Move iterator IT past the end of the text line it is in. */
7847 move_it_past_eol (struct it
*it
)
7849 enum move_it_result rc
;
7851 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7852 if (rc
== MOVE_NEWLINE_OR_CR
)
7853 set_iterator_to_next (it
, 0);
7857 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7858 negative means move up. DVPOS == 0 means move to the start of the
7859 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7860 NEED_Y_P is zero, IT->current_y will be left unchanged.
7862 Further optimization ideas: If we would know that IT->f doesn't use
7863 a face with proportional font, we could be faster for
7864 truncate-lines nil. */
7867 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7869 struct position pos
;
7871 /* The commented-out optimization uses vmotion on terminals. This
7872 gives bad results, because elements like it->what, on which
7873 callers such as pos_visible_p rely, aren't updated. */
7874 /* if (!FRAME_WINDOW_P (it->f))
7876 struct text_pos textpos;
7878 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7879 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7880 reseat (it, textpos, 1);
7881 it->vpos += pos.vpos;
7882 it->current_y += pos.vpos;
7888 /* DVPOS == 0 means move to the start of the screen line. */
7889 move_it_vertically_backward (it
, 0);
7890 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7891 /* Let next call to line_bottom_y calculate real line height */
7896 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7897 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7898 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7903 int start_charpos
, i
;
7905 /* Start at the beginning of the screen line containing IT's
7906 position. This may actually move vertically backwards,
7907 in case of overlays, so adjust dvpos accordingly. */
7909 move_it_vertically_backward (it
, 0);
7912 /* Go back -DVPOS visible lines and reseat the iterator there. */
7913 start_charpos
= IT_CHARPOS (*it
);
7914 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7915 back_to_previous_visible_line_start (it
);
7916 reseat (it
, it
->current
.pos
, 1);
7918 /* Move further back if we end up in a string or an image. */
7919 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7921 /* First try to move to start of display line. */
7923 move_it_vertically_backward (it
, 0);
7925 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7927 /* If start of line is still in string or image,
7928 move further back. */
7929 back_to_previous_visible_line_start (it
);
7930 reseat (it
, it
->current
.pos
, 1);
7934 it
->current_x
= it
->hpos
= 0;
7936 /* Above call may have moved too far if continuation lines
7937 are involved. Scan forward and see if it did. */
7939 it2
.vpos
= it2
.current_y
= 0;
7940 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7941 it
->vpos
-= it2
.vpos
;
7942 it
->current_y
-= it2
.current_y
;
7943 it
->current_x
= it
->hpos
= 0;
7945 /* If we moved too far back, move IT some lines forward. */
7946 if (it2
.vpos
> -dvpos
)
7948 int delta
= it2
.vpos
+ dvpos
;
7950 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7951 /* Move back again if we got too far ahead. */
7952 if (IT_CHARPOS (*it
) >= start_charpos
)
7958 /* Return 1 if IT points into the middle of a display vector. */
7961 in_display_vector_p (struct it
*it
)
7963 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7964 && it
->current
.dpvec_index
> 0
7965 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7969 /***********************************************************************
7971 ***********************************************************************/
7974 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7978 add_to_log (char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7980 Lisp_Object args
[3];
7981 Lisp_Object msg
, fmt
;
7984 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7987 /* Do nothing if called asynchronously. Inserting text into
7988 a buffer may call after-change-functions and alike and
7989 that would means running Lisp asynchronously. */
7990 if (handling_signal
)
7994 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7996 args
[0] = fmt
= build_string (format
);
7999 msg
= Fformat (3, args
);
8001 len
= SBYTES (msg
) + 1;
8002 SAFE_ALLOCA (buffer
, char *, len
);
8003 memcpy (buffer
, SDATA (msg
), len
);
8005 message_dolog (buffer
, len
- 1, 1, 0);
8012 /* Output a newline in the *Messages* buffer if "needs" one. */
8015 message_log_maybe_newline (void)
8017 if (message_log_need_newline
)
8018 message_dolog ("", 0, 1, 0);
8022 /* Add a string M of length NBYTES to the message log, optionally
8023 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8024 nonzero, means interpret the contents of M as multibyte. This
8025 function calls low-level routines in order to bypass text property
8026 hooks, etc. which might not be safe to run.
8028 This may GC (insert may run before/after change hooks),
8029 so the buffer M must NOT point to a Lisp string. */
8032 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
8034 if (!NILP (Vmemory_full
))
8037 if (!NILP (Vmessage_log_max
))
8039 struct buffer
*oldbuf
;
8040 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8041 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8042 int point_at_end
= 0;
8044 Lisp_Object old_deactivate_mark
, tem
;
8045 struct gcpro gcpro1
;
8047 old_deactivate_mark
= Vdeactivate_mark
;
8048 oldbuf
= current_buffer
;
8049 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8050 current_buffer
->undo_list
= Qt
;
8052 oldpoint
= message_dolog_marker1
;
8053 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8054 oldbegv
= message_dolog_marker2
;
8055 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8056 oldzv
= message_dolog_marker3
;
8057 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8058 GCPRO1 (old_deactivate_mark
);
8066 BEGV_BYTE
= BEG_BYTE
;
8069 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8071 /* Insert the string--maybe converting multibyte to single byte
8072 or vice versa, so that all the text fits the buffer. */
8074 && NILP (current_buffer
->enable_multibyte_characters
))
8076 int i
, c
, char_bytes
;
8077 unsigned char work
[1];
8079 /* Convert a multibyte string to single-byte
8080 for the *Message* buffer. */
8081 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8083 c
= string_char_and_length (m
+ i
, &char_bytes
);
8084 work
[0] = (ASCII_CHAR_P (c
)
8086 : multibyte_char_to_unibyte (c
, Qnil
));
8087 insert_1_both (work
, 1, 1, 1, 0, 0);
8090 else if (! multibyte
8091 && ! NILP (current_buffer
->enable_multibyte_characters
))
8093 int i
, c
, char_bytes
;
8094 unsigned char *msg
= (unsigned char *) m
;
8095 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8096 /* Convert a single-byte string to multibyte
8097 for the *Message* buffer. */
8098 for (i
= 0; i
< nbytes
; i
++)
8101 MAKE_CHAR_MULTIBYTE (c
);
8102 char_bytes
= CHAR_STRING (c
, str
);
8103 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8107 insert_1 (m
, nbytes
, 1, 0, 0);
8111 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8112 insert_1 ("\n", 1, 1, 0, 0);
8114 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8116 this_bol_byte
= PT_BYTE
;
8118 /* See if this line duplicates the previous one.
8119 If so, combine duplicates. */
8122 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8124 prev_bol_byte
= PT_BYTE
;
8126 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8127 this_bol
, this_bol_byte
);
8130 del_range_both (prev_bol
, prev_bol_byte
,
8131 this_bol
, this_bol_byte
, 0);
8137 /* If you change this format, don't forget to also
8138 change message_log_check_duplicate. */
8139 sprintf (dupstr
, " [%d times]", dup
);
8140 duplen
= strlen (dupstr
);
8141 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8142 insert_1 (dupstr
, duplen
, 1, 0, 1);
8147 /* If we have more than the desired maximum number of lines
8148 in the *Messages* buffer now, delete the oldest ones.
8149 This is safe because we don't have undo in this buffer. */
8151 if (NATNUMP (Vmessage_log_max
))
8153 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8154 -XFASTINT (Vmessage_log_max
) - 1, 0);
8155 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8158 BEGV
= XMARKER (oldbegv
)->charpos
;
8159 BEGV_BYTE
= marker_byte_position (oldbegv
);
8168 ZV
= XMARKER (oldzv
)->charpos
;
8169 ZV_BYTE
= marker_byte_position (oldzv
);
8173 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8175 /* We can't do Fgoto_char (oldpoint) because it will run some
8177 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8178 XMARKER (oldpoint
)->bytepos
);
8181 unchain_marker (XMARKER (oldpoint
));
8182 unchain_marker (XMARKER (oldbegv
));
8183 unchain_marker (XMARKER (oldzv
));
8185 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8186 set_buffer_internal (oldbuf
);
8188 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8189 message_log_need_newline
= !nlflag
;
8190 Vdeactivate_mark
= old_deactivate_mark
;
8195 /* We are at the end of the buffer after just having inserted a newline.
8196 (Note: We depend on the fact we won't be crossing the gap.)
8197 Check to see if the most recent message looks a lot like the previous one.
8198 Return 0 if different, 1 if the new one should just replace it, or a
8199 value N > 1 if we should also append " [N times]". */
8202 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8203 int this_bol
, int this_bol_byte
)
8206 int len
= Z_BYTE
- 1 - this_bol_byte
;
8208 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8209 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8211 for (i
= 0; i
< len
; i
++)
8213 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8221 if (*p1
++ == ' ' && *p1
++ == '[')
8224 while (*p1
>= '0' && *p1
<= '9')
8225 n
= n
* 10 + *p1
++ - '0';
8226 if (strncmp (p1
, " times]\n", 8) == 0)
8233 /* Display an echo area message M with a specified length of NBYTES
8234 bytes. The string may include null characters. If M is 0, clear
8235 out any existing message, and let the mini-buffer text show
8238 This may GC, so the buffer M must NOT point to a Lisp string. */
8241 message2 (const char *m
, int nbytes
, int multibyte
)
8243 /* First flush out any partial line written with print. */
8244 message_log_maybe_newline ();
8246 message_dolog (m
, nbytes
, 1, multibyte
);
8247 message2_nolog (m
, nbytes
, multibyte
);
8251 /* The non-logging counterpart of message2. */
8254 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8256 struct frame
*sf
= SELECTED_FRAME ();
8257 message_enable_multibyte
= multibyte
;
8259 if (FRAME_INITIAL_P (sf
))
8261 if (noninteractive_need_newline
)
8262 putc ('\n', stderr
);
8263 noninteractive_need_newline
= 0;
8265 fwrite (m
, nbytes
, 1, stderr
);
8266 if (cursor_in_echo_area
== 0)
8267 fprintf (stderr
, "\n");
8270 /* A null message buffer means that the frame hasn't really been
8271 initialized yet. Error messages get reported properly by
8272 cmd_error, so this must be just an informative message; toss it. */
8273 else if (INTERACTIVE
8274 && sf
->glyphs_initialized_p
8275 && FRAME_MESSAGE_BUF (sf
))
8277 Lisp_Object mini_window
;
8280 /* Get the frame containing the mini-buffer
8281 that the selected frame is using. */
8282 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8283 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8285 FRAME_SAMPLE_VISIBILITY (f
);
8286 if (FRAME_VISIBLE_P (sf
)
8287 && ! FRAME_VISIBLE_P (f
))
8288 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8292 set_message (m
, Qnil
, nbytes
, multibyte
);
8293 if (minibuffer_auto_raise
)
8294 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8297 clear_message (1, 1);
8299 do_pending_window_change (0);
8300 echo_area_display (1);
8301 do_pending_window_change (0);
8302 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8303 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8308 /* Display an echo area message M with a specified length of NBYTES
8309 bytes. The string may include null characters. If M is not a
8310 string, clear out any existing message, and let the mini-buffer
8313 This function cancels echoing. */
8316 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8318 struct gcpro gcpro1
;
8321 clear_message (1,1);
8324 /* First flush out any partial line written with print. */
8325 message_log_maybe_newline ();
8331 SAFE_ALLOCA (buffer
, char *, nbytes
);
8332 memcpy (buffer
, SDATA (m
), nbytes
);
8333 message_dolog (buffer
, nbytes
, 1, multibyte
);
8336 message3_nolog (m
, nbytes
, multibyte
);
8342 /* The non-logging version of message3.
8343 This does not cancel echoing, because it is used for echoing.
8344 Perhaps we need to make a separate function for echoing
8345 and make this cancel echoing. */
8348 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8350 struct frame
*sf
= SELECTED_FRAME ();
8351 message_enable_multibyte
= multibyte
;
8353 if (FRAME_INITIAL_P (sf
))
8355 if (noninteractive_need_newline
)
8356 putc ('\n', stderr
);
8357 noninteractive_need_newline
= 0;
8359 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8360 if (cursor_in_echo_area
== 0)
8361 fprintf (stderr
, "\n");
8364 /* A null message buffer means that the frame hasn't really been
8365 initialized yet. Error messages get reported properly by
8366 cmd_error, so this must be just an informative message; toss it. */
8367 else if (INTERACTIVE
8368 && sf
->glyphs_initialized_p
8369 && FRAME_MESSAGE_BUF (sf
))
8371 Lisp_Object mini_window
;
8375 /* Get the frame containing the mini-buffer
8376 that the selected frame is using. */
8377 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8378 frame
= XWINDOW (mini_window
)->frame
;
8381 FRAME_SAMPLE_VISIBILITY (f
);
8382 if (FRAME_VISIBLE_P (sf
)
8383 && !FRAME_VISIBLE_P (f
))
8384 Fmake_frame_visible (frame
);
8386 if (STRINGP (m
) && SCHARS (m
) > 0)
8388 set_message (NULL
, m
, nbytes
, multibyte
);
8389 if (minibuffer_auto_raise
)
8390 Fraise_frame (frame
);
8391 /* Assume we are not echoing.
8392 (If we are, echo_now will override this.) */
8393 echo_message_buffer
= Qnil
;
8396 clear_message (1, 1);
8398 do_pending_window_change (0);
8399 echo_area_display (1);
8400 do_pending_window_change (0);
8401 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8402 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8407 /* Display a null-terminated echo area message M. If M is 0, clear
8408 out any existing message, and let the mini-buffer text show through.
8410 The buffer M must continue to exist until after the echo area gets
8411 cleared or some other message gets displayed there. Do not pass
8412 text that is stored in a Lisp string. Do not pass text in a buffer
8413 that was alloca'd. */
8416 message1 (const char *m
)
8418 message2 (m
, (m
? strlen (m
) : 0), 0);
8422 /* The non-logging counterpart of message1. */
8425 message1_nolog (const char *m
)
8427 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8430 /* Display a message M which contains a single %s
8431 which gets replaced with STRING. */
8434 message_with_string (const char *m
, Lisp_Object string
, int log
)
8436 CHECK_STRING (string
);
8442 if (noninteractive_need_newline
)
8443 putc ('\n', stderr
);
8444 noninteractive_need_newline
= 0;
8445 fprintf (stderr
, m
, SDATA (string
));
8446 if (!cursor_in_echo_area
)
8447 fprintf (stderr
, "\n");
8451 else if (INTERACTIVE
)
8453 /* The frame whose minibuffer we're going to display the message on.
8454 It may be larger than the selected frame, so we need
8455 to use its buffer, not the selected frame's buffer. */
8456 Lisp_Object mini_window
;
8457 struct frame
*f
, *sf
= SELECTED_FRAME ();
8459 /* Get the frame containing the minibuffer
8460 that the selected frame is using. */
8461 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8462 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8464 /* A null message buffer means that the frame hasn't really been
8465 initialized yet. Error messages get reported properly by
8466 cmd_error, so this must be just an informative message; toss it. */
8467 if (FRAME_MESSAGE_BUF (f
))
8469 Lisp_Object args
[2], message
;
8470 struct gcpro gcpro1
, gcpro2
;
8472 args
[0] = build_string (m
);
8473 args
[1] = message
= string
;
8474 GCPRO2 (args
[0], message
);
8477 message
= Fformat (2, args
);
8480 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8482 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8486 /* Print should start at the beginning of the message
8487 buffer next time. */
8488 message_buf_print
= 0;
8494 /* Dump an informative message to the minibuf. If M is 0, clear out
8495 any existing message, and let the mini-buffer text show through. */
8498 vmessage (const char *m
, va_list ap
)
8504 if (noninteractive_need_newline
)
8505 putc ('\n', stderr
);
8506 noninteractive_need_newline
= 0;
8507 vfprintf (stderr
, m
, ap
);
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
))
8536 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8537 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8539 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8544 /* Print should start at the beginning of the message
8545 buffer next time. */
8546 message_buf_print
= 0;
8552 message (const char *m
, ...)
8561 /* The non-logging version of message. */
8564 message_nolog (const char *m
, ...)
8566 Lisp_Object old_log_max
;
8569 old_log_max
= Vmessage_log_max
;
8570 Vmessage_log_max
= Qnil
;
8572 Vmessage_log_max
= old_log_max
;
8577 /* Display the current message in the current mini-buffer. This is
8578 only called from error handlers in process.c, and is not time
8582 update_echo_area (void)
8584 if (!NILP (echo_area_buffer
[0]))
8587 string
= Fcurrent_message ();
8588 message3 (string
, SBYTES (string
),
8589 !NILP (current_buffer
->enable_multibyte_characters
));
8594 /* Make sure echo area buffers in `echo_buffers' are live.
8595 If they aren't, make new ones. */
8598 ensure_echo_area_buffers (void)
8602 for (i
= 0; i
< 2; ++i
)
8603 if (!BUFFERP (echo_buffer
[i
])
8604 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8607 Lisp_Object old_buffer
;
8610 old_buffer
= echo_buffer
[i
];
8611 sprintf (name
, " *Echo Area %d*", i
);
8612 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8613 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8614 /* to force word wrap in echo area -
8615 it was decided to postpone this*/
8616 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8618 for (j
= 0; j
< 2; ++j
)
8619 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8620 echo_area_buffer
[j
] = echo_buffer
[i
];
8625 /* Call FN with args A1..A4 with either the current or last displayed
8626 echo_area_buffer as current buffer.
8628 WHICH zero means use the current message buffer
8629 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8630 from echo_buffer[] and clear it.
8632 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8633 suitable buffer from echo_buffer[] and clear it.
8635 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8636 that the current message becomes the last displayed one, make
8637 choose a suitable buffer for echo_area_buffer[0], and clear it.
8639 Value is what FN returns. */
8642 with_echo_area_buffer (struct window
*w
, int which
,
8643 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8644 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8647 int this_one
, the_other
, clear_buffer_p
, rc
;
8648 int count
= SPECPDL_INDEX ();
8650 /* If buffers aren't live, make new ones. */
8651 ensure_echo_area_buffers ();
8656 this_one
= 0, the_other
= 1;
8658 this_one
= 1, the_other
= 0;
8661 this_one
= 0, the_other
= 1;
8664 /* We need a fresh one in case the current echo buffer equals
8665 the one containing the last displayed echo area message. */
8666 if (!NILP (echo_area_buffer
[this_one
])
8667 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8668 echo_area_buffer
[this_one
] = Qnil
;
8671 /* Choose a suitable buffer from echo_buffer[] is we don't
8673 if (NILP (echo_area_buffer
[this_one
]))
8675 echo_area_buffer
[this_one
]
8676 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8677 ? echo_buffer
[the_other
]
8678 : echo_buffer
[this_one
]);
8682 buffer
= echo_area_buffer
[this_one
];
8684 /* Don't get confused by reusing the buffer used for echoing
8685 for a different purpose. */
8686 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8689 record_unwind_protect (unwind_with_echo_area_buffer
,
8690 with_echo_area_buffer_unwind_data (w
));
8692 /* Make the echo area buffer current. Note that for display
8693 purposes, it is not necessary that the displayed window's buffer
8694 == current_buffer, except for text property lookup. So, let's
8695 only set that buffer temporarily here without doing a full
8696 Fset_window_buffer. We must also change w->pointm, though,
8697 because otherwise an assertions in unshow_buffer fails, and Emacs
8699 set_buffer_internal_1 (XBUFFER (buffer
));
8703 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8706 current_buffer
->undo_list
= Qt
;
8707 current_buffer
->read_only
= Qnil
;
8708 specbind (Qinhibit_read_only
, Qt
);
8709 specbind (Qinhibit_modification_hooks
, Qt
);
8711 if (clear_buffer_p
&& Z
> BEG
)
8714 xassert (BEGV
>= BEG
);
8715 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8717 rc
= fn (a1
, a2
, a3
, a4
);
8719 xassert (BEGV
>= BEG
);
8720 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8722 unbind_to (count
, Qnil
);
8727 /* Save state that should be preserved around the call to the function
8728 FN called in with_echo_area_buffer. */
8731 with_echo_area_buffer_unwind_data (struct window
*w
)
8734 Lisp_Object vector
, tmp
;
8736 /* Reduce consing by keeping one vector in
8737 Vwith_echo_area_save_vector. */
8738 vector
= Vwith_echo_area_save_vector
;
8739 Vwith_echo_area_save_vector
= Qnil
;
8742 vector
= Fmake_vector (make_number (7), Qnil
);
8744 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8745 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8746 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8750 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8751 ASET (vector
, i
, w
->buffer
); ++i
;
8752 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8753 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8758 for (; i
< end
; ++i
)
8759 ASET (vector
, i
, Qnil
);
8762 xassert (i
== ASIZE (vector
));
8767 /* Restore global state from VECTOR which was created by
8768 with_echo_area_buffer_unwind_data. */
8771 unwind_with_echo_area_buffer (Lisp_Object vector
)
8773 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8774 Vdeactivate_mark
= AREF (vector
, 1);
8775 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8777 if (WINDOWP (AREF (vector
, 3)))
8780 Lisp_Object buffer
, charpos
, bytepos
;
8782 w
= XWINDOW (AREF (vector
, 3));
8783 buffer
= AREF (vector
, 4);
8784 charpos
= AREF (vector
, 5);
8785 bytepos
= AREF (vector
, 6);
8788 set_marker_both (w
->pointm
, buffer
,
8789 XFASTINT (charpos
), XFASTINT (bytepos
));
8792 Vwith_echo_area_save_vector
= vector
;
8797 /* Set up the echo area for use by print functions. MULTIBYTE_P
8798 non-zero means we will print multibyte. */
8801 setup_echo_area_for_printing (int multibyte_p
)
8803 /* If we can't find an echo area any more, exit. */
8804 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8807 ensure_echo_area_buffers ();
8809 if (!message_buf_print
)
8811 /* A message has been output since the last time we printed.
8812 Choose a fresh echo area buffer. */
8813 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8814 echo_area_buffer
[0] = echo_buffer
[1];
8816 echo_area_buffer
[0] = echo_buffer
[0];
8818 /* Switch to that buffer and clear it. */
8819 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8820 current_buffer
->truncate_lines
= Qnil
;
8824 int count
= SPECPDL_INDEX ();
8825 specbind (Qinhibit_read_only
, Qt
);
8826 /* Note that undo recording is always disabled. */
8828 unbind_to (count
, Qnil
);
8830 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8832 /* Set up the buffer for the multibyteness we need. */
8834 != !NILP (current_buffer
->enable_multibyte_characters
))
8835 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8837 /* Raise the frame containing the echo area. */
8838 if (minibuffer_auto_raise
)
8840 struct frame
*sf
= SELECTED_FRAME ();
8841 Lisp_Object mini_window
;
8842 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8843 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8846 message_log_maybe_newline ();
8847 message_buf_print
= 1;
8851 if (NILP (echo_area_buffer
[0]))
8853 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8854 echo_area_buffer
[0] = echo_buffer
[1];
8856 echo_area_buffer
[0] = echo_buffer
[0];
8859 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8861 /* Someone switched buffers between print requests. */
8862 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8863 current_buffer
->truncate_lines
= Qnil
;
8869 /* Display an echo area message in window W. Value is non-zero if W's
8870 height is changed. If display_last_displayed_message_p is
8871 non-zero, display the message that was last displayed, otherwise
8872 display the current message. */
8875 display_echo_area (struct window
*w
)
8877 int i
, no_message_p
, window_height_changed_p
, count
;
8879 /* Temporarily disable garbage collections while displaying the echo
8880 area. This is done because a GC can print a message itself.
8881 That message would modify the echo area buffer's contents while a
8882 redisplay of the buffer is going on, and seriously confuse
8884 count
= inhibit_garbage_collection ();
8886 /* If there is no message, we must call display_echo_area_1
8887 nevertheless because it resizes the window. But we will have to
8888 reset the echo_area_buffer in question to nil at the end because
8889 with_echo_area_buffer will sets it to an empty buffer. */
8890 i
= display_last_displayed_message_p
? 1 : 0;
8891 no_message_p
= NILP (echo_area_buffer
[i
]);
8893 window_height_changed_p
8894 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8895 display_echo_area_1
,
8896 (EMACS_INT
) w
, Qnil
, 0, 0);
8899 echo_area_buffer
[i
] = Qnil
;
8901 unbind_to (count
, Qnil
);
8902 return window_height_changed_p
;
8906 /* Helper for display_echo_area. Display the current buffer which
8907 contains the current echo area message in window W, a mini-window,
8908 a pointer to which is passed in A1. A2..A4 are currently not used.
8909 Change the height of W so that all of the message is displayed.
8910 Value is non-zero if height of W was changed. */
8913 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8915 struct window
*w
= (struct window
*) a1
;
8917 struct text_pos start
;
8918 int window_height_changed_p
= 0;
8920 /* Do this before displaying, so that we have a large enough glyph
8921 matrix for the display. If we can't get enough space for the
8922 whole text, display the last N lines. That works by setting w->start. */
8923 window_height_changed_p
= resize_mini_window (w
, 0);
8925 /* Use the starting position chosen by resize_mini_window. */
8926 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8929 clear_glyph_matrix (w
->desired_matrix
);
8930 XSETWINDOW (window
, w
);
8931 try_window (window
, start
, 0);
8933 return window_height_changed_p
;
8937 /* Resize the echo area window to exactly the size needed for the
8938 currently displayed message, if there is one. If a mini-buffer
8939 is active, don't shrink it. */
8942 resize_echo_area_exactly (void)
8944 if (BUFFERP (echo_area_buffer
[0])
8945 && WINDOWP (echo_area_window
))
8947 struct window
*w
= XWINDOW (echo_area_window
);
8949 Lisp_Object resize_exactly
;
8951 if (minibuf_level
== 0)
8952 resize_exactly
= Qt
;
8954 resize_exactly
= Qnil
;
8956 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8957 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8960 ++windows_or_buffers_changed
;
8961 ++update_mode_lines
;
8962 redisplay_internal (0);
8968 /* Callback function for with_echo_area_buffer, when used from
8969 resize_echo_area_exactly. A1 contains a pointer to the window to
8970 resize, EXACTLY non-nil means resize the mini-window exactly to the
8971 size of the text displayed. A3 and A4 are not used. Value is what
8972 resize_mini_window returns. */
8975 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8977 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8981 /* Resize mini-window W to fit the size of its contents. EXACT_P
8982 means size the window exactly to the size needed. Otherwise, it's
8983 only enlarged until W's buffer is empty.
8985 Set W->start to the right place to begin display. If the whole
8986 contents fit, start at the beginning. Otherwise, start so as
8987 to make the end of the contents appear. This is particularly
8988 important for y-or-n-p, but seems desirable generally.
8990 Value is non-zero if the window height has been changed. */
8993 resize_mini_window (struct window
*w
, int exact_p
)
8995 struct frame
*f
= XFRAME (w
->frame
);
8996 int window_height_changed_p
= 0;
8998 xassert (MINI_WINDOW_P (w
));
9000 /* By default, start display at the beginning. */
9001 set_marker_both (w
->start
, w
->buffer
,
9002 BUF_BEGV (XBUFFER (w
->buffer
)),
9003 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9005 /* Don't resize windows while redisplaying a window; it would
9006 confuse redisplay functions when the size of the window they are
9007 displaying changes from under them. Such a resizing can happen,
9008 for instance, when which-func prints a long message while
9009 we are running fontification-functions. We're running these
9010 functions with safe_call which binds inhibit-redisplay to t. */
9011 if (!NILP (Vinhibit_redisplay
))
9014 /* Nil means don't try to resize. */
9015 if (NILP (Vresize_mini_windows
)
9016 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9019 if (!FRAME_MINIBUF_ONLY_P (f
))
9022 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9023 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9024 int height
, max_height
;
9025 int unit
= FRAME_LINE_HEIGHT (f
);
9026 struct text_pos start
;
9027 struct buffer
*old_current_buffer
= NULL
;
9029 if (current_buffer
!= XBUFFER (w
->buffer
))
9031 old_current_buffer
= current_buffer
;
9032 set_buffer_internal (XBUFFER (w
->buffer
));
9035 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9037 /* Compute the max. number of lines specified by the user. */
9038 if (FLOATP (Vmax_mini_window_height
))
9039 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9040 else if (INTEGERP (Vmax_mini_window_height
))
9041 max_height
= XINT (Vmax_mini_window_height
);
9043 max_height
= total_height
/ 4;
9045 /* Correct that max. height if it's bogus. */
9046 max_height
= max (1, max_height
);
9047 max_height
= min (total_height
, max_height
);
9049 /* Find out the height of the text in the window. */
9050 if (it
.line_wrap
== TRUNCATE
)
9055 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9056 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9057 height
= it
.current_y
+ last_height
;
9059 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9060 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9061 height
= (height
+ unit
- 1) / unit
;
9064 /* Compute a suitable window start. */
9065 if (height
> max_height
)
9067 height
= max_height
;
9068 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9069 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9070 start
= it
.current
.pos
;
9073 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9074 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9076 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9078 /* Let it grow only, until we display an empty message, in which
9079 case the window shrinks again. */
9080 if (height
> WINDOW_TOTAL_LINES (w
))
9082 int old_height
= WINDOW_TOTAL_LINES (w
);
9083 freeze_window_starts (f
, 1);
9084 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9085 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9087 else if (height
< WINDOW_TOTAL_LINES (w
)
9088 && (exact_p
|| BEGV
== ZV
))
9090 int old_height
= WINDOW_TOTAL_LINES (w
);
9091 freeze_window_starts (f
, 0);
9092 shrink_mini_window (w
);
9093 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9098 /* Always resize to exact size needed. */
9099 if (height
> WINDOW_TOTAL_LINES (w
))
9101 int old_height
= WINDOW_TOTAL_LINES (w
);
9102 freeze_window_starts (f
, 1);
9103 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9104 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9106 else if (height
< WINDOW_TOTAL_LINES (w
))
9108 int old_height
= WINDOW_TOTAL_LINES (w
);
9109 freeze_window_starts (f
, 0);
9110 shrink_mini_window (w
);
9114 freeze_window_starts (f
, 1);
9115 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9118 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9122 if (old_current_buffer
)
9123 set_buffer_internal (old_current_buffer
);
9126 return window_height_changed_p
;
9130 /* Value is the current message, a string, or nil if there is no
9134 current_message (void)
9138 if (!BUFFERP (echo_area_buffer
[0]))
9142 with_echo_area_buffer (0, 0, current_message_1
,
9143 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9145 echo_area_buffer
[0] = Qnil
;
9153 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9155 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9158 *msg
= make_buffer_string (BEG
, Z
, 1);
9165 /* Push the current message on Vmessage_stack for later restauration
9166 by restore_message. Value is non-zero if the current message isn't
9167 empty. This is a relatively infrequent operation, so it's not
9168 worth optimizing. */
9174 msg
= current_message ();
9175 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9176 return STRINGP (msg
);
9180 /* Restore message display from the top of Vmessage_stack. */
9183 restore_message (void)
9187 xassert (CONSP (Vmessage_stack
));
9188 msg
= XCAR (Vmessage_stack
);
9190 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9192 message3_nolog (msg
, 0, 0);
9196 /* Handler for record_unwind_protect calling pop_message. */
9199 pop_message_unwind (Lisp_Object dummy
)
9205 /* Pop the top-most entry off Vmessage_stack. */
9210 xassert (CONSP (Vmessage_stack
));
9211 Vmessage_stack
= XCDR (Vmessage_stack
);
9215 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9216 exits. If the stack is not empty, we have a missing pop_message
9220 check_message_stack (void)
9222 if (!NILP (Vmessage_stack
))
9227 /* Truncate to NCHARS what will be displayed in the echo area the next
9228 time we display it---but don't redisplay it now. */
9231 truncate_echo_area (int nchars
)
9234 echo_area_buffer
[0] = Qnil
;
9235 /* A null message buffer means that the frame hasn't really been
9236 initialized yet. Error messages get reported properly by
9237 cmd_error, so this must be just an informative message; toss it. */
9238 else if (!noninteractive
9240 && !NILP (echo_area_buffer
[0]))
9242 struct frame
*sf
= SELECTED_FRAME ();
9243 if (FRAME_MESSAGE_BUF (sf
))
9244 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9249 /* Helper function for truncate_echo_area. Truncate the current
9250 message to at most NCHARS characters. */
9253 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9255 if (BEG
+ nchars
< Z
)
9256 del_range (BEG
+ nchars
, Z
);
9258 echo_area_buffer
[0] = Qnil
;
9263 /* Set the current message to a substring of S or STRING.
9265 If STRING is a Lisp string, set the message to the first NBYTES
9266 bytes from STRING. NBYTES zero means use the whole string. If
9267 STRING is multibyte, the message will be displayed multibyte.
9269 If S is not null, set the message to the first LEN bytes of S. LEN
9270 zero means use the whole string. MULTIBYTE_P non-zero means S is
9271 multibyte. Display the message multibyte in that case.
9273 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9274 to t before calling set_message_1 (which calls insert).
9278 set_message (const char *s
, Lisp_Object string
, int nbytes
, int multibyte_p
)
9280 message_enable_multibyte
9281 = ((s
&& multibyte_p
)
9282 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9284 with_echo_area_buffer (0, -1, set_message_1
,
9285 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9286 message_buf_print
= 0;
9287 help_echo_showing_p
= 0;
9291 /* Helper function for set_message. Arguments have the same meaning
9292 as there, with A1 corresponding to S and A2 corresponding to STRING
9293 This function is called with the echo area buffer being
9297 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9299 const char *s
= (const char *) a1
;
9300 Lisp_Object string
= a2
;
9302 /* Change multibyteness of the echo buffer appropriately. */
9303 if (message_enable_multibyte
9304 != !NILP (current_buffer
->enable_multibyte_characters
))
9305 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9307 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9309 /* Insert new message at BEG. */
9310 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9312 if (STRINGP (string
))
9317 nbytes
= SBYTES (string
);
9318 nchars
= string_byte_to_char (string
, nbytes
);
9320 /* This function takes care of single/multibyte conversion. We
9321 just have to ensure that the echo area buffer has the right
9322 setting of enable_multibyte_characters. */
9323 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9328 nbytes
= strlen (s
);
9330 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9332 /* Convert from multi-byte to single-byte. */
9334 unsigned char work
[1];
9336 /* Convert a multibyte string to single-byte. */
9337 for (i
= 0; i
< nbytes
; i
+= n
)
9339 c
= string_char_and_length (s
+ i
, &n
);
9340 work
[0] = (ASCII_CHAR_P (c
)
9342 : multibyte_char_to_unibyte (c
, Qnil
));
9343 insert_1_both (work
, 1, 1, 1, 0, 0);
9346 else if (!multibyte_p
9347 && !NILP (current_buffer
->enable_multibyte_characters
))
9349 /* Convert from single-byte to multi-byte. */
9351 const unsigned char *msg
= (const unsigned char *) s
;
9352 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9354 /* Convert a single-byte string to multibyte. */
9355 for (i
= 0; i
< nbytes
; i
++)
9358 MAKE_CHAR_MULTIBYTE (c
);
9359 n
= CHAR_STRING (c
, str
);
9360 insert_1_both (str
, 1, n
, 1, 0, 0);
9364 insert_1 (s
, nbytes
, 1, 0, 0);
9371 /* Clear messages. CURRENT_P non-zero means clear the current
9372 message. LAST_DISPLAYED_P non-zero means clear the message
9376 clear_message (int current_p
, int last_displayed_p
)
9380 echo_area_buffer
[0] = Qnil
;
9381 message_cleared_p
= 1;
9384 if (last_displayed_p
)
9385 echo_area_buffer
[1] = Qnil
;
9387 message_buf_print
= 0;
9390 /* Clear garbaged frames.
9392 This function is used where the old redisplay called
9393 redraw_garbaged_frames which in turn called redraw_frame which in
9394 turn called clear_frame. The call to clear_frame was a source of
9395 flickering. I believe a clear_frame is not necessary. It should
9396 suffice in the new redisplay to invalidate all current matrices,
9397 and ensure a complete redisplay of all windows. */
9400 clear_garbaged_frames (void)
9404 Lisp_Object tail
, frame
;
9405 int changed_count
= 0;
9407 FOR_EACH_FRAME (tail
, frame
)
9409 struct frame
*f
= XFRAME (frame
);
9411 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9415 Fredraw_frame (frame
);
9416 f
->force_flush_display_p
= 1;
9418 clear_current_matrices (f
);
9427 ++windows_or_buffers_changed
;
9432 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9433 is non-zero update selected_frame. Value is non-zero if the
9434 mini-windows height has been changed. */
9437 echo_area_display (int update_frame_p
)
9439 Lisp_Object mini_window
;
9442 int window_height_changed_p
= 0;
9443 struct frame
*sf
= SELECTED_FRAME ();
9445 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9446 w
= XWINDOW (mini_window
);
9447 f
= XFRAME (WINDOW_FRAME (w
));
9449 /* Don't display if frame is invisible or not yet initialized. */
9450 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9453 #ifdef HAVE_WINDOW_SYSTEM
9454 /* When Emacs starts, selected_frame may be the initial terminal
9455 frame. If we let this through, a message would be displayed on
9457 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9459 #endif /* HAVE_WINDOW_SYSTEM */
9461 /* Redraw garbaged frames. */
9463 clear_garbaged_frames ();
9465 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9467 echo_area_window
= mini_window
;
9468 window_height_changed_p
= display_echo_area (w
);
9469 w
->must_be_updated_p
= 1;
9471 /* Update the display, unless called from redisplay_internal.
9472 Also don't update the screen during redisplay itself. The
9473 update will happen at the end of redisplay, and an update
9474 here could cause confusion. */
9475 if (update_frame_p
&& !redisplaying_p
)
9479 /* If the display update has been interrupted by pending
9480 input, update mode lines in the frame. Due to the
9481 pending input, it might have been that redisplay hasn't
9482 been called, so that mode lines above the echo area are
9483 garbaged. This looks odd, so we prevent it here. */
9484 if (!display_completed
)
9485 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9487 if (window_height_changed_p
9488 /* Don't do this if Emacs is shutting down. Redisplay
9489 needs to run hooks. */
9490 && !NILP (Vrun_hooks
))
9492 /* Must update other windows. Likewise as in other
9493 cases, don't let this update be interrupted by
9495 int count
= SPECPDL_INDEX ();
9496 specbind (Qredisplay_dont_pause
, Qt
);
9497 windows_or_buffers_changed
= 1;
9498 redisplay_internal (0);
9499 unbind_to (count
, Qnil
);
9501 else if (FRAME_WINDOW_P (f
) && n
== 0)
9503 /* Window configuration is the same as before.
9504 Can do with a display update of the echo area,
9505 unless we displayed some mode lines. */
9506 update_single_window (w
, 1);
9507 FRAME_RIF (f
)->flush_display (f
);
9510 update_frame (f
, 1, 1);
9512 /* If cursor is in the echo area, make sure that the next
9513 redisplay displays the minibuffer, so that the cursor will
9514 be replaced with what the minibuffer wants. */
9515 if (cursor_in_echo_area
)
9516 ++windows_or_buffers_changed
;
9519 else if (!EQ (mini_window
, selected_window
))
9520 windows_or_buffers_changed
++;
9522 /* Last displayed message is now the current message. */
9523 echo_area_buffer
[1] = echo_area_buffer
[0];
9524 /* Inform read_char that we're not echoing. */
9525 echo_message_buffer
= Qnil
;
9527 /* Prevent redisplay optimization in redisplay_internal by resetting
9528 this_line_start_pos. This is done because the mini-buffer now
9529 displays the message instead of its buffer text. */
9530 if (EQ (mini_window
, selected_window
))
9531 CHARPOS (this_line_start_pos
) = 0;
9533 return window_height_changed_p
;
9538 /***********************************************************************
9539 Mode Lines and Frame Titles
9540 ***********************************************************************/
9542 /* A buffer for constructing non-propertized mode-line strings and
9543 frame titles in it; allocated from the heap in init_xdisp and
9544 resized as needed in store_mode_line_noprop_char. */
9546 static char *mode_line_noprop_buf
;
9548 /* The buffer's end, and a current output position in it. */
9550 static char *mode_line_noprop_buf_end
;
9551 static char *mode_line_noprop_ptr
;
9553 #define MODE_LINE_NOPROP_LEN(start) \
9554 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9557 MODE_LINE_DISPLAY
= 0,
9563 /* Alist that caches the results of :propertize.
9564 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9565 static Lisp_Object mode_line_proptrans_alist
;
9567 /* List of strings making up the mode-line. */
9568 static Lisp_Object mode_line_string_list
;
9570 /* Base face property when building propertized mode line string. */
9571 static Lisp_Object mode_line_string_face
;
9572 static Lisp_Object mode_line_string_face_prop
;
9575 /* Unwind data for mode line strings */
9577 static Lisp_Object Vmode_line_unwind_vector
;
9580 format_mode_line_unwind_data (struct buffer
*obuf
,
9584 Lisp_Object vector
, tmp
;
9586 /* Reduce consing by keeping one vector in
9587 Vwith_echo_area_save_vector. */
9588 vector
= Vmode_line_unwind_vector
;
9589 Vmode_line_unwind_vector
= Qnil
;
9592 vector
= Fmake_vector (make_number (8), Qnil
);
9594 ASET (vector
, 0, make_number (mode_line_target
));
9595 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9596 ASET (vector
, 2, mode_line_string_list
);
9597 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9598 ASET (vector
, 4, mode_line_string_face
);
9599 ASET (vector
, 5, mode_line_string_face_prop
);
9602 XSETBUFFER (tmp
, obuf
);
9605 ASET (vector
, 6, tmp
);
9606 ASET (vector
, 7, owin
);
9612 unwind_format_mode_line (Lisp_Object vector
)
9614 mode_line_target
= XINT (AREF (vector
, 0));
9615 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9616 mode_line_string_list
= AREF (vector
, 2);
9617 if (! EQ (AREF (vector
, 3), Qt
))
9618 mode_line_proptrans_alist
= AREF (vector
, 3);
9619 mode_line_string_face
= AREF (vector
, 4);
9620 mode_line_string_face_prop
= AREF (vector
, 5);
9622 if (!NILP (AREF (vector
, 7)))
9623 /* Select window before buffer, since it may change the buffer. */
9624 Fselect_window (AREF (vector
, 7), Qt
);
9626 if (!NILP (AREF (vector
, 6)))
9628 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9629 ASET (vector
, 6, Qnil
);
9632 Vmode_line_unwind_vector
= vector
;
9637 /* Store a single character C for the frame title in mode_line_noprop_buf.
9638 Re-allocate mode_line_noprop_buf if necessary. */
9641 store_mode_line_noprop_char (char c
)
9643 /* If output position has reached the end of the allocated buffer,
9644 double the buffer's size. */
9645 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9647 int len
= MODE_LINE_NOPROP_LEN (0);
9648 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9649 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9650 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9651 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9654 *mode_line_noprop_ptr
++ = c
;
9658 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9659 mode_line_noprop_ptr. STR is the string to store. Do not copy
9660 characters that yield more columns than PRECISION; PRECISION <= 0
9661 means copy the whole string. Pad with spaces until FIELD_WIDTH
9662 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9663 pad. Called from display_mode_element when it is used to build a
9667 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9672 /* Copy at most PRECISION chars from STR. */
9673 nbytes
= strlen (str
);
9674 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9676 store_mode_line_noprop_char (*str
++);
9678 /* Fill up with spaces until FIELD_WIDTH reached. */
9679 while (field_width
> 0
9682 store_mode_line_noprop_char (' ');
9689 /***********************************************************************
9691 ***********************************************************************/
9693 #ifdef HAVE_WINDOW_SYSTEM
9695 /* Set the title of FRAME, if it has changed. The title format is
9696 Vicon_title_format if FRAME is iconified, otherwise it is
9697 frame_title_format. */
9700 x_consider_frame_title (Lisp_Object frame
)
9702 struct frame
*f
= XFRAME (frame
);
9704 if (FRAME_WINDOW_P (f
)
9705 || FRAME_MINIBUF_ONLY_P (f
)
9706 || f
->explicit_name
)
9708 /* Do we have more than one visible frame on this X display? */
9715 int count
= SPECPDL_INDEX ();
9717 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9719 Lisp_Object other_frame
= XCAR (tail
);
9720 struct frame
*tf
= XFRAME (other_frame
);
9723 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9724 && !FRAME_MINIBUF_ONLY_P (tf
)
9725 && !EQ (other_frame
, tip_frame
)
9726 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9730 /* Set global variable indicating that multiple frames exist. */
9731 multiple_frames
= CONSP (tail
);
9733 /* Switch to the buffer of selected window of the frame. Set up
9734 mode_line_target so that display_mode_element will output into
9735 mode_line_noprop_buf; then display the title. */
9736 record_unwind_protect (unwind_format_mode_line
,
9737 format_mode_line_unwind_data
9738 (current_buffer
, selected_window
, 0));
9740 Fselect_window (f
->selected_window
, Qt
);
9741 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9742 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9744 mode_line_target
= MODE_LINE_TITLE
;
9745 title_start
= MODE_LINE_NOPROP_LEN (0);
9746 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9747 NULL
, DEFAULT_FACE_ID
);
9748 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9749 len
= MODE_LINE_NOPROP_LEN (title_start
);
9750 title
= mode_line_noprop_buf
+ title_start
;
9751 unbind_to (count
, Qnil
);
9753 /* Set the title only if it's changed. This avoids consing in
9754 the common case where it hasn't. (If it turns out that we've
9755 already wasted too much time by walking through the list with
9756 display_mode_element, then we might need to optimize at a
9757 higher level than this.) */
9758 if (! STRINGP (f
->name
)
9759 || SBYTES (f
->name
) != len
9760 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9761 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9765 #endif /* not HAVE_WINDOW_SYSTEM */
9770 /***********************************************************************
9772 ***********************************************************************/
9775 /* Prepare for redisplay by updating menu-bar item lists when
9776 appropriate. This can call eval. */
9779 prepare_menu_bars (void)
9782 struct gcpro gcpro1
, gcpro2
;
9784 Lisp_Object tooltip_frame
;
9786 #ifdef HAVE_WINDOW_SYSTEM
9787 tooltip_frame
= tip_frame
;
9789 tooltip_frame
= Qnil
;
9792 /* Update all frame titles based on their buffer names, etc. We do
9793 this before the menu bars so that the buffer-menu will show the
9794 up-to-date frame titles. */
9795 #ifdef HAVE_WINDOW_SYSTEM
9796 if (windows_or_buffers_changed
|| update_mode_lines
)
9798 Lisp_Object tail
, frame
;
9800 FOR_EACH_FRAME (tail
, frame
)
9803 if (!EQ (frame
, tooltip_frame
)
9804 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9805 x_consider_frame_title (frame
);
9808 #endif /* HAVE_WINDOW_SYSTEM */
9810 /* Update the menu bar item lists, if appropriate. This has to be
9811 done before any actual redisplay or generation of display lines. */
9812 all_windows
= (update_mode_lines
9813 || buffer_shared
> 1
9814 || windows_or_buffers_changed
);
9817 Lisp_Object tail
, frame
;
9818 int count
= SPECPDL_INDEX ();
9819 /* 1 means that update_menu_bar has run its hooks
9820 so any further calls to update_menu_bar shouldn't do so again. */
9821 int menu_bar_hooks_run
= 0;
9823 record_unwind_save_match_data ();
9825 FOR_EACH_FRAME (tail
, frame
)
9829 /* Ignore tooltip frame. */
9830 if (EQ (frame
, tooltip_frame
))
9833 /* If a window on this frame changed size, report that to
9834 the user and clear the size-change flag. */
9835 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9837 Lisp_Object functions
;
9839 /* Clear flag first in case we get an error below. */
9840 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9841 functions
= Vwindow_size_change_functions
;
9842 GCPRO2 (tail
, functions
);
9844 while (CONSP (functions
))
9846 if (!EQ (XCAR (functions
), Qt
))
9847 call1 (XCAR (functions
), frame
);
9848 functions
= XCDR (functions
);
9854 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9855 #ifdef HAVE_WINDOW_SYSTEM
9856 update_tool_bar (f
, 0);
9859 if (windows_or_buffers_changed
9861 ns_set_doc_edited (f
, Fbuffer_modified_p
9862 (XWINDOW (f
->selected_window
)->buffer
));
9867 unbind_to (count
, Qnil
);
9871 struct frame
*sf
= SELECTED_FRAME ();
9872 update_menu_bar (sf
, 1, 0);
9873 #ifdef HAVE_WINDOW_SYSTEM
9874 update_tool_bar (sf
, 1);
9878 /* Motif needs this. See comment in xmenu.c. Turn it off when
9879 pending_menu_activation is not defined. */
9880 #ifdef USE_X_TOOLKIT
9881 pending_menu_activation
= 0;
9886 /* Update the menu bar item list for frame F. This has to be done
9887 before we start to fill in any display lines, because it can call
9890 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9892 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9893 already ran the menu bar hooks for this redisplay, so there
9894 is no need to run them again. The return value is the
9895 updated value of this flag, to pass to the next call. */
9898 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9901 register struct window
*w
;
9903 /* If called recursively during a menu update, do nothing. This can
9904 happen when, for instance, an activate-menubar-hook causes a
9906 if (inhibit_menubar_update
)
9909 window
= FRAME_SELECTED_WINDOW (f
);
9910 w
= XWINDOW (window
);
9912 if (FRAME_WINDOW_P (f
)
9914 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9915 || defined (HAVE_NS) || defined (USE_GTK)
9916 FRAME_EXTERNAL_MENU_BAR (f
)
9918 FRAME_MENU_BAR_LINES (f
) > 0
9920 : FRAME_MENU_BAR_LINES (f
) > 0)
9922 /* If the user has switched buffers or windows, we need to
9923 recompute to reflect the new bindings. But we'll
9924 recompute when update_mode_lines is set too; that means
9925 that people can use force-mode-line-update to request
9926 that the menu bar be recomputed. The adverse effect on
9927 the rest of the redisplay algorithm is about the same as
9928 windows_or_buffers_changed anyway. */
9929 if (windows_or_buffers_changed
9930 /* This used to test w->update_mode_line, but we believe
9931 there is no need to recompute the menu in that case. */
9932 || update_mode_lines
9933 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9934 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9935 != !NILP (w
->last_had_star
))
9936 || ((!NILP (Vtransient_mark_mode
)
9937 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9938 != !NILP (w
->region_showing
)))
9940 struct buffer
*prev
= current_buffer
;
9941 int count
= SPECPDL_INDEX ();
9943 specbind (Qinhibit_menubar_update
, Qt
);
9945 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9946 if (save_match_data
)
9947 record_unwind_save_match_data ();
9948 if (NILP (Voverriding_local_map_menu_flag
))
9950 specbind (Qoverriding_terminal_local_map
, Qnil
);
9951 specbind (Qoverriding_local_map
, Qnil
);
9956 /* Run the Lucid hook. */
9957 safe_run_hooks (Qactivate_menubar_hook
);
9959 /* If it has changed current-menubar from previous value,
9960 really recompute the menu-bar from the value. */
9961 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9962 call0 (Qrecompute_lucid_menubar
);
9964 safe_run_hooks (Qmenu_bar_update_hook
);
9969 XSETFRAME (Vmenu_updating_frame
, f
);
9970 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9972 /* Redisplay the menu bar in case we changed it. */
9973 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9974 || defined (HAVE_NS) || defined (USE_GTK)
9975 if (FRAME_WINDOW_P (f
))
9977 #if defined (HAVE_NS)
9978 /* All frames on Mac OS share the same menubar. So only
9979 the selected frame should be allowed to set it. */
9980 if (f
== SELECTED_FRAME ())
9982 set_frame_menubar (f
, 0, 0);
9985 /* On a terminal screen, the menu bar is an ordinary screen
9986 line, and this makes it get updated. */
9987 w
->update_mode_line
= Qt
;
9988 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9989 /* In the non-toolkit version, the menu bar is an ordinary screen
9990 line, and this makes it get updated. */
9991 w
->update_mode_line
= Qt
;
9992 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9994 unbind_to (count
, Qnil
);
9995 set_buffer_internal_1 (prev
);
10004 /***********************************************************************
10006 ***********************************************************************/
10008 #ifdef HAVE_WINDOW_SYSTEM
10011 Nominal cursor position -- where to draw output.
10012 HPOS and VPOS are window relative glyph matrix coordinates.
10013 X and Y are window relative pixel coordinates. */
10015 struct cursor_pos output_cursor
;
10019 Set the global variable output_cursor to CURSOR. All cursor
10020 positions are relative to updated_window. */
10023 set_output_cursor (struct cursor_pos
*cursor
)
10025 output_cursor
.hpos
= cursor
->hpos
;
10026 output_cursor
.vpos
= cursor
->vpos
;
10027 output_cursor
.x
= cursor
->x
;
10028 output_cursor
.y
= cursor
->y
;
10033 Set a nominal cursor position.
10035 HPOS and VPOS are column/row positions in a window glyph matrix. X
10036 and Y are window text area relative pixel positions.
10038 If this is done during an update, updated_window will contain the
10039 window that is being updated and the position is the future output
10040 cursor position for that window. If updated_window is null, use
10041 selected_window and display the cursor at the given position. */
10044 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10048 /* If updated_window is not set, work on selected_window. */
10049 if (updated_window
)
10050 w
= updated_window
;
10052 w
= XWINDOW (selected_window
);
10054 /* Set the output cursor. */
10055 output_cursor
.hpos
= hpos
;
10056 output_cursor
.vpos
= vpos
;
10057 output_cursor
.x
= x
;
10058 output_cursor
.y
= y
;
10060 /* If not called as part of an update, really display the cursor.
10061 This will also set the cursor position of W. */
10062 if (updated_window
== NULL
)
10065 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10066 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10067 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10072 #endif /* HAVE_WINDOW_SYSTEM */
10075 /***********************************************************************
10077 ***********************************************************************/
10079 #ifdef HAVE_WINDOW_SYSTEM
10081 /* Where the mouse was last time we reported a mouse event. */
10083 FRAME_PTR last_mouse_frame
;
10085 /* Tool-bar item index of the item on which a mouse button was pressed
10088 int last_tool_bar_item
;
10092 update_tool_bar_unwind (Lisp_Object frame
)
10094 selected_frame
= frame
;
10098 /* Update the tool-bar item list for frame F. This has to be done
10099 before we start to fill in any display lines. Called from
10100 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10101 and restore it here. */
10104 update_tool_bar (struct frame
*f
, int save_match_data
)
10106 #if defined (USE_GTK) || defined (HAVE_NS)
10107 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10109 int do_update
= WINDOWP (f
->tool_bar_window
)
10110 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10115 Lisp_Object window
;
10118 window
= FRAME_SELECTED_WINDOW (f
);
10119 w
= XWINDOW (window
);
10121 /* If the user has switched buffers or windows, we need to
10122 recompute to reflect the new bindings. But we'll
10123 recompute when update_mode_lines is set too; that means
10124 that people can use force-mode-line-update to request
10125 that the menu bar be recomputed. The adverse effect on
10126 the rest of the redisplay algorithm is about the same as
10127 windows_or_buffers_changed anyway. */
10128 if (windows_or_buffers_changed
10129 || !NILP (w
->update_mode_line
)
10130 || update_mode_lines
10131 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10132 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10133 != !NILP (w
->last_had_star
))
10134 || ((!NILP (Vtransient_mark_mode
)
10135 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10136 != !NILP (w
->region_showing
)))
10138 struct buffer
*prev
= current_buffer
;
10139 int count
= SPECPDL_INDEX ();
10140 Lisp_Object frame
, new_tool_bar
;
10141 int new_n_tool_bar
;
10142 struct gcpro gcpro1
;
10144 /* Set current_buffer to the buffer of the selected
10145 window of the frame, so that we get the right local
10147 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10149 /* Save match data, if we must. */
10150 if (save_match_data
)
10151 record_unwind_save_match_data ();
10153 /* Make sure that we don't accidentally use bogus keymaps. */
10154 if (NILP (Voverriding_local_map_menu_flag
))
10156 specbind (Qoverriding_terminal_local_map
, Qnil
);
10157 specbind (Qoverriding_local_map
, Qnil
);
10160 GCPRO1 (new_tool_bar
);
10162 /* We must temporarily set the selected frame to this frame
10163 before calling tool_bar_items, because the calculation of
10164 the tool-bar keymap uses the selected frame (see
10165 `tool-bar-make-keymap' in tool-bar.el). */
10166 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10167 XSETFRAME (frame
, f
);
10168 selected_frame
= frame
;
10170 /* Build desired tool-bar items from keymaps. */
10171 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10174 /* Redisplay the tool-bar if we changed it. */
10175 if (new_n_tool_bar
!= f
->n_tool_bar_items
10176 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10178 /* Redisplay that happens asynchronously due to an expose event
10179 may access f->tool_bar_items. Make sure we update both
10180 variables within BLOCK_INPUT so no such event interrupts. */
10182 f
->tool_bar_items
= new_tool_bar
;
10183 f
->n_tool_bar_items
= new_n_tool_bar
;
10184 w
->update_mode_line
= Qt
;
10190 unbind_to (count
, Qnil
);
10191 set_buffer_internal_1 (prev
);
10197 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10198 F's desired tool-bar contents. F->tool_bar_items must have
10199 been set up previously by calling prepare_menu_bars. */
10202 build_desired_tool_bar_string (struct frame
*f
)
10204 int i
, size
, size_needed
;
10205 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10206 Lisp_Object image
, plist
, props
;
10208 image
= plist
= props
= Qnil
;
10209 GCPRO3 (image
, plist
, props
);
10211 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10212 Otherwise, make a new string. */
10214 /* The size of the string we might be able to reuse. */
10215 size
= (STRINGP (f
->desired_tool_bar_string
)
10216 ? SCHARS (f
->desired_tool_bar_string
)
10219 /* We need one space in the string for each image. */
10220 size_needed
= f
->n_tool_bar_items
;
10222 /* Reuse f->desired_tool_bar_string, if possible. */
10223 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10224 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10225 make_number (' '));
10228 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10229 Fremove_text_properties (make_number (0), make_number (size
),
10230 props
, f
->desired_tool_bar_string
);
10233 /* Put a `display' property on the string for the images to display,
10234 put a `menu_item' property on tool-bar items with a value that
10235 is the index of the item in F's tool-bar item vector. */
10236 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10238 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10240 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10241 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10242 int hmargin
, vmargin
, relief
, idx
, end
;
10243 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10245 /* If image is a vector, choose the image according to the
10247 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10248 if (VECTORP (image
))
10252 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10253 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10256 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10257 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10259 xassert (ASIZE (image
) >= idx
);
10260 image
= AREF (image
, idx
);
10265 /* Ignore invalid image specifications. */
10266 if (!valid_image_p (image
))
10269 /* Display the tool-bar button pressed, or depressed. */
10270 plist
= Fcopy_sequence (XCDR (image
));
10272 /* Compute margin and relief to draw. */
10273 relief
= (tool_bar_button_relief
>= 0
10274 ? tool_bar_button_relief
10275 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10276 hmargin
= vmargin
= relief
;
10278 if (INTEGERP (Vtool_bar_button_margin
)
10279 && XINT (Vtool_bar_button_margin
) > 0)
10281 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10282 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10284 else if (CONSP (Vtool_bar_button_margin
))
10286 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10287 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10288 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10290 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10291 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10292 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10295 if (auto_raise_tool_bar_buttons_p
)
10297 /* Add a `:relief' property to the image spec if the item is
10301 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10308 /* If image is selected, display it pressed, i.e. with a
10309 negative relief. If it's not selected, display it with a
10311 plist
= Fplist_put (plist
, QCrelief
,
10313 ? make_number (-relief
)
10314 : make_number (relief
)));
10319 /* Put a margin around the image. */
10320 if (hmargin
|| vmargin
)
10322 if (hmargin
== vmargin
)
10323 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10325 plist
= Fplist_put (plist
, QCmargin
,
10326 Fcons (make_number (hmargin
),
10327 make_number (vmargin
)));
10330 /* If button is not enabled, and we don't have special images
10331 for the disabled state, make the image appear disabled by
10332 applying an appropriate algorithm to it. */
10333 if (!enabled_p
&& idx
< 0)
10334 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10336 /* Put a `display' text property on the string for the image to
10337 display. Put a `menu-item' property on the string that gives
10338 the start of this item's properties in the tool-bar items
10340 image
= Fcons (Qimage
, plist
);
10341 props
= list4 (Qdisplay
, image
,
10342 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10344 /* Let the last image hide all remaining spaces in the tool bar
10345 string. The string can be longer than needed when we reuse a
10346 previous string. */
10347 if (i
+ 1 == f
->n_tool_bar_items
)
10348 end
= SCHARS (f
->desired_tool_bar_string
);
10351 Fadd_text_properties (make_number (i
), make_number (end
),
10352 props
, f
->desired_tool_bar_string
);
10360 /* Display one line of the tool-bar of frame IT->f.
10362 HEIGHT specifies the desired height of the tool-bar line.
10363 If the actual height of the glyph row is less than HEIGHT, the
10364 row's height is increased to HEIGHT, and the icons are centered
10365 vertically in the new height.
10367 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10368 count a final empty row in case the tool-bar width exactly matches
10373 display_tool_bar_line (struct it
*it
, int height
)
10375 struct glyph_row
*row
= it
->glyph_row
;
10376 int max_x
= it
->last_visible_x
;
10377 struct glyph
*last
;
10379 prepare_desired_row (row
);
10380 row
->y
= it
->current_y
;
10382 /* Note that this isn't made use of if the face hasn't a box,
10383 so there's no need to check the face here. */
10384 it
->start_of_box_run_p
= 1;
10386 while (it
->current_x
< max_x
)
10388 int x
, n_glyphs_before
, i
, nglyphs
;
10389 struct it it_before
;
10391 /* Get the next display element. */
10392 if (!get_next_display_element (it
))
10394 /* Don't count empty row if we are counting needed tool-bar lines. */
10395 if (height
< 0 && !it
->hpos
)
10400 /* Produce glyphs. */
10401 n_glyphs_before
= row
->used
[TEXT_AREA
];
10404 PRODUCE_GLYPHS (it
);
10406 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10408 x
= it_before
.current_x
;
10409 while (i
< nglyphs
)
10411 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10413 if (x
+ glyph
->pixel_width
> max_x
)
10415 /* Glyph doesn't fit on line. Backtrack. */
10416 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10418 /* If this is the only glyph on this line, it will never fit on the
10419 toolbar, so skip it. But ensure there is at least one glyph,
10420 so we don't accidentally disable the tool-bar. */
10421 if (n_glyphs_before
== 0
10422 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10428 x
+= glyph
->pixel_width
;
10432 /* Stop at line ends. */
10433 if (ITERATOR_AT_END_OF_LINE_P (it
))
10436 set_iterator_to_next (it
, 1);
10441 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10443 /* Use default face for the border below the tool bar.
10445 FIXME: When auto-resize-tool-bars is grow-only, there is
10446 no additional border below the possibly empty tool-bar lines.
10447 So to make the extra empty lines look "normal", we have to
10448 use the tool-bar face for the border too. */
10449 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10450 it
->face_id
= DEFAULT_FACE_ID
;
10452 extend_face_to_end_of_line (it
);
10453 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10454 last
->right_box_line_p
= 1;
10455 if (last
== row
->glyphs
[TEXT_AREA
])
10456 last
->left_box_line_p
= 1;
10458 /* Make line the desired height and center it vertically. */
10459 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10461 /* Don't add more than one line height. */
10462 height
%= FRAME_LINE_HEIGHT (it
->f
);
10463 it
->max_ascent
+= height
/ 2;
10464 it
->max_descent
+= (height
+ 1) / 2;
10467 compute_line_metrics (it
);
10469 /* If line is empty, make it occupy the rest of the tool-bar. */
10470 if (!row
->displays_text_p
)
10472 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10473 row
->visible_height
= row
->height
;
10474 row
->ascent
= row
->phys_ascent
= 0;
10475 row
->extra_line_spacing
= 0;
10478 row
->full_width_p
= 1;
10479 row
->continued_p
= 0;
10480 row
->truncated_on_left_p
= 0;
10481 row
->truncated_on_right_p
= 0;
10483 it
->current_x
= it
->hpos
= 0;
10484 it
->current_y
+= row
->height
;
10490 /* Max tool-bar height. */
10492 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10493 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10495 /* Value is the number of screen lines needed to make all tool-bar
10496 items of frame F visible. The number of actual rows needed is
10497 returned in *N_ROWS if non-NULL. */
10500 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10502 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10504 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10505 the desired matrix, so use (unused) mode-line row as temporary row to
10506 avoid destroying the first tool-bar row. */
10507 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10509 /* Initialize an iterator for iteration over
10510 F->desired_tool_bar_string in the tool-bar window of frame F. */
10511 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10512 it
.first_visible_x
= 0;
10513 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10514 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10516 while (!ITERATOR_AT_END_P (&it
))
10518 clear_glyph_row (temp_row
);
10519 it
.glyph_row
= temp_row
;
10520 display_tool_bar_line (&it
, -1);
10522 clear_glyph_row (temp_row
);
10524 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10526 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10528 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10532 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10534 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10535 (Lisp_Object frame
)
10542 frame
= selected_frame
;
10544 CHECK_FRAME (frame
);
10545 f
= XFRAME (frame
);
10547 if (WINDOWP (f
->tool_bar_window
)
10548 || (w
= XWINDOW (f
->tool_bar_window
),
10549 WINDOW_TOTAL_LINES (w
) > 0))
10551 update_tool_bar (f
, 1);
10552 if (f
->n_tool_bar_items
)
10554 build_desired_tool_bar_string (f
);
10555 nlines
= tool_bar_lines_needed (f
, NULL
);
10559 return make_number (nlines
);
10563 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10564 height should be changed. */
10567 redisplay_tool_bar (struct frame
*f
)
10571 struct glyph_row
*row
;
10573 #if defined (USE_GTK) || defined (HAVE_NS)
10574 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10575 update_frame_tool_bar (f
);
10579 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10580 do anything. This means you must start with tool-bar-lines
10581 non-zero to get the auto-sizing effect. Or in other words, you
10582 can turn off tool-bars by specifying tool-bar-lines zero. */
10583 if (!WINDOWP (f
->tool_bar_window
)
10584 || (w
= XWINDOW (f
->tool_bar_window
),
10585 WINDOW_TOTAL_LINES (w
) == 0))
10588 /* Set up an iterator for the tool-bar window. */
10589 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10590 it
.first_visible_x
= 0;
10591 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10592 row
= it
.glyph_row
;
10594 /* Build a string that represents the contents of the tool-bar. */
10595 build_desired_tool_bar_string (f
);
10596 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10598 if (f
->n_tool_bar_rows
== 0)
10602 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10603 nlines
!= WINDOW_TOTAL_LINES (w
)))
10605 extern Lisp_Object Qtool_bar_lines
;
10607 int old_height
= WINDOW_TOTAL_LINES (w
);
10609 XSETFRAME (frame
, f
);
10610 Fmodify_frame_parameters (frame
,
10611 Fcons (Fcons (Qtool_bar_lines
,
10612 make_number (nlines
)),
10614 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10616 clear_glyph_matrix (w
->desired_matrix
);
10617 fonts_changed_p
= 1;
10623 /* Display as many lines as needed to display all tool-bar items. */
10625 if (f
->n_tool_bar_rows
> 0)
10627 int border
, rows
, height
, extra
;
10629 if (INTEGERP (Vtool_bar_border
))
10630 border
= XINT (Vtool_bar_border
);
10631 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10632 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10633 else if (EQ (Vtool_bar_border
, Qborder_width
))
10634 border
= f
->border_width
;
10640 rows
= f
->n_tool_bar_rows
;
10641 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10642 extra
= it
.last_visible_y
- border
- height
* rows
;
10644 while (it
.current_y
< it
.last_visible_y
)
10647 if (extra
> 0 && rows
-- > 0)
10649 h
= (extra
+ rows
- 1) / rows
;
10652 display_tool_bar_line (&it
, height
+ h
);
10657 while (it
.current_y
< it
.last_visible_y
)
10658 display_tool_bar_line (&it
, 0);
10661 /* It doesn't make much sense to try scrolling in the tool-bar
10662 window, so don't do it. */
10663 w
->desired_matrix
->no_scrolling_p
= 1;
10664 w
->must_be_updated_p
= 1;
10666 if (!NILP (Vauto_resize_tool_bars
))
10668 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10669 int change_height_p
= 0;
10671 /* If we couldn't display everything, change the tool-bar's
10672 height if there is room for more. */
10673 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10674 && it
.current_y
< max_tool_bar_height
)
10675 change_height_p
= 1;
10677 row
= it
.glyph_row
- 1;
10679 /* If there are blank lines at the end, except for a partially
10680 visible blank line at the end that is smaller than
10681 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10682 if (!row
->displays_text_p
10683 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10684 change_height_p
= 1;
10686 /* If row displays tool-bar items, but is partially visible,
10687 change the tool-bar's height. */
10688 if (row
->displays_text_p
10689 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10690 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10691 change_height_p
= 1;
10693 /* Resize windows as needed by changing the `tool-bar-lines'
10694 frame parameter. */
10695 if (change_height_p
)
10697 extern Lisp_Object Qtool_bar_lines
;
10699 int old_height
= WINDOW_TOTAL_LINES (w
);
10701 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10703 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10704 && !f
->minimize_tool_bar_window_p
)
10705 ? (nlines
> old_height
)
10706 : (nlines
!= old_height
));
10707 f
->minimize_tool_bar_window_p
= 0;
10709 if (change_height_p
)
10711 XSETFRAME (frame
, f
);
10712 Fmodify_frame_parameters (frame
,
10713 Fcons (Fcons (Qtool_bar_lines
,
10714 make_number (nlines
)),
10716 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10718 clear_glyph_matrix (w
->desired_matrix
);
10719 f
->n_tool_bar_rows
= nrows
;
10720 fonts_changed_p
= 1;
10727 f
->minimize_tool_bar_window_p
= 0;
10732 /* Get information about the tool-bar item which is displayed in GLYPH
10733 on frame F. Return in *PROP_IDX the index where tool-bar item
10734 properties start in F->tool_bar_items. Value is zero if
10735 GLYPH doesn't display a tool-bar item. */
10738 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10744 /* This function can be called asynchronously, which means we must
10745 exclude any possibility that Fget_text_property signals an
10747 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10748 charpos
= max (0, charpos
);
10750 /* Get the text property `menu-item' at pos. The value of that
10751 property is the start index of this item's properties in
10752 F->tool_bar_items. */
10753 prop
= Fget_text_property (make_number (charpos
),
10754 Qmenu_item
, f
->current_tool_bar_string
);
10755 if (INTEGERP (prop
))
10757 *prop_idx
= XINT (prop
);
10767 /* Get information about the tool-bar item at position X/Y on frame F.
10768 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10769 the current matrix of the tool-bar window of F, or NULL if not
10770 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10771 item in F->tool_bar_items. Value is
10773 -1 if X/Y is not on a tool-bar item
10774 0 if X/Y is on the same item that was highlighted before.
10778 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10779 int *hpos
, int *vpos
, int *prop_idx
)
10781 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10782 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10785 /* Find the glyph under X/Y. */
10786 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10787 if (*glyph
== NULL
)
10790 /* Get the start of this tool-bar item's properties in
10791 f->tool_bar_items. */
10792 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10795 /* Is mouse on the highlighted item? */
10796 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10797 && *vpos
>= dpyinfo
->mouse_face_beg_row
10798 && *vpos
<= dpyinfo
->mouse_face_end_row
10799 && (*vpos
> dpyinfo
->mouse_face_beg_row
10800 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10801 && (*vpos
< dpyinfo
->mouse_face_end_row
10802 || *hpos
< dpyinfo
->mouse_face_end_col
10803 || dpyinfo
->mouse_face_past_end
))
10811 Handle mouse button event on the tool-bar of frame F, at
10812 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10813 0 for button release. MODIFIERS is event modifiers for button
10817 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10818 unsigned int modifiers
)
10820 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10821 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10822 int hpos
, vpos
, prop_idx
;
10823 struct glyph
*glyph
;
10824 Lisp_Object enabled_p
;
10826 /* If not on the highlighted tool-bar item, return. */
10827 frame_to_window_pixel_xy (w
, &x
, &y
);
10828 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10831 /* If item is disabled, do nothing. */
10832 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10833 if (NILP (enabled_p
))
10838 /* Show item in pressed state. */
10839 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10840 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10841 last_tool_bar_item
= prop_idx
;
10845 Lisp_Object key
, frame
;
10846 struct input_event event
;
10847 EVENT_INIT (event
);
10849 /* Show item in released state. */
10850 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10851 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10853 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10855 XSETFRAME (frame
, f
);
10856 event
.kind
= TOOL_BAR_EVENT
;
10857 event
.frame_or_window
= frame
;
10859 kbd_buffer_store_event (&event
);
10861 event
.kind
= TOOL_BAR_EVENT
;
10862 event
.frame_or_window
= frame
;
10864 event
.modifiers
= modifiers
;
10865 kbd_buffer_store_event (&event
);
10866 last_tool_bar_item
= -1;
10871 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10872 tool-bar window-relative coordinates X/Y. Called from
10873 note_mouse_highlight. */
10876 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10878 Lisp_Object window
= f
->tool_bar_window
;
10879 struct window
*w
= XWINDOW (window
);
10880 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10882 struct glyph
*glyph
;
10883 struct glyph_row
*row
;
10885 Lisp_Object enabled_p
;
10887 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10888 int mouse_down_p
, rc
;
10890 /* Function note_mouse_highlight is called with negative x(y
10891 values when mouse moves outside of the frame. */
10892 if (x
<= 0 || y
<= 0)
10894 clear_mouse_face (dpyinfo
);
10898 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10901 /* Not on tool-bar item. */
10902 clear_mouse_face (dpyinfo
);
10906 /* On same tool-bar item as before. */
10907 goto set_help_echo
;
10909 clear_mouse_face (dpyinfo
);
10911 /* Mouse is down, but on different tool-bar item? */
10912 mouse_down_p
= (dpyinfo
->grabbed
10913 && f
== last_mouse_frame
10914 && FRAME_LIVE_P (f
));
10916 && last_tool_bar_item
!= prop_idx
)
10919 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10920 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10922 /* If tool-bar item is not enabled, don't highlight it. */
10923 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10924 if (!NILP (enabled_p
))
10926 /* Compute the x-position of the glyph. In front and past the
10927 image is a space. We include this in the highlighted area. */
10928 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10929 for (i
= x
= 0; i
< hpos
; ++i
)
10930 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10932 /* Record this as the current active region. */
10933 dpyinfo
->mouse_face_beg_col
= hpos
;
10934 dpyinfo
->mouse_face_beg_row
= vpos
;
10935 dpyinfo
->mouse_face_beg_x
= x
;
10936 dpyinfo
->mouse_face_beg_y
= row
->y
;
10937 dpyinfo
->mouse_face_past_end
= 0;
10939 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10940 dpyinfo
->mouse_face_end_row
= vpos
;
10941 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10942 dpyinfo
->mouse_face_end_y
= row
->y
;
10943 dpyinfo
->mouse_face_window
= window
;
10944 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10946 /* Display it as active. */
10947 show_mouse_face (dpyinfo
, draw
);
10948 dpyinfo
->mouse_face_image_state
= draw
;
10953 /* Set help_echo_string to a help string to display for this tool-bar item.
10954 XTread_socket does the rest. */
10955 help_echo_object
= help_echo_window
= Qnil
;
10956 help_echo_pos
= -1;
10957 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10958 if (NILP (help_echo_string
))
10959 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10962 #endif /* HAVE_WINDOW_SYSTEM */
10966 /************************************************************************
10967 Horizontal scrolling
10968 ************************************************************************/
10970 static int hscroll_window_tree (Lisp_Object
);
10971 static int hscroll_windows (Lisp_Object
);
10973 /* For all leaf windows in the window tree rooted at WINDOW, set their
10974 hscroll value so that PT is (i) visible in the window, and (ii) so
10975 that it is not within a certain margin at the window's left and
10976 right border. Value is non-zero if any window's hscroll has been
10980 hscroll_window_tree (Lisp_Object window
)
10982 int hscrolled_p
= 0;
10983 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10984 int hscroll_step_abs
= 0;
10985 double hscroll_step_rel
= 0;
10987 if (hscroll_relative_p
)
10989 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10990 if (hscroll_step_rel
< 0)
10992 hscroll_relative_p
= 0;
10993 hscroll_step_abs
= 0;
10996 else if (INTEGERP (Vhscroll_step
))
10998 hscroll_step_abs
= XINT (Vhscroll_step
);
10999 if (hscroll_step_abs
< 0)
11000 hscroll_step_abs
= 0;
11003 hscroll_step_abs
= 0;
11005 while (WINDOWP (window
))
11007 struct window
*w
= XWINDOW (window
);
11009 if (WINDOWP (w
->hchild
))
11010 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11011 else if (WINDOWP (w
->vchild
))
11012 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11013 else if (w
->cursor
.vpos
>= 0)
11016 int text_area_width
;
11017 struct glyph_row
*current_cursor_row
11018 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11019 struct glyph_row
*desired_cursor_row
11020 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11021 struct glyph_row
*cursor_row
11022 = (desired_cursor_row
->enabled_p
11023 ? desired_cursor_row
11024 : current_cursor_row
);
11026 text_area_width
= window_box_width (w
, TEXT_AREA
);
11028 /* Scroll when cursor is inside this scroll margin. */
11029 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11031 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11032 && ((XFASTINT (w
->hscroll
)
11033 && w
->cursor
.x
<= h_margin
)
11034 || (cursor_row
->enabled_p
11035 && cursor_row
->truncated_on_right_p
11036 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11040 struct buffer
*saved_current_buffer
;
11044 /* Find point in a display of infinite width. */
11045 saved_current_buffer
= current_buffer
;
11046 current_buffer
= XBUFFER (w
->buffer
);
11048 if (w
== XWINDOW (selected_window
))
11049 pt
= BUF_PT (current_buffer
);
11052 pt
= marker_position (w
->pointm
);
11053 pt
= max (BEGV
, pt
);
11057 /* Move iterator to pt starting at cursor_row->start in
11058 a line with infinite width. */
11059 init_to_row_start (&it
, w
, cursor_row
);
11060 it
.last_visible_x
= INFINITY
;
11061 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11062 current_buffer
= saved_current_buffer
;
11064 /* Position cursor in window. */
11065 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11066 hscroll
= max (0, (it
.current_x
11067 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11068 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11069 : (text_area_width
/ 2))))
11070 / FRAME_COLUMN_WIDTH (it
.f
);
11071 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11073 if (hscroll_relative_p
)
11074 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11077 wanted_x
= text_area_width
11078 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11081 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11085 if (hscroll_relative_p
)
11086 wanted_x
= text_area_width
* hscroll_step_rel
11089 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11092 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11094 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11096 /* Don't call Fset_window_hscroll if value hasn't
11097 changed because it will prevent redisplay
11099 if (XFASTINT (w
->hscroll
) != hscroll
)
11101 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11102 w
->hscroll
= make_number (hscroll
);
11111 /* Value is non-zero if hscroll of any leaf window has been changed. */
11112 return hscrolled_p
;
11116 /* Set hscroll so that cursor is visible and not inside horizontal
11117 scroll margins for all windows in the tree rooted at WINDOW. See
11118 also hscroll_window_tree above. Value is non-zero if any window's
11119 hscroll has been changed. If it has, desired matrices on the frame
11120 of WINDOW are cleared. */
11123 hscroll_windows (Lisp_Object window
)
11125 int hscrolled_p
= hscroll_window_tree (window
);
11127 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11128 return hscrolled_p
;
11133 /************************************************************************
11135 ************************************************************************/
11137 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11138 to a non-zero value. This is sometimes handy to have in a debugger
11143 /* First and last unchanged row for try_window_id. */
11145 int debug_first_unchanged_at_end_vpos
;
11146 int debug_last_unchanged_at_beg_vpos
;
11148 /* Delta vpos and y. */
11150 int debug_dvpos
, debug_dy
;
11152 /* Delta in characters and bytes for try_window_id. */
11154 int debug_delta
, debug_delta_bytes
;
11156 /* Values of window_end_pos and window_end_vpos at the end of
11159 EMACS_INT debug_end_pos
, debug_end_vpos
;
11161 /* Append a string to W->desired_matrix->method. FMT is a printf
11162 format string. A1...A9 are a supplement for a variable-length
11163 argument list. If trace_redisplay_p is non-zero also printf the
11164 resulting string to stderr. */
11167 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11170 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11173 char *method
= w
->desired_matrix
->method
;
11174 int len
= strlen (method
);
11175 int size
= sizeof w
->desired_matrix
->method
;
11176 int remaining
= size
- len
- 1;
11178 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11179 if (len
&& remaining
)
11182 --remaining
, ++len
;
11185 strncpy (method
+ len
, buffer
, remaining
);
11187 if (trace_redisplay_p
)
11188 fprintf (stderr
, "%p (%s): %s\n",
11190 ((BUFFERP (w
->buffer
)
11191 && STRINGP (XBUFFER (w
->buffer
)->name
))
11192 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11197 #endif /* GLYPH_DEBUG */
11200 /* Value is non-zero if all changes in window W, which displays
11201 current_buffer, are in the text between START and END. START is a
11202 buffer position, END is given as a distance from Z. Used in
11203 redisplay_internal for display optimization. */
11206 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11208 int unchanged_p
= 1;
11210 /* If text or overlays have changed, see where. */
11211 if (XFASTINT (w
->last_modified
) < MODIFF
11212 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11214 /* Gap in the line? */
11215 if (GPT
< start
|| Z
- GPT
< end
)
11218 /* Changes start in front of the line, or end after it? */
11220 && (BEG_UNCHANGED
< start
- 1
11221 || END_UNCHANGED
< end
))
11224 /* If selective display, can't optimize if changes start at the
11225 beginning of the line. */
11227 && INTEGERP (current_buffer
->selective_display
)
11228 && XINT (current_buffer
->selective_display
) > 0
11229 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11232 /* If there are overlays at the start or end of the line, these
11233 may have overlay strings with newlines in them. A change at
11234 START, for instance, may actually concern the display of such
11235 overlay strings as well, and they are displayed on different
11236 lines. So, quickly rule out this case. (For the future, it
11237 might be desirable to implement something more telling than
11238 just BEG/END_UNCHANGED.) */
11241 if (BEG
+ BEG_UNCHANGED
== start
11242 && overlay_touches_p (start
))
11244 if (END_UNCHANGED
== end
11245 && overlay_touches_p (Z
- end
))
11249 /* Under bidi reordering, adding or deleting a character in the
11250 beginning of a paragraph, before the first strong directional
11251 character, can change the base direction of the paragraph (unless
11252 the buffer specifies a fixed paragraph direction), which will
11253 require to redisplay the whole paragraph. It might be worthwhile
11254 to find the paragraph limits and widen the range of redisplayed
11255 lines to that, but for now just give up this optimization. */
11256 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11257 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11261 return unchanged_p
;
11265 /* Do a frame update, taking possible shortcuts into account. This is
11266 the main external entry point for redisplay.
11268 If the last redisplay displayed an echo area message and that message
11269 is no longer requested, we clear the echo area or bring back the
11270 mini-buffer if that is in use. */
11275 redisplay_internal (0);
11280 overlay_arrow_string_or_property (Lisp_Object var
)
11284 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11287 return Voverlay_arrow_string
;
11290 /* Return 1 if there are any overlay-arrows in current_buffer. */
11292 overlay_arrow_in_current_buffer_p (void)
11296 for (vlist
= Voverlay_arrow_variable_list
;
11298 vlist
= XCDR (vlist
))
11300 Lisp_Object var
= XCAR (vlist
);
11303 if (!SYMBOLP (var
))
11305 val
= find_symbol_value (var
);
11307 && current_buffer
== XMARKER (val
)->buffer
)
11314 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11318 overlay_arrows_changed_p (void)
11322 for (vlist
= Voverlay_arrow_variable_list
;
11324 vlist
= XCDR (vlist
))
11326 Lisp_Object var
= XCAR (vlist
);
11327 Lisp_Object val
, pstr
;
11329 if (!SYMBOLP (var
))
11331 val
= find_symbol_value (var
);
11332 if (!MARKERP (val
))
11334 if (! EQ (COERCE_MARKER (val
),
11335 Fget (var
, Qlast_arrow_position
))
11336 || ! (pstr
= overlay_arrow_string_or_property (var
),
11337 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11343 /* Mark overlay arrows to be updated on next redisplay. */
11346 update_overlay_arrows (int up_to_date
)
11350 for (vlist
= Voverlay_arrow_variable_list
;
11352 vlist
= XCDR (vlist
))
11354 Lisp_Object var
= XCAR (vlist
);
11356 if (!SYMBOLP (var
))
11359 if (up_to_date
> 0)
11361 Lisp_Object val
= find_symbol_value (var
);
11362 Fput (var
, Qlast_arrow_position
,
11363 COERCE_MARKER (val
));
11364 Fput (var
, Qlast_arrow_string
,
11365 overlay_arrow_string_or_property (var
));
11367 else if (up_to_date
< 0
11368 || !NILP (Fget (var
, Qlast_arrow_position
)))
11370 Fput (var
, Qlast_arrow_position
, Qt
);
11371 Fput (var
, Qlast_arrow_string
, Qt
);
11377 /* Return overlay arrow string to display at row.
11378 Return integer (bitmap number) for arrow bitmap in left fringe.
11379 Return nil if no overlay arrow. */
11382 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11386 for (vlist
= Voverlay_arrow_variable_list
;
11388 vlist
= XCDR (vlist
))
11390 Lisp_Object var
= XCAR (vlist
);
11393 if (!SYMBOLP (var
))
11396 val
= find_symbol_value (var
);
11399 && current_buffer
== XMARKER (val
)->buffer
11400 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11402 if (FRAME_WINDOW_P (it
->f
)
11403 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11405 #ifdef HAVE_WINDOW_SYSTEM
11406 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11409 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11410 return make_number (fringe_bitmap
);
11413 return make_number (-1); /* Use default arrow bitmap */
11415 return overlay_arrow_string_or_property (var
);
11422 /* Return 1 if point moved out of or into a composition. Otherwise
11423 return 0. PREV_BUF and PREV_PT are the last point buffer and
11424 position. BUF and PT are the current point buffer and position. */
11427 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11428 struct buffer
*buf
, int pt
)
11430 EMACS_INT start
, end
;
11432 Lisp_Object buffer
;
11434 XSETBUFFER (buffer
, buf
);
11435 /* Check a composition at the last point if point moved within the
11437 if (prev_buf
== buf
)
11440 /* Point didn't move. */
11443 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11444 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11445 && COMPOSITION_VALID_P (start
, end
, prop
)
11446 && start
< prev_pt
&& end
> prev_pt
)
11447 /* The last point was within the composition. Return 1 iff
11448 point moved out of the composition. */
11449 return (pt
<= start
|| pt
>= end
);
11452 /* Check a composition at the current point. */
11453 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11454 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11455 && COMPOSITION_VALID_P (start
, end
, prop
)
11456 && start
< pt
&& end
> pt
);
11460 /* Reconsider the setting of B->clip_changed which is displayed
11464 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11466 if (b
->clip_changed
11467 && !NILP (w
->window_end_valid
)
11468 && w
->current_matrix
->buffer
== b
11469 && w
->current_matrix
->zv
== BUF_ZV (b
)
11470 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11471 b
->clip_changed
= 0;
11473 /* If display wasn't paused, and W is not a tool bar window, see if
11474 point has been moved into or out of a composition. In that case,
11475 we set b->clip_changed to 1 to force updating the screen. If
11476 b->clip_changed has already been set to 1, we can skip this
11478 if (!b
->clip_changed
11479 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11483 if (w
== XWINDOW (selected_window
))
11484 pt
= BUF_PT (current_buffer
);
11486 pt
= marker_position (w
->pointm
);
11488 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11489 || pt
!= XINT (w
->last_point
))
11490 && check_point_in_composition (w
->current_matrix
->buffer
,
11491 XINT (w
->last_point
),
11492 XBUFFER (w
->buffer
), pt
))
11493 b
->clip_changed
= 1;
11498 /* Select FRAME to forward the values of frame-local variables into C
11499 variables so that the redisplay routines can access those values
11503 select_frame_for_redisplay (Lisp_Object frame
)
11505 Lisp_Object tail
, tem
;
11506 Lisp_Object old
= selected_frame
;
11507 struct Lisp_Symbol
*sym
;
11509 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11511 selected_frame
= frame
;
11514 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11515 if (CONSP (XCAR (tail
))
11516 && (tem
= XCAR (XCAR (tail
)),
11518 && (sym
= indirect_variable (XSYMBOL (tem
)),
11519 sym
->redirect
== SYMBOL_LOCALIZED
)
11520 && sym
->val
.blv
->frame_local
)
11521 /* Use find_symbol_value rather than Fsymbol_value
11522 to avoid an error if it is void. */
11523 find_symbol_value (tem
);
11524 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11528 #define STOP_POLLING \
11529 do { if (! polling_stopped_here) stop_polling (); \
11530 polling_stopped_here = 1; } while (0)
11532 #define RESUME_POLLING \
11533 do { if (polling_stopped_here) start_polling (); \
11534 polling_stopped_here = 0; } while (0)
11537 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11538 response to any user action; therefore, we should preserve the echo
11539 area. (Actually, our caller does that job.) Perhaps in the future
11540 avoid recentering windows if it is not necessary; currently that
11541 causes some problems. */
11544 redisplay_internal (int preserve_echo_area
)
11546 struct window
*w
= XWINDOW (selected_window
);
11549 int must_finish
= 0;
11550 struct text_pos tlbufpos
, tlendpos
;
11551 int number_of_visible_frames
;
11554 int polling_stopped_here
= 0;
11555 Lisp_Object old_frame
= selected_frame
;
11557 /* Non-zero means redisplay has to consider all windows on all
11558 frames. Zero means, only selected_window is considered. */
11559 int consider_all_windows_p
;
11561 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11563 /* No redisplay if running in batch mode or frame is not yet fully
11564 initialized, or redisplay is explicitly turned off by setting
11565 Vinhibit_redisplay. */
11566 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11567 || !NILP (Vinhibit_redisplay
))
11570 /* Don't examine these until after testing Vinhibit_redisplay.
11571 When Emacs is shutting down, perhaps because its connection to
11572 X has dropped, we should not look at them at all. */
11573 f
= XFRAME (w
->frame
);
11574 sf
= SELECTED_FRAME ();
11576 if (!f
->glyphs_initialized_p
)
11579 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11580 if (popup_activated ())
11584 /* I don't think this happens but let's be paranoid. */
11585 if (redisplaying_p
)
11588 /* Record a function that resets redisplaying_p to its old value
11589 when we leave this function. */
11590 count
= SPECPDL_INDEX ();
11591 record_unwind_protect (unwind_redisplay
,
11592 Fcons (make_number (redisplaying_p
), selected_frame
));
11594 specbind (Qinhibit_free_realized_faces
, Qnil
);
11597 Lisp_Object tail
, frame
;
11599 FOR_EACH_FRAME (tail
, frame
)
11601 struct frame
*f
= XFRAME (frame
);
11602 f
->already_hscrolled_p
= 0;
11607 if (!EQ (old_frame
, selected_frame
)
11608 && FRAME_LIVE_P (XFRAME (old_frame
)))
11609 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11610 selected_frame and selected_window to be temporarily out-of-sync so
11611 when we come back here via `goto retry', we need to resync because we
11612 may need to run Elisp code (via prepare_menu_bars). */
11613 select_frame_for_redisplay (old_frame
);
11616 reconsider_clip_changes (w
, current_buffer
);
11617 last_escape_glyph_frame
= NULL
;
11618 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11620 /* If new fonts have been loaded that make a glyph matrix adjustment
11621 necessary, do it. */
11622 if (fonts_changed_p
)
11624 adjust_glyphs (NULL
);
11625 ++windows_or_buffers_changed
;
11626 fonts_changed_p
= 0;
11629 /* If face_change_count is non-zero, init_iterator will free all
11630 realized faces, which includes the faces referenced from current
11631 matrices. So, we can't reuse current matrices in this case. */
11632 if (face_change_count
)
11633 ++windows_or_buffers_changed
;
11635 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11636 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11638 /* Since frames on a single ASCII terminal share the same
11639 display area, displaying a different frame means redisplay
11640 the whole thing. */
11641 windows_or_buffers_changed
++;
11642 SET_FRAME_GARBAGED (sf
);
11644 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11646 FRAME_TTY (sf
)->previous_frame
= sf
;
11649 /* Set the visible flags for all frames. Do this before checking
11650 for resized or garbaged frames; they want to know if their frames
11651 are visible. See the comment in frame.h for
11652 FRAME_SAMPLE_VISIBILITY. */
11654 Lisp_Object tail
, frame
;
11656 number_of_visible_frames
= 0;
11658 FOR_EACH_FRAME (tail
, frame
)
11660 struct frame
*f
= XFRAME (frame
);
11662 FRAME_SAMPLE_VISIBILITY (f
);
11663 if (FRAME_VISIBLE_P (f
))
11664 ++number_of_visible_frames
;
11665 clear_desired_matrices (f
);
11669 /* Notice any pending interrupt request to change frame size. */
11670 do_pending_window_change (1);
11672 /* Clear frames marked as garbaged. */
11673 if (frame_garbaged
)
11674 clear_garbaged_frames ();
11676 /* Build menubar and tool-bar items. */
11677 if (NILP (Vmemory_full
))
11678 prepare_menu_bars ();
11680 if (windows_or_buffers_changed
)
11681 update_mode_lines
++;
11683 /* Detect case that we need to write or remove a star in the mode line. */
11684 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11686 w
->update_mode_line
= Qt
;
11687 if (buffer_shared
> 1)
11688 update_mode_lines
++;
11691 /* Avoid invocation of point motion hooks by `current_column' below. */
11692 count1
= SPECPDL_INDEX ();
11693 specbind (Qinhibit_point_motion_hooks
, Qt
);
11695 /* If %c is in the mode line, update it if needed. */
11696 if (!NILP (w
->column_number_displayed
)
11697 /* This alternative quickly identifies a common case
11698 where no change is needed. */
11699 && !(PT
== XFASTINT (w
->last_point
)
11700 && XFASTINT (w
->last_modified
) >= MODIFF
11701 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11702 && (XFASTINT (w
->column_number_displayed
)
11703 != (int) current_column ())) /* iftc */
11704 w
->update_mode_line
= Qt
;
11706 unbind_to (count1
, Qnil
);
11708 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11710 /* The variable buffer_shared is set in redisplay_window and
11711 indicates that we redisplay a buffer in different windows. See
11713 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11714 || cursor_type_changed
);
11716 /* If specs for an arrow have changed, do thorough redisplay
11717 to ensure we remove any arrow that should no longer exist. */
11718 if (overlay_arrows_changed_p ())
11719 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11721 /* Normally the message* functions will have already displayed and
11722 updated the echo area, but the frame may have been trashed, or
11723 the update may have been preempted, so display the echo area
11724 again here. Checking message_cleared_p captures the case that
11725 the echo area should be cleared. */
11726 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11727 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11728 || (message_cleared_p
11729 && minibuf_level
== 0
11730 /* If the mini-window is currently selected, this means the
11731 echo-area doesn't show through. */
11732 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11734 int window_height_changed_p
= echo_area_display (0);
11737 /* If we don't display the current message, don't clear the
11738 message_cleared_p flag, because, if we did, we wouldn't clear
11739 the echo area in the next redisplay which doesn't preserve
11741 if (!display_last_displayed_message_p
)
11742 message_cleared_p
= 0;
11744 if (fonts_changed_p
)
11746 else if (window_height_changed_p
)
11748 consider_all_windows_p
= 1;
11749 ++update_mode_lines
;
11750 ++windows_or_buffers_changed
;
11752 /* If window configuration was changed, frames may have been
11753 marked garbaged. Clear them or we will experience
11754 surprises wrt scrolling. */
11755 if (frame_garbaged
)
11756 clear_garbaged_frames ();
11759 else if (EQ (selected_window
, minibuf_window
)
11760 && (current_buffer
->clip_changed
11761 || XFASTINT (w
->last_modified
) < MODIFF
11762 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11763 && resize_mini_window (w
, 0))
11765 /* Resized active mini-window to fit the size of what it is
11766 showing if its contents might have changed. */
11768 /* FIXME: this causes all frames to be updated, which seems unnecessary
11769 since only the current frame needs to be considered. This function needs
11770 to be rewritten with two variables, consider_all_windows and
11771 consider_all_frames. */
11772 consider_all_windows_p
= 1;
11773 ++windows_or_buffers_changed
;
11774 ++update_mode_lines
;
11776 /* If window configuration was changed, frames may have been
11777 marked garbaged. Clear them or we will experience
11778 surprises wrt scrolling. */
11779 if (frame_garbaged
)
11780 clear_garbaged_frames ();
11784 /* If showing the region, and mark has changed, we must redisplay
11785 the whole window. The assignment to this_line_start_pos prevents
11786 the optimization directly below this if-statement. */
11787 if (((!NILP (Vtransient_mark_mode
)
11788 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11789 != !NILP (w
->region_showing
))
11790 || (!NILP (w
->region_showing
)
11791 && !EQ (w
->region_showing
,
11792 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11793 CHARPOS (this_line_start_pos
) = 0;
11795 /* Optimize the case that only the line containing the cursor in the
11796 selected window has changed. Variables starting with this_ are
11797 set in display_line and record information about the line
11798 containing the cursor. */
11799 tlbufpos
= this_line_start_pos
;
11800 tlendpos
= this_line_end_pos
;
11801 if (!consider_all_windows_p
11802 && CHARPOS (tlbufpos
) > 0
11803 && NILP (w
->update_mode_line
)
11804 && !current_buffer
->clip_changed
11805 && !current_buffer
->prevent_redisplay_optimizations_p
11806 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11807 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11808 /* Make sure recorded data applies to current buffer, etc. */
11809 && this_line_buffer
== current_buffer
11810 && current_buffer
== XBUFFER (w
->buffer
)
11811 && NILP (w
->force_start
)
11812 && NILP (w
->optional_new_start
)
11813 /* Point must be on the line that we have info recorded about. */
11814 && PT
>= CHARPOS (tlbufpos
)
11815 && PT
<= Z
- CHARPOS (tlendpos
)
11816 /* All text outside that line, including its final newline,
11817 must be unchanged. */
11818 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11819 CHARPOS (tlendpos
)))
11821 if (CHARPOS (tlbufpos
) > BEGV
11822 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11823 && (CHARPOS (tlbufpos
) == ZV
11824 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11825 /* Former continuation line has disappeared by becoming empty. */
11827 else if (XFASTINT (w
->last_modified
) < MODIFF
11828 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11829 || MINI_WINDOW_P (w
))
11831 /* We have to handle the case of continuation around a
11832 wide-column character (see the comment in indent.c around
11835 For instance, in the following case:
11837 -------- Insert --------
11838 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11839 J_I_ ==> J_I_ `^^' are cursors.
11843 As we have to redraw the line above, we cannot use this
11847 int line_height_before
= this_line_pixel_height
;
11849 /* Note that start_display will handle the case that the
11850 line starting at tlbufpos is a continuation line. */
11851 start_display (&it
, w
, tlbufpos
);
11853 /* Implementation note: It this still necessary? */
11854 if (it
.current_x
!= this_line_start_x
)
11857 TRACE ((stderr
, "trying display optimization 1\n"));
11858 w
->cursor
.vpos
= -1;
11859 overlay_arrow_seen
= 0;
11860 it
.vpos
= this_line_vpos
;
11861 it
.current_y
= this_line_y
;
11862 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11863 display_line (&it
);
11865 /* If line contains point, is not continued,
11866 and ends at same distance from eob as before, we win. */
11867 if (w
->cursor
.vpos
>= 0
11868 /* Line is not continued, otherwise this_line_start_pos
11869 would have been set to 0 in display_line. */
11870 && CHARPOS (this_line_start_pos
)
11871 /* Line ends as before. */
11872 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11873 /* Line has same height as before. Otherwise other lines
11874 would have to be shifted up or down. */
11875 && this_line_pixel_height
== line_height_before
)
11877 /* If this is not the window's last line, we must adjust
11878 the charstarts of the lines below. */
11879 if (it
.current_y
< it
.last_visible_y
)
11881 struct glyph_row
*row
11882 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11883 int delta
, delta_bytes
;
11885 /* We used to distinguish between two cases here,
11886 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11887 when the line ends in a newline or the end of the
11888 buffer's accessible portion. But both cases did
11889 the same, so they were collapsed. */
11891 - CHARPOS (tlendpos
)
11892 - MATRIX_ROW_START_CHARPOS (row
));
11893 delta_bytes
= (Z_BYTE
11894 - BYTEPOS (tlendpos
)
11895 - MATRIX_ROW_START_BYTEPOS (row
));
11897 increment_matrix_positions (w
->current_matrix
,
11898 this_line_vpos
+ 1,
11899 w
->current_matrix
->nrows
,
11900 delta
, delta_bytes
);
11903 /* If this row displays text now but previously didn't,
11904 or vice versa, w->window_end_vpos may have to be
11906 if ((it
.glyph_row
- 1)->displays_text_p
)
11908 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11909 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11911 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11912 && this_line_vpos
> 0)
11913 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11914 w
->window_end_valid
= Qnil
;
11916 /* Update hint: No need to try to scroll in update_window. */
11917 w
->desired_matrix
->no_scrolling_p
= 1;
11920 *w
->desired_matrix
->method
= 0;
11921 debug_method_add (w
, "optimization 1");
11923 #ifdef HAVE_WINDOW_SYSTEM
11924 update_window_fringes (w
, 0);
11931 else if (/* Cursor position hasn't changed. */
11932 PT
== XFASTINT (w
->last_point
)
11933 /* Make sure the cursor was last displayed
11934 in this window. Otherwise we have to reposition it. */
11935 && 0 <= w
->cursor
.vpos
11936 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11940 do_pending_window_change (1);
11942 /* We used to always goto end_of_redisplay here, but this
11943 isn't enough if we have a blinking cursor. */
11944 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11945 goto end_of_redisplay
;
11949 /* If highlighting the region, or if the cursor is in the echo area,
11950 then we can't just move the cursor. */
11951 else if (! (!NILP (Vtransient_mark_mode
)
11952 && !NILP (current_buffer
->mark_active
))
11953 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11954 || highlight_nonselected_windows
)
11955 && NILP (w
->region_showing
)
11956 && NILP (Vshow_trailing_whitespace
)
11957 && !cursor_in_echo_area
)
11960 struct glyph_row
*row
;
11962 /* Skip from tlbufpos to PT and see where it is. Note that
11963 PT may be in invisible text. If so, we will end at the
11964 next visible position. */
11965 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11966 NULL
, DEFAULT_FACE_ID
);
11967 it
.current_x
= this_line_start_x
;
11968 it
.current_y
= this_line_y
;
11969 it
.vpos
= this_line_vpos
;
11971 /* The call to move_it_to stops in front of PT, but
11972 moves over before-strings. */
11973 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11975 if (it
.vpos
== this_line_vpos
11976 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11979 xassert (this_line_vpos
== it
.vpos
);
11980 xassert (this_line_y
== it
.current_y
);
11981 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11983 *w
->desired_matrix
->method
= 0;
11984 debug_method_add (w
, "optimization 3");
11993 /* Text changed drastically or point moved off of line. */
11994 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11997 CHARPOS (this_line_start_pos
) = 0;
11998 consider_all_windows_p
|= buffer_shared
> 1;
11999 ++clear_face_cache_count
;
12000 #ifdef HAVE_WINDOW_SYSTEM
12001 ++clear_image_cache_count
;
12004 /* Build desired matrices, and update the display. If
12005 consider_all_windows_p is non-zero, do it for all windows on all
12006 frames. Otherwise do it for selected_window, only. */
12008 if (consider_all_windows_p
)
12010 Lisp_Object tail
, frame
;
12012 FOR_EACH_FRAME (tail
, frame
)
12013 XFRAME (frame
)->updated_p
= 0;
12015 /* Recompute # windows showing selected buffer. This will be
12016 incremented each time such a window is displayed. */
12019 FOR_EACH_FRAME (tail
, frame
)
12021 struct frame
*f
= XFRAME (frame
);
12023 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12025 if (! EQ (frame
, selected_frame
))
12026 /* Select the frame, for the sake of frame-local
12028 select_frame_for_redisplay (frame
);
12030 /* Mark all the scroll bars to be removed; we'll redeem
12031 the ones we want when we redisplay their windows. */
12032 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12033 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12035 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12036 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12038 /* The X error handler may have deleted that frame. */
12039 if (!FRAME_LIVE_P (f
))
12042 /* Any scroll bars which redisplay_windows should have
12043 nuked should now go away. */
12044 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12045 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12047 /* If fonts changed, display again. */
12048 /* ??? rms: I suspect it is a mistake to jump all the way
12049 back to retry here. It should just retry this frame. */
12050 if (fonts_changed_p
)
12053 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12055 /* See if we have to hscroll. */
12056 if (!f
->already_hscrolled_p
)
12058 f
->already_hscrolled_p
= 1;
12059 if (hscroll_windows (f
->root_window
))
12063 /* Prevent various kinds of signals during display
12064 update. stdio is not robust about handling
12065 signals, which can cause an apparent I/O
12067 if (interrupt_input
)
12068 unrequest_sigio ();
12071 /* Update the display. */
12072 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12073 pause
|= update_frame (f
, 0, 0);
12079 if (!EQ (old_frame
, selected_frame
)
12080 && FRAME_LIVE_P (XFRAME (old_frame
)))
12081 /* We played a bit fast-and-loose above and allowed selected_frame
12082 and selected_window to be temporarily out-of-sync but let's make
12083 sure this stays contained. */
12084 select_frame_for_redisplay (old_frame
);
12085 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12089 /* Do the mark_window_display_accurate after all windows have
12090 been redisplayed because this call resets flags in buffers
12091 which are needed for proper redisplay. */
12092 FOR_EACH_FRAME (tail
, frame
)
12094 struct frame
*f
= XFRAME (frame
);
12097 mark_window_display_accurate (f
->root_window
, 1);
12098 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12099 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12104 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12106 Lisp_Object mini_window
;
12107 struct frame
*mini_frame
;
12109 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12110 /* Use list_of_error, not Qerror, so that
12111 we catch only errors and don't run the debugger. */
12112 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12114 redisplay_window_error
);
12116 /* Compare desired and current matrices, perform output. */
12119 /* If fonts changed, display again. */
12120 if (fonts_changed_p
)
12123 /* Prevent various kinds of signals during display update.
12124 stdio is not robust about handling signals,
12125 which can cause an apparent I/O error. */
12126 if (interrupt_input
)
12127 unrequest_sigio ();
12130 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12132 if (hscroll_windows (selected_window
))
12135 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12136 pause
= update_frame (sf
, 0, 0);
12139 /* We may have called echo_area_display at the top of this
12140 function. If the echo area is on another frame, that may
12141 have put text on a frame other than the selected one, so the
12142 above call to update_frame would not have caught it. Catch
12144 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12145 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12147 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12149 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12150 pause
|= update_frame (mini_frame
, 0, 0);
12151 if (!pause
&& hscroll_windows (mini_window
))
12156 /* If display was paused because of pending input, make sure we do a
12157 thorough update the next time. */
12160 /* Prevent the optimization at the beginning of
12161 redisplay_internal that tries a single-line update of the
12162 line containing the cursor in the selected window. */
12163 CHARPOS (this_line_start_pos
) = 0;
12165 /* Let the overlay arrow be updated the next time. */
12166 update_overlay_arrows (0);
12168 /* If we pause after scrolling, some rows in the current
12169 matrices of some windows are not valid. */
12170 if (!WINDOW_FULL_WIDTH_P (w
)
12171 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12172 update_mode_lines
= 1;
12176 if (!consider_all_windows_p
)
12178 /* This has already been done above if
12179 consider_all_windows_p is set. */
12180 mark_window_display_accurate_1 (w
, 1);
12182 /* Say overlay arrows are up to date. */
12183 update_overlay_arrows (1);
12185 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12186 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12189 update_mode_lines
= 0;
12190 windows_or_buffers_changed
= 0;
12191 cursor_type_changed
= 0;
12194 /* Start SIGIO interrupts coming again. Having them off during the
12195 code above makes it less likely one will discard output, but not
12196 impossible, since there might be stuff in the system buffer here.
12197 But it is much hairier to try to do anything about that. */
12198 if (interrupt_input
)
12202 /* If a frame has become visible which was not before, redisplay
12203 again, so that we display it. Expose events for such a frame
12204 (which it gets when becoming visible) don't call the parts of
12205 redisplay constructing glyphs, so simply exposing a frame won't
12206 display anything in this case. So, we have to display these
12207 frames here explicitly. */
12210 Lisp_Object tail
, frame
;
12213 FOR_EACH_FRAME (tail
, frame
)
12215 int this_is_visible
= 0;
12217 if (XFRAME (frame
)->visible
)
12218 this_is_visible
= 1;
12219 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12220 if (XFRAME (frame
)->visible
)
12221 this_is_visible
= 1;
12223 if (this_is_visible
)
12227 if (new_count
!= number_of_visible_frames
)
12228 windows_or_buffers_changed
++;
12231 /* Change frame size now if a change is pending. */
12232 do_pending_window_change (1);
12234 /* If we just did a pending size change, or have additional
12235 visible frames, redisplay again. */
12236 if (windows_or_buffers_changed
&& !pause
)
12239 /* Clear the face and image caches.
12241 We used to do this only if consider_all_windows_p. But the cache
12242 needs to be cleared if a timer creates images in the current
12243 buffer (e.g. the test case in Bug#6230). */
12245 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12247 clear_face_cache (0);
12248 clear_face_cache_count
= 0;
12251 #ifdef HAVE_WINDOW_SYSTEM
12252 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12254 clear_image_caches (Qnil
);
12255 clear_image_cache_count
= 0;
12257 #endif /* HAVE_WINDOW_SYSTEM */
12260 unbind_to (count
, Qnil
);
12265 /* Redisplay, but leave alone any recent echo area message unless
12266 another message has been requested in its place.
12268 This is useful in situations where you need to redisplay but no
12269 user action has occurred, making it inappropriate for the message
12270 area to be cleared. See tracking_off and
12271 wait_reading_process_output for examples of these situations.
12273 FROM_WHERE is an integer saying from where this function was
12274 called. This is useful for debugging. */
12277 redisplay_preserve_echo_area (int from_where
)
12279 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12281 if (!NILP (echo_area_buffer
[1]))
12283 /* We have a previously displayed message, but no current
12284 message. Redisplay the previous message. */
12285 display_last_displayed_message_p
= 1;
12286 redisplay_internal (1);
12287 display_last_displayed_message_p
= 0;
12290 redisplay_internal (1);
12292 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12293 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12294 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12298 /* Function registered with record_unwind_protect in
12299 redisplay_internal. Reset redisplaying_p to the value it had
12300 before redisplay_internal was called, and clear
12301 prevent_freeing_realized_faces_p. It also selects the previously
12302 selected frame, unless it has been deleted (by an X connection
12303 failure during redisplay, for example). */
12306 unwind_redisplay (Lisp_Object val
)
12308 Lisp_Object old_redisplaying_p
, old_frame
;
12310 old_redisplaying_p
= XCAR (val
);
12311 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12312 old_frame
= XCDR (val
);
12313 if (! EQ (old_frame
, selected_frame
)
12314 && FRAME_LIVE_P (XFRAME (old_frame
)))
12315 select_frame_for_redisplay (old_frame
);
12320 /* Mark the display of window W as accurate or inaccurate. If
12321 ACCURATE_P is non-zero mark display of W as accurate. If
12322 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12323 redisplay_internal is called. */
12326 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12328 if (BUFFERP (w
->buffer
))
12330 struct buffer
*b
= XBUFFER (w
->buffer
);
12333 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12334 w
->last_overlay_modified
12335 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12337 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12341 b
->clip_changed
= 0;
12342 b
->prevent_redisplay_optimizations_p
= 0;
12344 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12345 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12346 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12347 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12349 w
->current_matrix
->buffer
= b
;
12350 w
->current_matrix
->begv
= BUF_BEGV (b
);
12351 w
->current_matrix
->zv
= BUF_ZV (b
);
12353 w
->last_cursor
= w
->cursor
;
12354 w
->last_cursor_off_p
= w
->cursor_off_p
;
12356 if (w
== XWINDOW (selected_window
))
12357 w
->last_point
= make_number (BUF_PT (b
));
12359 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12365 w
->window_end_valid
= w
->buffer
;
12366 w
->update_mode_line
= Qnil
;
12371 /* Mark the display of windows in the window tree rooted at WINDOW as
12372 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12373 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12374 be redisplayed the next time redisplay_internal is called. */
12377 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12381 for (; !NILP (window
); window
= w
->next
)
12383 w
= XWINDOW (window
);
12384 mark_window_display_accurate_1 (w
, accurate_p
);
12386 if (!NILP (w
->vchild
))
12387 mark_window_display_accurate (w
->vchild
, accurate_p
);
12388 if (!NILP (w
->hchild
))
12389 mark_window_display_accurate (w
->hchild
, accurate_p
);
12394 update_overlay_arrows (1);
12398 /* Force a thorough redisplay the next time by setting
12399 last_arrow_position and last_arrow_string to t, which is
12400 unequal to any useful value of Voverlay_arrow_... */
12401 update_overlay_arrows (-1);
12406 /* Return value in display table DP (Lisp_Char_Table *) for character
12407 C. Since a display table doesn't have any parent, we don't have to
12408 follow parent. Do not call this function directly but use the
12409 macro DISP_CHAR_VECTOR. */
12412 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12416 if (ASCII_CHAR_P (c
))
12419 if (SUB_CHAR_TABLE_P (val
))
12420 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12426 XSETCHAR_TABLE (table
, dp
);
12427 val
= char_table_ref (table
, c
);
12436 /***********************************************************************
12438 ***********************************************************************/
12440 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12443 redisplay_windows (Lisp_Object window
)
12445 while (!NILP (window
))
12447 struct window
*w
= XWINDOW (window
);
12449 if (!NILP (w
->hchild
))
12450 redisplay_windows (w
->hchild
);
12451 else if (!NILP (w
->vchild
))
12452 redisplay_windows (w
->vchild
);
12453 else if (!NILP (w
->buffer
))
12455 displayed_buffer
= XBUFFER (w
->buffer
);
12456 /* Use list_of_error, not Qerror, so that
12457 we catch only errors and don't run the debugger. */
12458 internal_condition_case_1 (redisplay_window_0
, window
,
12460 redisplay_window_error
);
12468 redisplay_window_error (Lisp_Object ignore
)
12470 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12475 redisplay_window_0 (Lisp_Object window
)
12477 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12478 redisplay_window (window
, 0);
12483 redisplay_window_1 (Lisp_Object window
)
12485 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12486 redisplay_window (window
, 1);
12491 /* Increment GLYPH until it reaches END or CONDITION fails while
12492 adding (GLYPH)->pixel_width to X. */
12494 #define SKIP_GLYPHS(glyph, end, x, condition) \
12497 (x) += (glyph)->pixel_width; \
12500 while ((glyph) < (end) && (condition))
12503 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12504 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12505 which positions recorded in ROW differ from current buffer
12508 Return 0 if cursor is not on this row, 1 otherwise. */
12511 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12512 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12515 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12516 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12517 struct glyph
*cursor
= NULL
;
12518 /* The last known character position in row. */
12519 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12521 EMACS_INT pt_old
= PT
- delta
;
12522 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12523 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12524 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12525 /* A glyph beyond the edge of TEXT_AREA which we should never
12527 struct glyph
*glyphs_end
= end
;
12528 /* Non-zero means we've found a match for cursor position, but that
12529 glyph has the avoid_cursor_p flag set. */
12530 int match_with_avoid_cursor
= 0;
12531 /* Non-zero means we've seen at least one glyph that came from a
12533 int string_seen
= 0;
12534 /* Largest buffer position seen so far during scan of glyph row. */
12535 EMACS_INT bpos_max
= last_pos
;
12536 /* Last buffer position covered by an overlay string with an integer
12537 `cursor' property. */
12538 EMACS_INT bpos_covered
= 0;
12540 /* Skip over glyphs not having an object at the start and the end of
12541 the row. These are special glyphs like truncation marks on
12542 terminal frames. */
12543 if (row
->displays_text_p
)
12545 if (!row
->reversed_p
)
12548 && INTEGERP (glyph
->object
)
12549 && glyph
->charpos
< 0)
12551 x
+= glyph
->pixel_width
;
12555 && INTEGERP ((end
- 1)->object
)
12556 /* CHARPOS is zero for blanks and stretch glyphs
12557 inserted by extend_face_to_end_of_line. */
12558 && (end
- 1)->charpos
<= 0)
12560 glyph_before
= glyph
- 1;
12567 /* If the glyph row is reversed, we need to process it from back
12568 to front, so swap the edge pointers. */
12569 glyphs_end
= end
= glyph
- 1;
12570 glyph
+= row
->used
[TEXT_AREA
] - 1;
12572 while (glyph
> end
+ 1
12573 && INTEGERP (glyph
->object
)
12574 && glyph
->charpos
< 0)
12577 x
-= glyph
->pixel_width
;
12579 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12581 /* By default, in reversed rows we put the cursor on the
12582 rightmost (first in the reading order) glyph. */
12583 for (g
= end
+ 1; g
< glyph
; g
++)
12584 x
+= g
->pixel_width
;
12586 && INTEGERP ((end
+ 1)->object
)
12587 && (end
+ 1)->charpos
<= 0)
12589 glyph_before
= glyph
+ 1;
12593 else if (row
->reversed_p
)
12595 /* In R2L rows that don't display text, put the cursor on the
12596 rightmost glyph. Case in point: an empty last line that is
12597 part of an R2L paragraph. */
12599 /* Avoid placing the cursor on the last glyph of the row, where
12600 on terminal frames we hold the vertical border between
12601 adjacent windows. */
12602 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12603 && !WINDOW_RIGHTMOST_P (w
)
12604 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12606 x
= -1; /* will be computed below, at label compute_x */
12609 /* Step 1: Try to find the glyph whose character position
12610 corresponds to point. If that's not possible, find 2 glyphs
12611 whose character positions are the closest to point, one before
12612 point, the other after it. */
12613 if (!row
->reversed_p
)
12614 while (/* not marched to end of glyph row */
12616 /* glyph was not inserted by redisplay for internal purposes */
12617 && !INTEGERP (glyph
->object
))
12619 if (BUFFERP (glyph
->object
))
12621 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12623 if (glyph
->charpos
> bpos_max
)
12624 bpos_max
= glyph
->charpos
;
12625 if (!glyph
->avoid_cursor_p
)
12627 /* If we hit point, we've found the glyph on which to
12628 display the cursor. */
12631 match_with_avoid_cursor
= 0;
12634 /* See if we've found a better approximation to
12635 POS_BEFORE or to POS_AFTER. Note that we want the
12636 first (leftmost) glyph of all those that are the
12637 closest from below, and the last (rightmost) of all
12638 those from above. */
12639 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12641 pos_before
= glyph
->charpos
;
12642 glyph_before
= glyph
;
12644 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12646 pos_after
= glyph
->charpos
;
12647 glyph_after
= glyph
;
12650 else if (dpos
== 0)
12651 match_with_avoid_cursor
= 1;
12653 else if (STRINGP (glyph
->object
))
12655 Lisp_Object chprop
;
12656 int glyph_pos
= glyph
->charpos
;
12658 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12660 if (INTEGERP (chprop
))
12662 bpos_covered
= bpos_max
+ XINT (chprop
);
12663 /* If the `cursor' property covers buffer positions up
12664 to and including point, we should display cursor on
12665 this glyph. Note that overlays and text properties
12666 with string values stop bidi reordering, so every
12667 buffer position to the left of the string is always
12668 smaller than any position to the right of the
12669 string. Therefore, if a `cursor' property on one
12670 of the string's characters has an integer value, we
12671 will break out of the loop below _before_ we get to
12672 the position match above. IOW, integer values of
12673 the `cursor' property override the "exact match for
12674 point" strategy of positioning the cursor. */
12675 /* Implementation note: bpos_max == pt_old when, e.g.,
12676 we are in an empty line, where bpos_max is set to
12677 MATRIX_ROW_START_CHARPOS, see above. */
12678 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12687 x
+= glyph
->pixel_width
;
12690 else if (glyph
> end
) /* row is reversed */
12691 while (!INTEGERP (glyph
->object
))
12693 if (BUFFERP (glyph
->object
))
12695 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12697 if (glyph
->charpos
> bpos_max
)
12698 bpos_max
= glyph
->charpos
;
12699 if (!glyph
->avoid_cursor_p
)
12703 match_with_avoid_cursor
= 0;
12706 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12708 pos_before
= glyph
->charpos
;
12709 glyph_before
= glyph
;
12711 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12713 pos_after
= glyph
->charpos
;
12714 glyph_after
= glyph
;
12717 else if (dpos
== 0)
12718 match_with_avoid_cursor
= 1;
12720 else if (STRINGP (glyph
->object
))
12722 Lisp_Object chprop
;
12723 int glyph_pos
= glyph
->charpos
;
12725 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12727 if (INTEGERP (chprop
))
12729 bpos_covered
= bpos_max
+ XINT (chprop
);
12730 /* If the `cursor' property covers buffer positions up
12731 to and including point, we should display cursor on
12733 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12742 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12744 x
--; /* can't use any pixel_width */
12747 x
-= glyph
->pixel_width
;
12750 /* Step 2: If we didn't find an exact match for point, we need to
12751 look for a proper place to put the cursor among glyphs between
12752 GLYPH_BEFORE and GLYPH_AFTER. */
12753 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12754 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12755 && bpos_covered
< pt_old
)
12757 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12759 EMACS_INT ellipsis_pos
;
12761 /* Scan back over the ellipsis glyphs. */
12762 if (!row
->reversed_p
)
12764 ellipsis_pos
= (glyph
- 1)->charpos
;
12765 while (glyph
> row
->glyphs
[TEXT_AREA
]
12766 && (glyph
- 1)->charpos
== ellipsis_pos
)
12767 glyph
--, x
-= glyph
->pixel_width
;
12768 /* That loop always goes one position too far, including
12769 the glyph before the ellipsis. So scan forward over
12771 x
+= glyph
->pixel_width
;
12774 else /* row is reversed */
12776 ellipsis_pos
= (glyph
+ 1)->charpos
;
12777 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12778 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12779 glyph
++, x
+= glyph
->pixel_width
;
12780 x
-= glyph
->pixel_width
;
12784 else if (match_with_avoid_cursor
12785 /* zero-width characters produce no glyphs */
12786 || ((row
->reversed_p
12787 ? glyph_after
> glyphs_end
12788 : glyph_after
< glyphs_end
)
12789 && eabs (glyph_after
- glyph_before
) == 1))
12791 cursor
= glyph_after
;
12794 else if (string_seen
)
12796 int incr
= row
->reversed_p
? -1 : +1;
12798 /* Need to find the glyph that came out of a string which is
12799 present at point. That glyph is somewhere between
12800 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12801 positioned between POS_BEFORE and POS_AFTER in the
12803 struct glyph
*stop
= glyph_after
;
12804 EMACS_INT pos
= pos_before
;
12807 for (glyph
= glyph_before
+ incr
;
12808 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12811 /* Any glyphs that come from the buffer are here because
12812 of bidi reordering. Skip them, and only pay
12813 attention to glyphs that came from some string. */
12814 if (STRINGP (glyph
->object
))
12819 str
= glyph
->object
;
12820 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12821 if (tem
== 0 /* from overlay */
12824 /* If the string from which this glyph came is
12825 found in the buffer at point, then we've
12826 found the glyph we've been looking for. If
12827 it comes from an overlay (tem == 0), and it
12828 has the `cursor' property on one of its
12829 glyphs, record that glyph as a candidate for
12830 displaying the cursor. (As in the
12831 unidirectional version, we will display the
12832 cursor on the last candidate we find.) */
12833 if (tem
== 0 || tem
== pt_old
)
12835 /* The glyphs from this string could have
12836 been reordered. Find the one with the
12837 smallest string position. Or there could
12838 be a character in the string with the
12839 `cursor' property, which means display
12840 cursor on that character's glyph. */
12841 int strpos
= glyph
->charpos
;
12844 for (glyph
+= incr
;
12845 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12846 && EQ (glyph
->object
, str
);
12850 int gpos
= glyph
->charpos
;
12852 cprop
= Fget_char_property (make_number (gpos
),
12860 if (glyph
->charpos
< strpos
)
12862 strpos
= glyph
->charpos
;
12871 pos
= tem
+ 1; /* don't find previous instances */
12873 /* This string is not what we want; skip all of the
12874 glyphs that came from it. */
12877 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12878 && EQ (glyph
->object
, str
));
12884 /* If we reached the end of the line, and END was from a string,
12885 the cursor is not on this line. */
12887 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12888 && STRINGP (end
->object
)
12889 && row
->continued_p
)
12895 if (cursor
!= NULL
)
12901 /* Need to compute x that corresponds to GLYPH. */
12902 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12904 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12906 x
+= g
->pixel_width
;
12910 /* ROW could be part of a continued line, which, under bidi
12911 reordering, might have other rows whose start and end charpos
12912 occlude point. Only set w->cursor if we found a better
12913 approximation to the cursor position than we have from previously
12914 examined candidate rows belonging to the same continued line. */
12915 if (/* we already have a candidate row */
12916 w
->cursor
.vpos
>= 0
12917 /* that candidate is not the row we are processing */
12918 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12919 /* the row we are processing is part of a continued line */
12920 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12921 /* Make sure cursor.vpos specifies a row whose start and end
12922 charpos occlude point. This is because some callers of this
12923 function leave cursor.vpos at the row where the cursor was
12924 displayed during the last redisplay cycle. */
12925 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12926 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12929 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12931 /* Don't consider glyphs that are outside TEXT_AREA. */
12932 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12934 /* Keep the candidate whose buffer position is the closest to
12936 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12937 w
->cursor
.hpos
>= 0
12938 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12939 && BUFFERP (g1
->object
)
12940 && (g1
->charpos
== pt_old
/* an exact match always wins */
12941 || (BUFFERP (glyph
->object
)
12942 && eabs (g1
->charpos
- pt_old
)
12943 < eabs (glyph
->charpos
- pt_old
))))
12945 /* If this candidate gives an exact match, use that. */
12946 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12947 /* Otherwise, keep the candidate that comes from a row
12948 spanning less buffer positions. This may win when one or
12949 both candidate positions are on glyphs that came from
12950 display strings, for which we cannot compare buffer
12952 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12953 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12954 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12957 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12959 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12960 w
->cursor
.y
= row
->y
+ dy
;
12962 if (w
== XWINDOW (selected_window
))
12964 if (!row
->continued_p
12965 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12968 this_line_buffer
= XBUFFER (w
->buffer
);
12970 CHARPOS (this_line_start_pos
)
12971 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12972 BYTEPOS (this_line_start_pos
)
12973 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12975 CHARPOS (this_line_end_pos
)
12976 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12977 BYTEPOS (this_line_end_pos
)
12978 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12980 this_line_y
= w
->cursor
.y
;
12981 this_line_pixel_height
= row
->height
;
12982 this_line_vpos
= w
->cursor
.vpos
;
12983 this_line_start_x
= row
->x
;
12986 CHARPOS (this_line_start_pos
) = 0;
12993 /* Run window scroll functions, if any, for WINDOW with new window
12994 start STARTP. Sets the window start of WINDOW to that position.
12996 We assume that the window's buffer is really current. */
12998 static INLINE
struct text_pos
12999 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13001 struct window
*w
= XWINDOW (window
);
13002 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13004 if (current_buffer
!= XBUFFER (w
->buffer
))
13007 if (!NILP (Vwindow_scroll_functions
))
13009 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13010 make_number (CHARPOS (startp
)));
13011 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13012 /* In case the hook functions switch buffers. */
13013 if (current_buffer
!= XBUFFER (w
->buffer
))
13014 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13021 /* Make sure the line containing the cursor is fully visible.
13022 A value of 1 means there is nothing to be done.
13023 (Either the line is fully visible, or it cannot be made so,
13024 or we cannot tell.)
13026 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13027 is higher than window.
13029 A value of 0 means the caller should do scrolling
13030 as if point had gone off the screen. */
13033 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13035 struct glyph_matrix
*matrix
;
13036 struct glyph_row
*row
;
13039 if (!make_cursor_line_fully_visible_p
)
13042 /* It's not always possible to find the cursor, e.g, when a window
13043 is full of overlay strings. Don't do anything in that case. */
13044 if (w
->cursor
.vpos
< 0)
13047 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13048 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13050 /* If the cursor row is not partially visible, there's nothing to do. */
13051 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13054 /* If the row the cursor is in is taller than the window's height,
13055 it's not clear what to do, so do nothing. */
13056 window_height
= window_box_height (w
);
13057 if (row
->height
>= window_height
)
13059 if (!force_p
|| MINI_WINDOW_P (w
)
13060 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13067 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13068 non-zero means only WINDOW is redisplayed in redisplay_internal.
13069 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13070 in redisplay_window to bring a partially visible line into view in
13071 the case that only the cursor has moved.
13073 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13074 last screen line's vertical height extends past the end of the screen.
13078 1 if scrolling succeeded
13080 0 if scrolling didn't find point.
13082 -1 if new fonts have been loaded so that we must interrupt
13083 redisplay, adjust glyph matrices, and try again. */
13089 SCROLLING_NEED_LARGER_MATRICES
13093 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13094 scroll_step
, temp_scroll_step
, last_line_misfit
)
13095 Lisp_Object window
;
13096 int just_this_one_p
;
13097 EMACS_INT scroll_conservatively
, scroll_step
;
13098 int temp_scroll_step
;
13099 int last_line_misfit
;
13101 struct window
*w
= XWINDOW (window
);
13102 struct frame
*f
= XFRAME (w
->frame
);
13103 struct text_pos pos
, startp
;
13105 int this_scroll_margin
, scroll_max
, rc
, height
;
13106 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13107 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13108 Lisp_Object aggressive
;
13109 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13112 debug_method_add (w
, "try_scrolling");
13115 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13117 /* Compute scroll margin height in pixels. We scroll when point is
13118 within this distance from the top or bottom of the window. */
13119 if (scroll_margin
> 0)
13120 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13121 * FRAME_LINE_HEIGHT (f
);
13123 this_scroll_margin
= 0;
13125 /* Force scroll_conservatively to have a reasonable value, to avoid
13126 overflow while computing how much to scroll. Note that the user
13127 can supply scroll-conservatively equal to `most-positive-fixnum',
13128 which can be larger than INT_MAX. */
13129 if (scroll_conservatively
> scroll_limit
)
13131 scroll_conservatively
= scroll_limit
;
13132 scroll_max
= INT_MAX
;
13134 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13135 /* Compute how much we should try to scroll maximally to bring
13136 point into view. */
13137 scroll_max
= (max (scroll_step
,
13138 max (scroll_conservatively
, temp_scroll_step
))
13139 * FRAME_LINE_HEIGHT (f
));
13140 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13141 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13142 /* We're trying to scroll because of aggressive scrolling but no
13143 scroll_step is set. Choose an arbitrary one. */
13144 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13150 /* Decide whether to scroll down. */
13151 if (PT
> CHARPOS (startp
))
13153 int scroll_margin_y
;
13155 /* Compute the pixel ypos of the scroll margin, then move it to
13156 either that ypos or PT, whichever comes first. */
13157 start_display (&it
, w
, startp
);
13158 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13159 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13160 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13161 (MOVE_TO_POS
| MOVE_TO_Y
));
13163 if (PT
> CHARPOS (it
.current
.pos
))
13165 int y0
= line_bottom_y (&it
);
13166 /* Compute how many pixels below window bottom to stop searching
13167 for PT. This avoids costly search for PT that is far away if
13168 the user limited scrolling by a small number of lines, but
13169 always finds PT if scroll_conservatively is set to a large
13170 number, such as most-positive-fixnum. */
13171 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13173 slack
>= INT_MAX
- it
.last_visible_y
13175 : it
.last_visible_y
+ slack
;
13177 /* Compute the distance from the scroll margin to PT or to
13178 the scroll limit, whichever comes first. This should
13179 include the height of the cursor line, to make that line
13181 move_it_to (&it
, PT
, -1, y_to_move
,
13182 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13183 dy
= line_bottom_y (&it
) - y0
;
13185 if (dy
> scroll_max
)
13186 return SCROLLING_FAILED
;
13194 /* Point is in or below the bottom scroll margin, so move the
13195 window start down. If scrolling conservatively, move it just
13196 enough down to make point visible. If scroll_step is set,
13197 move it down by scroll_step. */
13198 if (scroll_conservatively
)
13200 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13201 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13202 else if (scroll_step
|| temp_scroll_step
)
13203 amount_to_scroll
= scroll_max
;
13206 aggressive
= current_buffer
->scroll_up_aggressively
;
13207 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13208 if (NUMBERP (aggressive
))
13210 double float_amount
= XFLOATINT (aggressive
) * height
;
13211 amount_to_scroll
= float_amount
;
13212 if (amount_to_scroll
== 0 && float_amount
> 0)
13213 amount_to_scroll
= 1;
13217 if (amount_to_scroll
<= 0)
13218 return SCROLLING_FAILED
;
13220 start_display (&it
, w
, startp
);
13221 if (scroll_max
< INT_MAX
)
13222 move_it_vertically (&it
, amount_to_scroll
);
13225 /* Extra precision for users who set scroll-conservatively
13226 to most-positive-fixnum: make sure the amount we scroll
13227 the window start is never less than amount_to_scroll,
13228 which was computed as distance from window bottom to
13229 point. This matters when lines at window top and lines
13230 below window bottom have different height. */
13231 struct it it1
= it
;
13232 /* We use a temporary it1 because line_bottom_y can modify
13233 its argument, if it moves one line down; see there. */
13234 int start_y
= line_bottom_y (&it1
);
13237 move_it_by_lines (&it
, 1, 1);
13239 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13242 /* If STARTP is unchanged, move it down another screen line. */
13243 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13244 move_it_by_lines (&it
, 1, 1);
13245 startp
= it
.current
.pos
;
13249 struct text_pos scroll_margin_pos
= startp
;
13251 /* See if point is inside the scroll margin at the top of the
13253 if (this_scroll_margin
)
13255 start_display (&it
, w
, startp
);
13256 move_it_vertically (&it
, this_scroll_margin
);
13257 scroll_margin_pos
= it
.current
.pos
;
13260 if (PT
< CHARPOS (scroll_margin_pos
))
13262 /* Point is in the scroll margin at the top of the window or
13263 above what is displayed in the window. */
13266 /* Compute the vertical distance from PT to the scroll
13267 margin position. Give up if distance is greater than
13269 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13270 start_display (&it
, w
, pos
);
13272 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13273 it
.last_visible_y
, -1,
13274 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13275 dy
= it
.current_y
- y0
;
13276 if (dy
> scroll_max
)
13277 return SCROLLING_FAILED
;
13279 /* Compute new window start. */
13280 start_display (&it
, w
, startp
);
13282 if (scroll_conservatively
)
13284 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13285 else if (scroll_step
|| temp_scroll_step
)
13286 amount_to_scroll
= scroll_max
;
13289 aggressive
= current_buffer
->scroll_down_aggressively
;
13290 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13291 if (NUMBERP (aggressive
))
13293 double float_amount
= XFLOATINT (aggressive
) * height
;
13294 amount_to_scroll
= float_amount
;
13295 if (amount_to_scroll
== 0 && float_amount
> 0)
13296 amount_to_scroll
= 1;
13300 if (amount_to_scroll
<= 0)
13301 return SCROLLING_FAILED
;
13303 move_it_vertically_backward (&it
, amount_to_scroll
);
13304 startp
= it
.current
.pos
;
13308 /* Run window scroll functions. */
13309 startp
= run_window_scroll_functions (window
, startp
);
13311 /* Display the window. Give up if new fonts are loaded, or if point
13313 if (!try_window (window
, startp
, 0))
13314 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13315 else if (w
->cursor
.vpos
< 0)
13317 clear_glyph_matrix (w
->desired_matrix
);
13318 rc
= SCROLLING_FAILED
;
13322 /* Maybe forget recorded base line for line number display. */
13323 if (!just_this_one_p
13324 || current_buffer
->clip_changed
13325 || BEG_UNCHANGED
< CHARPOS (startp
))
13326 w
->base_line_number
= Qnil
;
13328 /* If cursor ends up on a partially visible line,
13329 treat that as being off the bottom of the screen. */
13330 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13332 clear_glyph_matrix (w
->desired_matrix
);
13333 ++extra_scroll_margin_lines
;
13336 rc
= SCROLLING_SUCCESS
;
13343 /* Compute a suitable window start for window W if display of W starts
13344 on a continuation line. Value is non-zero if a new window start
13347 The new window start will be computed, based on W's width, starting
13348 from the start of the continued line. It is the start of the
13349 screen line with the minimum distance from the old start W->start. */
13352 compute_window_start_on_continuation_line (struct window
*w
)
13354 struct text_pos pos
, start_pos
;
13355 int window_start_changed_p
= 0;
13357 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13359 /* If window start is on a continuation line... Window start may be
13360 < BEGV in case there's invisible text at the start of the
13361 buffer (M-x rmail, for example). */
13362 if (CHARPOS (start_pos
) > BEGV
13363 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13366 struct glyph_row
*row
;
13368 /* Handle the case that the window start is out of range. */
13369 if (CHARPOS (start_pos
) < BEGV
)
13370 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13371 else if (CHARPOS (start_pos
) > ZV
)
13372 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13374 /* Find the start of the continued line. This should be fast
13375 because scan_buffer is fast (newline cache). */
13376 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13377 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13378 row
, DEFAULT_FACE_ID
);
13379 reseat_at_previous_visible_line_start (&it
);
13381 /* If the line start is "too far" away from the window start,
13382 say it takes too much time to compute a new window start. */
13383 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13384 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13386 int min_distance
, distance
;
13388 /* Move forward by display lines to find the new window
13389 start. If window width was enlarged, the new start can
13390 be expected to be > the old start. If window width was
13391 decreased, the new window start will be < the old start.
13392 So, we're looking for the display line start with the
13393 minimum distance from the old window start. */
13394 pos
= it
.current
.pos
;
13395 min_distance
= INFINITY
;
13396 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13397 distance
< min_distance
)
13399 min_distance
= distance
;
13400 pos
= it
.current
.pos
;
13401 move_it_by_lines (&it
, 1, 0);
13404 /* Set the window start there. */
13405 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13406 window_start_changed_p
= 1;
13410 return window_start_changed_p
;
13414 /* Try cursor movement in case text has not changed in window WINDOW,
13415 with window start STARTP. Value is
13417 CURSOR_MOVEMENT_SUCCESS if successful
13419 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13421 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13422 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13423 we want to scroll as if scroll-step were set to 1. See the code.
13425 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13426 which case we have to abort this redisplay, and adjust matrices
13431 CURSOR_MOVEMENT_SUCCESS
,
13432 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13433 CURSOR_MOVEMENT_MUST_SCROLL
,
13434 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13438 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13440 struct window
*w
= XWINDOW (window
);
13441 struct frame
*f
= XFRAME (w
->frame
);
13442 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13445 if (inhibit_try_cursor_movement
)
13449 /* Handle case where text has not changed, only point, and it has
13450 not moved off the frame. */
13451 if (/* Point may be in this window. */
13452 PT
>= CHARPOS (startp
)
13453 /* Selective display hasn't changed. */
13454 && !current_buffer
->clip_changed
13455 /* Function force-mode-line-update is used to force a thorough
13456 redisplay. It sets either windows_or_buffers_changed or
13457 update_mode_lines. So don't take a shortcut here for these
13459 && !update_mode_lines
13460 && !windows_or_buffers_changed
13461 && !cursor_type_changed
13462 /* Can't use this case if highlighting a region. When a
13463 region exists, cursor movement has to do more than just
13465 && !(!NILP (Vtransient_mark_mode
)
13466 && !NILP (current_buffer
->mark_active
))
13467 && NILP (w
->region_showing
)
13468 && NILP (Vshow_trailing_whitespace
)
13469 /* Right after splitting windows, last_point may be nil. */
13470 && INTEGERP (w
->last_point
)
13471 /* This code is not used for mini-buffer for the sake of the case
13472 of redisplaying to replace an echo area message; since in
13473 that case the mini-buffer contents per se are usually
13474 unchanged. This code is of no real use in the mini-buffer
13475 since the handling of this_line_start_pos, etc., in redisplay
13476 handles the same cases. */
13477 && !EQ (window
, minibuf_window
)
13478 /* When splitting windows or for new windows, it happens that
13479 redisplay is called with a nil window_end_vpos or one being
13480 larger than the window. This should really be fixed in
13481 window.c. I don't have this on my list, now, so we do
13482 approximately the same as the old redisplay code. --gerd. */
13483 && INTEGERP (w
->window_end_vpos
)
13484 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13485 && (FRAME_WINDOW_P (f
)
13486 || !overlay_arrow_in_current_buffer_p ()))
13488 int this_scroll_margin
, top_scroll_margin
;
13489 struct glyph_row
*row
= NULL
;
13492 debug_method_add (w
, "cursor movement");
13495 /* Scroll if point within this distance from the top or bottom
13496 of the window. This is a pixel value. */
13497 if (scroll_margin
> 0)
13499 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13500 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13503 this_scroll_margin
= 0;
13505 top_scroll_margin
= this_scroll_margin
;
13506 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13507 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13509 /* Start with the row the cursor was displayed during the last
13510 not paused redisplay. Give up if that row is not valid. */
13511 if (w
->last_cursor
.vpos
< 0
13512 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13513 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13516 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13517 if (row
->mode_line_p
)
13519 if (!row
->enabled_p
)
13520 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13523 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13525 int scroll_p
= 0, must_scroll
= 0;
13526 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13528 if (PT
> XFASTINT (w
->last_point
))
13530 /* Point has moved forward. */
13531 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13532 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13534 xassert (row
->enabled_p
);
13538 /* If the end position of a row equals the start
13539 position of the next row, and PT is at that position,
13540 we would rather display cursor in the next line. */
13541 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13542 && MATRIX_ROW_END_CHARPOS (row
) == PT
13543 && row
< w
->current_matrix
->rows
13544 + w
->current_matrix
->nrows
- 1
13545 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13546 && !cursor_row_p (w
, row
))
13549 /* If within the scroll margin, scroll. Note that
13550 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13551 the next line would be drawn, and that
13552 this_scroll_margin can be zero. */
13553 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13554 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13555 /* Line is completely visible last line in window
13556 and PT is to be set in the next line. */
13557 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13558 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13559 && !row
->ends_at_zv_p
13560 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13563 else if (PT
< XFASTINT (w
->last_point
))
13565 /* Cursor has to be moved backward. Note that PT >=
13566 CHARPOS (startp) because of the outer if-statement. */
13567 while (!row
->mode_line_p
13568 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13569 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13570 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13571 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13572 row
> w
->current_matrix
->rows
13573 && (row
-1)->ends_in_newline_from_string_p
))))
13574 && (row
->y
> top_scroll_margin
13575 || CHARPOS (startp
) == BEGV
))
13577 xassert (row
->enabled_p
);
13581 /* Consider the following case: Window starts at BEGV,
13582 there is invisible, intangible text at BEGV, so that
13583 display starts at some point START > BEGV. It can
13584 happen that we are called with PT somewhere between
13585 BEGV and START. Try to handle that case. */
13586 if (row
< w
->current_matrix
->rows
13587 || row
->mode_line_p
)
13589 row
= w
->current_matrix
->rows
;
13590 if (row
->mode_line_p
)
13594 /* Due to newlines in overlay strings, we may have to
13595 skip forward over overlay strings. */
13596 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13597 && MATRIX_ROW_END_CHARPOS (row
) == PT
13598 && !cursor_row_p (w
, row
))
13601 /* If within the scroll margin, scroll. */
13602 if (row
->y
< top_scroll_margin
13603 && CHARPOS (startp
) != BEGV
)
13608 /* Cursor did not move. So don't scroll even if cursor line
13609 is partially visible, as it was so before. */
13610 rc
= CURSOR_MOVEMENT_SUCCESS
;
13613 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13614 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13616 /* if PT is not in the glyph row, give up. */
13617 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13620 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13621 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13623 /* If rows are bidi-reordered and point moved, back up
13624 until we find a row that does not belong to a
13625 continuation line. This is because we must consider
13626 all rows of a continued line as candidates for the
13627 new cursor positioning, since row start and end
13628 positions change non-linearly with vertical position
13630 /* FIXME: Revisit this when glyph ``spilling'' in
13631 continuation lines' rows is implemented for
13632 bidi-reordered rows. */
13633 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13635 xassert (row
->enabled_p
);
13637 /* If we hit the beginning of the displayed portion
13638 without finding the first row of a continued
13640 if (row
<= w
->current_matrix
->rows
)
13642 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13650 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13651 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13652 && make_cursor_line_fully_visible_p
)
13654 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13655 && !row
->ends_at_zv_p
13656 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13658 else if (row
->height
> window_box_height (w
))
13660 /* If we end up in a partially visible line, let's
13661 make it fully visible, except when it's taller
13662 than the window, in which case we can't do much
13665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13669 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13670 if (!cursor_row_fully_visible_p (w
, 0, 1))
13671 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13673 rc
= CURSOR_MOVEMENT_SUCCESS
;
13677 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13678 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13679 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13681 /* With bidi-reordered rows, there could be more than
13682 one candidate row whose start and end positions
13683 occlude point. We need to let set_cursor_from_row
13684 find the best candidate. */
13685 /* FIXME: Revisit this when glyph ``spilling'' in
13686 continuation lines' rows is implemented for
13687 bidi-reordered rows. */
13692 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13693 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13694 && cursor_row_p (w
, row
))
13695 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13697 /* As soon as we've found the first suitable row
13698 whose ends_at_zv_p flag is set, we are done. */
13700 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13702 rc
= CURSOR_MOVEMENT_SUCCESS
;
13707 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13708 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13709 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13710 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13711 /* If we didn't find any candidate rows, or exited the
13712 loop before all the candidates were examined, signal
13713 to the caller that this method failed. */
13714 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13715 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13716 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13718 rc
= CURSOR_MOVEMENT_SUCCESS
;
13724 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13726 rc
= CURSOR_MOVEMENT_SUCCESS
;
13731 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13732 && MATRIX_ROW_START_CHARPOS (row
) == PT
13733 && cursor_row_p (w
, row
));
13742 set_vertical_scroll_bar (struct window
*w
)
13744 int start
, end
, whole
;
13746 /* Calculate the start and end positions for the current window.
13747 At some point, it would be nice to choose between scrollbars
13748 which reflect the whole buffer size, with special markers
13749 indicating narrowing, and scrollbars which reflect only the
13752 Note that mini-buffers sometimes aren't displaying any text. */
13753 if (!MINI_WINDOW_P (w
)
13754 || (w
== XWINDOW (minibuf_window
)
13755 && NILP (echo_area_buffer
[0])))
13757 struct buffer
*buf
= XBUFFER (w
->buffer
);
13758 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13759 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13760 /* I don't think this is guaranteed to be right. For the
13761 moment, we'll pretend it is. */
13762 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13766 if (whole
< (end
- start
))
13767 whole
= end
- start
;
13770 start
= end
= whole
= 0;
13772 /* Indicate what this scroll bar ought to be displaying now. */
13773 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13774 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13775 (w
, end
- start
, whole
, start
);
13779 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13780 selected_window is redisplayed.
13782 We can return without actually redisplaying the window if
13783 fonts_changed_p is nonzero. In that case, redisplay_internal will
13787 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13789 struct window
*w
= XWINDOW (window
);
13790 struct frame
*f
= XFRAME (w
->frame
);
13791 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13792 struct buffer
*old
= current_buffer
;
13793 struct text_pos lpoint
, opoint
, startp
;
13794 int update_mode_line
;
13797 /* Record it now because it's overwritten. */
13798 int current_matrix_up_to_date_p
= 0;
13799 int used_current_matrix_p
= 0;
13800 /* This is less strict than current_matrix_up_to_date_p.
13801 It indictes that the buffer contents and narrowing are unchanged. */
13802 int buffer_unchanged_p
= 0;
13803 int temp_scroll_step
= 0;
13804 int count
= SPECPDL_INDEX ();
13806 int centering_position
= -1;
13807 int last_line_misfit
= 0;
13808 int beg_unchanged
, end_unchanged
;
13810 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13813 /* W must be a leaf window here. */
13814 xassert (!NILP (w
->buffer
));
13816 *w
->desired_matrix
->method
= 0;
13820 reconsider_clip_changes (w
, buffer
);
13822 /* Has the mode line to be updated? */
13823 update_mode_line
= (!NILP (w
->update_mode_line
)
13824 || update_mode_lines
13825 || buffer
->clip_changed
13826 || buffer
->prevent_redisplay_optimizations_p
);
13828 if (MINI_WINDOW_P (w
))
13830 if (w
== XWINDOW (echo_area_window
)
13831 && !NILP (echo_area_buffer
[0]))
13833 if (update_mode_line
)
13834 /* We may have to update a tty frame's menu bar or a
13835 tool-bar. Example `M-x C-h C-h C-g'. */
13836 goto finish_menu_bars
;
13838 /* We've already displayed the echo area glyphs in this window. */
13839 goto finish_scroll_bars
;
13841 else if ((w
!= XWINDOW (minibuf_window
)
13842 || minibuf_level
== 0)
13843 /* When buffer is nonempty, redisplay window normally. */
13844 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13845 /* Quail displays non-mini buffers in minibuffer window.
13846 In that case, redisplay the window normally. */
13847 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13849 /* W is a mini-buffer window, but it's not active, so clear
13851 int yb
= window_text_bottom_y (w
);
13852 struct glyph_row
*row
;
13855 for (y
= 0, row
= w
->desired_matrix
->rows
;
13857 y
+= row
->height
, ++row
)
13858 blank_row (w
, row
, y
);
13859 goto finish_scroll_bars
;
13862 clear_glyph_matrix (w
->desired_matrix
);
13865 /* Otherwise set up data on this window; select its buffer and point
13867 /* Really select the buffer, for the sake of buffer-local
13869 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13871 current_matrix_up_to_date_p
13872 = (!NILP (w
->window_end_valid
)
13873 && !current_buffer
->clip_changed
13874 && !current_buffer
->prevent_redisplay_optimizations_p
13875 && XFASTINT (w
->last_modified
) >= MODIFF
13876 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13878 /* Run the window-bottom-change-functions
13879 if it is possible that the text on the screen has changed
13880 (either due to modification of the text, or any other reason). */
13881 if (!current_matrix_up_to_date_p
13882 && !NILP (Vwindow_text_change_functions
))
13884 safe_run_hooks (Qwindow_text_change_functions
);
13888 beg_unchanged
= BEG_UNCHANGED
;
13889 end_unchanged
= END_UNCHANGED
;
13891 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13893 specbind (Qinhibit_point_motion_hooks
, Qt
);
13896 = (!NILP (w
->window_end_valid
)
13897 && !current_buffer
->clip_changed
13898 && XFASTINT (w
->last_modified
) >= MODIFF
13899 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13901 /* When windows_or_buffers_changed is non-zero, we can't rely on
13902 the window end being valid, so set it to nil there. */
13903 if (windows_or_buffers_changed
)
13905 /* If window starts on a continuation line, maybe adjust the
13906 window start in case the window's width changed. */
13907 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13908 compute_window_start_on_continuation_line (w
);
13910 w
->window_end_valid
= Qnil
;
13913 /* Some sanity checks. */
13914 CHECK_WINDOW_END (w
);
13915 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13917 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13920 /* If %c is in mode line, update it if needed. */
13921 if (!NILP (w
->column_number_displayed
)
13922 /* This alternative quickly identifies a common case
13923 where no change is needed. */
13924 && !(PT
== XFASTINT (w
->last_point
)
13925 && XFASTINT (w
->last_modified
) >= MODIFF
13926 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13927 && (XFASTINT (w
->column_number_displayed
)
13928 != (int) current_column ())) /* iftc */
13929 update_mode_line
= 1;
13931 /* Count number of windows showing the selected buffer. An indirect
13932 buffer counts as its base buffer. */
13933 if (!just_this_one_p
)
13935 struct buffer
*current_base
, *window_base
;
13936 current_base
= current_buffer
;
13937 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13938 if (current_base
->base_buffer
)
13939 current_base
= current_base
->base_buffer
;
13940 if (window_base
->base_buffer
)
13941 window_base
= window_base
->base_buffer
;
13942 if (current_base
== window_base
)
13946 /* Point refers normally to the selected window. For any other
13947 window, set up appropriate value. */
13948 if (!EQ (window
, selected_window
))
13950 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13951 int new_pt_byte
= marker_byte_position (w
->pointm
);
13955 new_pt_byte
= BEGV_BYTE
;
13956 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13958 else if (new_pt
> (ZV
- 1))
13961 new_pt_byte
= ZV_BYTE
;
13962 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13965 /* We don't use SET_PT so that the point-motion hooks don't run. */
13966 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13969 /* If any of the character widths specified in the display table
13970 have changed, invalidate the width run cache. It's true that
13971 this may be a bit late to catch such changes, but the rest of
13972 redisplay goes (non-fatally) haywire when the display table is
13973 changed, so why should we worry about doing any better? */
13974 if (current_buffer
->width_run_cache
)
13976 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13978 if (! disptab_matches_widthtab (disptab
,
13979 XVECTOR (current_buffer
->width_table
)))
13981 invalidate_region_cache (current_buffer
,
13982 current_buffer
->width_run_cache
,
13984 recompute_width_table (current_buffer
, disptab
);
13988 /* If window-start is screwed up, choose a new one. */
13989 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13992 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13994 /* If someone specified a new starting point but did not insist,
13995 check whether it can be used. */
13996 if (!NILP (w
->optional_new_start
)
13997 && CHARPOS (startp
) >= BEGV
13998 && CHARPOS (startp
) <= ZV
)
14000 w
->optional_new_start
= Qnil
;
14001 start_display (&it
, w
, startp
);
14002 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14003 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14004 if (IT_CHARPOS (it
) == PT
)
14005 w
->force_start
= Qt
;
14006 /* IT may overshoot PT if text at PT is invisible. */
14007 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14008 w
->force_start
= Qt
;
14013 /* Handle case where place to start displaying has been specified,
14014 unless the specified location is outside the accessible range. */
14015 if (!NILP (w
->force_start
)
14016 || w
->frozen_window_start_p
)
14018 /* We set this later on if we have to adjust point. */
14021 w
->force_start
= Qnil
;
14023 w
->window_end_valid
= Qnil
;
14025 /* Forget any recorded base line for line number display. */
14026 if (!buffer_unchanged_p
)
14027 w
->base_line_number
= Qnil
;
14029 /* Redisplay the mode line. Select the buffer properly for that.
14030 Also, run the hook window-scroll-functions
14031 because we have scrolled. */
14032 /* Note, we do this after clearing force_start because
14033 if there's an error, it is better to forget about force_start
14034 than to get into an infinite loop calling the hook functions
14035 and having them get more errors. */
14036 if (!update_mode_line
14037 || ! NILP (Vwindow_scroll_functions
))
14039 update_mode_line
= 1;
14040 w
->update_mode_line
= Qt
;
14041 startp
= run_window_scroll_functions (window
, startp
);
14044 w
->last_modified
= make_number (0);
14045 w
->last_overlay_modified
= make_number (0);
14046 if (CHARPOS (startp
) < BEGV
)
14047 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14048 else if (CHARPOS (startp
) > ZV
)
14049 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14051 /* Redisplay, then check if cursor has been set during the
14052 redisplay. Give up if new fonts were loaded. */
14053 /* We used to issue a CHECK_MARGINS argument to try_window here,
14054 but this causes scrolling to fail when point begins inside
14055 the scroll margin (bug#148) -- cyd */
14056 if (!try_window (window
, startp
, 0))
14058 w
->force_start
= Qt
;
14059 clear_glyph_matrix (w
->desired_matrix
);
14060 goto need_larger_matrices
;
14063 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14065 /* If point does not appear, try to move point so it does
14066 appear. The desired matrix has been built above, so we
14067 can use it here. */
14068 new_vpos
= window_box_height (w
) / 2;
14071 if (!cursor_row_fully_visible_p (w
, 0, 0))
14073 /* Point does appear, but on a line partly visible at end of window.
14074 Move it back to a fully-visible line. */
14075 new_vpos
= window_box_height (w
);
14078 /* If we need to move point for either of the above reasons,
14079 now actually do it. */
14082 struct glyph_row
*row
;
14084 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14085 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14088 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14089 MATRIX_ROW_START_BYTEPOS (row
));
14091 if (w
!= XWINDOW (selected_window
))
14092 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14093 else if (current_buffer
== old
)
14094 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14096 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14098 /* If we are highlighting the region, then we just changed
14099 the region, so redisplay to show it. */
14100 if (!NILP (Vtransient_mark_mode
)
14101 && !NILP (current_buffer
->mark_active
))
14103 clear_glyph_matrix (w
->desired_matrix
);
14104 if (!try_window (window
, startp
, 0))
14105 goto need_larger_matrices
;
14110 debug_method_add (w
, "forced window start");
14115 /* Handle case where text has not changed, only point, and it has
14116 not moved off the frame, and we are not retrying after hscroll.
14117 (current_matrix_up_to_date_p is nonzero when retrying.) */
14118 if (current_matrix_up_to_date_p
14119 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14120 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14124 case CURSOR_MOVEMENT_SUCCESS
:
14125 used_current_matrix_p
= 1;
14128 case CURSOR_MOVEMENT_MUST_SCROLL
:
14129 goto try_to_scroll
;
14135 /* If current starting point was originally the beginning of a line
14136 but no longer is, find a new starting point. */
14137 else if (!NILP (w
->start_at_line_beg
)
14138 && !(CHARPOS (startp
) <= BEGV
14139 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14142 debug_method_add (w
, "recenter 1");
14147 /* Try scrolling with try_window_id. Value is > 0 if update has
14148 been done, it is -1 if we know that the same window start will
14149 not work. It is 0 if unsuccessful for some other reason. */
14150 else if ((tem
= try_window_id (w
)) != 0)
14153 debug_method_add (w
, "try_window_id %d", tem
);
14156 if (fonts_changed_p
)
14157 goto need_larger_matrices
;
14161 /* Otherwise try_window_id has returned -1 which means that we
14162 don't want the alternative below this comment to execute. */
14164 else if (CHARPOS (startp
) >= BEGV
14165 && CHARPOS (startp
) <= ZV
14166 && PT
>= CHARPOS (startp
)
14167 && (CHARPOS (startp
) < ZV
14168 /* Avoid starting at end of buffer. */
14169 || CHARPOS (startp
) == BEGV
14170 || (XFASTINT (w
->last_modified
) >= MODIFF
14171 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14174 /* If first window line is a continuation line, and window start
14175 is inside the modified region, but the first change is before
14176 current window start, we must select a new window start.
14178 However, if this is the result of a down-mouse event (e.g. by
14179 extending the mouse-drag-overlay), we don't want to select a
14180 new window start, since that would change the position under
14181 the mouse, resulting in an unwanted mouse-movement rather
14182 than a simple mouse-click. */
14183 if (NILP (w
->start_at_line_beg
)
14184 && NILP (do_mouse_tracking
)
14185 && CHARPOS (startp
) > BEGV
14186 && CHARPOS (startp
) > BEG
+ beg_unchanged
14187 && CHARPOS (startp
) <= Z
- end_unchanged
14188 /* Even if w->start_at_line_beg is nil, a new window may
14189 start at a line_beg, since that's how set_buffer_window
14190 sets it. So, we need to check the return value of
14191 compute_window_start_on_continuation_line. (See also
14193 && XMARKER (w
->start
)->buffer
== current_buffer
14194 && compute_window_start_on_continuation_line (w
))
14196 w
->force_start
= Qt
;
14197 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14202 debug_method_add (w
, "same window start");
14205 /* Try to redisplay starting at same place as before.
14206 If point has not moved off frame, accept the results. */
14207 if (!current_matrix_up_to_date_p
14208 /* Don't use try_window_reusing_current_matrix in this case
14209 because a window scroll function can have changed the
14211 || !NILP (Vwindow_scroll_functions
)
14212 || MINI_WINDOW_P (w
)
14213 || !(used_current_matrix_p
14214 = try_window_reusing_current_matrix (w
)))
14216 IF_DEBUG (debug_method_add (w
, "1"));
14217 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14218 /* -1 means we need to scroll.
14219 0 means we need new matrices, but fonts_changed_p
14220 is set in that case, so we will detect it below. */
14221 goto try_to_scroll
;
14224 if (fonts_changed_p
)
14225 goto need_larger_matrices
;
14227 if (w
->cursor
.vpos
>= 0)
14229 if (!just_this_one_p
14230 || current_buffer
->clip_changed
14231 || BEG_UNCHANGED
< CHARPOS (startp
))
14232 /* Forget any recorded base line for line number display. */
14233 w
->base_line_number
= Qnil
;
14235 if (!cursor_row_fully_visible_p (w
, 1, 0))
14237 clear_glyph_matrix (w
->desired_matrix
);
14238 last_line_misfit
= 1;
14240 /* Drop through and scroll. */
14245 clear_glyph_matrix (w
->desired_matrix
);
14250 w
->last_modified
= make_number (0);
14251 w
->last_overlay_modified
= make_number (0);
14253 /* Redisplay the mode line. Select the buffer properly for that. */
14254 if (!update_mode_line
)
14256 update_mode_line
= 1;
14257 w
->update_mode_line
= Qt
;
14260 /* Try to scroll by specified few lines. */
14261 if ((scroll_conservatively
14263 || temp_scroll_step
14264 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14265 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14266 && !current_buffer
->clip_changed
14267 && CHARPOS (startp
) >= BEGV
14268 && CHARPOS (startp
) <= ZV
)
14270 /* The function returns -1 if new fonts were loaded, 1 if
14271 successful, 0 if not successful. */
14272 int rc
= try_scrolling (window
, just_this_one_p
,
14273 scroll_conservatively
,
14275 temp_scroll_step
, last_line_misfit
);
14278 case SCROLLING_SUCCESS
:
14281 case SCROLLING_NEED_LARGER_MATRICES
:
14282 goto need_larger_matrices
;
14284 case SCROLLING_FAILED
:
14292 /* Finally, just choose place to start which centers point */
14295 if (centering_position
< 0)
14296 centering_position
= window_box_height (w
) / 2;
14299 debug_method_add (w
, "recenter");
14302 /* w->vscroll = 0; */
14304 /* Forget any previously recorded base line for line number display. */
14305 if (!buffer_unchanged_p
)
14306 w
->base_line_number
= Qnil
;
14308 /* Move backward half the height of the window. */
14309 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14310 it
.current_y
= it
.last_visible_y
;
14311 move_it_vertically_backward (&it
, centering_position
);
14312 xassert (IT_CHARPOS (it
) >= BEGV
);
14314 /* The function move_it_vertically_backward may move over more
14315 than the specified y-distance. If it->w is small, e.g. a
14316 mini-buffer window, we may end up in front of the window's
14317 display area. Start displaying at the start of the line
14318 containing PT in this case. */
14319 if (it
.current_y
<= 0)
14321 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14322 move_it_vertically_backward (&it
, 0);
14326 it
.current_x
= it
.hpos
= 0;
14328 /* Set startp here explicitly in case that helps avoid an infinite loop
14329 in case the window-scroll-functions functions get errors. */
14330 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14332 /* Run scroll hooks. */
14333 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14335 /* Redisplay the window. */
14336 if (!current_matrix_up_to_date_p
14337 || windows_or_buffers_changed
14338 || cursor_type_changed
14339 /* Don't use try_window_reusing_current_matrix in this case
14340 because it can have changed the buffer. */
14341 || !NILP (Vwindow_scroll_functions
)
14342 || !just_this_one_p
14343 || MINI_WINDOW_P (w
)
14344 || !(used_current_matrix_p
14345 = try_window_reusing_current_matrix (w
)))
14346 try_window (window
, startp
, 0);
14348 /* If new fonts have been loaded (due to fontsets), give up. We
14349 have to start a new redisplay since we need to re-adjust glyph
14351 if (fonts_changed_p
)
14352 goto need_larger_matrices
;
14354 /* If cursor did not appear assume that the middle of the window is
14355 in the first line of the window. Do it again with the next line.
14356 (Imagine a window of height 100, displaying two lines of height
14357 60. Moving back 50 from it->last_visible_y will end in the first
14359 if (w
->cursor
.vpos
< 0)
14361 if (!NILP (w
->window_end_valid
)
14362 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14364 clear_glyph_matrix (w
->desired_matrix
);
14365 move_it_by_lines (&it
, 1, 0);
14366 try_window (window
, it
.current
.pos
, 0);
14368 else if (PT
< IT_CHARPOS (it
))
14370 clear_glyph_matrix (w
->desired_matrix
);
14371 move_it_by_lines (&it
, -1, 0);
14372 try_window (window
, it
.current
.pos
, 0);
14376 /* Not much we can do about it. */
14380 /* Consider the following case: Window starts at BEGV, there is
14381 invisible, intangible text at BEGV, so that display starts at
14382 some point START > BEGV. It can happen that we are called with
14383 PT somewhere between BEGV and START. Try to handle that case. */
14384 if (w
->cursor
.vpos
< 0)
14386 struct glyph_row
*row
= w
->current_matrix
->rows
;
14387 if (row
->mode_line_p
)
14389 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14392 if (!cursor_row_fully_visible_p (w
, 0, 0))
14394 /* If vscroll is enabled, disable it and try again. */
14398 clear_glyph_matrix (w
->desired_matrix
);
14402 /* If centering point failed to make the whole line visible,
14403 put point at the top instead. That has to make the whole line
14404 visible, if it can be done. */
14405 if (centering_position
== 0)
14408 clear_glyph_matrix (w
->desired_matrix
);
14409 centering_position
= 0;
14415 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14416 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14417 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14420 /* Display the mode line, if we must. */
14421 if ((update_mode_line
14422 /* If window not full width, must redo its mode line
14423 if (a) the window to its side is being redone and
14424 (b) we do a frame-based redisplay. This is a consequence
14425 of how inverted lines are drawn in frame-based redisplay. */
14426 || (!just_this_one_p
14427 && !FRAME_WINDOW_P (f
)
14428 && !WINDOW_FULL_WIDTH_P (w
))
14429 /* Line number to display. */
14430 || INTEGERP (w
->base_line_pos
)
14431 /* Column number is displayed and different from the one displayed. */
14432 || (!NILP (w
->column_number_displayed
)
14433 && (XFASTINT (w
->column_number_displayed
)
14434 != (int) current_column ()))) /* iftc */
14435 /* This means that the window has a mode line. */
14436 && (WINDOW_WANTS_MODELINE_P (w
)
14437 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14439 display_mode_lines (w
);
14441 /* If mode line height has changed, arrange for a thorough
14442 immediate redisplay using the correct mode line height. */
14443 if (WINDOW_WANTS_MODELINE_P (w
)
14444 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14446 fonts_changed_p
= 1;
14447 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14448 = DESIRED_MODE_LINE_HEIGHT (w
);
14451 /* If header line height has changed, arrange for a thorough
14452 immediate redisplay using the correct header line height. */
14453 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14454 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14456 fonts_changed_p
= 1;
14457 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14458 = DESIRED_HEADER_LINE_HEIGHT (w
);
14461 if (fonts_changed_p
)
14462 goto need_larger_matrices
;
14465 if (!line_number_displayed
14466 && !BUFFERP (w
->base_line_pos
))
14468 w
->base_line_pos
= Qnil
;
14469 w
->base_line_number
= Qnil
;
14474 /* When we reach a frame's selected window, redo the frame's menu bar. */
14475 if (update_mode_line
14476 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14478 int redisplay_menu_p
= 0;
14479 int redisplay_tool_bar_p
= 0;
14481 if (FRAME_WINDOW_P (f
))
14483 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14484 || defined (HAVE_NS) || defined (USE_GTK)
14485 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14487 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14491 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14493 if (redisplay_menu_p
)
14494 display_menu_bar (w
);
14496 #ifdef HAVE_WINDOW_SYSTEM
14497 if (FRAME_WINDOW_P (f
))
14499 #if defined (USE_GTK) || defined (HAVE_NS)
14500 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14502 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14503 && (FRAME_TOOL_BAR_LINES (f
) > 0
14504 || !NILP (Vauto_resize_tool_bars
));
14507 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14509 extern int ignore_mouse_drag_p
;
14510 ignore_mouse_drag_p
= 1;
14516 #ifdef HAVE_WINDOW_SYSTEM
14517 if (FRAME_WINDOW_P (f
)
14518 && update_window_fringes (w
, (just_this_one_p
14519 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14520 || w
->pseudo_window_p
)))
14524 if (draw_window_fringes (w
, 1))
14525 x_draw_vertical_border (w
);
14529 #endif /* HAVE_WINDOW_SYSTEM */
14531 /* We go to this label, with fonts_changed_p nonzero,
14532 if it is necessary to try again using larger glyph matrices.
14533 We have to redeem the scroll bar even in this case,
14534 because the loop in redisplay_internal expects that. */
14535 need_larger_matrices
:
14537 finish_scroll_bars
:
14539 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14541 /* Set the thumb's position and size. */
14542 set_vertical_scroll_bar (w
);
14544 /* Note that we actually used the scroll bar attached to this
14545 window, so it shouldn't be deleted at the end of redisplay. */
14546 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14547 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14550 /* Restore current_buffer and value of point in it. The window
14551 update may have changed the buffer, so first make sure `opoint'
14552 is still valid (Bug#6177). */
14553 if (CHARPOS (opoint
) < BEGV
)
14554 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14555 else if (CHARPOS (opoint
) > ZV
)
14556 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14558 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14560 set_buffer_internal_1 (old
);
14561 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14562 shorter. This can be caused by log truncation in *Messages*. */
14563 if (CHARPOS (lpoint
) <= ZV
)
14564 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14566 unbind_to (count
, Qnil
);
14570 /* Build the complete desired matrix of WINDOW with a window start
14571 buffer position POS.
14573 Value is 1 if successful. It is zero if fonts were loaded during
14574 redisplay which makes re-adjusting glyph matrices necessary, and -1
14575 if point would appear in the scroll margins.
14576 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14577 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14581 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14583 struct window
*w
= XWINDOW (window
);
14585 struct glyph_row
*last_text_row
= NULL
;
14586 struct frame
*f
= XFRAME (w
->frame
);
14588 /* Make POS the new window start. */
14589 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14591 /* Mark cursor position as unknown. No overlay arrow seen. */
14592 w
->cursor
.vpos
= -1;
14593 overlay_arrow_seen
= 0;
14595 /* Initialize iterator and info to start at POS. */
14596 start_display (&it
, w
, pos
);
14598 /* Display all lines of W. */
14599 while (it
.current_y
< it
.last_visible_y
)
14601 if (display_line (&it
))
14602 last_text_row
= it
.glyph_row
- 1;
14603 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14607 /* Don't let the cursor end in the scroll margins. */
14608 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14609 && !MINI_WINDOW_P (w
))
14611 int this_scroll_margin
;
14613 if (scroll_margin
> 0)
14615 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14616 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14619 this_scroll_margin
= 0;
14621 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14622 && w
->cursor
.y
< this_scroll_margin
14623 && CHARPOS (pos
) > BEGV
14624 && IT_CHARPOS (it
) < ZV
)
14625 /* rms: considering make_cursor_line_fully_visible_p here
14626 seems to give wrong results. We don't want to recenter
14627 when the last line is partly visible, we want to allow
14628 that case to be handled in the usual way. */
14629 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14631 w
->cursor
.vpos
= -1;
14632 clear_glyph_matrix (w
->desired_matrix
);
14637 /* If bottom moved off end of frame, change mode line percentage. */
14638 if (XFASTINT (w
->window_end_pos
) <= 0
14639 && Z
!= IT_CHARPOS (it
))
14640 w
->update_mode_line
= Qt
;
14642 /* Set window_end_pos to the offset of the last character displayed
14643 on the window from the end of current_buffer. Set
14644 window_end_vpos to its row number. */
14647 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14648 w
->window_end_bytepos
14649 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14651 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14653 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14654 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14655 ->displays_text_p
);
14659 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14660 w
->window_end_pos
= make_number (Z
- ZV
);
14661 w
->window_end_vpos
= make_number (0);
14664 /* But that is not valid info until redisplay finishes. */
14665 w
->window_end_valid
= Qnil
;
14671 /************************************************************************
14672 Window redisplay reusing current matrix when buffer has not changed
14673 ************************************************************************/
14675 /* Try redisplay of window W showing an unchanged buffer with a
14676 different window start than the last time it was displayed by
14677 reusing its current matrix. Value is non-zero if successful.
14678 W->start is the new window start. */
14681 try_window_reusing_current_matrix (struct window
*w
)
14683 struct frame
*f
= XFRAME (w
->frame
);
14684 struct glyph_row
*row
, *bottom_row
;
14687 struct text_pos start
, new_start
;
14688 int nrows_scrolled
, i
;
14689 struct glyph_row
*last_text_row
;
14690 struct glyph_row
*last_reused_text_row
;
14691 struct glyph_row
*start_row
;
14692 int start_vpos
, min_y
, max_y
;
14695 if (inhibit_try_window_reusing
)
14699 if (/* This function doesn't handle terminal frames. */
14700 !FRAME_WINDOW_P (f
)
14701 /* Don't try to reuse the display if windows have been split
14703 || windows_or_buffers_changed
14704 || cursor_type_changed
)
14707 /* Can't do this if region may have changed. */
14708 if ((!NILP (Vtransient_mark_mode
)
14709 && !NILP (current_buffer
->mark_active
))
14710 || !NILP (w
->region_showing
)
14711 || !NILP (Vshow_trailing_whitespace
))
14714 /* If top-line visibility has changed, give up. */
14715 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14716 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14719 /* Give up if old or new display is scrolled vertically. We could
14720 make this function handle this, but right now it doesn't. */
14721 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14722 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14725 /* The variable new_start now holds the new window start. The old
14726 start `start' can be determined from the current matrix. */
14727 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14728 start
= start_row
->minpos
;
14729 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14731 /* Clear the desired matrix for the display below. */
14732 clear_glyph_matrix (w
->desired_matrix
);
14734 if (CHARPOS (new_start
) <= CHARPOS (start
))
14738 /* Don't use this method if the display starts with an ellipsis
14739 displayed for invisible text. It's not easy to handle that case
14740 below, and it's certainly not worth the effort since this is
14741 not a frequent case. */
14742 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14745 IF_DEBUG (debug_method_add (w
, "twu1"));
14747 /* Display up to a row that can be reused. The variable
14748 last_text_row is set to the last row displayed that displays
14749 text. Note that it.vpos == 0 if or if not there is a
14750 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14751 start_display (&it
, w
, new_start
);
14752 first_row_y
= it
.current_y
;
14753 w
->cursor
.vpos
= -1;
14754 last_text_row
= last_reused_text_row
= NULL
;
14756 while (it
.current_y
< it
.last_visible_y
14757 && !fonts_changed_p
)
14759 /* If we have reached into the characters in the START row,
14760 that means the line boundaries have changed. So we
14761 can't start copying with the row START. Maybe it will
14762 work to start copying with the following row. */
14763 while (IT_CHARPOS (it
) > CHARPOS (start
))
14765 /* Advance to the next row as the "start". */
14767 start
= start_row
->minpos
;
14768 /* If there are no more rows to try, or just one, give up. */
14769 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14770 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14771 || CHARPOS (start
) == ZV
)
14773 clear_glyph_matrix (w
->desired_matrix
);
14777 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14779 /* If we have reached alignment,
14780 we can copy the rest of the rows. */
14781 if (IT_CHARPOS (it
) == CHARPOS (start
))
14784 if (display_line (&it
))
14785 last_text_row
= it
.glyph_row
- 1;
14788 /* A value of current_y < last_visible_y means that we stopped
14789 at the previous window start, which in turn means that we
14790 have at least one reusable row. */
14791 if (it
.current_y
< it
.last_visible_y
)
14793 /* IT.vpos always starts from 0; it counts text lines. */
14794 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14796 /* Find PT if not already found in the lines displayed. */
14797 if (w
->cursor
.vpos
< 0)
14799 int dy
= it
.current_y
- start_row
->y
;
14801 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14802 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14804 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14805 dy
, nrows_scrolled
);
14808 clear_glyph_matrix (w
->desired_matrix
);
14813 /* Scroll the display. Do it before the current matrix is
14814 changed. The problem here is that update has not yet
14815 run, i.e. part of the current matrix is not up to date.
14816 scroll_run_hook will clear the cursor, and use the
14817 current matrix to get the height of the row the cursor is
14819 run
.current_y
= start_row
->y
;
14820 run
.desired_y
= it
.current_y
;
14821 run
.height
= it
.last_visible_y
- it
.current_y
;
14823 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14826 FRAME_RIF (f
)->update_window_begin_hook (w
);
14827 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14828 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14829 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14833 /* Shift current matrix down by nrows_scrolled lines. */
14834 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14835 rotate_matrix (w
->current_matrix
,
14837 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14840 /* Disable lines that must be updated. */
14841 for (i
= 0; i
< nrows_scrolled
; ++i
)
14842 (start_row
+ i
)->enabled_p
= 0;
14844 /* Re-compute Y positions. */
14845 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14846 max_y
= it
.last_visible_y
;
14847 for (row
= start_row
+ nrows_scrolled
;
14851 row
->y
= it
.current_y
;
14852 row
->visible_height
= row
->height
;
14854 if (row
->y
< min_y
)
14855 row
->visible_height
-= min_y
- row
->y
;
14856 if (row
->y
+ row
->height
> max_y
)
14857 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14858 row
->redraw_fringe_bitmaps_p
= 1;
14860 it
.current_y
+= row
->height
;
14862 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14863 last_reused_text_row
= row
;
14864 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14868 /* Disable lines in the current matrix which are now
14869 below the window. */
14870 for (++row
; row
< bottom_row
; ++row
)
14871 row
->enabled_p
= row
->mode_line_p
= 0;
14874 /* Update window_end_pos etc.; last_reused_text_row is the last
14875 reused row from the current matrix containing text, if any.
14876 The value of last_text_row is the last displayed line
14877 containing text. */
14878 if (last_reused_text_row
)
14880 w
->window_end_bytepos
14881 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14883 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14885 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14886 w
->current_matrix
));
14888 else if (last_text_row
)
14890 w
->window_end_bytepos
14891 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14893 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14895 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14899 /* This window must be completely empty. */
14900 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14901 w
->window_end_pos
= make_number (Z
- ZV
);
14902 w
->window_end_vpos
= make_number (0);
14904 w
->window_end_valid
= Qnil
;
14906 /* Update hint: don't try scrolling again in update_window. */
14907 w
->desired_matrix
->no_scrolling_p
= 1;
14910 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14914 else if (CHARPOS (new_start
) > CHARPOS (start
))
14916 struct glyph_row
*pt_row
, *row
;
14917 struct glyph_row
*first_reusable_row
;
14918 struct glyph_row
*first_row_to_display
;
14920 int yb
= window_text_bottom_y (w
);
14922 /* Find the row starting at new_start, if there is one. Don't
14923 reuse a partially visible line at the end. */
14924 first_reusable_row
= start_row
;
14925 while (first_reusable_row
->enabled_p
14926 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14927 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14928 < CHARPOS (new_start
)))
14929 ++first_reusable_row
;
14931 /* Give up if there is no row to reuse. */
14932 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14933 || !first_reusable_row
->enabled_p
14934 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14935 != CHARPOS (new_start
)))
14938 /* We can reuse fully visible rows beginning with
14939 first_reusable_row to the end of the window. Set
14940 first_row_to_display to the first row that cannot be reused.
14941 Set pt_row to the row containing point, if there is any. */
14943 for (first_row_to_display
= first_reusable_row
;
14944 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14945 ++first_row_to_display
)
14947 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14948 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14949 pt_row
= first_row_to_display
;
14952 /* Start displaying at the start of first_row_to_display. */
14953 xassert (first_row_to_display
->y
< yb
);
14954 init_to_row_start (&it
, w
, first_row_to_display
);
14956 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14958 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14960 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14961 + WINDOW_HEADER_LINE_HEIGHT (w
));
14963 /* Display lines beginning with first_row_to_display in the
14964 desired matrix. Set last_text_row to the last row displayed
14965 that displays text. */
14966 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14967 if (pt_row
== NULL
)
14968 w
->cursor
.vpos
= -1;
14969 last_text_row
= NULL
;
14970 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14971 if (display_line (&it
))
14972 last_text_row
= it
.glyph_row
- 1;
14974 /* If point is in a reused row, adjust y and vpos of the cursor
14978 w
->cursor
.vpos
-= nrows_scrolled
;
14979 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14982 /* Give up if point isn't in a row displayed or reused. (This
14983 also handles the case where w->cursor.vpos < nrows_scrolled
14984 after the calls to display_line, which can happen with scroll
14985 margins. See bug#1295.) */
14986 if (w
->cursor
.vpos
< 0)
14988 clear_glyph_matrix (w
->desired_matrix
);
14992 /* Scroll the display. */
14993 run
.current_y
= first_reusable_row
->y
;
14994 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14995 run
.height
= it
.last_visible_y
- run
.current_y
;
14996 dy
= run
.current_y
- run
.desired_y
;
15001 FRAME_RIF (f
)->update_window_begin_hook (w
);
15002 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15003 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15004 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15008 /* Adjust Y positions of reused rows. */
15009 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15010 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15011 max_y
= it
.last_visible_y
;
15012 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15015 row
->visible_height
= row
->height
;
15016 if (row
->y
< min_y
)
15017 row
->visible_height
-= min_y
- row
->y
;
15018 if (row
->y
+ row
->height
> max_y
)
15019 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15020 row
->redraw_fringe_bitmaps_p
= 1;
15023 /* Scroll the current matrix. */
15024 xassert (nrows_scrolled
> 0);
15025 rotate_matrix (w
->current_matrix
,
15027 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15030 /* Disable rows not reused. */
15031 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15032 row
->enabled_p
= 0;
15034 /* Point may have moved to a different line, so we cannot assume that
15035 the previous cursor position is valid; locate the correct row. */
15038 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15039 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15043 w
->cursor
.y
= row
->y
;
15045 if (row
< bottom_row
)
15047 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15048 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15050 /* Can't use this optimization with bidi-reordered glyph
15051 rows, unless cursor is already at point. */
15052 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15054 if (!(w
->cursor
.hpos
>= 0
15055 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15056 && BUFFERP (glyph
->object
)
15057 && glyph
->charpos
== PT
))
15062 && (!BUFFERP (glyph
->object
)
15063 || glyph
->charpos
< PT
);
15067 w
->cursor
.x
+= glyph
->pixel_width
;
15072 /* Adjust window end. A null value of last_text_row means that
15073 the window end is in reused rows which in turn means that
15074 only its vpos can have changed. */
15077 w
->window_end_bytepos
15078 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15080 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15082 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15087 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15090 w
->window_end_valid
= Qnil
;
15091 w
->desired_matrix
->no_scrolling_p
= 1;
15094 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15104 /************************************************************************
15105 Window redisplay reusing current matrix when buffer has changed
15106 ************************************************************************/
15108 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15109 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15111 static struct glyph_row
*
15112 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15113 struct glyph_row
*);
15116 /* Return the last row in MATRIX displaying text. If row START is
15117 non-null, start searching with that row. IT gives the dimensions
15118 of the display. Value is null if matrix is empty; otherwise it is
15119 a pointer to the row found. */
15121 static struct glyph_row
*
15122 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15123 struct glyph_row
*start
)
15125 struct glyph_row
*row
, *row_found
;
15127 /* Set row_found to the last row in IT->w's current matrix
15128 displaying text. The loop looks funny but think of partially
15131 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15132 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15134 xassert (row
->enabled_p
);
15136 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15145 /* Return the last row in the current matrix of W that is not affected
15146 by changes at the start of current_buffer that occurred since W's
15147 current matrix was built. Value is null if no such row exists.
15149 BEG_UNCHANGED us the number of characters unchanged at the start of
15150 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15151 first changed character in current_buffer. Characters at positions <
15152 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15153 when the current matrix was built. */
15155 static struct glyph_row
*
15156 find_last_unchanged_at_beg_row (struct window
*w
)
15158 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15159 struct glyph_row
*row
;
15160 struct glyph_row
*row_found
= NULL
;
15161 int yb
= window_text_bottom_y (w
);
15163 /* Find the last row displaying unchanged text. */
15164 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15165 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15166 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15169 if (/* If row ends before first_changed_pos, it is unchanged,
15170 except in some case. */
15171 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15172 /* When row ends in ZV and we write at ZV it is not
15174 && !row
->ends_at_zv_p
15175 /* When first_changed_pos is the end of a continued line,
15176 row is not unchanged because it may be no longer
15178 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15179 && (row
->continued_p
15180 || row
->exact_window_width_line_p
)))
15183 /* Stop if last visible row. */
15184 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15192 /* Find the first glyph row in the current matrix of W that is not
15193 affected by changes at the end of current_buffer since the
15194 time W's current matrix was built.
15196 Return in *DELTA the number of chars by which buffer positions in
15197 unchanged text at the end of current_buffer must be adjusted.
15199 Return in *DELTA_BYTES the corresponding number of bytes.
15201 Value is null if no such row exists, i.e. all rows are affected by
15204 static struct glyph_row
*
15205 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15207 struct glyph_row
*row
;
15208 struct glyph_row
*row_found
= NULL
;
15210 *delta
= *delta_bytes
= 0;
15212 /* Display must not have been paused, otherwise the current matrix
15213 is not up to date. */
15214 eassert (!NILP (w
->window_end_valid
));
15216 /* A value of window_end_pos >= END_UNCHANGED means that the window
15217 end is in the range of changed text. If so, there is no
15218 unchanged row at the end of W's current matrix. */
15219 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15222 /* Set row to the last row in W's current matrix displaying text. */
15223 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15225 /* If matrix is entirely empty, no unchanged row exists. */
15226 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15228 /* The value of row is the last glyph row in the matrix having a
15229 meaningful buffer position in it. The end position of row
15230 corresponds to window_end_pos. This allows us to translate
15231 buffer positions in the current matrix to current buffer
15232 positions for characters not in changed text. */
15233 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15234 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15235 int last_unchanged_pos
, last_unchanged_pos_old
;
15236 struct glyph_row
*first_text_row
15237 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15239 *delta
= Z
- Z_old
;
15240 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15242 /* Set last_unchanged_pos to the buffer position of the last
15243 character in the buffer that has not been changed. Z is the
15244 index + 1 of the last character in current_buffer, i.e. by
15245 subtracting END_UNCHANGED we get the index of the last
15246 unchanged character, and we have to add BEG to get its buffer
15248 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15249 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15251 /* Search backward from ROW for a row displaying a line that
15252 starts at a minimum position >= last_unchanged_pos_old. */
15253 for (; row
> first_text_row
; --row
)
15255 /* This used to abort, but it can happen.
15256 It is ok to just stop the search instead here. KFS. */
15257 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15260 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15265 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15271 /* Make sure that glyph rows in the current matrix of window W
15272 reference the same glyph memory as corresponding rows in the
15273 frame's frame matrix. This function is called after scrolling W's
15274 current matrix on a terminal frame in try_window_id and
15275 try_window_reusing_current_matrix. */
15278 sync_frame_with_window_matrix_rows (struct window
*w
)
15280 struct frame
*f
= XFRAME (w
->frame
);
15281 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15283 /* Preconditions: W must be a leaf window and full-width. Its frame
15284 must have a frame matrix. */
15285 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15286 xassert (WINDOW_FULL_WIDTH_P (w
));
15287 xassert (!FRAME_WINDOW_P (f
));
15289 /* If W is a full-width window, glyph pointers in W's current matrix
15290 have, by definition, to be the same as glyph pointers in the
15291 corresponding frame matrix. Note that frame matrices have no
15292 marginal areas (see build_frame_matrix). */
15293 window_row
= w
->current_matrix
->rows
;
15294 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15295 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15296 while (window_row
< window_row_end
)
15298 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15299 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15301 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15302 frame_row
->glyphs
[TEXT_AREA
] = start
;
15303 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15304 frame_row
->glyphs
[LAST_AREA
] = end
;
15306 /* Disable frame rows whose corresponding window rows have
15307 been disabled in try_window_id. */
15308 if (!window_row
->enabled_p
)
15309 frame_row
->enabled_p
= 0;
15311 ++window_row
, ++frame_row
;
15316 /* Find the glyph row in window W containing CHARPOS. Consider all
15317 rows between START and END (not inclusive). END null means search
15318 all rows to the end of the display area of W. Value is the row
15319 containing CHARPOS or null. */
15322 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15323 struct glyph_row
*end
, int dy
)
15325 struct glyph_row
*row
= start
;
15326 struct glyph_row
*best_row
= NULL
;
15327 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15330 /* If we happen to start on a header-line, skip that. */
15331 if (row
->mode_line_p
)
15334 if ((end
&& row
>= end
) || !row
->enabled_p
)
15337 last_y
= window_text_bottom_y (w
) - dy
;
15341 /* Give up if we have gone too far. */
15342 if (end
&& row
>= end
)
15344 /* This formerly returned if they were equal.
15345 I think that both quantities are of a "last plus one" type;
15346 if so, when they are equal, the row is within the screen. -- rms. */
15347 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15350 /* If it is in this row, return this row. */
15351 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15352 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15353 /* The end position of a row equals the start
15354 position of the next row. If CHARPOS is there, we
15355 would rather display it in the next line, except
15356 when this line ends in ZV. */
15357 && !row
->ends_at_zv_p
15358 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15359 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15363 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15365 /* In bidi-reordered rows, there could be several rows
15366 occluding point. We need to find the one which fits
15367 CHARPOS the best. */
15368 for (g
= row
->glyphs
[TEXT_AREA
];
15369 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15372 if (!STRINGP (g
->object
))
15374 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15376 mindif
= eabs (g
->charpos
- charpos
);
15389 /* Try to redisplay window W by reusing its existing display. W's
15390 current matrix must be up to date when this function is called,
15391 i.e. window_end_valid must not be nil.
15395 1 if display has been updated
15396 0 if otherwise unsuccessful
15397 -1 if redisplay with same window start is known not to succeed
15399 The following steps are performed:
15401 1. Find the last row in the current matrix of W that is not
15402 affected by changes at the start of current_buffer. If no such row
15405 2. Find the first row in W's current matrix that is not affected by
15406 changes at the end of current_buffer. Maybe there is no such row.
15408 3. Display lines beginning with the row + 1 found in step 1 to the
15409 row found in step 2 or, if step 2 didn't find a row, to the end of
15412 4. If cursor is not known to appear on the window, give up.
15414 5. If display stopped at the row found in step 2, scroll the
15415 display and current matrix as needed.
15417 6. Maybe display some lines at the end of W, if we must. This can
15418 happen under various circumstances, like a partially visible line
15419 becoming fully visible, or because newly displayed lines are displayed
15420 in smaller font sizes.
15422 7. Update W's window end information. */
15425 try_window_id (struct window
*w
)
15427 struct frame
*f
= XFRAME (w
->frame
);
15428 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15429 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15430 struct glyph_row
*last_unchanged_at_beg_row
;
15431 struct glyph_row
*first_unchanged_at_end_row
;
15432 struct glyph_row
*row
;
15433 struct glyph_row
*bottom_row
;
15436 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15437 struct text_pos start_pos
;
15439 int first_unchanged_at_end_vpos
= 0;
15440 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15441 struct text_pos start
;
15442 int first_changed_charpos
, last_changed_charpos
;
15445 if (inhibit_try_window_id
)
15449 /* This is handy for debugging. */
15451 #define GIVE_UP(X) \
15453 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15457 #define GIVE_UP(X) return 0
15460 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15462 /* Don't use this for mini-windows because these can show
15463 messages and mini-buffers, and we don't handle that here. */
15464 if (MINI_WINDOW_P (w
))
15467 /* This flag is used to prevent redisplay optimizations. */
15468 if (windows_or_buffers_changed
|| cursor_type_changed
)
15471 /* Verify that narrowing has not changed.
15472 Also verify that we were not told to prevent redisplay optimizations.
15473 It would be nice to further
15474 reduce the number of cases where this prevents try_window_id. */
15475 if (current_buffer
->clip_changed
15476 || current_buffer
->prevent_redisplay_optimizations_p
)
15479 /* Window must either use window-based redisplay or be full width. */
15480 if (!FRAME_WINDOW_P (f
)
15481 && (!FRAME_LINE_INS_DEL_OK (f
)
15482 || !WINDOW_FULL_WIDTH_P (w
)))
15485 /* Give up if point is known NOT to appear in W. */
15486 if (PT
< CHARPOS (start
))
15489 /* Another way to prevent redisplay optimizations. */
15490 if (XFASTINT (w
->last_modified
) == 0)
15493 /* Verify that window is not hscrolled. */
15494 if (XFASTINT (w
->hscroll
) != 0)
15497 /* Verify that display wasn't paused. */
15498 if (NILP (w
->window_end_valid
))
15501 /* Can't use this if highlighting a region because a cursor movement
15502 will do more than just set the cursor. */
15503 if (!NILP (Vtransient_mark_mode
)
15504 && !NILP (current_buffer
->mark_active
))
15507 /* Likewise if highlighting trailing whitespace. */
15508 if (!NILP (Vshow_trailing_whitespace
))
15511 /* Likewise if showing a region. */
15512 if (!NILP (w
->region_showing
))
15515 /* Can't use this if overlay arrow position and/or string have
15517 if (overlay_arrows_changed_p ())
15520 /* When word-wrap is on, adding a space to the first word of a
15521 wrapped line can change the wrap position, altering the line
15522 above it. It might be worthwhile to handle this more
15523 intelligently, but for now just redisplay from scratch. */
15524 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15527 /* Under bidi reordering, adding or deleting a character in the
15528 beginning of a paragraph, before the first strong directional
15529 character, can change the base direction of the paragraph (unless
15530 the buffer specifies a fixed paragraph direction), which will
15531 require to redisplay the whole paragraph. It might be worthwhile
15532 to find the paragraph limits and widen the range of redisplayed
15533 lines to that, but for now just give up this optimization and
15534 redisplay from scratch. */
15535 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15536 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15539 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15540 only if buffer has really changed. The reason is that the gap is
15541 initially at Z for freshly visited files. The code below would
15542 set end_unchanged to 0 in that case. */
15543 if (MODIFF
> SAVE_MODIFF
15544 /* This seems to happen sometimes after saving a buffer. */
15545 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15547 if (GPT
- BEG
< BEG_UNCHANGED
)
15548 BEG_UNCHANGED
= GPT
- BEG
;
15549 if (Z
- GPT
< END_UNCHANGED
)
15550 END_UNCHANGED
= Z
- GPT
;
15553 /* The position of the first and last character that has been changed. */
15554 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15555 last_changed_charpos
= Z
- END_UNCHANGED
;
15557 /* If window starts after a line end, and the last change is in
15558 front of that newline, then changes don't affect the display.
15559 This case happens with stealth-fontification. Note that although
15560 the display is unchanged, glyph positions in the matrix have to
15561 be adjusted, of course. */
15562 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15563 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15564 && ((last_changed_charpos
< CHARPOS (start
)
15565 && CHARPOS (start
) == BEGV
)
15566 || (last_changed_charpos
< CHARPOS (start
) - 1
15567 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15569 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15570 struct glyph_row
*r0
;
15572 /* Compute how many chars/bytes have been added to or removed
15573 from the buffer. */
15574 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15575 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15577 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15579 /* Give up if PT is not in the window. Note that it already has
15580 been checked at the start of try_window_id that PT is not in
15581 front of the window start. */
15582 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15585 /* If window start is unchanged, we can reuse the whole matrix
15586 as is, after adjusting glyph positions. No need to compute
15587 the window end again, since its offset from Z hasn't changed. */
15588 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15589 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15590 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15591 /* PT must not be in a partially visible line. */
15592 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15593 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15595 /* Adjust positions in the glyph matrix. */
15596 if (delta
|| delta_bytes
)
15598 struct glyph_row
*r1
15599 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15600 increment_matrix_positions (w
->current_matrix
,
15601 MATRIX_ROW_VPOS (r0
, current_matrix
),
15602 MATRIX_ROW_VPOS (r1
, current_matrix
),
15603 delta
, delta_bytes
);
15606 /* Set the cursor. */
15607 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15609 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15616 /* Handle the case that changes are all below what is displayed in
15617 the window, and that PT is in the window. This shortcut cannot
15618 be taken if ZV is visible in the window, and text has been added
15619 there that is visible in the window. */
15620 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15621 /* ZV is not visible in the window, or there are no
15622 changes at ZV, actually. */
15623 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15624 || first_changed_charpos
== last_changed_charpos
))
15626 struct glyph_row
*r0
;
15628 /* Give up if PT is not in the window. Note that it already has
15629 been checked at the start of try_window_id that PT is not in
15630 front of the window start. */
15631 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15634 /* If window start is unchanged, we can reuse the whole matrix
15635 as is, without changing glyph positions since no text has
15636 been added/removed in front of the window end. */
15637 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15638 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15639 /* PT must not be in a partially visible line. */
15640 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15641 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15643 /* We have to compute the window end anew since text
15644 could have been added/removed after it. */
15646 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15647 w
->window_end_bytepos
15648 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15650 /* Set the cursor. */
15651 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15653 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15660 /* Give up if window start is in the changed area.
15662 The condition used to read
15664 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15666 but why that was tested escapes me at the moment. */
15667 if (CHARPOS (start
) >= first_changed_charpos
15668 && CHARPOS (start
) <= last_changed_charpos
)
15671 /* Check that window start agrees with the start of the first glyph
15672 row in its current matrix. Check this after we know the window
15673 start is not in changed text, otherwise positions would not be
15675 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15676 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15679 /* Give up if the window ends in strings. Overlay strings
15680 at the end are difficult to handle, so don't try. */
15681 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15682 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15685 /* Compute the position at which we have to start displaying new
15686 lines. Some of the lines at the top of the window might be
15687 reusable because they are not displaying changed text. Find the
15688 last row in W's current matrix not affected by changes at the
15689 start of current_buffer. Value is null if changes start in the
15690 first line of window. */
15691 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15692 if (last_unchanged_at_beg_row
)
15694 /* Avoid starting to display in the moddle of a character, a TAB
15695 for instance. This is easier than to set up the iterator
15696 exactly, and it's not a frequent case, so the additional
15697 effort wouldn't really pay off. */
15698 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15699 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15700 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15701 --last_unchanged_at_beg_row
;
15703 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15706 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15708 start_pos
= it
.current
.pos
;
15710 /* Start displaying new lines in the desired matrix at the same
15711 vpos we would use in the current matrix, i.e. below
15712 last_unchanged_at_beg_row. */
15713 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15715 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15716 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15718 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15722 /* There are no reusable lines at the start of the window.
15723 Start displaying in the first text line. */
15724 start_display (&it
, w
, start
);
15725 it
.vpos
= it
.first_vpos
;
15726 start_pos
= it
.current
.pos
;
15729 /* Find the first row that is not affected by changes at the end of
15730 the buffer. Value will be null if there is no unchanged row, in
15731 which case we must redisplay to the end of the window. delta
15732 will be set to the value by which buffer positions beginning with
15733 first_unchanged_at_end_row have to be adjusted due to text
15735 first_unchanged_at_end_row
15736 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15737 IF_DEBUG (debug_delta
= delta
);
15738 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15740 /* Set stop_pos to the buffer position up to which we will have to
15741 display new lines. If first_unchanged_at_end_row != NULL, this
15742 is the buffer position of the start of the line displayed in that
15743 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15744 that we don't stop at a buffer position. */
15746 if (first_unchanged_at_end_row
)
15748 xassert (last_unchanged_at_beg_row
== NULL
15749 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15751 /* If this is a continuation line, move forward to the next one
15752 that isn't. Changes in lines above affect this line.
15753 Caution: this may move first_unchanged_at_end_row to a row
15754 not displaying text. */
15755 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15756 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15757 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15758 < it
.last_visible_y
))
15759 ++first_unchanged_at_end_row
;
15761 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15762 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15763 >= it
.last_visible_y
))
15764 first_unchanged_at_end_row
= NULL
;
15767 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15769 first_unchanged_at_end_vpos
15770 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15771 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15774 else if (last_unchanged_at_beg_row
== NULL
)
15780 /* Either there is no unchanged row at the end, or the one we have
15781 now displays text. This is a necessary condition for the window
15782 end pos calculation at the end of this function. */
15783 xassert (first_unchanged_at_end_row
== NULL
15784 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15786 debug_last_unchanged_at_beg_vpos
15787 = (last_unchanged_at_beg_row
15788 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15790 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15792 #endif /* GLYPH_DEBUG != 0 */
15795 /* Display new lines. Set last_text_row to the last new line
15796 displayed which has text on it, i.e. might end up as being the
15797 line where the window_end_vpos is. */
15798 w
->cursor
.vpos
= -1;
15799 last_text_row
= NULL
;
15800 overlay_arrow_seen
= 0;
15801 while (it
.current_y
< it
.last_visible_y
15802 && !fonts_changed_p
15803 && (first_unchanged_at_end_row
== NULL
15804 || IT_CHARPOS (it
) < stop_pos
))
15806 if (display_line (&it
))
15807 last_text_row
= it
.glyph_row
- 1;
15810 if (fonts_changed_p
)
15814 /* Compute differences in buffer positions, y-positions etc. for
15815 lines reused at the bottom of the window. Compute what we can
15817 if (first_unchanged_at_end_row
15818 /* No lines reused because we displayed everything up to the
15819 bottom of the window. */
15820 && it
.current_y
< it
.last_visible_y
)
15823 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15825 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15826 run
.current_y
= first_unchanged_at_end_row
->y
;
15827 run
.desired_y
= run
.current_y
+ dy
;
15828 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15832 delta
= delta_bytes
= dvpos
= dy
15833 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15834 first_unchanged_at_end_row
= NULL
;
15836 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15839 /* Find the cursor if not already found. We have to decide whether
15840 PT will appear on this window (it sometimes doesn't, but this is
15841 not a very frequent case.) This decision has to be made before
15842 the current matrix is altered. A value of cursor.vpos < 0 means
15843 that PT is either in one of the lines beginning at
15844 first_unchanged_at_end_row or below the window. Don't care for
15845 lines that might be displayed later at the window end; as
15846 mentioned, this is not a frequent case. */
15847 if (w
->cursor
.vpos
< 0)
15849 /* Cursor in unchanged rows at the top? */
15850 if (PT
< CHARPOS (start_pos
)
15851 && last_unchanged_at_beg_row
)
15853 row
= row_containing_pos (w
, PT
,
15854 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15855 last_unchanged_at_beg_row
+ 1, 0);
15857 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15860 /* Start from first_unchanged_at_end_row looking for PT. */
15861 else if (first_unchanged_at_end_row
)
15863 row
= row_containing_pos (w
, PT
- delta
,
15864 first_unchanged_at_end_row
, NULL
, 0);
15866 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15867 delta_bytes
, dy
, dvpos
);
15870 /* Give up if cursor was not found. */
15871 if (w
->cursor
.vpos
< 0)
15873 clear_glyph_matrix (w
->desired_matrix
);
15878 /* Don't let the cursor end in the scroll margins. */
15880 int this_scroll_margin
, cursor_height
;
15882 this_scroll_margin
= max (0, scroll_margin
);
15883 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15884 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15885 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15887 if ((w
->cursor
.y
< this_scroll_margin
15888 && CHARPOS (start
) > BEGV
)
15889 /* Old redisplay didn't take scroll margin into account at the bottom,
15890 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15891 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15892 ? cursor_height
+ this_scroll_margin
15893 : 1)) > it
.last_visible_y
)
15895 w
->cursor
.vpos
= -1;
15896 clear_glyph_matrix (w
->desired_matrix
);
15901 /* Scroll the display. Do it before changing the current matrix so
15902 that xterm.c doesn't get confused about where the cursor glyph is
15904 if (dy
&& run
.height
)
15908 if (FRAME_WINDOW_P (f
))
15910 FRAME_RIF (f
)->update_window_begin_hook (w
);
15911 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15912 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15913 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15917 /* Terminal frame. In this case, dvpos gives the number of
15918 lines to scroll by; dvpos < 0 means scroll up. */
15919 int first_unchanged_at_end_vpos
15920 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15921 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15922 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15923 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15924 + window_internal_height (w
));
15926 /* Perform the operation on the screen. */
15929 /* Scroll last_unchanged_at_beg_row to the end of the
15930 window down dvpos lines. */
15931 set_terminal_window (f
, end
);
15933 /* On dumb terminals delete dvpos lines at the end
15934 before inserting dvpos empty lines. */
15935 if (!FRAME_SCROLL_REGION_OK (f
))
15936 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15938 /* Insert dvpos empty lines in front of
15939 last_unchanged_at_beg_row. */
15940 ins_del_lines (f
, from
, dvpos
);
15942 else if (dvpos
< 0)
15944 /* Scroll up last_unchanged_at_beg_vpos to the end of
15945 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15946 set_terminal_window (f
, end
);
15948 /* Delete dvpos lines in front of
15949 last_unchanged_at_beg_vpos. ins_del_lines will set
15950 the cursor to the given vpos and emit |dvpos| delete
15952 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15954 /* On a dumb terminal insert dvpos empty lines at the
15956 if (!FRAME_SCROLL_REGION_OK (f
))
15957 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15960 set_terminal_window (f
, 0);
15966 /* Shift reused rows of the current matrix to the right position.
15967 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15969 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15970 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15973 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15974 bottom_vpos
, dvpos
);
15975 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15978 else if (dvpos
> 0)
15980 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15981 bottom_vpos
, dvpos
);
15982 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15983 first_unchanged_at_end_vpos
+ dvpos
, 0);
15986 /* For frame-based redisplay, make sure that current frame and window
15987 matrix are in sync with respect to glyph memory. */
15988 if (!FRAME_WINDOW_P (f
))
15989 sync_frame_with_window_matrix_rows (w
);
15991 /* Adjust buffer positions in reused rows. */
15992 if (delta
|| delta_bytes
)
15993 increment_matrix_positions (current_matrix
,
15994 first_unchanged_at_end_vpos
+ dvpos
,
15995 bottom_vpos
, delta
, delta_bytes
);
15997 /* Adjust Y positions. */
15999 shift_glyph_matrix (w
, current_matrix
,
16000 first_unchanged_at_end_vpos
+ dvpos
,
16003 if (first_unchanged_at_end_row
)
16005 first_unchanged_at_end_row
+= dvpos
;
16006 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16007 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16008 first_unchanged_at_end_row
= NULL
;
16011 /* If scrolling up, there may be some lines to display at the end of
16013 last_text_row_at_end
= NULL
;
16016 /* Scrolling up can leave for example a partially visible line
16017 at the end of the window to be redisplayed. */
16018 /* Set last_row to the glyph row in the current matrix where the
16019 window end line is found. It has been moved up or down in
16020 the matrix by dvpos. */
16021 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16022 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16024 /* If last_row is the window end line, it should display text. */
16025 xassert (last_row
->displays_text_p
);
16027 /* If window end line was partially visible before, begin
16028 displaying at that line. Otherwise begin displaying with the
16029 line following it. */
16030 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16032 init_to_row_start (&it
, w
, last_row
);
16033 it
.vpos
= last_vpos
;
16034 it
.current_y
= last_row
->y
;
16038 init_to_row_end (&it
, w
, last_row
);
16039 it
.vpos
= 1 + last_vpos
;
16040 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16044 /* We may start in a continuation line. If so, we have to
16045 get the right continuation_lines_width and current_x. */
16046 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16047 it
.hpos
= it
.current_x
= 0;
16049 /* Display the rest of the lines at the window end. */
16050 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16051 while (it
.current_y
< it
.last_visible_y
16052 && !fonts_changed_p
)
16054 /* Is it always sure that the display agrees with lines in
16055 the current matrix? I don't think so, so we mark rows
16056 displayed invalid in the current matrix by setting their
16057 enabled_p flag to zero. */
16058 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16059 if (display_line (&it
))
16060 last_text_row_at_end
= it
.glyph_row
- 1;
16064 /* Update window_end_pos and window_end_vpos. */
16065 if (first_unchanged_at_end_row
16066 && !last_text_row_at_end
)
16068 /* Window end line if one of the preserved rows from the current
16069 matrix. Set row to the last row displaying text in current
16070 matrix starting at first_unchanged_at_end_row, after
16072 xassert (first_unchanged_at_end_row
->displays_text_p
);
16073 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16074 first_unchanged_at_end_row
);
16075 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16077 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16078 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16080 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16081 xassert (w
->window_end_bytepos
>= 0);
16082 IF_DEBUG (debug_method_add (w
, "A"));
16084 else if (last_text_row_at_end
)
16087 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16088 w
->window_end_bytepos
16089 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16091 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16092 xassert (w
->window_end_bytepos
>= 0);
16093 IF_DEBUG (debug_method_add (w
, "B"));
16095 else if (last_text_row
)
16097 /* We have displayed either to the end of the window or at the
16098 end of the window, i.e. the last row with text is to be found
16099 in the desired matrix. */
16101 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16102 w
->window_end_bytepos
16103 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16105 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16106 xassert (w
->window_end_bytepos
>= 0);
16108 else if (first_unchanged_at_end_row
== NULL
16109 && last_text_row
== NULL
16110 && last_text_row_at_end
== NULL
)
16112 /* Displayed to end of window, but no line containing text was
16113 displayed. Lines were deleted at the end of the window. */
16114 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16115 int vpos
= XFASTINT (w
->window_end_vpos
);
16116 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16117 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16120 row
== NULL
&& vpos
>= first_vpos
;
16121 --vpos
, --current_row
, --desired_row
)
16123 if (desired_row
->enabled_p
)
16125 if (desired_row
->displays_text_p
)
16128 else if (current_row
->displays_text_p
)
16132 xassert (row
!= NULL
);
16133 w
->window_end_vpos
= make_number (vpos
+ 1);
16134 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16135 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16136 xassert (w
->window_end_bytepos
>= 0);
16137 IF_DEBUG (debug_method_add (w
, "C"));
16142 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16143 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16145 /* Record that display has not been completed. */
16146 w
->window_end_valid
= Qnil
;
16147 w
->desired_matrix
->no_scrolling_p
= 1;
16155 /***********************************************************************
16156 More debugging support
16157 ***********************************************************************/
16161 void dump_glyph_row (struct glyph_row
*, int, int);
16162 void dump_glyph_matrix (struct glyph_matrix
*, int);
16163 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16166 /* Dump the contents of glyph matrix MATRIX on stderr.
16168 GLYPHS 0 means don't show glyph contents.
16169 GLYPHS 1 means show glyphs in short form
16170 GLYPHS > 1 means show glyphs in long form. */
16173 dump_glyph_matrix (matrix
, glyphs
)
16174 struct glyph_matrix
*matrix
;
16178 for (i
= 0; i
< matrix
->nrows
; ++i
)
16179 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16183 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16184 the glyph row and area where the glyph comes from. */
16187 dump_glyph (row
, glyph
, area
)
16188 struct glyph_row
*row
;
16189 struct glyph
*glyph
;
16192 if (glyph
->type
== CHAR_GLYPH
)
16195 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16196 glyph
- row
->glyphs
[TEXT_AREA
],
16199 (BUFFERP (glyph
->object
)
16201 : (STRINGP (glyph
->object
)
16204 glyph
->pixel_width
,
16206 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16210 glyph
->left_box_line_p
,
16211 glyph
->right_box_line_p
);
16213 else if (glyph
->type
== STRETCH_GLYPH
)
16216 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16217 glyph
- row
->glyphs
[TEXT_AREA
],
16220 (BUFFERP (glyph
->object
)
16222 : (STRINGP (glyph
->object
)
16225 glyph
->pixel_width
,
16229 glyph
->left_box_line_p
,
16230 glyph
->right_box_line_p
);
16232 else if (glyph
->type
== IMAGE_GLYPH
)
16235 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16236 glyph
- row
->glyphs
[TEXT_AREA
],
16239 (BUFFERP (glyph
->object
)
16241 : (STRINGP (glyph
->object
)
16244 glyph
->pixel_width
,
16248 glyph
->left_box_line_p
,
16249 glyph
->right_box_line_p
);
16251 else if (glyph
->type
== COMPOSITE_GLYPH
)
16254 " %5d %4c %6d %c %3d 0x%05x",
16255 glyph
- row
->glyphs
[TEXT_AREA
],
16258 (BUFFERP (glyph
->object
)
16260 : (STRINGP (glyph
->object
)
16263 glyph
->pixel_width
,
16265 if (glyph
->u
.cmp
.automatic
)
16268 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16269 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16271 glyph
->left_box_line_p
,
16272 glyph
->right_box_line_p
);
16277 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16278 GLYPHS 0 means don't show glyph contents.
16279 GLYPHS 1 means show glyphs in short form
16280 GLYPHS > 1 means show glyphs in long form. */
16283 dump_glyph_row (row
, vpos
, glyphs
)
16284 struct glyph_row
*row
;
16289 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16290 fprintf (stderr
, "======================================================================\n");
16292 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16293 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16295 MATRIX_ROW_START_CHARPOS (row
),
16296 MATRIX_ROW_END_CHARPOS (row
),
16297 row
->used
[TEXT_AREA
],
16298 row
->contains_overlapping_glyphs_p
,
16300 row
->truncated_on_left_p
,
16301 row
->truncated_on_right_p
,
16303 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16304 row
->displays_text_p
,
16307 row
->ends_in_middle_of_char_p
,
16308 row
->starts_in_middle_of_char_p
,
16314 row
->visible_height
,
16317 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16318 row
->end
.overlay_string_index
,
16319 row
->continuation_lines_width
);
16320 fprintf (stderr
, "%9d %5d\n",
16321 CHARPOS (row
->start
.string_pos
),
16322 CHARPOS (row
->end
.string_pos
));
16323 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16324 row
->end
.dpvec_index
);
16331 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16333 struct glyph
*glyph
= row
->glyphs
[area
];
16334 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16336 /* Glyph for a line end in text. */
16337 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16340 if (glyph
< glyph_end
)
16341 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16343 for (; glyph
< glyph_end
; ++glyph
)
16344 dump_glyph (row
, glyph
, area
);
16347 else if (glyphs
== 1)
16351 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16353 char *s
= (char *) alloca (row
->used
[area
] + 1);
16356 for (i
= 0; i
< row
->used
[area
]; ++i
)
16358 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16359 if (glyph
->type
== CHAR_GLYPH
16360 && glyph
->u
.ch
< 0x80
16361 && glyph
->u
.ch
>= ' ')
16362 s
[i
] = glyph
->u
.ch
;
16368 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16374 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16375 Sdump_glyph_matrix
, 0, 1, "p",
16376 doc
: /* Dump the current matrix of the selected window to stderr.
16377 Shows contents of glyph row structures. With non-nil
16378 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16379 glyphs in short form, otherwise show glyphs in long form. */)
16380 (Lisp_Object glyphs
)
16382 struct window
*w
= XWINDOW (selected_window
);
16383 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16385 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16386 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16387 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16388 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16389 fprintf (stderr
, "=============================================\n");
16390 dump_glyph_matrix (w
->current_matrix
,
16391 NILP (glyphs
) ? 0 : XINT (glyphs
));
16396 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16397 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16400 struct frame
*f
= XFRAME (selected_frame
);
16401 dump_glyph_matrix (f
->current_matrix
, 1);
16406 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16407 doc
: /* Dump glyph row ROW to stderr.
16408 GLYPH 0 means don't dump glyphs.
16409 GLYPH 1 means dump glyphs in short form.
16410 GLYPH > 1 or omitted means dump glyphs in long form. */)
16411 (Lisp_Object row
, Lisp_Object 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. */)
16432 (Lisp_Object row
, Lisp_Object glyphs
)
16434 struct frame
*sf
= SELECTED_FRAME ();
16435 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16438 CHECK_NUMBER (row
);
16440 if (vpos
>= 0 && vpos
< m
->nrows
)
16441 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16442 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16447 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16448 doc
: /* Toggle tracing of redisplay.
16449 With ARG, turn tracing on if and only if ARG is positive. */)
16453 trace_redisplay_p
= !trace_redisplay_p
;
16456 arg
= Fprefix_numeric_value (arg
);
16457 trace_redisplay_p
= XINT (arg
) > 0;
16464 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16465 doc
: /* Like `format', but print result to stderr.
16466 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16467 (int nargs
, Lisp_Object
*args
)
16469 Lisp_Object s
= Fformat (nargs
, args
);
16470 fprintf (stderr
, "%s", SDATA (s
));
16474 #endif /* GLYPH_DEBUG */
16478 /***********************************************************************
16479 Building Desired Matrix Rows
16480 ***********************************************************************/
16482 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16483 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16485 static struct glyph_row
*
16486 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16488 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16489 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16490 struct buffer
*old
= current_buffer
;
16491 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16492 int arrow_len
= SCHARS (overlay_arrow_string
);
16493 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16494 const unsigned char *p
;
16497 int n_glyphs_before
;
16499 set_buffer_temp (buffer
);
16500 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16501 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16502 SET_TEXT_POS (it
.position
, 0, 0);
16504 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16506 while (p
< arrow_end
)
16508 Lisp_Object face
, ilisp
;
16510 /* Get the next character. */
16512 it
.c
= string_char_and_length (p
, &it
.len
);
16514 it
.c
= *p
, it
.len
= 1;
16517 /* Get its face. */
16518 ilisp
= make_number (p
- arrow_string
);
16519 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16520 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16522 /* Compute its width, get its glyphs. */
16523 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16524 SET_TEXT_POS (it
.position
, -1, -1);
16525 PRODUCE_GLYPHS (&it
);
16527 /* If this character doesn't fit any more in the line, we have
16528 to remove some glyphs. */
16529 if (it
.current_x
> it
.last_visible_x
)
16531 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16536 set_buffer_temp (old
);
16537 return it
.glyph_row
;
16541 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16542 glyphs are only inserted for terminal frames since we can't really
16543 win with truncation glyphs when partially visible glyphs are
16544 involved. Which glyphs to insert is determined by
16545 produce_special_glyphs. */
16548 insert_left_trunc_glyphs (struct it
*it
)
16550 struct it truncate_it
;
16551 struct glyph
*from
, *end
, *to
, *toend
;
16553 xassert (!FRAME_WINDOW_P (it
->f
));
16555 /* Get the truncation glyphs. */
16557 truncate_it
.current_x
= 0;
16558 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16559 truncate_it
.glyph_row
= &scratch_glyph_row
;
16560 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16561 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16562 truncate_it
.object
= make_number (0);
16563 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16565 /* Overwrite glyphs from IT with truncation glyphs. */
16566 if (!it
->glyph_row
->reversed_p
)
16568 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16569 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16570 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16571 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16576 /* There may be padding glyphs left over. Overwrite them too. */
16577 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16579 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16585 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16589 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16590 that back to front. */
16591 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16592 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16593 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16594 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16596 while (from
>= end
&& to
>= toend
)
16598 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16601 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16602 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16603 while (from
>= end
&& to
>= toend
)
16608 /* Need to free some room before prepending additional
16610 int move_by
= from
- end
+ 1;
16611 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16612 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16614 for ( ; g
>= g0
; g
--)
16616 while (from
>= end
)
16618 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16624 /* Compute the pixel height and width of IT->glyph_row.
16626 Most of the time, ascent and height of a display line will be equal
16627 to the max_ascent and max_height values of the display iterator
16628 structure. This is not the case if
16630 1. We hit ZV without displaying anything. In this case, max_ascent
16631 and max_height will be zero.
16633 2. We have some glyphs that don't contribute to the line height.
16634 (The glyph row flag contributes_to_line_height_p is for future
16635 pixmap extensions).
16637 The first case is easily covered by using default values because in
16638 these cases, the line height does not really matter, except that it
16639 must not be zero. */
16642 compute_line_metrics (struct it
*it
)
16644 struct glyph_row
*row
= it
->glyph_row
;
16647 if (FRAME_WINDOW_P (it
->f
))
16649 int i
, min_y
, max_y
;
16651 /* The line may consist of one space only, that was added to
16652 place the cursor on it. If so, the row's height hasn't been
16654 if (row
->height
== 0)
16656 if (it
->max_ascent
+ it
->max_descent
== 0)
16657 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16658 row
->ascent
= it
->max_ascent
;
16659 row
->height
= it
->max_ascent
+ it
->max_descent
;
16660 row
->phys_ascent
= it
->max_phys_ascent
;
16661 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16662 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16665 /* Compute the width of this line. */
16666 row
->pixel_width
= row
->x
;
16667 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16668 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16670 xassert (row
->pixel_width
>= 0);
16671 xassert (row
->ascent
>= 0 && row
->height
> 0);
16673 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16674 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16676 /* If first line's physical ascent is larger than its logical
16677 ascent, use the physical ascent, and make the row taller.
16678 This makes accented characters fully visible. */
16679 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16680 && row
->phys_ascent
> row
->ascent
)
16682 row
->height
+= row
->phys_ascent
- row
->ascent
;
16683 row
->ascent
= row
->phys_ascent
;
16686 /* Compute how much of the line is visible. */
16687 row
->visible_height
= row
->height
;
16689 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16690 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16692 if (row
->y
< min_y
)
16693 row
->visible_height
-= min_y
- row
->y
;
16694 if (row
->y
+ row
->height
> max_y
)
16695 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16699 row
->pixel_width
= row
->used
[TEXT_AREA
];
16700 if (row
->continued_p
)
16701 row
->pixel_width
-= it
->continuation_pixel_width
;
16702 else if (row
->truncated_on_right_p
)
16703 row
->pixel_width
-= it
->truncation_pixel_width
;
16704 row
->ascent
= row
->phys_ascent
= 0;
16705 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16706 row
->extra_line_spacing
= 0;
16709 /* Compute a hash code for this row. */
16711 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16712 for (i
= 0; i
< row
->used
[area
]; ++i
)
16713 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16714 + row
->glyphs
[area
][i
].u
.val
16715 + row
->glyphs
[area
][i
].face_id
16716 + row
->glyphs
[area
][i
].padding_p
16717 + (row
->glyphs
[area
][i
].type
<< 2));
16719 it
->max_ascent
= it
->max_descent
= 0;
16720 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16724 /* Append one space to the glyph row of iterator IT if doing a
16725 window-based redisplay. The space has the same face as
16726 IT->face_id. Value is non-zero if a space was added.
16728 This function is called to make sure that there is always one glyph
16729 at the end of a glyph row that the cursor can be set on under
16730 window-systems. (If there weren't such a glyph we would not know
16731 how wide and tall a box cursor should be displayed).
16733 At the same time this space let's a nicely handle clearing to the
16734 end of the line if the row ends in italic text. */
16737 append_space_for_newline (struct it
*it
, int default_face_p
)
16739 if (FRAME_WINDOW_P (it
->f
))
16741 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16743 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16744 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16746 /* Save some values that must not be changed.
16747 Must save IT->c and IT->len because otherwise
16748 ITERATOR_AT_END_P wouldn't work anymore after
16749 append_space_for_newline has been called. */
16750 enum display_element_type saved_what
= it
->what
;
16751 int saved_c
= it
->c
, saved_len
= it
->len
;
16752 int saved_x
= it
->current_x
;
16753 int saved_face_id
= it
->face_id
;
16754 struct text_pos saved_pos
;
16755 Lisp_Object saved_object
;
16758 saved_object
= it
->object
;
16759 saved_pos
= it
->position
;
16761 it
->what
= IT_CHARACTER
;
16762 memset (&it
->position
, 0, sizeof it
->position
);
16763 it
->object
= make_number (0);
16767 if (default_face_p
)
16768 it
->face_id
= DEFAULT_FACE_ID
;
16769 else if (it
->face_before_selective_p
)
16770 it
->face_id
= it
->saved_face_id
;
16771 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16772 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16774 PRODUCE_GLYPHS (it
);
16776 it
->override_ascent
= -1;
16777 it
->constrain_row_ascent_descent_p
= 0;
16778 it
->current_x
= saved_x
;
16779 it
->object
= saved_object
;
16780 it
->position
= saved_pos
;
16781 it
->what
= saved_what
;
16782 it
->face_id
= saved_face_id
;
16783 it
->len
= saved_len
;
16793 /* Extend the face of the last glyph in the text area of IT->glyph_row
16794 to the end of the display line. Called from display_line. If the
16795 glyph row is empty, add a space glyph to it so that we know the
16796 face to draw. Set the glyph row flag fill_line_p. If the glyph
16797 row is R2L, prepend a stretch glyph to cover the empty space to the
16798 left of the leftmost glyph. */
16801 extend_face_to_end_of_line (struct it
*it
)
16804 struct frame
*f
= it
->f
;
16806 /* If line is already filled, do nothing. Non window-system frames
16807 get a grace of one more ``pixel'' because their characters are
16808 1-``pixel'' wide, so they hit the equality too early. This grace
16809 is needed only for R2L rows that are not continued, to produce
16810 one extra blank where we could display the cursor. */
16811 if (it
->current_x
>= it
->last_visible_x
16812 + (!FRAME_WINDOW_P (f
)
16813 && it
->glyph_row
->reversed_p
16814 && !it
->glyph_row
->continued_p
))
16817 /* Face extension extends the background and box of IT->face_id
16818 to the end of the line. If the background equals the background
16819 of the frame, we don't have to do anything. */
16820 if (it
->face_before_selective_p
)
16821 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16823 face
= FACE_FROM_ID (f
, it
->face_id
);
16825 if (FRAME_WINDOW_P (f
)
16826 && it
->glyph_row
->displays_text_p
16827 && face
->box
== FACE_NO_BOX
16828 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16830 && !it
->glyph_row
->reversed_p
)
16833 /* Set the glyph row flag indicating that the face of the last glyph
16834 in the text area has to be drawn to the end of the text area. */
16835 it
->glyph_row
->fill_line_p
= 1;
16837 /* If current character of IT is not ASCII, make sure we have the
16838 ASCII face. This will be automatically undone the next time
16839 get_next_display_element returns a multibyte character. Note
16840 that the character will always be single byte in unibyte
16842 if (!ASCII_CHAR_P (it
->c
))
16844 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16847 if (FRAME_WINDOW_P (f
))
16849 /* If the row is empty, add a space with the current face of IT,
16850 so that we know which face to draw. */
16851 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16853 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16854 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16855 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16857 #ifdef HAVE_WINDOW_SYSTEM
16858 if (it
->glyph_row
->reversed_p
)
16860 /* Prepend a stretch glyph to the row, such that the
16861 rightmost glyph will be drawn flushed all the way to the
16862 right margin of the window. The stretch glyph that will
16863 occupy the empty space, if any, to the left of the
16865 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16866 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16867 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16869 int row_width
, stretch_ascent
, stretch_width
;
16870 struct text_pos saved_pos
;
16871 int saved_face_id
, saved_avoid_cursor
;
16873 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16874 row_width
+= g
->pixel_width
;
16875 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16876 if (stretch_width
> 0)
16879 (((it
->ascent
+ it
->descent
)
16880 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16881 saved_pos
= it
->position
;
16882 memset (&it
->position
, 0, sizeof it
->position
);
16883 saved_avoid_cursor
= it
->avoid_cursor_p
;
16884 it
->avoid_cursor_p
= 1;
16885 saved_face_id
= it
->face_id
;
16886 /* The last row's stretch glyph should get the default
16887 face, to avoid painting the rest of the window with
16888 the region face, if the region ends at ZV. */
16889 if (it
->glyph_row
->ends_at_zv_p
)
16890 it
->face_id
= DEFAULT_FACE_ID
;
16892 it
->face_id
= face
->id
;
16893 append_stretch_glyph (it
, make_number (0), stretch_width
,
16894 it
->ascent
+ it
->descent
, stretch_ascent
);
16895 it
->position
= saved_pos
;
16896 it
->avoid_cursor_p
= saved_avoid_cursor
;
16897 it
->face_id
= saved_face_id
;
16900 #endif /* HAVE_WINDOW_SYSTEM */
16904 /* Save some values that must not be changed. */
16905 int saved_x
= it
->current_x
;
16906 struct text_pos saved_pos
;
16907 Lisp_Object saved_object
;
16908 enum display_element_type saved_what
= it
->what
;
16909 int saved_face_id
= it
->face_id
;
16911 saved_object
= it
->object
;
16912 saved_pos
= it
->position
;
16914 it
->what
= IT_CHARACTER
;
16915 memset (&it
->position
, 0, sizeof it
->position
);
16916 it
->object
= make_number (0);
16919 /* The last row's blank glyphs should get the default face, to
16920 avoid painting the rest of the window with the region face,
16921 if the region ends at ZV. */
16922 if (it
->glyph_row
->ends_at_zv_p
)
16923 it
->face_id
= DEFAULT_FACE_ID
;
16925 it
->face_id
= face
->id
;
16927 PRODUCE_GLYPHS (it
);
16929 while (it
->current_x
<= it
->last_visible_x
)
16930 PRODUCE_GLYPHS (it
);
16932 /* Don't count these blanks really. It would let us insert a left
16933 truncation glyph below and make us set the cursor on them, maybe. */
16934 it
->current_x
= saved_x
;
16935 it
->object
= saved_object
;
16936 it
->position
= saved_pos
;
16937 it
->what
= saved_what
;
16938 it
->face_id
= saved_face_id
;
16943 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16944 trailing whitespace. */
16947 trailing_whitespace_p (int charpos
)
16949 int bytepos
= CHAR_TO_BYTE (charpos
);
16952 while (bytepos
< ZV_BYTE
16953 && (c
= FETCH_CHAR (bytepos
),
16954 c
== ' ' || c
== '\t'))
16957 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16959 if (bytepos
!= PT_BYTE
)
16966 /* Highlight trailing whitespace, if any, in ROW. */
16969 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16971 int used
= row
->used
[TEXT_AREA
];
16975 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16976 struct glyph
*glyph
= start
+ used
- 1;
16978 if (row
->reversed_p
)
16980 /* Right-to-left rows need to be processed in the opposite
16981 direction, so swap the edge pointers. */
16983 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16986 /* Skip over glyphs inserted to display the cursor at the
16987 end of a line, for extending the face of the last glyph
16988 to the end of the line on terminals, and for truncation
16989 and continuation glyphs. */
16990 if (!row
->reversed_p
)
16992 while (glyph
>= start
16993 && glyph
->type
== CHAR_GLYPH
16994 && INTEGERP (glyph
->object
))
16999 while (glyph
<= start
17000 && glyph
->type
== CHAR_GLYPH
17001 && INTEGERP (glyph
->object
))
17005 /* If last glyph is a space or stretch, and it's trailing
17006 whitespace, set the face of all trailing whitespace glyphs in
17007 IT->glyph_row to `trailing-whitespace'. */
17008 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17009 && BUFFERP (glyph
->object
)
17010 && (glyph
->type
== STRETCH_GLYPH
17011 || (glyph
->type
== CHAR_GLYPH
17012 && glyph
->u
.ch
== ' '))
17013 && trailing_whitespace_p (glyph
->charpos
))
17015 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17019 if (!row
->reversed_p
)
17021 while (glyph
>= start
17022 && BUFFERP (glyph
->object
)
17023 && (glyph
->type
== STRETCH_GLYPH
17024 || (glyph
->type
== CHAR_GLYPH
17025 && glyph
->u
.ch
== ' ')))
17026 (glyph
--)->face_id
= face_id
;
17030 while (glyph
<= start
17031 && BUFFERP (glyph
->object
)
17032 && (glyph
->type
== STRETCH_GLYPH
17033 || (glyph
->type
== CHAR_GLYPH
17034 && glyph
->u
.ch
== ' ')))
17035 (glyph
++)->face_id
= face_id
;
17042 /* Value is non-zero if glyph row ROW in window W should be
17043 used to hold the cursor. */
17046 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17048 int cursor_row_p
= 1;
17050 if (PT
== CHARPOS (row
->end
.pos
))
17052 /* Suppose the row ends on a string.
17053 Unless the row is continued, that means it ends on a newline
17054 in the string. If it's anything other than a display string
17055 (e.g. a before-string from an overlay), we don't want the
17056 cursor there. (This heuristic seems to give the optimal
17057 behavior for the various types of multi-line strings.) */
17058 if (CHARPOS (row
->end
.string_pos
) >= 0)
17060 if (row
->continued_p
)
17064 /* Check for `display' property. */
17065 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17066 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17067 struct glyph
*glyph
;
17070 for (glyph
= end
; glyph
>= beg
; --glyph
)
17071 if (STRINGP (glyph
->object
))
17074 = Fget_char_property (make_number (PT
),
17078 && display_prop_string_p (prop
, glyph
->object
));
17083 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17085 /* If the row ends in middle of a real character,
17086 and the line is continued, we want the cursor here.
17087 That's because CHARPOS (ROW->end.pos) would equal
17088 PT if PT is before the character. */
17089 if (!row
->ends_in_ellipsis_p
)
17090 cursor_row_p
= row
->continued_p
;
17092 /* If the row ends in an ellipsis, then
17093 CHARPOS (ROW->end.pos) will equal point after the
17094 invisible text. We want that position to be displayed
17095 after the ellipsis. */
17098 /* If the row ends at ZV, display the cursor at the end of that
17099 row instead of at the start of the row below. */
17100 else if (row
->ends_at_zv_p
)
17106 return cursor_row_p
;
17111 /* Push the display property PROP so that it will be rendered at the
17112 current position in IT. Return 1 if PROP was successfully pushed,
17116 push_display_prop (struct it
*it
, Lisp_Object prop
)
17120 if (STRINGP (prop
))
17122 if (SCHARS (prop
) == 0)
17129 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17130 it
->current
.overlay_string_index
= -1;
17131 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17132 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17133 it
->method
= GET_FROM_STRING
;
17134 it
->stop_charpos
= 0;
17136 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17138 it
->method
= GET_FROM_STRETCH
;
17141 #ifdef HAVE_WINDOW_SYSTEM
17142 else if (IMAGEP (prop
))
17144 it
->what
= IT_IMAGE
;
17145 it
->image_id
= lookup_image (it
->f
, prop
);
17146 it
->method
= GET_FROM_IMAGE
;
17148 #endif /* HAVE_WINDOW_SYSTEM */
17151 pop_it (it
); /* bogus display property, give up */
17158 /* Return the character-property PROP at the current position in IT. */
17161 get_it_property (struct it
*it
, Lisp_Object prop
)
17163 Lisp_Object position
;
17165 if (STRINGP (it
->object
))
17166 position
= make_number (IT_STRING_CHARPOS (*it
));
17167 else if (BUFFERP (it
->object
))
17168 position
= make_number (IT_CHARPOS (*it
));
17172 return Fget_char_property (position
, prop
, it
->object
);
17175 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17178 handle_line_prefix (struct it
*it
)
17180 Lisp_Object prefix
;
17181 if (it
->continuation_lines_width
> 0)
17183 prefix
= get_it_property (it
, Qwrap_prefix
);
17185 prefix
= Vwrap_prefix
;
17189 prefix
= get_it_property (it
, Qline_prefix
);
17191 prefix
= Vline_prefix
;
17193 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17195 /* If the prefix is wider than the window, and we try to wrap
17196 it, it would acquire its own wrap prefix, and so on till the
17197 iterator stack overflows. So, don't wrap the prefix. */
17198 it
->line_wrap
= TRUNCATE
;
17199 it
->avoid_cursor_p
= 1;
17205 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17206 only for R2L lines from display_line, when it decides that too many
17207 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17210 unproduce_glyphs (struct it
*it
, int n
)
17212 struct glyph
*glyph
, *end
;
17214 xassert (it
->glyph_row
);
17215 xassert (it
->glyph_row
->reversed_p
);
17216 xassert (it
->area
== TEXT_AREA
);
17217 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17219 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17220 n
= it
->glyph_row
->used
[TEXT_AREA
];
17221 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17222 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17223 for ( ; glyph
< end
; glyph
++)
17224 glyph
[-n
] = *glyph
;
17227 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17228 and ROW->maxpos. */
17230 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17231 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17232 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17234 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17235 lines' rows is implemented for bidi-reordered rows. */
17237 /* ROW->minpos is the value of min_pos, the minimal buffer position
17240 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17243 /* We didn't find _any_ valid buffer positions in any of the
17244 glyphs, so we must trust the iterator's computed
17246 row
->minpos
= row
->start
.pos
;
17247 max_pos
= CHARPOS (it
->current
.pos
);
17248 max_bpos
= BYTEPOS (it
->current
.pos
);
17254 /* Here are the various use-cases for ending the row, and the
17255 corresponding values for ROW->maxpos:
17257 Line ends in a newline from buffer eol_pos + 1
17258 Line is continued from buffer max_pos + 1
17259 Line is truncated on right it->current.pos
17260 Line ends in a newline from string max_pos
17261 Line is continued from string max_pos
17262 Line is continued from display vector max_pos
17263 Line is entirely from a string min_pos == max_pos
17264 Line is entirely from a display vector min_pos == max_pos
17265 Line that ends at ZV ZV
17267 If you discover other use-cases, please add them here as
17269 if (row
->ends_at_zv_p
)
17270 row
->maxpos
= it
->current
.pos
;
17271 else if (row
->used
[TEXT_AREA
])
17273 if (row
->ends_in_newline_from_string_p
)
17274 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17275 else if (CHARPOS (it
->eol_pos
) > 0)
17276 SET_TEXT_POS (row
->maxpos
,
17277 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17278 else if (row
->continued_p
)
17280 /* If max_pos is different from IT's current position, it
17281 means IT->method does not belong to the display element
17282 at max_pos. However, it also means that the display
17283 element at max_pos was displayed in its entirety on this
17284 line, which is equivalent to saying that the next line
17285 starts at the next buffer position. */
17286 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17287 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17290 INC_BOTH (max_pos
, max_bpos
);
17291 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17294 else if (row
->truncated_on_right_p
)
17295 /* display_line already called reseat_at_next_visible_line_start,
17296 which puts the iterator at the beginning of the next line, in
17297 the logical order. */
17298 row
->maxpos
= it
->current
.pos
;
17299 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17300 /* A line that is entirely from a string/image/stretch... */
17301 row
->maxpos
= row
->minpos
;
17306 row
->maxpos
= it
->current
.pos
;
17309 /* Construct the glyph row IT->glyph_row in the desired matrix of
17310 IT->w from text at the current position of IT. See dispextern.h
17311 for an overview of struct it. Value is non-zero if
17312 IT->glyph_row displays text, as opposed to a line displaying ZV
17316 display_line (struct it
*it
)
17318 struct glyph_row
*row
= it
->glyph_row
;
17319 Lisp_Object overlay_arrow_string
;
17321 int may_wrap
= 0, wrap_x
;
17322 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17323 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17324 int wrap_row_extra_line_spacing
;
17325 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17326 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17328 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17330 /* We always start displaying at hpos zero even if hscrolled. */
17331 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17333 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17334 >= it
->w
->desired_matrix
->nrows
)
17336 it
->w
->nrows_scale_factor
++;
17337 fonts_changed_p
= 1;
17341 /* Is IT->w showing the region? */
17342 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17344 /* Clear the result glyph row and enable it. */
17345 prepare_desired_row (row
);
17347 row
->y
= it
->current_y
;
17348 row
->start
= it
->start
;
17349 row
->continuation_lines_width
= it
->continuation_lines_width
;
17350 row
->displays_text_p
= 1;
17351 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17352 it
->starts_in_middle_of_char_p
= 0;
17354 /* Arrange the overlays nicely for our purposes. Usually, we call
17355 display_line on only one line at a time, in which case this
17356 can't really hurt too much, or we call it on lines which appear
17357 one after another in the buffer, in which case all calls to
17358 recenter_overlay_lists but the first will be pretty cheap. */
17359 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17361 /* Move over display elements that are not visible because we are
17362 hscrolled. This may stop at an x-position < IT->first_visible_x
17363 if the first glyph is partially visible or if we hit a line end. */
17364 if (it
->current_x
< it
->first_visible_x
)
17366 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17367 MOVE_TO_POS
| MOVE_TO_X
);
17371 /* We only do this when not calling `move_it_in_display_line_to'
17372 above, because move_it_in_display_line_to calls
17373 handle_line_prefix itself. */
17374 handle_line_prefix (it
);
17377 /* Get the initial row height. This is either the height of the
17378 text hscrolled, if there is any, or zero. */
17379 row
->ascent
= it
->max_ascent
;
17380 row
->height
= it
->max_ascent
+ it
->max_descent
;
17381 row
->phys_ascent
= it
->max_phys_ascent
;
17382 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17383 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17385 /* Utility macro to record max and min buffer positions seen until now. */
17386 #define RECORD_MAX_MIN_POS(IT) \
17389 if (IT_CHARPOS (*(IT)) < min_pos) \
17391 min_pos = IT_CHARPOS (*(IT)); \
17392 min_bpos = IT_BYTEPOS (*(IT)); \
17394 if (IT_CHARPOS (*(IT)) > max_pos) \
17396 max_pos = IT_CHARPOS (*(IT)); \
17397 max_bpos = IT_BYTEPOS (*(IT)); \
17402 /* Loop generating characters. The loop is left with IT on the next
17403 character to display. */
17406 int n_glyphs_before
, hpos_before
, x_before
;
17408 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17410 /* Retrieve the next thing to display. Value is zero if end of
17412 if (!get_next_display_element (it
))
17414 /* Maybe add a space at the end of this line that is used to
17415 display the cursor there under X. Set the charpos of the
17416 first glyph of blank lines not corresponding to any text
17418 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17419 row
->exact_window_width_line_p
= 1;
17420 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17421 || row
->used
[TEXT_AREA
] == 0)
17423 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17424 row
->displays_text_p
= 0;
17426 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17427 && (!MINI_WINDOW_P (it
->w
)
17428 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17429 row
->indicate_empty_line_p
= 1;
17432 it
->continuation_lines_width
= 0;
17433 row
->ends_at_zv_p
= 1;
17434 /* A row that displays right-to-left text must always have
17435 its last face extended all the way to the end of line,
17436 even if this row ends in ZV, because we still write to th
17437 screen left to right. */
17438 if (row
->reversed_p
)
17439 extend_face_to_end_of_line (it
);
17443 /* Now, get the metrics of what we want to display. This also
17444 generates glyphs in `row' (which is IT->glyph_row). */
17445 n_glyphs_before
= row
->used
[TEXT_AREA
];
17448 /* Remember the line height so far in case the next element doesn't
17449 fit on the line. */
17450 if (it
->line_wrap
!= TRUNCATE
)
17452 ascent
= it
->max_ascent
;
17453 descent
= it
->max_descent
;
17454 phys_ascent
= it
->max_phys_ascent
;
17455 phys_descent
= it
->max_phys_descent
;
17457 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17459 if (IT_DISPLAYING_WHITESPACE (it
))
17465 wrap_row_used
= row
->used
[TEXT_AREA
];
17466 wrap_row_ascent
= row
->ascent
;
17467 wrap_row_height
= row
->height
;
17468 wrap_row_phys_ascent
= row
->phys_ascent
;
17469 wrap_row_phys_height
= row
->phys_height
;
17470 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17471 wrap_row_min_pos
= min_pos
;
17472 wrap_row_min_bpos
= min_bpos
;
17473 wrap_row_max_pos
= max_pos
;
17474 wrap_row_max_bpos
= max_bpos
;
17480 PRODUCE_GLYPHS (it
);
17482 /* If this display element was in marginal areas, continue with
17484 if (it
->area
!= TEXT_AREA
)
17486 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17487 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17488 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17489 row
->phys_height
= max (row
->phys_height
,
17490 it
->max_phys_ascent
+ it
->max_phys_descent
);
17491 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17492 it
->max_extra_line_spacing
);
17493 set_iterator_to_next (it
, 1);
17497 /* Does the display element fit on the line? If we truncate
17498 lines, we should draw past the right edge of the window. If
17499 we don't truncate, we want to stop so that we can display the
17500 continuation glyph before the right margin. If lines are
17501 continued, there are two possible strategies for characters
17502 resulting in more than 1 glyph (e.g. tabs): Display as many
17503 glyphs as possible in this line and leave the rest for the
17504 continuation line, or display the whole element in the next
17505 line. Original redisplay did the former, so we do it also. */
17506 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17507 hpos_before
= it
->hpos
;
17510 if (/* Not a newline. */
17512 /* Glyphs produced fit entirely in the line. */
17513 && it
->current_x
< it
->last_visible_x
)
17515 it
->hpos
+= nglyphs
;
17516 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17517 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17518 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17519 row
->phys_height
= max (row
->phys_height
,
17520 it
->max_phys_ascent
+ it
->max_phys_descent
);
17521 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17522 it
->max_extra_line_spacing
);
17523 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17524 row
->x
= x
- it
->first_visible_x
;
17525 /* Record the maximum and minimum buffer positions seen so
17526 far in glyphs that will be displayed by this row. */
17528 RECORD_MAX_MIN_POS (it
);
17533 struct glyph
*glyph
;
17535 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17537 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17538 new_x
= x
+ glyph
->pixel_width
;
17540 if (/* Lines are continued. */
17541 it
->line_wrap
!= TRUNCATE
17542 && (/* Glyph doesn't fit on the line. */
17543 new_x
> it
->last_visible_x
17544 /* Or it fits exactly on a window system frame. */
17545 || (new_x
== it
->last_visible_x
17546 && FRAME_WINDOW_P (it
->f
))))
17548 /* End of a continued line. */
17551 || (new_x
== it
->last_visible_x
17552 && FRAME_WINDOW_P (it
->f
)))
17554 /* Current glyph is the only one on the line or
17555 fits exactly on the line. We must continue
17556 the line because we can't draw the cursor
17557 after the glyph. */
17558 row
->continued_p
= 1;
17559 it
->current_x
= new_x
;
17560 it
->continuation_lines_width
+= new_x
;
17562 /* Record the maximum and minimum buffer
17563 positions seen so far in glyphs that will be
17564 displayed by this row. */
17566 RECORD_MAX_MIN_POS (it
);
17567 if (i
== nglyphs
- 1)
17569 /* If line-wrap is on, check if a previous
17570 wrap point was found. */
17571 if (wrap_row_used
> 0
17572 /* Even if there is a previous wrap
17573 point, continue the line here as
17574 usual, if (i) the previous character
17575 was a space or tab AND (ii) the
17576 current character is not. */
17578 || IT_DISPLAYING_WHITESPACE (it
)))
17581 set_iterator_to_next (it
, 1);
17582 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17584 if (!get_next_display_element (it
))
17586 row
->exact_window_width_line_p
= 1;
17587 it
->continuation_lines_width
= 0;
17588 row
->continued_p
= 0;
17589 row
->ends_at_zv_p
= 1;
17591 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17593 row
->continued_p
= 0;
17594 row
->exact_window_width_line_p
= 1;
17599 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17600 && !FRAME_WINDOW_P (it
->f
))
17602 /* A padding glyph that doesn't fit on this line.
17603 This means the whole character doesn't fit
17605 if (row
->reversed_p
)
17606 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17607 - n_glyphs_before
);
17608 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17610 /* Fill the rest of the row with continuation
17611 glyphs like in 20.x. */
17612 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17613 < row
->glyphs
[1 + TEXT_AREA
])
17614 produce_special_glyphs (it
, IT_CONTINUATION
);
17616 row
->continued_p
= 1;
17617 it
->current_x
= x_before
;
17618 it
->continuation_lines_width
+= x_before
;
17620 /* Restore the height to what it was before the
17621 element not fitting on the line. */
17622 it
->max_ascent
= ascent
;
17623 it
->max_descent
= descent
;
17624 it
->max_phys_ascent
= phys_ascent
;
17625 it
->max_phys_descent
= phys_descent
;
17627 else if (wrap_row_used
> 0)
17630 if (row
->reversed_p
)
17631 unproduce_glyphs (it
,
17632 row
->used
[TEXT_AREA
] - wrap_row_used
);
17634 it
->continuation_lines_width
+= wrap_x
;
17635 row
->used
[TEXT_AREA
] = wrap_row_used
;
17636 row
->ascent
= wrap_row_ascent
;
17637 row
->height
= wrap_row_height
;
17638 row
->phys_ascent
= wrap_row_phys_ascent
;
17639 row
->phys_height
= wrap_row_phys_height
;
17640 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17641 min_pos
= wrap_row_min_pos
;
17642 min_bpos
= wrap_row_min_bpos
;
17643 max_pos
= wrap_row_max_pos
;
17644 max_bpos
= wrap_row_max_bpos
;
17645 row
->continued_p
= 1;
17646 row
->ends_at_zv_p
= 0;
17647 row
->exact_window_width_line_p
= 0;
17648 it
->continuation_lines_width
+= x
;
17650 /* Make sure that a non-default face is extended
17651 up to the right margin of the window. */
17652 extend_face_to_end_of_line (it
);
17654 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17656 /* A TAB that extends past the right edge of the
17657 window. This produces a single glyph on
17658 window system frames. We leave the glyph in
17659 this row and let it fill the row, but don't
17660 consume the TAB. */
17661 it
->continuation_lines_width
+= it
->last_visible_x
;
17662 row
->ends_in_middle_of_char_p
= 1;
17663 row
->continued_p
= 1;
17664 glyph
->pixel_width
= it
->last_visible_x
- x
;
17665 it
->starts_in_middle_of_char_p
= 1;
17669 /* Something other than a TAB that draws past
17670 the right edge of the window. Restore
17671 positions to values before the element. */
17672 if (row
->reversed_p
)
17673 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17674 - (n_glyphs_before
+ i
));
17675 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17677 /* Display continuation glyphs. */
17678 if (!FRAME_WINDOW_P (it
->f
))
17679 produce_special_glyphs (it
, IT_CONTINUATION
);
17680 row
->continued_p
= 1;
17682 it
->current_x
= x_before
;
17683 it
->continuation_lines_width
+= x
;
17684 extend_face_to_end_of_line (it
);
17686 if (nglyphs
> 1 && i
> 0)
17688 row
->ends_in_middle_of_char_p
= 1;
17689 it
->starts_in_middle_of_char_p
= 1;
17692 /* Restore the height to what it was before the
17693 element not fitting on the line. */
17694 it
->max_ascent
= ascent
;
17695 it
->max_descent
= descent
;
17696 it
->max_phys_ascent
= phys_ascent
;
17697 it
->max_phys_descent
= phys_descent
;
17702 else if (new_x
> it
->first_visible_x
)
17704 /* Increment number of glyphs actually displayed. */
17707 /* Record the maximum and minimum buffer positions
17708 seen so far in glyphs that will be displayed by
17711 RECORD_MAX_MIN_POS (it
);
17713 if (x
< it
->first_visible_x
)
17714 /* Glyph is partially visible, i.e. row starts at
17715 negative X position. */
17716 row
->x
= x
- it
->first_visible_x
;
17720 /* Glyph is completely off the left margin of the
17721 window. This should not happen because of the
17722 move_it_in_display_line at the start of this
17723 function, unless the text display area of the
17724 window is empty. */
17725 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17729 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17730 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17731 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17732 row
->phys_height
= max (row
->phys_height
,
17733 it
->max_phys_ascent
+ it
->max_phys_descent
);
17734 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17735 it
->max_extra_line_spacing
);
17737 /* End of this display line if row is continued. */
17738 if (row
->continued_p
|| row
->ends_at_zv_p
)
17743 /* Is this a line end? If yes, we're also done, after making
17744 sure that a non-default face is extended up to the right
17745 margin of the window. */
17746 if (ITERATOR_AT_END_OF_LINE_P (it
))
17748 int used_before
= row
->used
[TEXT_AREA
];
17750 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17752 /* Add a space at the end of the line that is used to
17753 display the cursor there. */
17754 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17755 append_space_for_newline (it
, 0);
17757 /* Extend the face to the end of the line. */
17758 extend_face_to_end_of_line (it
);
17760 /* Make sure we have the position. */
17761 if (used_before
== 0)
17762 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17764 /* Record the position of the newline, for use in
17766 it
->eol_pos
= it
->current
.pos
;
17768 /* Consume the line end. This skips over invisible lines. */
17769 set_iterator_to_next (it
, 1);
17770 it
->continuation_lines_width
= 0;
17774 /* Proceed with next display element. Note that this skips
17775 over lines invisible because of selective display. */
17776 set_iterator_to_next (it
, 1);
17778 /* If we truncate lines, we are done when the last displayed
17779 glyphs reach past the right margin of the window. */
17780 if (it
->line_wrap
== TRUNCATE
17781 && (FRAME_WINDOW_P (it
->f
)
17782 ? (it
->current_x
>= it
->last_visible_x
)
17783 : (it
->current_x
> it
->last_visible_x
)))
17785 /* Maybe add truncation glyphs. */
17786 if (!FRAME_WINDOW_P (it
->f
))
17790 if (!row
->reversed_p
)
17792 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17793 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17798 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17799 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17801 /* Remove any padding glyphs at the front of ROW, to
17802 make room for the truncation glyphs we will be
17803 adding below. The loop below always inserts at
17804 least one truncation glyph, so also remove the
17805 last glyph added to ROW. */
17806 unproduce_glyphs (it
, i
+ 1);
17807 /* Adjust i for the loop below. */
17808 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17811 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17813 row
->used
[TEXT_AREA
] = i
;
17814 produce_special_glyphs (it
, IT_TRUNCATION
);
17817 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17819 /* Don't truncate if we can overflow newline into fringe. */
17820 if (!get_next_display_element (it
))
17822 it
->continuation_lines_width
= 0;
17823 row
->ends_at_zv_p
= 1;
17824 row
->exact_window_width_line_p
= 1;
17827 if (ITERATOR_AT_END_OF_LINE_P (it
))
17829 row
->exact_window_width_line_p
= 1;
17830 goto at_end_of_line
;
17834 row
->truncated_on_right_p
= 1;
17835 it
->continuation_lines_width
= 0;
17836 reseat_at_next_visible_line_start (it
, 0);
17837 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17838 it
->hpos
= hpos_before
;
17839 it
->current_x
= x_before
;
17844 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17845 at the left window margin. */
17846 if (it
->first_visible_x
17847 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17849 if (!FRAME_WINDOW_P (it
->f
))
17850 insert_left_trunc_glyphs (it
);
17851 row
->truncated_on_left_p
= 1;
17854 /* If the start of this line is the overlay arrow-position, then
17855 mark this glyph row as the one containing the overlay arrow.
17856 This is clearly a mess with variable size fonts. It would be
17857 better to let it be displayed like cursors under X. */
17858 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17859 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17860 !NILP (overlay_arrow_string
)))
17862 /* Overlay arrow in window redisplay is a fringe bitmap. */
17863 if (STRINGP (overlay_arrow_string
))
17865 struct glyph_row
*arrow_row
17866 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17867 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17868 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17869 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17870 struct glyph
*p2
, *end
;
17872 /* Copy the arrow glyphs. */
17873 while (glyph
< arrow_end
)
17876 /* Throw away padding glyphs. */
17878 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17879 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17885 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17890 xassert (INTEGERP (overlay_arrow_string
));
17891 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17893 overlay_arrow_seen
= 1;
17896 /* Compute pixel dimensions of this line. */
17897 compute_line_metrics (it
);
17899 /* Remember the position at which this line ends. */
17900 row
->end
= it
->current
;
17903 row
->minpos
= row
->start
.pos
;
17904 row
->maxpos
= row
->end
.pos
;
17908 /* ROW->minpos and ROW->maxpos must be the smallest and
17909 `1 + the largest' buffer positions in ROW. But if ROW was
17910 bidi-reordered, these two positions can be anywhere in the
17911 row, so we must determine them now. */
17912 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17915 /* Record whether this row ends inside an ellipsis. */
17916 row
->ends_in_ellipsis_p
17917 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17918 && it
->ellipsis_p
);
17920 /* Save fringe bitmaps in this row. */
17921 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17922 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17923 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17924 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17926 it
->left_user_fringe_bitmap
= 0;
17927 it
->left_user_fringe_face_id
= 0;
17928 it
->right_user_fringe_bitmap
= 0;
17929 it
->right_user_fringe_face_id
= 0;
17931 /* Maybe set the cursor. */
17932 cvpos
= it
->w
->cursor
.vpos
;
17934 /* In bidi-reordered rows, keep checking for proper cursor
17935 position even if one has been found already, because buffer
17936 positions in such rows change non-linearly with ROW->VPOS,
17937 when a line is continued. One exception: when we are at ZV,
17938 display cursor on the first suitable glyph row, since all
17939 the empty rows after that also have their position set to ZV. */
17940 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17941 lines' rows is implemented for bidi-reordered rows. */
17943 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17944 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17945 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17946 && cursor_row_p (it
->w
, row
))
17947 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17949 /* Highlight trailing whitespace. */
17950 if (!NILP (Vshow_trailing_whitespace
))
17951 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17953 /* Prepare for the next line. This line starts horizontally at (X
17954 HPOS) = (0 0). Vertical positions are incremented. As a
17955 convenience for the caller, IT->glyph_row is set to the next
17957 it
->current_x
= it
->hpos
= 0;
17958 it
->current_y
+= row
->height
;
17959 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17962 /* The next row should by default use the same value of the
17963 reversed_p flag as this one. set_iterator_to_next decides when
17964 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17965 the flag accordingly. */
17966 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17967 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17968 it
->start
= row
->end
;
17969 return row
->displays_text_p
;
17971 #undef RECORD_MAX_MIN_POS
17974 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17975 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17976 doc
: /* Return paragraph direction at point in BUFFER.
17977 Value is either `left-to-right' or `right-to-left'.
17978 If BUFFER is omitted or nil, it defaults to the current buffer.
17980 Paragraph direction determines how the text in the paragraph is displayed.
17981 In left-to-right paragraphs, text begins at the left margin of the window
17982 and the reading direction is generally left to right. In right-to-left
17983 paragraphs, text begins at the right margin and is read from right to left.
17985 See also `bidi-paragraph-direction'. */)
17986 (Lisp_Object buffer
)
17988 struct buffer
*buf
;
17989 struct buffer
*old
;
17992 buf
= current_buffer
;
17995 CHECK_BUFFER (buffer
);
17996 buf
= XBUFFER (buffer
);
17997 old
= current_buffer
;
18000 if (NILP (buf
->bidi_display_reordering
))
18001 return Qleft_to_right
;
18002 else if (!NILP (buf
->bidi_paragraph_direction
))
18003 return buf
->bidi_paragraph_direction
;
18006 /* Determine the direction from buffer text. We could try to
18007 use current_matrix if it is up to date, but this seems fast
18008 enough as it is. */
18009 struct bidi_it itb
;
18010 EMACS_INT pos
= BUF_PT (buf
);
18011 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18013 if (buf
!= current_buffer
)
18014 set_buffer_temp (buf
);
18015 /* Find previous non-empty line. */
18016 if (pos
>= ZV
&& pos
> BEGV
)
18019 bytepos
= CHAR_TO_BYTE (pos
);
18021 while (FETCH_BYTE (bytepos
) == '\n')
18023 if (bytepos
<= BEGV_BYTE
)
18028 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18031 itb
.bytepos
= bytepos
;
18034 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
18035 if (buf
!= current_buffer
)
18036 set_buffer_temp (old
);
18037 switch (itb
.paragraph_dir
)
18040 return Qleft_to_right
;
18043 return Qright_to_left
;
18053 /***********************************************************************
18055 ***********************************************************************/
18057 /* Redisplay the menu bar in the frame for window W.
18059 The menu bar of X frames that don't have X toolkit support is
18060 displayed in a special window W->frame->menu_bar_window.
18062 The menu bar of terminal frames is treated specially as far as
18063 glyph matrices are concerned. Menu bar lines are not part of
18064 windows, so the update is done directly on the frame matrix rows
18065 for the menu bar. */
18068 display_menu_bar (struct window
*w
)
18070 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18075 /* Don't do all this for graphical frames. */
18077 if (FRAME_W32_P (f
))
18080 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18086 if (FRAME_NS_P (f
))
18088 #endif /* HAVE_NS */
18090 #ifdef USE_X_TOOLKIT
18091 xassert (!FRAME_WINDOW_P (f
));
18092 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18093 it
.first_visible_x
= 0;
18094 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18095 #else /* not USE_X_TOOLKIT */
18096 if (FRAME_WINDOW_P (f
))
18098 /* Menu bar lines are displayed in the desired matrix of the
18099 dummy window menu_bar_window. */
18100 struct window
*menu_w
;
18101 xassert (WINDOWP (f
->menu_bar_window
));
18102 menu_w
= XWINDOW (f
->menu_bar_window
);
18103 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18105 it
.first_visible_x
= 0;
18106 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18110 /* This is a TTY frame, i.e. character hpos/vpos are used as
18112 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18114 it
.first_visible_x
= 0;
18115 it
.last_visible_x
= FRAME_COLS (f
);
18117 #endif /* not USE_X_TOOLKIT */
18119 if (! mode_line_inverse_video
)
18120 /* Force the menu-bar to be displayed in the default face. */
18121 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18123 /* Clear all rows of the menu bar. */
18124 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18126 struct glyph_row
*row
= it
.glyph_row
+ i
;
18127 clear_glyph_row (row
);
18128 row
->enabled_p
= 1;
18129 row
->full_width_p
= 1;
18132 /* Display all items of the menu bar. */
18133 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18134 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18136 Lisp_Object string
;
18138 /* Stop at nil string. */
18139 string
= AREF (items
, i
+ 1);
18143 /* Remember where item was displayed. */
18144 ASET (items
, i
+ 3, make_number (it
.hpos
));
18146 /* Display the item, pad with one space. */
18147 if (it
.current_x
< it
.last_visible_x
)
18148 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18149 SCHARS (string
) + 1, 0, 0, -1);
18152 /* Fill out the line with spaces. */
18153 if (it
.current_x
< it
.last_visible_x
)
18154 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18156 /* Compute the total height of the lines. */
18157 compute_line_metrics (&it
);
18162 /***********************************************************************
18164 ***********************************************************************/
18166 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18167 FORCE is non-zero, redisplay mode lines unconditionally.
18168 Otherwise, redisplay only mode lines that are garbaged. Value is
18169 the number of windows whose mode lines were redisplayed. */
18172 redisplay_mode_lines (Lisp_Object window
, int force
)
18176 while (!NILP (window
))
18178 struct window
*w
= XWINDOW (window
);
18180 if (WINDOWP (w
->hchild
))
18181 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18182 else if (WINDOWP (w
->vchild
))
18183 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18185 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18186 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18188 struct text_pos lpoint
;
18189 struct buffer
*old
= current_buffer
;
18191 /* Set the window's buffer for the mode line display. */
18192 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18193 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18195 /* Point refers normally to the selected window. For any
18196 other window, set up appropriate value. */
18197 if (!EQ (window
, selected_window
))
18199 struct text_pos pt
;
18201 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18202 if (CHARPOS (pt
) < BEGV
)
18203 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18204 else if (CHARPOS (pt
) > (ZV
- 1))
18205 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18207 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18210 /* Display mode lines. */
18211 clear_glyph_matrix (w
->desired_matrix
);
18212 if (display_mode_lines (w
))
18215 w
->must_be_updated_p
= 1;
18218 /* Restore old settings. */
18219 set_buffer_internal_1 (old
);
18220 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18230 /* Display the mode and/or header line of window W. Value is the
18231 sum number of mode lines and header lines displayed. */
18234 display_mode_lines (struct window
*w
)
18236 Lisp_Object old_selected_window
, old_selected_frame
;
18239 old_selected_frame
= selected_frame
;
18240 selected_frame
= w
->frame
;
18241 old_selected_window
= selected_window
;
18242 XSETWINDOW (selected_window
, w
);
18244 /* These will be set while the mode line specs are processed. */
18245 line_number_displayed
= 0;
18246 w
->column_number_displayed
= Qnil
;
18248 if (WINDOW_WANTS_MODELINE_P (w
))
18250 struct window
*sel_w
= XWINDOW (old_selected_window
);
18252 /* Select mode line face based on the real selected window. */
18253 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18254 current_buffer
->mode_line_format
);
18258 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18260 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18261 current_buffer
->header_line_format
);
18265 selected_frame
= old_selected_frame
;
18266 selected_window
= old_selected_window
;
18271 /* Display mode or header line of window W. FACE_ID specifies which
18272 line to display; it is either MODE_LINE_FACE_ID or
18273 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18274 display. Value is the pixel height of the mode/header line
18278 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18282 int count
= SPECPDL_INDEX ();
18284 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18285 /* Don't extend on a previously drawn mode-line.
18286 This may happen if called from pos_visible_p. */
18287 it
.glyph_row
->enabled_p
= 0;
18288 prepare_desired_row (it
.glyph_row
);
18290 it
.glyph_row
->mode_line_p
= 1;
18292 if (! mode_line_inverse_video
)
18293 /* Force the mode-line to be displayed in the default face. */
18294 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18296 record_unwind_protect (unwind_format_mode_line
,
18297 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18299 mode_line_target
= MODE_LINE_DISPLAY
;
18301 /* Temporarily make frame's keyboard the current kboard so that
18302 kboard-local variables in the mode_line_format will get the right
18304 push_kboard (FRAME_KBOARD (it
.f
));
18305 record_unwind_save_match_data ();
18306 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18309 unbind_to (count
, Qnil
);
18311 /* Fill up with spaces. */
18312 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18314 compute_line_metrics (&it
);
18315 it
.glyph_row
->full_width_p
= 1;
18316 it
.glyph_row
->continued_p
= 0;
18317 it
.glyph_row
->truncated_on_left_p
= 0;
18318 it
.glyph_row
->truncated_on_right_p
= 0;
18320 /* Make a 3D mode-line have a shadow at its right end. */
18321 face
= FACE_FROM_ID (it
.f
, face_id
);
18322 extend_face_to_end_of_line (&it
);
18323 if (face
->box
!= FACE_NO_BOX
)
18325 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18326 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18327 last
->right_box_line_p
= 1;
18330 return it
.glyph_row
->height
;
18333 /* Move element ELT in LIST to the front of LIST.
18334 Return the updated list. */
18337 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18339 register Lisp_Object tail
, prev
;
18340 register Lisp_Object tem
;
18344 while (CONSP (tail
))
18350 /* Splice out the link TAIL. */
18352 list
= XCDR (tail
);
18354 Fsetcdr (prev
, XCDR (tail
));
18356 /* Now make it the first. */
18357 Fsetcdr (tail
, list
);
18362 tail
= XCDR (tail
);
18366 /* Not found--return unchanged LIST. */
18370 /* Contribute ELT to the mode line for window IT->w. How it
18371 translates into text depends on its data type.
18373 IT describes the display environment in which we display, as usual.
18375 DEPTH is the depth in recursion. It is used to prevent
18376 infinite recursion here.
18378 FIELD_WIDTH is the number of characters the display of ELT should
18379 occupy in the mode line, and PRECISION is the maximum number of
18380 characters to display from ELT's representation. See
18381 display_string for details.
18383 Returns the hpos of the end of the text generated by ELT.
18385 PROPS is a property list to add to any string we encounter.
18387 If RISKY is nonzero, remove (disregard) any properties in any string
18388 we encounter, and ignore :eval and :propertize.
18390 The global variable `mode_line_target' determines whether the
18391 output is passed to `store_mode_line_noprop',
18392 `store_mode_line_string', or `display_string'. */
18395 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18396 Lisp_Object elt
, Lisp_Object props
, int risky
)
18398 int n
= 0, field
, prec
;
18403 elt
= build_string ("*too-deep*");
18407 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18411 /* A string: output it and check for %-constructs within it. */
18415 if (SCHARS (elt
) > 0
18416 && (!NILP (props
) || risky
))
18418 Lisp_Object oprops
, aelt
;
18419 oprops
= Ftext_properties_at (make_number (0), elt
);
18421 /* If the starting string's properties are not what
18422 we want, translate the string. Also, if the string
18423 is risky, do that anyway. */
18425 if (NILP (Fequal (props
, oprops
)) || risky
)
18427 /* If the starting string has properties,
18428 merge the specified ones onto the existing ones. */
18429 if (! NILP (oprops
) && !risky
)
18433 oprops
= Fcopy_sequence (oprops
);
18435 while (CONSP (tem
))
18437 oprops
= Fplist_put (oprops
, XCAR (tem
),
18438 XCAR (XCDR (tem
)));
18439 tem
= XCDR (XCDR (tem
));
18444 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18445 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18447 /* AELT is what we want. Move it to the front
18448 without consing. */
18450 mode_line_proptrans_alist
18451 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18457 /* If AELT has the wrong props, it is useless.
18458 so get rid of it. */
18460 mode_line_proptrans_alist
18461 = Fdelq (aelt
, mode_line_proptrans_alist
);
18463 elt
= Fcopy_sequence (elt
);
18464 Fset_text_properties (make_number (0), Flength (elt
),
18466 /* Add this item to mode_line_proptrans_alist. */
18467 mode_line_proptrans_alist
18468 = Fcons (Fcons (elt
, props
),
18469 mode_line_proptrans_alist
);
18470 /* Truncate mode_line_proptrans_alist
18471 to at most 50 elements. */
18472 tem
= Fnthcdr (make_number (50),
18473 mode_line_proptrans_alist
);
18475 XSETCDR (tem
, Qnil
);
18484 prec
= precision
- n
;
18485 switch (mode_line_target
)
18487 case MODE_LINE_NOPROP
:
18488 case MODE_LINE_TITLE
:
18489 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18491 case MODE_LINE_STRING
:
18492 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18494 case MODE_LINE_DISPLAY
:
18495 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18496 0, prec
, 0, STRING_MULTIBYTE (elt
));
18503 /* Handle the non-literal case. */
18505 while ((precision
<= 0 || n
< precision
)
18506 && SREF (elt
, offset
) != 0
18507 && (mode_line_target
!= MODE_LINE_DISPLAY
18508 || it
->current_x
< it
->last_visible_x
))
18510 int last_offset
= offset
;
18512 /* Advance to end of string or next format specifier. */
18513 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18516 if (offset
- 1 != last_offset
)
18518 int nchars
, nbytes
;
18520 /* Output to end of string or up to '%'. Field width
18521 is length of string. Don't output more than
18522 PRECISION allows us. */
18525 prec
= c_string_width (SDATA (elt
) + last_offset
,
18526 offset
- last_offset
, precision
- n
,
18529 switch (mode_line_target
)
18531 case MODE_LINE_NOPROP
:
18532 case MODE_LINE_TITLE
:
18533 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18535 case MODE_LINE_STRING
:
18537 int bytepos
= last_offset
;
18538 int charpos
= string_byte_to_char (elt
, bytepos
);
18539 int endpos
= (precision
<= 0
18540 ? string_byte_to_char (elt
, offset
)
18541 : charpos
+ nchars
);
18543 n
+= store_mode_line_string (NULL
,
18544 Fsubstring (elt
, make_number (charpos
),
18545 make_number (endpos
)),
18549 case MODE_LINE_DISPLAY
:
18551 int bytepos
= last_offset
;
18552 int charpos
= string_byte_to_char (elt
, bytepos
);
18554 if (precision
<= 0)
18555 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18556 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18558 STRING_MULTIBYTE (elt
));
18563 else /* c == '%' */
18565 int percent_position
= offset
;
18567 /* Get the specified minimum width. Zero means
18570 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18571 field
= field
* 10 + c
- '0';
18573 /* Don't pad beyond the total padding allowed. */
18574 if (field_width
- n
> 0 && field
> field_width
- n
)
18575 field
= field_width
- n
;
18577 /* Note that either PRECISION <= 0 or N < PRECISION. */
18578 prec
= precision
- n
;
18581 n
+= display_mode_element (it
, depth
, field
, prec
,
18582 Vglobal_mode_string
, props
,
18587 int bytepos
, charpos
;
18588 unsigned char *spec
;
18589 Lisp_Object string
;
18591 bytepos
= percent_position
;
18592 charpos
= (STRING_MULTIBYTE (elt
)
18593 ? string_byte_to_char (elt
, bytepos
)
18595 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18596 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18598 switch (mode_line_target
)
18600 case MODE_LINE_NOPROP
:
18601 case MODE_LINE_TITLE
:
18602 n
+= store_mode_line_noprop (spec
, field
, prec
);
18604 case MODE_LINE_STRING
:
18606 int len
= strlen (spec
);
18607 Lisp_Object tem
= make_string (spec
, len
);
18608 props
= Ftext_properties_at (make_number (charpos
), elt
);
18609 /* Should only keep face property in props */
18610 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18613 case MODE_LINE_DISPLAY
:
18615 int nglyphs_before
, nwritten
;
18617 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18618 nwritten
= display_string (spec
, string
, elt
,
18623 /* Assign to the glyphs written above the
18624 string where the `%x' came from, position
18628 struct glyph
*glyph
18629 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18633 for (i
= 0; i
< nwritten
; ++i
)
18635 glyph
[i
].object
= elt
;
18636 glyph
[i
].charpos
= charpos
;
18653 /* A symbol: process the value of the symbol recursively
18654 as if it appeared here directly. Avoid error if symbol void.
18655 Special case: if value of symbol is a string, output the string
18658 register Lisp_Object tem
;
18660 /* If the variable is not marked as risky to set
18661 then its contents are risky to use. */
18662 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18665 tem
= Fboundp (elt
);
18668 tem
= Fsymbol_value (elt
);
18669 /* If value is a string, output that string literally:
18670 don't check for % within it. */
18674 if (!EQ (tem
, elt
))
18676 /* Give up right away for nil or t. */
18686 register Lisp_Object car
, tem
;
18688 /* A cons cell: five distinct cases.
18689 If first element is :eval or :propertize, do something special.
18690 If first element is a string or a cons, process all the elements
18691 and effectively concatenate them.
18692 If first element is a negative number, truncate displaying cdr to
18693 at most that many characters. If positive, pad (with spaces)
18694 to at least that many characters.
18695 If first element is a symbol, process the cadr or caddr recursively
18696 according to whether the symbol's value is non-nil or nil. */
18698 if (EQ (car
, QCeval
))
18700 /* An element of the form (:eval FORM) means evaluate FORM
18701 and use the result as mode line elements. */
18706 if (CONSP (XCDR (elt
)))
18709 spec
= safe_eval (XCAR (XCDR (elt
)));
18710 n
+= display_mode_element (it
, depth
, field_width
- n
,
18711 precision
- n
, spec
, props
,
18715 else if (EQ (car
, QCpropertize
))
18717 /* An element of the form (:propertize ELT PROPS...)
18718 means display ELT but applying properties PROPS. */
18723 if (CONSP (XCDR (elt
)))
18724 n
+= display_mode_element (it
, depth
, field_width
- n
,
18725 precision
- n
, XCAR (XCDR (elt
)),
18726 XCDR (XCDR (elt
)), risky
);
18728 else if (SYMBOLP (car
))
18730 tem
= Fboundp (car
);
18734 /* elt is now the cdr, and we know it is a cons cell.
18735 Use its car if CAR has a non-nil value. */
18738 tem
= Fsymbol_value (car
);
18745 /* Symbol's value is nil (or symbol is unbound)
18746 Get the cddr of the original list
18747 and if possible find the caddr and use that. */
18751 else if (!CONSP (elt
))
18756 else if (INTEGERP (car
))
18758 register int lim
= XINT (car
);
18762 /* Negative int means reduce maximum width. */
18763 if (precision
<= 0)
18766 precision
= min (precision
, -lim
);
18770 /* Padding specified. Don't let it be more than
18771 current maximum. */
18773 lim
= min (precision
, lim
);
18775 /* If that's more padding than already wanted, queue it.
18776 But don't reduce padding already specified even if
18777 that is beyond the current truncation point. */
18778 field_width
= max (lim
, field_width
);
18782 else if (STRINGP (car
) || CONSP (car
))
18784 Lisp_Object halftail
= elt
;
18788 && (precision
<= 0 || n
< precision
))
18790 n
+= display_mode_element (it
, depth
,
18791 /* Do padding only after the last
18792 element in the list. */
18793 (! CONSP (XCDR (elt
))
18796 precision
- n
, XCAR (elt
),
18800 if ((len
& 1) == 0)
18801 halftail
= XCDR (halftail
);
18802 /* Check for cycle. */
18803 if (EQ (halftail
, elt
))
18812 elt
= build_string ("*invalid*");
18816 /* Pad to FIELD_WIDTH. */
18817 if (field_width
> 0 && n
< field_width
)
18819 switch (mode_line_target
)
18821 case MODE_LINE_NOPROP
:
18822 case MODE_LINE_TITLE
:
18823 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18825 case MODE_LINE_STRING
:
18826 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18828 case MODE_LINE_DISPLAY
:
18829 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18838 /* Store a mode-line string element in mode_line_string_list.
18840 If STRING is non-null, display that C string. Otherwise, the Lisp
18841 string LISP_STRING is displayed.
18843 FIELD_WIDTH is the minimum number of output glyphs to produce.
18844 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18845 with spaces. FIELD_WIDTH <= 0 means don't pad.
18847 PRECISION is the maximum number of characters to output from
18848 STRING. PRECISION <= 0 means don't truncate the string.
18850 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18851 properties to the string.
18853 PROPS are the properties to add to the string.
18854 The mode_line_string_face face property is always added to the string.
18858 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18859 int field_width
, int precision
, Lisp_Object props
)
18864 if (string
!= NULL
)
18866 len
= strlen (string
);
18867 if (precision
> 0 && len
> precision
)
18869 lisp_string
= make_string (string
, len
);
18871 props
= mode_line_string_face_prop
;
18872 else if (!NILP (mode_line_string_face
))
18874 Lisp_Object face
= Fplist_get (props
, Qface
);
18875 props
= Fcopy_sequence (props
);
18877 face
= mode_line_string_face
;
18879 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18880 props
= Fplist_put (props
, Qface
, face
);
18882 Fadd_text_properties (make_number (0), make_number (len
),
18883 props
, lisp_string
);
18887 len
= XFASTINT (Flength (lisp_string
));
18888 if (precision
> 0 && len
> precision
)
18891 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18894 if (!NILP (mode_line_string_face
))
18898 props
= Ftext_properties_at (make_number (0), lisp_string
);
18899 face
= Fplist_get (props
, Qface
);
18901 face
= mode_line_string_face
;
18903 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18904 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18906 lisp_string
= Fcopy_sequence (lisp_string
);
18909 Fadd_text_properties (make_number (0), make_number (len
),
18910 props
, lisp_string
);
18915 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18919 if (field_width
> len
)
18921 field_width
-= len
;
18922 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18924 Fadd_text_properties (make_number (0), make_number (field_width
),
18925 props
, lisp_string
);
18926 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18934 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18936 doc
: /* Format a string out of a mode line format specification.
18937 First arg FORMAT specifies the mode line format (see `mode-line-format'
18938 for details) to use.
18940 Optional second arg FACE specifies the face property to put
18941 on all characters for which no face is specified.
18942 The value t means whatever face the window's mode line currently uses
18943 \(either `mode-line' or `mode-line-inactive', depending).
18944 A value of nil means the default is no face property.
18945 If FACE is an integer, the value string has no text properties.
18947 Optional third and fourth args WINDOW and BUFFER specify the window
18948 and buffer to use as the context for the formatting (defaults
18949 are the selected window and the window's buffer). */)
18950 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18955 struct buffer
*old_buffer
= NULL
;
18957 int no_props
= INTEGERP (face
);
18958 int count
= SPECPDL_INDEX ();
18960 int string_start
= 0;
18963 window
= selected_window
;
18964 CHECK_WINDOW (window
);
18965 w
= XWINDOW (window
);
18968 buffer
= w
->buffer
;
18969 CHECK_BUFFER (buffer
);
18971 /* Make formatting the modeline a non-op when noninteractive, otherwise
18972 there will be problems later caused by a partially initialized frame. */
18973 if (NILP (format
) || noninteractive
)
18974 return empty_unibyte_string
;
18982 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18983 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18987 face_id
= DEFAULT_FACE_ID
;
18989 if (XBUFFER (buffer
) != current_buffer
)
18990 old_buffer
= current_buffer
;
18992 /* Save things including mode_line_proptrans_alist,
18993 and set that to nil so that we don't alter the outer value. */
18994 record_unwind_protect (unwind_format_mode_line
,
18995 format_mode_line_unwind_data
18996 (old_buffer
, selected_window
, 1));
18997 mode_line_proptrans_alist
= Qnil
;
18999 Fselect_window (window
, Qt
);
19001 set_buffer_internal_1 (XBUFFER (buffer
));
19003 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19007 mode_line_target
= MODE_LINE_NOPROP
;
19008 mode_line_string_face_prop
= Qnil
;
19009 mode_line_string_list
= Qnil
;
19010 string_start
= MODE_LINE_NOPROP_LEN (0);
19014 mode_line_target
= MODE_LINE_STRING
;
19015 mode_line_string_list
= Qnil
;
19016 mode_line_string_face
= face
;
19017 mode_line_string_face_prop
19018 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19021 push_kboard (FRAME_KBOARD (it
.f
));
19022 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19027 len
= MODE_LINE_NOPROP_LEN (string_start
);
19028 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19032 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19033 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19034 empty_unibyte_string
);
19037 unbind_to (count
, Qnil
);
19041 /* Write a null-terminated, right justified decimal representation of
19042 the positive integer D to BUF using a minimal field width WIDTH. */
19045 pint2str (register char *buf
, register int width
, register int d
)
19047 register char *p
= buf
;
19055 *p
++ = d
% 10 + '0';
19060 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19071 /* Write a null-terminated, right justified decimal and "human
19072 readable" representation of the nonnegative integer D to BUF using
19073 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19075 static const char power_letter
[] =
19089 pint2hrstr (char *buf
, int width
, int d
)
19091 /* We aim to represent the nonnegative integer D as
19092 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19095 /* -1 means: do not use TENTHS. */
19099 /* Length of QUOTIENT.TENTHS as a string. */
19105 if (1000 <= quotient
)
19107 /* Scale to the appropriate EXPONENT. */
19110 remainder
= quotient
% 1000;
19114 while (1000 <= quotient
);
19116 /* Round to nearest and decide whether to use TENTHS or not. */
19119 tenths
= remainder
/ 100;
19120 if (50 <= remainder
% 100)
19127 if (quotient
== 10)
19135 if (500 <= remainder
)
19137 if (quotient
< 999)
19148 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19149 if (tenths
== -1 && quotient
<= 99)
19156 p
= psuffix
= buf
+ max (width
, length
);
19158 /* Print EXPONENT. */
19160 *psuffix
++ = power_letter
[exponent
];
19163 /* Print TENTHS. */
19166 *--p
= '0' + tenths
;
19170 /* Print QUOTIENT. */
19173 int digit
= quotient
% 10;
19174 *--p
= '0' + digit
;
19176 while ((quotient
/= 10) != 0);
19178 /* Print leading spaces. */
19183 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19184 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19185 type of CODING_SYSTEM. Return updated pointer into BUF. */
19187 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19190 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19193 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19194 const unsigned char *eol_str
;
19196 /* The EOL conversion we are using. */
19197 Lisp_Object eoltype
;
19199 val
= CODING_SYSTEM_SPEC (coding_system
);
19202 if (!VECTORP (val
)) /* Not yet decided. */
19207 eoltype
= eol_mnemonic_undecided
;
19208 /* Don't mention EOL conversion if it isn't decided. */
19213 Lisp_Object eolvalue
;
19215 attrs
= AREF (val
, 0);
19216 eolvalue
= AREF (val
, 2);
19219 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19223 /* The EOL conversion that is normal on this system. */
19225 if (NILP (eolvalue
)) /* Not yet decided. */
19226 eoltype
= eol_mnemonic_undecided
;
19227 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19228 eoltype
= eol_mnemonic_undecided
;
19229 else /* eolvalue is Qunix, Qdos, or Qmac. */
19230 eoltype
= (EQ (eolvalue
, Qunix
)
19231 ? eol_mnemonic_unix
19232 : (EQ (eolvalue
, Qdos
) == 1
19233 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19239 /* Mention the EOL conversion if it is not the usual one. */
19240 if (STRINGP (eoltype
))
19242 eol_str
= SDATA (eoltype
);
19243 eol_str_len
= SBYTES (eoltype
);
19245 else if (CHARACTERP (eoltype
))
19247 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19248 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19253 eol_str
= invalid_eol_type
;
19254 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19256 memcpy (buf
, eol_str
, eol_str_len
);
19257 buf
+= eol_str_len
;
19263 /* Return a string for the output of a mode line %-spec for window W,
19264 generated by character C. PRECISION >= 0 means don't return a
19265 string longer than that value. FIELD_WIDTH > 0 means pad the
19266 string returned with spaces to that value. Return a Lisp string in
19267 *STRING if the resulting string is taken from that Lisp string.
19269 Note we operate on the current buffer for most purposes,
19270 the exception being w->base_line_pos. */
19272 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19275 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19276 int precision
, Lisp_Object
*string
)
19279 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19280 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19281 struct buffer
*b
= current_buffer
;
19289 if (!NILP (b
->read_only
))
19291 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19296 /* This differs from %* only for a modified read-only buffer. */
19297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19299 if (!NILP (b
->read_only
))
19304 /* This differs from %* in ignoring read-only-ness. */
19305 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19317 if (command_loop_level
> 5)
19319 p
= decode_mode_spec_buf
;
19320 for (i
= 0; i
< command_loop_level
; i
++)
19323 return decode_mode_spec_buf
;
19331 if (command_loop_level
> 5)
19333 p
= decode_mode_spec_buf
;
19334 for (i
= 0; i
< command_loop_level
; i
++)
19337 return decode_mode_spec_buf
;
19344 /* Let lots_of_dashes be a string of infinite length. */
19345 if (mode_line_target
== MODE_LINE_NOPROP
||
19346 mode_line_target
== MODE_LINE_STRING
)
19348 if (field_width
<= 0
19349 || field_width
> sizeof (lots_of_dashes
))
19351 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19352 decode_mode_spec_buf
[i
] = '-';
19353 decode_mode_spec_buf
[i
] = '\0';
19354 return decode_mode_spec_buf
;
19357 return lots_of_dashes
;
19365 /* %c and %l are ignored in `frame-title-format'.
19366 (In redisplay_internal, the frame title is drawn _before_ the
19367 windows are updated, so the stuff which depends on actual
19368 window contents (such as %l) may fail to render properly, or
19369 even crash emacs.) */
19370 if (mode_line_target
== MODE_LINE_TITLE
)
19374 int col
= (int) current_column (); /* iftc */
19375 w
->column_number_displayed
= make_number (col
);
19376 pint2str (decode_mode_spec_buf
, field_width
, col
);
19377 return decode_mode_spec_buf
;
19381 #ifndef SYSTEM_MALLOC
19383 if (NILP (Vmemory_full
))
19386 return "!MEM FULL! ";
19393 /* %F displays the frame name. */
19394 if (!NILP (f
->title
))
19395 return (char *) SDATA (f
->title
);
19396 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19397 return (char *) SDATA (f
->name
);
19406 int size
= ZV
- BEGV
;
19407 pint2str (decode_mode_spec_buf
, field_width
, size
);
19408 return decode_mode_spec_buf
;
19413 int size
= ZV
- BEGV
;
19414 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19415 return decode_mode_spec_buf
;
19420 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19421 int topline
, nlines
, junk
, height
;
19423 /* %c and %l are ignored in `frame-title-format'. */
19424 if (mode_line_target
== MODE_LINE_TITLE
)
19427 startpos
= XMARKER (w
->start
)->charpos
;
19428 startpos_byte
= marker_byte_position (w
->start
);
19429 height
= WINDOW_TOTAL_LINES (w
);
19431 /* If we decided that this buffer isn't suitable for line numbers,
19432 don't forget that too fast. */
19433 if (EQ (w
->base_line_pos
, w
->buffer
))
19435 /* But do forget it, if the window shows a different buffer now. */
19436 else if (BUFFERP (w
->base_line_pos
))
19437 w
->base_line_pos
= Qnil
;
19439 /* If the buffer is very big, don't waste time. */
19440 if (INTEGERP (Vline_number_display_limit
)
19441 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19443 w
->base_line_pos
= Qnil
;
19444 w
->base_line_number
= Qnil
;
19448 if (INTEGERP (w
->base_line_number
)
19449 && INTEGERP (w
->base_line_pos
)
19450 && XFASTINT (w
->base_line_pos
) <= startpos
)
19452 line
= XFASTINT (w
->base_line_number
);
19453 linepos
= XFASTINT (w
->base_line_pos
);
19454 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19459 linepos
= BUF_BEGV (b
);
19460 linepos_byte
= BUF_BEGV_BYTE (b
);
19463 /* Count lines from base line to window start position. */
19464 nlines
= display_count_lines (linepos
, linepos_byte
,
19468 topline
= nlines
+ line
;
19470 /* Determine a new base line, if the old one is too close
19471 or too far away, or if we did not have one.
19472 "Too close" means it's plausible a scroll-down would
19473 go back past it. */
19474 if (startpos
== BUF_BEGV (b
))
19476 w
->base_line_number
= make_number (topline
);
19477 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19479 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19480 || linepos
== BUF_BEGV (b
))
19482 int limit
= BUF_BEGV (b
);
19483 int limit_byte
= BUF_BEGV_BYTE (b
);
19485 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19487 if (startpos
- distance
> limit
)
19489 limit
= startpos
- distance
;
19490 limit_byte
= CHAR_TO_BYTE (limit
);
19493 nlines
= display_count_lines (startpos
, startpos_byte
,
19495 - (height
* 2 + 30),
19497 /* If we couldn't find the lines we wanted within
19498 line_number_display_limit_width chars per line,
19499 give up on line numbers for this window. */
19500 if (position
== limit_byte
&& limit
== startpos
- distance
)
19502 w
->base_line_pos
= w
->buffer
;
19503 w
->base_line_number
= Qnil
;
19507 w
->base_line_number
= make_number (topline
- nlines
);
19508 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19511 /* Now count lines from the start pos to point. */
19512 nlines
= display_count_lines (startpos
, startpos_byte
,
19513 PT_BYTE
, PT
, &junk
);
19515 /* Record that we did display the line number. */
19516 line_number_displayed
= 1;
19518 /* Make the string to show. */
19519 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19520 return decode_mode_spec_buf
;
19523 char* p
= decode_mode_spec_buf
;
19524 int pad
= field_width
- 2;
19530 return decode_mode_spec_buf
;
19536 obj
= b
->mode_name
;
19540 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19546 int pos
= marker_position (w
->start
);
19547 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19549 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19551 if (pos
<= BUF_BEGV (b
))
19556 else if (pos
<= BUF_BEGV (b
))
19560 if (total
> 1000000)
19561 /* Do it differently for a large value, to avoid overflow. */
19562 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19564 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19565 /* We can't normally display a 3-digit number,
19566 so get us a 2-digit number that is close. */
19569 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19570 return decode_mode_spec_buf
;
19574 /* Display percentage of size above the bottom of the screen. */
19577 int toppos
= marker_position (w
->start
);
19578 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19579 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19581 if (botpos
>= BUF_ZV (b
))
19583 if (toppos
<= BUF_BEGV (b
))
19590 if (total
> 1000000)
19591 /* Do it differently for a large value, to avoid overflow. */
19592 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19594 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19595 /* We can't normally display a 3-digit number,
19596 so get us a 2-digit number that is close. */
19599 if (toppos
<= BUF_BEGV (b
))
19600 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19602 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19603 return decode_mode_spec_buf
;
19608 /* status of process */
19609 obj
= Fget_buffer_process (Fcurrent_buffer ());
19611 return "no process";
19612 #ifdef subprocesses
19613 obj
= Fsymbol_name (Fprocess_status (obj
));
19619 int count
= inhibit_garbage_collection ();
19620 Lisp_Object val
= call1 (intern ("file-remote-p"),
19621 current_buffer
->directory
);
19622 unbind_to (count
, Qnil
);
19630 case 't': /* indicate TEXT or BINARY */
19631 #ifdef MODE_LINE_BINARY_TEXT
19632 return MODE_LINE_BINARY_TEXT (b
);
19638 /* coding-system (not including end-of-line format) */
19640 /* coding-system (including end-of-line type) */
19642 int eol_flag
= (c
== 'Z');
19643 char *p
= decode_mode_spec_buf
;
19645 if (! FRAME_WINDOW_P (f
))
19647 /* No need to mention EOL here--the terminal never needs
19648 to do EOL conversion. */
19649 p
= decode_mode_spec_coding (CODING_ID_NAME
19650 (FRAME_KEYBOARD_CODING (f
)->id
),
19652 p
= decode_mode_spec_coding (CODING_ID_NAME
19653 (FRAME_TERMINAL_CODING (f
)->id
),
19656 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19659 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19660 #ifdef subprocesses
19661 obj
= Fget_buffer_process (Fcurrent_buffer ());
19662 if (PROCESSP (obj
))
19664 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19666 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19669 #endif /* subprocesses */
19672 return decode_mode_spec_buf
;
19679 return (char *) SDATA (obj
);
19686 /* Count up to COUNT lines starting from START / START_BYTE.
19687 But don't go beyond LIMIT_BYTE.
19688 Return the number of lines thus found (always nonnegative).
19690 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19693 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19696 register unsigned char *cursor
;
19697 unsigned char *base
;
19699 register int ceiling
;
19700 register unsigned char *ceiling_addr
;
19701 int orig_count
= count
;
19703 /* If we are not in selective display mode,
19704 check only for newlines. */
19705 int selective_display
= (!NILP (current_buffer
->selective_display
)
19706 && !INTEGERP (current_buffer
->selective_display
));
19710 while (start_byte
< limit_byte
)
19712 ceiling
= BUFFER_CEILING_OF (start_byte
);
19713 ceiling
= min (limit_byte
- 1, ceiling
);
19714 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19715 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19718 if (selective_display
)
19719 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19722 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19725 if (cursor
!= ceiling_addr
)
19729 start_byte
+= cursor
- base
+ 1;
19730 *byte_pos_ptr
= start_byte
;
19734 if (++cursor
== ceiling_addr
)
19740 start_byte
+= cursor
- base
;
19745 while (start_byte
> limit_byte
)
19747 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19748 ceiling
= max (limit_byte
, ceiling
);
19749 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19750 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19753 if (selective_display
)
19754 while (--cursor
!= ceiling_addr
19755 && *cursor
!= '\n' && *cursor
!= 015)
19758 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19761 if (cursor
!= ceiling_addr
)
19765 start_byte
+= cursor
- base
+ 1;
19766 *byte_pos_ptr
= start_byte
;
19767 /* When scanning backwards, we should
19768 not count the newline posterior to which we stop. */
19769 return - orig_count
- 1;
19775 /* Here we add 1 to compensate for the last decrement
19776 of CURSOR, which took it past the valid range. */
19777 start_byte
+= cursor
- base
+ 1;
19781 *byte_pos_ptr
= limit_byte
;
19784 return - orig_count
+ count
;
19785 return orig_count
- count
;
19791 /***********************************************************************
19793 ***********************************************************************/
19795 /* Display a NUL-terminated string, starting with index START.
19797 If STRING is non-null, display that C string. Otherwise, the Lisp
19798 string LISP_STRING is displayed. There's a case that STRING is
19799 non-null and LISP_STRING is not nil. It means STRING is a string
19800 data of LISP_STRING. In that case, we display LISP_STRING while
19801 ignoring its text properties.
19803 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19804 FACE_STRING. Display STRING or LISP_STRING with the face at
19805 FACE_STRING_POS in FACE_STRING:
19807 Display the string in the environment given by IT, but use the
19808 standard display table, temporarily.
19810 FIELD_WIDTH is the minimum number of output glyphs to produce.
19811 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19812 with spaces. If STRING has more characters, more than FIELD_WIDTH
19813 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19815 PRECISION is the maximum number of characters to output from
19816 STRING. PRECISION < 0 means don't truncate the string.
19818 This is roughly equivalent to printf format specifiers:
19820 FIELD_WIDTH PRECISION PRINTF
19821 ----------------------------------------
19827 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19828 display them, and < 0 means obey the current buffer's value of
19829 enable_multibyte_characters.
19831 Value is the number of columns displayed. */
19834 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19835 start
, it
, field_width
, precision
, max_x
, multibyte
)
19836 unsigned char *string
;
19837 Lisp_Object lisp_string
;
19838 Lisp_Object face_string
;
19839 EMACS_INT face_string_pos
;
19842 int field_width
, precision
, max_x
;
19845 int hpos_at_start
= it
->hpos
;
19846 int saved_face_id
= it
->face_id
;
19847 struct glyph_row
*row
= it
->glyph_row
;
19849 /* Initialize the iterator IT for iteration over STRING beginning
19850 with index START. */
19851 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19852 precision
, field_width
, multibyte
);
19853 if (string
&& STRINGP (lisp_string
))
19854 /* LISP_STRING is the one returned by decode_mode_spec. We should
19855 ignore its text properties. */
19856 it
->stop_charpos
= -1;
19858 /* If displaying STRING, set up the face of the iterator
19859 from LISP_STRING, if that's given. */
19860 if (STRINGP (face_string
))
19866 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19867 0, it
->region_beg_charpos
,
19868 it
->region_end_charpos
,
19869 &endptr
, it
->base_face_id
, 0);
19870 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19871 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19874 /* Set max_x to the maximum allowed X position. Don't let it go
19875 beyond the right edge of the window. */
19877 max_x
= it
->last_visible_x
;
19879 max_x
= min (max_x
, it
->last_visible_x
);
19881 /* Skip over display elements that are not visible. because IT->w is
19883 if (it
->current_x
< it
->first_visible_x
)
19884 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19885 MOVE_TO_POS
| MOVE_TO_X
);
19887 row
->ascent
= it
->max_ascent
;
19888 row
->height
= it
->max_ascent
+ it
->max_descent
;
19889 row
->phys_ascent
= it
->max_phys_ascent
;
19890 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19891 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19893 /* This condition is for the case that we are called with current_x
19894 past last_visible_x. */
19895 while (it
->current_x
< max_x
)
19897 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19899 /* Get the next display element. */
19900 if (!get_next_display_element (it
))
19903 /* Produce glyphs. */
19904 x_before
= it
->current_x
;
19905 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19906 PRODUCE_GLYPHS (it
);
19908 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19911 while (i
< nglyphs
)
19913 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19915 if (it
->line_wrap
!= TRUNCATE
19916 && x
+ glyph
->pixel_width
> max_x
)
19918 /* End of continued line or max_x reached. */
19919 if (CHAR_GLYPH_PADDING_P (*glyph
))
19921 /* A wide character is unbreakable. */
19922 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19923 it
->current_x
= x_before
;
19927 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19932 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19934 /* Glyph is at least partially visible. */
19936 if (x
< it
->first_visible_x
)
19937 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19941 /* Glyph is off the left margin of the display area.
19942 Should not happen. */
19946 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19947 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19948 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19949 row
->phys_height
= max (row
->phys_height
,
19950 it
->max_phys_ascent
+ it
->max_phys_descent
);
19951 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19952 it
->max_extra_line_spacing
);
19953 x
+= glyph
->pixel_width
;
19957 /* Stop if max_x reached. */
19961 /* Stop at line ends. */
19962 if (ITERATOR_AT_END_OF_LINE_P (it
))
19964 it
->continuation_lines_width
= 0;
19968 set_iterator_to_next (it
, 1);
19970 /* Stop if truncating at the right edge. */
19971 if (it
->line_wrap
== TRUNCATE
19972 && it
->current_x
>= it
->last_visible_x
)
19974 /* Add truncation mark, but don't do it if the line is
19975 truncated at a padding space. */
19976 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19978 if (!FRAME_WINDOW_P (it
->f
))
19982 if (it
->current_x
> it
->last_visible_x
)
19984 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19985 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19987 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19989 row
->used
[TEXT_AREA
] = i
;
19990 produce_special_glyphs (it
, IT_TRUNCATION
);
19993 produce_special_glyphs (it
, IT_TRUNCATION
);
19995 it
->glyph_row
->truncated_on_right_p
= 1;
20001 /* Maybe insert a truncation at the left. */
20002 if (it
->first_visible_x
20003 && IT_CHARPOS (*it
) > 0)
20005 if (!FRAME_WINDOW_P (it
->f
))
20006 insert_left_trunc_glyphs (it
);
20007 it
->glyph_row
->truncated_on_left_p
= 1;
20010 it
->face_id
= saved_face_id
;
20012 /* Value is number of columns displayed. */
20013 return it
->hpos
- hpos_at_start
;
20018 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20019 appears as an element of LIST or as the car of an element of LIST.
20020 If PROPVAL is a list, compare each element against LIST in that
20021 way, and return 1/2 if any element of PROPVAL is found in LIST.
20022 Otherwise return 0. This function cannot quit.
20023 The return value is 2 if the text is invisible but with an ellipsis
20024 and 1 if it's invisible and without an ellipsis. */
20027 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20029 register Lisp_Object tail
, proptail
;
20031 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20033 register Lisp_Object tem
;
20035 if (EQ (propval
, tem
))
20037 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20038 return NILP (XCDR (tem
)) ? 1 : 2;
20041 if (CONSP (propval
))
20043 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20045 Lisp_Object propelt
;
20046 propelt
= XCAR (proptail
);
20047 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20049 register Lisp_Object tem
;
20051 if (EQ (propelt
, tem
))
20053 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20054 return NILP (XCDR (tem
)) ? 1 : 2;
20062 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20063 doc
: /* Non-nil if the property makes the text invisible.
20064 POS-OR-PROP can be a marker or number, in which case it is taken to be
20065 a position in the current buffer and the value of the `invisible' property
20066 is checked; or it can be some other value, which is then presumed to be the
20067 value of the `invisible' property of the text of interest.
20068 The non-nil value returned can be t for truly invisible text or something
20069 else if the text is replaced by an ellipsis. */)
20070 (Lisp_Object pos_or_prop
)
20073 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20074 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20076 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20077 return (invis
== 0 ? Qnil
20079 : make_number (invis
));
20082 /* Calculate a width or height in pixels from a specification using
20083 the following elements:
20086 NUM - a (fractional) multiple of the default font width/height
20087 (NUM) - specifies exactly NUM pixels
20088 UNIT - a fixed number of pixels, see below.
20089 ELEMENT - size of a display element in pixels, see below.
20090 (NUM . SPEC) - equals NUM * SPEC
20091 (+ SPEC SPEC ...) - add pixel values
20092 (- SPEC SPEC ...) - subtract pixel values
20093 (- SPEC) - negate pixel value
20096 INT or FLOAT - a number constant
20097 SYMBOL - use symbol's (buffer local) variable binding.
20100 in - pixels per inch *)
20101 mm - pixels per 1/1000 meter *)
20102 cm - pixels per 1/100 meter *)
20103 width - width of current font in pixels.
20104 height - height of current font in pixels.
20106 *) using the ratio(s) defined in display-pixels-per-inch.
20110 left-fringe - left fringe width in pixels
20111 right-fringe - right fringe width in pixels
20113 left-margin - left margin width in pixels
20114 right-margin - right margin width in pixels
20116 scroll-bar - scroll-bar area width in pixels
20120 Pixels corresponding to 5 inches:
20123 Total width of non-text areas on left side of window (if scroll-bar is on left):
20124 '(space :width (+ left-fringe left-margin scroll-bar))
20126 Align to first text column (in header line):
20127 '(space :align-to 0)
20129 Align to middle of text area minus half the width of variable `my-image'
20130 containing a loaded image:
20131 '(space :align-to (0.5 . (- text my-image)))
20133 Width of left margin minus width of 1 character in the default font:
20134 '(space :width (- left-margin 1))
20136 Width of left margin minus width of 2 characters in the current font:
20137 '(space :width (- left-margin (2 . width)))
20139 Center 1 character over left-margin (in header line):
20140 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20142 Different ways to express width of left fringe plus left margin minus one pixel:
20143 '(space :width (- (+ left-fringe left-margin) (1)))
20144 '(space :width (+ left-fringe left-margin (- (1))))
20145 '(space :width (+ left-fringe left-margin (-1)))
20149 #define NUMVAL(X) \
20150 ((INTEGERP (X) || FLOATP (X)) \
20155 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20156 struct font
*font
, int width_p
, int *align_to
)
20160 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20161 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20164 return OK_PIXELS (0);
20166 xassert (FRAME_LIVE_P (it
->f
));
20168 if (SYMBOLP (prop
))
20170 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20172 char *unit
= SDATA (SYMBOL_NAME (prop
));
20174 if (unit
[0] == 'i' && unit
[1] == 'n')
20176 else if (unit
[0] == 'm' && unit
[1] == 'm')
20178 else if (unit
[0] == 'c' && unit
[1] == 'm')
20185 #ifdef HAVE_WINDOW_SYSTEM
20186 if (FRAME_WINDOW_P (it
->f
)
20188 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20189 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20191 return OK_PIXELS (ppi
/ pixels
);
20194 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20195 || (CONSP (Vdisplay_pixels_per_inch
)
20197 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20198 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20200 return OK_PIXELS (ppi
/ pixels
);
20206 #ifdef HAVE_WINDOW_SYSTEM
20207 if (EQ (prop
, Qheight
))
20208 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20209 if (EQ (prop
, Qwidth
))
20210 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20212 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20213 return OK_PIXELS (1);
20216 if (EQ (prop
, Qtext
))
20217 return OK_PIXELS (width_p
20218 ? window_box_width (it
->w
, TEXT_AREA
)
20219 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20221 if (align_to
&& *align_to
< 0)
20224 if (EQ (prop
, Qleft
))
20225 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20226 if (EQ (prop
, Qright
))
20227 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20228 if (EQ (prop
, Qcenter
))
20229 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20230 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20231 if (EQ (prop
, Qleft_fringe
))
20232 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20233 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20234 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20235 if (EQ (prop
, Qright_fringe
))
20236 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20237 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20238 : window_box_right_offset (it
->w
, TEXT_AREA
));
20239 if (EQ (prop
, Qleft_margin
))
20240 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20241 if (EQ (prop
, Qright_margin
))
20242 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20243 if (EQ (prop
, Qscroll_bar
))
20244 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20246 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20247 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20248 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20253 if (EQ (prop
, Qleft_fringe
))
20254 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20255 if (EQ (prop
, Qright_fringe
))
20256 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20257 if (EQ (prop
, Qleft_margin
))
20258 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20259 if (EQ (prop
, Qright_margin
))
20260 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20261 if (EQ (prop
, Qscroll_bar
))
20262 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20265 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20268 if (INTEGERP (prop
) || FLOATP (prop
))
20270 int base_unit
= (width_p
20271 ? FRAME_COLUMN_WIDTH (it
->f
)
20272 : FRAME_LINE_HEIGHT (it
->f
));
20273 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20278 Lisp_Object car
= XCAR (prop
);
20279 Lisp_Object cdr
= XCDR (prop
);
20283 #ifdef HAVE_WINDOW_SYSTEM
20284 if (FRAME_WINDOW_P (it
->f
)
20285 && valid_image_p (prop
))
20287 int id
= lookup_image (it
->f
, prop
);
20288 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20290 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20293 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20299 while (CONSP (cdr
))
20301 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20302 font
, width_p
, align_to
))
20305 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20310 if (EQ (car
, Qminus
))
20312 return OK_PIXELS (pixels
);
20315 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20318 if (INTEGERP (car
) || FLOATP (car
))
20321 pixels
= XFLOATINT (car
);
20323 return OK_PIXELS (pixels
);
20324 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20325 font
, width_p
, align_to
))
20326 return OK_PIXELS (pixels
* fact
);
20337 /***********************************************************************
20339 ***********************************************************************/
20341 #ifdef HAVE_WINDOW_SYSTEM
20346 dump_glyph_string (s
)
20347 struct glyph_string
*s
;
20349 fprintf (stderr
, "glyph string\n");
20350 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20351 s
->x
, s
->y
, s
->width
, s
->height
);
20352 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20353 fprintf (stderr
, " hl = %d\n", s
->hl
);
20354 fprintf (stderr
, " left overhang = %d, right = %d\n",
20355 s
->left_overhang
, s
->right_overhang
);
20356 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20357 fprintf (stderr
, " extends to end of line = %d\n",
20358 s
->extends_to_end_of_line_p
);
20359 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20360 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20363 #endif /* GLYPH_DEBUG */
20365 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20366 of XChar2b structures for S; it can't be allocated in
20367 init_glyph_string because it must be allocated via `alloca'. W
20368 is the window on which S is drawn. ROW and AREA are the glyph row
20369 and area within the row from which S is constructed. START is the
20370 index of the first glyph structure covered by S. HL is a
20371 face-override for drawing S. */
20374 #define OPTIONAL_HDC(hdc) HDC hdc,
20375 #define DECLARE_HDC(hdc) HDC hdc;
20376 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20377 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20380 #ifndef OPTIONAL_HDC
20381 #define OPTIONAL_HDC(hdc)
20382 #define DECLARE_HDC(hdc)
20383 #define ALLOCATE_HDC(hdc, f)
20384 #define RELEASE_HDC(hdc, f)
20388 init_glyph_string (struct glyph_string
*s
,
20390 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20391 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20393 memset (s
, 0, sizeof *s
);
20395 s
->f
= XFRAME (w
->frame
);
20399 s
->display
= FRAME_X_DISPLAY (s
->f
);
20400 s
->window
= FRAME_X_WINDOW (s
->f
);
20401 s
->char2b
= char2b
;
20405 s
->first_glyph
= row
->glyphs
[area
] + start
;
20406 s
->height
= row
->height
;
20407 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20408 s
->ybase
= s
->y
+ row
->ascent
;
20412 /* Append the list of glyph strings with head H and tail T to the list
20413 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20416 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20417 struct glyph_string
*h
, struct glyph_string
*t
)
20431 /* Prepend the list of glyph strings with head H and tail T to the
20432 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20436 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20437 struct glyph_string
*h
, struct glyph_string
*t
)
20451 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20452 Set *HEAD and *TAIL to the resulting list. */
20455 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20456 struct glyph_string
*s
)
20458 s
->next
= s
->prev
= NULL
;
20459 append_glyph_string_lists (head
, tail
, s
, s
);
20463 /* Get face and two-byte form of character C in face FACE_ID on frame
20464 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20465 means we want to display multibyte text. DISPLAY_P non-zero means
20466 make sure that X resources for the face returned are allocated.
20467 Value is a pointer to a realized face that is ready for display if
20468 DISPLAY_P is non-zero. */
20470 static INLINE
struct face
*
20471 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20472 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20474 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20478 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20480 if (code
!= FONT_INVALID_CODE
)
20481 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20483 STORE_XCHAR2B (char2b
, 0, 0);
20486 /* Make sure X resources of the face are allocated. */
20487 #ifdef HAVE_X_WINDOWS
20491 xassert (face
!= NULL
);
20492 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20499 /* Get face and two-byte form of character glyph GLYPH on frame F.
20500 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20501 a pointer to a realized face that is ready for display. */
20503 static INLINE
struct face
*
20504 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20505 XChar2b
*char2b
, int *two_byte_p
)
20509 xassert (glyph
->type
== CHAR_GLYPH
);
20510 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20517 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20519 if (code
!= FONT_INVALID_CODE
)
20520 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20522 STORE_XCHAR2B (char2b
, 0, 0);
20525 /* Make sure X resources of the face are allocated. */
20526 xassert (face
!= NULL
);
20527 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20532 /* Fill glyph string S with composition components specified by S->cmp.
20534 BASE_FACE is the base face of the composition.
20535 S->cmp_from is the index of the first component for S.
20537 OVERLAPS non-zero means S should draw the foreground only, and use
20538 its physical height for clipping. See also draw_glyphs.
20540 Value is the index of a component not in S. */
20543 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20547 /* For all glyphs of this composition, starting at the offset
20548 S->cmp_from, until we reach the end of the definition or encounter a
20549 glyph that requires the different face, add it to S. */
20554 s
->for_overlaps
= overlaps
;
20557 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20559 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20563 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20566 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20567 s
->char2b
+ i
, 1, 1);
20573 s
->font
= s
->face
->font
;
20575 else if (s
->face
!= face
)
20583 /* All glyph strings for the same composition has the same width,
20584 i.e. the width set for the first component of the composition. */
20585 s
->width
= s
->first_glyph
->pixel_width
;
20587 /* If the specified font could not be loaded, use the frame's
20588 default font, but record the fact that we couldn't load it in
20589 the glyph string so that we can draw rectangles for the
20590 characters of the glyph string. */
20591 if (s
->font
== NULL
)
20593 s
->font_not_found_p
= 1;
20594 s
->font
= FRAME_FONT (s
->f
);
20597 /* Adjust base line for subscript/superscript text. */
20598 s
->ybase
+= s
->first_glyph
->voffset
;
20600 /* This glyph string must always be drawn with 16-bit functions. */
20607 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20608 int start
, int end
, int overlaps
)
20610 struct glyph
*glyph
, *last
;
20611 Lisp_Object lgstring
;
20614 s
->for_overlaps
= overlaps
;
20615 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20616 last
= s
->row
->glyphs
[s
->area
] + end
;
20617 s
->cmp_id
= glyph
->u
.cmp
.id
;
20618 s
->cmp_from
= glyph
->u
.cmp
.from
;
20619 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20620 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20621 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20622 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20624 while (glyph
< last
20625 && glyph
->u
.cmp
.automatic
20626 && glyph
->u
.cmp
.id
== s
->cmp_id
20627 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20628 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20630 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20632 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20633 unsigned code
= LGLYPH_CODE (lglyph
);
20635 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20637 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20638 return glyph
- s
->row
->glyphs
[s
->area
];
20642 /* Fill glyph string S from a sequence of character glyphs.
20644 FACE_ID is the face id of the string. START is the index of the
20645 first glyph to consider, END is the index of the last + 1.
20646 OVERLAPS non-zero means S should draw the foreground only, and use
20647 its physical height for clipping. See also draw_glyphs.
20649 Value is the index of the first glyph not in S. */
20652 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20653 int start
, int end
, int overlaps
)
20655 struct glyph
*glyph
, *last
;
20657 int glyph_not_available_p
;
20659 xassert (s
->f
== XFRAME (s
->w
->frame
));
20660 xassert (s
->nchars
== 0);
20661 xassert (start
>= 0 && end
> start
);
20663 s
->for_overlaps
= overlaps
;
20664 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20665 last
= s
->row
->glyphs
[s
->area
] + end
;
20666 voffset
= glyph
->voffset
;
20667 s
->padding_p
= glyph
->padding_p
;
20668 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20670 while (glyph
< last
20671 && glyph
->type
== CHAR_GLYPH
20672 && glyph
->voffset
== voffset
20673 /* Same face id implies same font, nowadays. */
20674 && glyph
->face_id
== face_id
20675 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20679 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20680 s
->char2b
+ s
->nchars
,
20682 s
->two_byte_p
= two_byte_p
;
20684 xassert (s
->nchars
<= end
- start
);
20685 s
->width
+= glyph
->pixel_width
;
20686 if (glyph
++->padding_p
!= s
->padding_p
)
20690 s
->font
= s
->face
->font
;
20692 /* If the specified font could not be loaded, use the frame's font,
20693 but record the fact that we couldn't load it in
20694 S->font_not_found_p so that we can draw rectangles for the
20695 characters of the glyph string. */
20696 if (s
->font
== NULL
|| glyph_not_available_p
)
20698 s
->font_not_found_p
= 1;
20699 s
->font
= FRAME_FONT (s
->f
);
20702 /* Adjust base line for subscript/superscript text. */
20703 s
->ybase
+= voffset
;
20705 xassert (s
->face
&& s
->face
->gc
);
20706 return glyph
- s
->row
->glyphs
[s
->area
];
20710 /* Fill glyph string S from image glyph S->first_glyph. */
20713 fill_image_glyph_string (struct glyph_string
*s
)
20715 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20716 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20718 s
->slice
= s
->first_glyph
->slice
;
20719 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20720 s
->font
= s
->face
->font
;
20721 s
->width
= s
->first_glyph
->pixel_width
;
20723 /* Adjust base line for subscript/superscript text. */
20724 s
->ybase
+= s
->first_glyph
->voffset
;
20728 /* Fill glyph string S from a sequence of stretch glyphs.
20730 ROW is the glyph row in which the glyphs are found, AREA is the
20731 area within the row. START is the index of the first glyph to
20732 consider, END is the index of the last + 1.
20734 Value is the index of the first glyph not in S. */
20737 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20738 enum glyph_row_area area
, int start
, int end
)
20740 struct glyph
*glyph
, *last
;
20741 int voffset
, face_id
;
20743 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20745 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20746 last
= s
->row
->glyphs
[s
->area
] + end
;
20747 face_id
= glyph
->face_id
;
20748 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20749 s
->font
= s
->face
->font
;
20750 s
->width
= glyph
->pixel_width
;
20752 voffset
= glyph
->voffset
;
20756 && glyph
->type
== STRETCH_GLYPH
20757 && glyph
->voffset
== voffset
20758 && glyph
->face_id
== face_id
);
20760 s
->width
+= glyph
->pixel_width
;
20762 /* Adjust base line for subscript/superscript text. */
20763 s
->ybase
+= voffset
;
20765 /* The case that face->gc == 0 is handled when drawing the glyph
20766 string by calling PREPARE_FACE_FOR_DISPLAY. */
20768 return glyph
- s
->row
->glyphs
[s
->area
];
20771 static struct font_metrics
*
20772 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20774 static struct font_metrics metrics
;
20775 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20777 if (! font
|| code
== FONT_INVALID_CODE
)
20779 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20784 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20785 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20786 assumed to be zero. */
20789 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20791 *left
= *right
= 0;
20793 if (glyph
->type
== CHAR_GLYPH
)
20797 struct font_metrics
*pcm
;
20799 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20800 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20802 if (pcm
->rbearing
> pcm
->width
)
20803 *right
= pcm
->rbearing
- pcm
->width
;
20804 if (pcm
->lbearing
< 0)
20805 *left
= -pcm
->lbearing
;
20808 else if (glyph
->type
== COMPOSITE_GLYPH
)
20810 if (! glyph
->u
.cmp
.automatic
)
20812 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20814 if (cmp
->rbearing
> cmp
->pixel_width
)
20815 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20816 if (cmp
->lbearing
< 0)
20817 *left
= - cmp
->lbearing
;
20821 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20822 struct font_metrics metrics
;
20824 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20825 glyph
->u
.cmp
.to
+ 1, &metrics
);
20826 if (metrics
.rbearing
> metrics
.width
)
20827 *right
= metrics
.rbearing
- metrics
.width
;
20828 if (metrics
.lbearing
< 0)
20829 *left
= - metrics
.lbearing
;
20835 /* Return the index of the first glyph preceding glyph string S that
20836 is overwritten by S because of S's left overhang. Value is -1
20837 if no glyphs are overwritten. */
20840 left_overwritten (struct glyph_string
*s
)
20844 if (s
->left_overhang
)
20847 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20848 int first
= s
->first_glyph
- glyphs
;
20850 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20851 x
-= glyphs
[i
].pixel_width
;
20862 /* Return the index of the first glyph preceding glyph string S that
20863 is overwriting S because of its right overhang. Value is -1 if no
20864 glyph in front of S overwrites S. */
20867 left_overwriting (struct glyph_string
*s
)
20870 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20871 int first
= s
->first_glyph
- glyphs
;
20875 for (i
= first
- 1; i
>= 0; --i
)
20878 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20881 x
-= glyphs
[i
].pixel_width
;
20888 /* Return the index of the last glyph following glyph string S that is
20889 overwritten by S because of S's right overhang. Value is -1 if
20890 no such glyph is found. */
20893 right_overwritten (struct glyph_string
*s
)
20897 if (s
->right_overhang
)
20900 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20901 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20902 int end
= s
->row
->used
[s
->area
];
20904 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20905 x
+= glyphs
[i
].pixel_width
;
20914 /* Return the index of the last glyph following glyph string S that
20915 overwrites S because of its left overhang. Value is negative
20916 if no such glyph is found. */
20919 right_overwriting (struct glyph_string
*s
)
20922 int end
= s
->row
->used
[s
->area
];
20923 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20924 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20928 for (i
= first
; i
< end
; ++i
)
20931 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20934 x
+= glyphs
[i
].pixel_width
;
20941 /* Set background width of glyph string S. START is the index of the
20942 first glyph following S. LAST_X is the right-most x-position + 1
20943 in the drawing area. */
20946 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20948 /* If the face of this glyph string has to be drawn to the end of
20949 the drawing area, set S->extends_to_end_of_line_p. */
20951 if (start
== s
->row
->used
[s
->area
]
20952 && s
->area
== TEXT_AREA
20953 && ((s
->row
->fill_line_p
20954 && (s
->hl
== DRAW_NORMAL_TEXT
20955 || s
->hl
== DRAW_IMAGE_RAISED
20956 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20957 || s
->hl
== DRAW_MOUSE_FACE
))
20958 s
->extends_to_end_of_line_p
= 1;
20960 /* If S extends its face to the end of the line, set its
20961 background_width to the distance to the right edge of the drawing
20963 if (s
->extends_to_end_of_line_p
)
20964 s
->background_width
= last_x
- s
->x
+ 1;
20966 s
->background_width
= s
->width
;
20970 /* Compute overhangs and x-positions for glyph string S and its
20971 predecessors, or successors. X is the starting x-position for S.
20972 BACKWARD_P non-zero means process predecessors. */
20975 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20981 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20982 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20992 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20993 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21003 /* The following macros are only called from draw_glyphs below.
21004 They reference the following parameters of that function directly:
21005 `w', `row', `area', and `overlap_p'
21006 as well as the following local variables:
21007 `s', `f', and `hdc' (in W32) */
21010 /* On W32, silently add local `hdc' variable to argument list of
21011 init_glyph_string. */
21012 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21013 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21015 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21016 init_glyph_string (s, char2b, w, row, area, start, hl)
21019 /* Add a glyph string for a stretch glyph to the list of strings
21020 between HEAD and TAIL. START is the index of the stretch glyph in
21021 row area AREA of glyph row ROW. END is the index of the last glyph
21022 in that glyph row area. X is the current output position assigned
21023 to the new glyph string constructed. HL overrides that face of the
21024 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21025 is the right-most x-position of the drawing area. */
21027 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21028 and below -- keep them on one line. */
21029 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21032 s = (struct glyph_string *) alloca (sizeof *s); \
21033 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21034 START = fill_stretch_glyph_string (s, row, area, START, END); \
21035 append_glyph_string (&HEAD, &TAIL, s); \
21041 /* Add a glyph string for an image glyph to the list of strings
21042 between HEAD and TAIL. START is the index of the image glyph in
21043 row area AREA of glyph row ROW. END is the index of the last glyph
21044 in that glyph row area. X is the current output position assigned
21045 to the new glyph string constructed. HL overrides that face of the
21046 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21047 is the right-most x-position of the drawing area. */
21049 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21052 s = (struct glyph_string *) alloca (sizeof *s); \
21053 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21054 fill_image_glyph_string (s); \
21055 append_glyph_string (&HEAD, &TAIL, s); \
21062 /* Add a glyph string for a sequence of character glyphs to the list
21063 of strings between HEAD and TAIL. START is the index of the first
21064 glyph in row area AREA of glyph row ROW that is part of the new
21065 glyph string. END is the index of the last glyph in that glyph row
21066 area. X is the current output position assigned to the new glyph
21067 string constructed. HL overrides that face of the glyph; e.g. it
21068 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21069 right-most x-position of the drawing area. */
21071 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21077 face_id = (row)->glyphs[area][START].face_id; \
21079 s = (struct glyph_string *) alloca (sizeof *s); \
21080 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21081 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21082 append_glyph_string (&HEAD, &TAIL, s); \
21084 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21089 /* Add a glyph string for a composite sequence to the list of strings
21090 between HEAD and TAIL. START is the index of the first glyph in
21091 row area AREA of glyph row ROW that is part of the new glyph
21092 string. END is the index of the last glyph in that glyph row area.
21093 X is the current output position assigned to the new glyph string
21094 constructed. HL overrides that face of the glyph; e.g. it is
21095 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21096 x-position of the drawing area. */
21098 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21100 int face_id = (row)->glyphs[area][START].face_id; \
21101 struct face *base_face = FACE_FROM_ID (f, face_id); \
21102 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21103 struct composition *cmp = composition_table[cmp_id]; \
21105 struct glyph_string *first_s; \
21108 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21110 /* Make glyph_strings for each glyph sequence that is drawable by \
21111 the same face, and append them to HEAD/TAIL. */ \
21112 for (n = 0; n < cmp->glyph_len;) \
21114 s = (struct glyph_string *) alloca (sizeof *s); \
21115 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21116 append_glyph_string (&(HEAD), &(TAIL), s); \
21122 n = fill_composite_glyph_string (s, base_face, overlaps); \
21130 /* Add a glyph string for a glyph-string sequence to the list of strings
21131 between HEAD and TAIL. */
21133 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21137 Lisp_Object gstring; \
21139 face_id = (row)->glyphs[area][START].face_id; \
21140 gstring = (composition_gstring_from_id \
21141 ((row)->glyphs[area][START].u.cmp.id)); \
21142 s = (struct glyph_string *) alloca (sizeof *s); \
21143 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21144 * LGSTRING_GLYPH_LEN (gstring)); \
21145 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21146 append_glyph_string (&(HEAD), &(TAIL), s); \
21148 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21152 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21153 of AREA of glyph row ROW on window W between indices START and END.
21154 HL overrides the face for drawing glyph strings, e.g. it is
21155 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21156 x-positions of the drawing area.
21158 This is an ugly monster macro construct because we must use alloca
21159 to allocate glyph strings (because draw_glyphs can be called
21160 asynchronously). */
21162 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21165 HEAD = TAIL = NULL; \
21166 while (START < END) \
21168 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21169 switch (first_glyph->type) \
21172 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21176 case COMPOSITE_GLYPH: \
21177 if (first_glyph->u.cmp.automatic) \
21178 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21181 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21185 case STRETCH_GLYPH: \
21186 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21190 case IMAGE_GLYPH: \
21191 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21201 set_glyph_string_background_width (s, START, LAST_X); \
21208 /* Draw glyphs between START and END in AREA of ROW on window W,
21209 starting at x-position X. X is relative to AREA in W. HL is a
21210 face-override with the following meaning:
21212 DRAW_NORMAL_TEXT draw normally
21213 DRAW_CURSOR draw in cursor face
21214 DRAW_MOUSE_FACE draw in mouse face.
21215 DRAW_INVERSE_VIDEO draw in mode line face
21216 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21217 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21219 If OVERLAPS is non-zero, draw only the foreground of characters and
21220 clip to the physical height of ROW. Non-zero value also defines
21221 the overlapping part to be drawn:
21223 OVERLAPS_PRED overlap with preceding rows
21224 OVERLAPS_SUCC overlap with succeeding rows
21225 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21226 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21228 Value is the x-position reached, relative to AREA of W. */
21231 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21232 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21233 enum draw_glyphs_face hl
, int overlaps
)
21235 struct glyph_string
*head
, *tail
;
21236 struct glyph_string
*s
;
21237 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21238 int i
, j
, x_reached
, last_x
, area_left
= 0;
21239 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21242 ALLOCATE_HDC (hdc
, f
);
21244 /* Let's rather be paranoid than getting a SEGV. */
21245 end
= min (end
, row
->used
[area
]);
21246 start
= max (0, start
);
21247 start
= min (end
, start
);
21249 /* Translate X to frame coordinates. Set last_x to the right
21250 end of the drawing area. */
21251 if (row
->full_width_p
)
21253 /* X is relative to the left edge of W, without scroll bars
21255 area_left
= WINDOW_LEFT_EDGE_X (w
);
21256 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21260 area_left
= window_box_left (w
, area
);
21261 last_x
= area_left
+ window_box_width (w
, area
);
21265 /* Build a doubly-linked list of glyph_string structures between
21266 head and tail from what we have to draw. Note that the macro
21267 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21268 the reason we use a separate variable `i'. */
21270 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21272 x_reached
= tail
->x
+ tail
->background_width
;
21276 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21277 the row, redraw some glyphs in front or following the glyph
21278 strings built above. */
21279 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21281 struct glyph_string
*h
, *t
;
21282 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21283 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21286 /* If mouse highlighting is on, we may need to draw adjacent
21287 glyphs using mouse-face highlighting. */
21288 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21290 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21292 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21293 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21295 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21297 check_mouse_face
= 1;
21298 mouse_beg_col
= (row
== mouse_beg_row
)
21299 ? dpyinfo
->mouse_face_beg_col
: 0;
21300 mouse_end_col
= (row
== mouse_end_row
)
21301 ? dpyinfo
->mouse_face_end_col
21302 : row
->used
[TEXT_AREA
];
21306 /* Compute overhangs for all glyph strings. */
21307 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21308 for (s
= head
; s
; s
= s
->next
)
21309 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21311 /* Prepend glyph strings for glyphs in front of the first glyph
21312 string that are overwritten because of the first glyph
21313 string's left overhang. The background of all strings
21314 prepended must be drawn because the first glyph string
21316 i
= left_overwritten (head
);
21319 enum draw_glyphs_face overlap_hl
;
21321 /* If this row contains mouse highlighting, attempt to draw
21322 the overlapped glyphs with the correct highlight. This
21323 code fails if the overlap encompasses more than one glyph
21324 and mouse-highlight spans only some of these glyphs.
21325 However, making it work perfectly involves a lot more
21326 code, and I don't know if the pathological case occurs in
21327 practice, so we'll stick to this for now. --- cyd */
21328 if (check_mouse_face
21329 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21330 overlap_hl
= DRAW_MOUSE_FACE
;
21332 overlap_hl
= DRAW_NORMAL_TEXT
;
21335 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21336 overlap_hl
, dummy_x
, last_x
);
21338 compute_overhangs_and_x (t
, head
->x
, 1);
21339 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21343 /* Prepend glyph strings for glyphs in front of the first glyph
21344 string that overwrite that glyph string because of their
21345 right overhang. For these strings, only the foreground must
21346 be drawn, because it draws over the glyph string at `head'.
21347 The background must not be drawn because this would overwrite
21348 right overhangs of preceding glyphs for which no glyph
21350 i
= left_overwriting (head
);
21353 enum draw_glyphs_face overlap_hl
;
21355 if (check_mouse_face
21356 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21357 overlap_hl
= DRAW_MOUSE_FACE
;
21359 overlap_hl
= DRAW_NORMAL_TEXT
;
21362 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21363 overlap_hl
, dummy_x
, last_x
);
21364 for (s
= h
; s
; s
= s
->next
)
21365 s
->background_filled_p
= 1;
21366 compute_overhangs_and_x (t
, head
->x
, 1);
21367 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21370 /* Append glyphs strings for glyphs following the last glyph
21371 string tail that are overwritten by tail. The background of
21372 these strings has to be drawn because tail's foreground draws
21374 i
= right_overwritten (tail
);
21377 enum draw_glyphs_face overlap_hl
;
21379 if (check_mouse_face
21380 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21381 overlap_hl
= DRAW_MOUSE_FACE
;
21383 overlap_hl
= DRAW_NORMAL_TEXT
;
21385 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21386 overlap_hl
, x
, last_x
);
21387 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21388 we don't have `end = i;' here. */
21389 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21390 append_glyph_string_lists (&head
, &tail
, h
, t
);
21394 /* Append glyph strings for glyphs following the last glyph
21395 string tail that overwrite tail. The foreground of such
21396 glyphs has to be drawn because it writes into the background
21397 of tail. The background must not be drawn because it could
21398 paint over the foreground of following glyphs. */
21399 i
= right_overwriting (tail
);
21402 enum draw_glyphs_face overlap_hl
;
21403 if (check_mouse_face
21404 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21405 overlap_hl
= DRAW_MOUSE_FACE
;
21407 overlap_hl
= DRAW_NORMAL_TEXT
;
21410 i
++; /* We must include the Ith glyph. */
21411 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21412 overlap_hl
, x
, last_x
);
21413 for (s
= h
; s
; s
= s
->next
)
21414 s
->background_filled_p
= 1;
21415 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21416 append_glyph_string_lists (&head
, &tail
, h
, t
);
21418 if (clip_head
|| clip_tail
)
21419 for (s
= head
; s
; s
= s
->next
)
21421 s
->clip_head
= clip_head
;
21422 s
->clip_tail
= clip_tail
;
21426 /* Draw all strings. */
21427 for (s
= head
; s
; s
= s
->next
)
21428 FRAME_RIF (f
)->draw_glyph_string (s
);
21431 /* When focus a sole frame and move horizontally, this sets on_p to 0
21432 causing a failure to erase prev cursor position. */
21433 if (area
== TEXT_AREA
21434 && !row
->full_width_p
21435 /* When drawing overlapping rows, only the glyph strings'
21436 foreground is drawn, which doesn't erase a cursor
21440 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21441 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21442 : (tail
? tail
->x
+ tail
->background_width
: x
));
21446 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21447 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21451 /* Value is the x-position up to which drawn, relative to AREA of W.
21452 This doesn't include parts drawn because of overhangs. */
21453 if (row
->full_width_p
)
21454 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21456 x_reached
-= area_left
;
21458 RELEASE_HDC (hdc
, f
);
21463 /* Expand row matrix if too narrow. Don't expand if area
21466 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21468 if (!fonts_changed_p \
21469 && (it->glyph_row->glyphs[area] \
21470 < it->glyph_row->glyphs[area + 1])) \
21472 it->w->ncols_scale_factor++; \
21473 fonts_changed_p = 1; \
21477 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21478 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21481 append_glyph (struct it
*it
)
21483 struct glyph
*glyph
;
21484 enum glyph_row_area area
= it
->area
;
21486 xassert (it
->glyph_row
);
21487 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21489 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21490 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21492 /* If the glyph row is reversed, we need to prepend the glyph
21493 rather than append it. */
21494 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21498 /* Make room for the additional glyph. */
21499 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21501 glyph
= it
->glyph_row
->glyphs
[area
];
21503 glyph
->charpos
= CHARPOS (it
->position
);
21504 glyph
->object
= it
->object
;
21505 if (it
->pixel_width
> 0)
21507 glyph
->pixel_width
= it
->pixel_width
;
21508 glyph
->padding_p
= 0;
21512 /* Assure at least 1-pixel width. Otherwise, cursor can't
21513 be displayed correctly. */
21514 glyph
->pixel_width
= 1;
21515 glyph
->padding_p
= 1;
21517 glyph
->ascent
= it
->ascent
;
21518 glyph
->descent
= it
->descent
;
21519 glyph
->voffset
= it
->voffset
;
21520 glyph
->type
= CHAR_GLYPH
;
21521 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21522 glyph
->multibyte_p
= it
->multibyte_p
;
21523 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21524 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21525 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21526 || it
->phys_descent
> it
->descent
);
21527 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21528 glyph
->face_id
= it
->face_id
;
21529 glyph
->u
.ch
= it
->char_to_display
;
21530 glyph
->slice
= null_glyph_slice
;
21531 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21534 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21535 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21537 glyph
->bidi_type
= it
->bidi_it
.type
;
21541 glyph
->resolved_level
= 0;
21542 glyph
->bidi_type
= UNKNOWN_BT
;
21544 ++it
->glyph_row
->used
[area
];
21547 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21550 /* Store one glyph for the composition IT->cmp_it.id in
21551 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21555 append_composite_glyph (struct it
*it
)
21557 struct glyph
*glyph
;
21558 enum glyph_row_area area
= it
->area
;
21560 xassert (it
->glyph_row
);
21562 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21563 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21565 /* If the glyph row is reversed, we need to prepend the glyph
21566 rather than append it. */
21567 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21571 /* Make room for the new glyph. */
21572 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21574 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21576 glyph
->charpos
= it
->cmp_it
.charpos
;
21577 glyph
->object
= it
->object
;
21578 glyph
->pixel_width
= it
->pixel_width
;
21579 glyph
->ascent
= it
->ascent
;
21580 glyph
->descent
= it
->descent
;
21581 glyph
->voffset
= it
->voffset
;
21582 glyph
->type
= COMPOSITE_GLYPH
;
21583 if (it
->cmp_it
.ch
< 0)
21585 glyph
->u
.cmp
.automatic
= 0;
21586 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21590 glyph
->u
.cmp
.automatic
= 1;
21591 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21592 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21593 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21595 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21596 glyph
->multibyte_p
= it
->multibyte_p
;
21597 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21598 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21599 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21600 || it
->phys_descent
> it
->descent
);
21601 glyph
->padding_p
= 0;
21602 glyph
->glyph_not_available_p
= 0;
21603 glyph
->face_id
= it
->face_id
;
21604 glyph
->slice
= null_glyph_slice
;
21605 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21608 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21609 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21611 glyph
->bidi_type
= it
->bidi_it
.type
;
21613 ++it
->glyph_row
->used
[area
];
21616 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21620 /* Change IT->ascent and IT->height according to the setting of
21624 take_vertical_position_into_account (struct it
*it
)
21628 if (it
->voffset
< 0)
21629 /* Increase the ascent so that we can display the text higher
21631 it
->ascent
-= it
->voffset
;
21633 /* Increase the descent so that we can display the text lower
21635 it
->descent
+= it
->voffset
;
21640 /* Produce glyphs/get display metrics for the image IT is loaded with.
21641 See the description of struct display_iterator in dispextern.h for
21642 an overview of struct display_iterator. */
21645 produce_image_glyph (struct it
*it
)
21649 int glyph_ascent
, crop
;
21650 struct glyph_slice slice
;
21652 xassert (it
->what
== IT_IMAGE
);
21654 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21656 /* Make sure X resources of the face is loaded. */
21657 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21659 if (it
->image_id
< 0)
21661 /* Fringe bitmap. */
21662 it
->ascent
= it
->phys_ascent
= 0;
21663 it
->descent
= it
->phys_descent
= 0;
21664 it
->pixel_width
= 0;
21669 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21671 /* Make sure X resources of the image is loaded. */
21672 prepare_image_for_display (it
->f
, img
);
21674 slice
.x
= slice
.y
= 0;
21675 slice
.width
= img
->width
;
21676 slice
.height
= img
->height
;
21678 if (INTEGERP (it
->slice
.x
))
21679 slice
.x
= XINT (it
->slice
.x
);
21680 else if (FLOATP (it
->slice
.x
))
21681 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21683 if (INTEGERP (it
->slice
.y
))
21684 slice
.y
= XINT (it
->slice
.y
);
21685 else if (FLOATP (it
->slice
.y
))
21686 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21688 if (INTEGERP (it
->slice
.width
))
21689 slice
.width
= XINT (it
->slice
.width
);
21690 else if (FLOATP (it
->slice
.width
))
21691 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21693 if (INTEGERP (it
->slice
.height
))
21694 slice
.height
= XINT (it
->slice
.height
);
21695 else if (FLOATP (it
->slice
.height
))
21696 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21698 if (slice
.x
>= img
->width
)
21699 slice
.x
= img
->width
;
21700 if (slice
.y
>= img
->height
)
21701 slice
.y
= img
->height
;
21702 if (slice
.x
+ slice
.width
>= img
->width
)
21703 slice
.width
= img
->width
- slice
.x
;
21704 if (slice
.y
+ slice
.height
> img
->height
)
21705 slice
.height
= img
->height
- slice
.y
;
21707 if (slice
.width
== 0 || slice
.height
== 0)
21710 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21712 it
->descent
= slice
.height
- glyph_ascent
;
21714 it
->descent
+= img
->vmargin
;
21715 if (slice
.y
+ slice
.height
== img
->height
)
21716 it
->descent
+= img
->vmargin
;
21717 it
->phys_descent
= it
->descent
;
21719 it
->pixel_width
= slice
.width
;
21721 it
->pixel_width
+= img
->hmargin
;
21722 if (slice
.x
+ slice
.width
== img
->width
)
21723 it
->pixel_width
+= img
->hmargin
;
21725 /* It's quite possible for images to have an ascent greater than
21726 their height, so don't get confused in that case. */
21727 if (it
->descent
< 0)
21732 if (face
->box
!= FACE_NO_BOX
)
21734 if (face
->box_line_width
> 0)
21737 it
->ascent
+= face
->box_line_width
;
21738 if (slice
.y
+ slice
.height
== img
->height
)
21739 it
->descent
+= face
->box_line_width
;
21742 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21743 it
->pixel_width
+= eabs (face
->box_line_width
);
21744 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21745 it
->pixel_width
+= eabs (face
->box_line_width
);
21748 take_vertical_position_into_account (it
);
21750 /* Automatically crop wide image glyphs at right edge so we can
21751 draw the cursor on same display row. */
21752 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21753 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21755 it
->pixel_width
-= crop
;
21756 slice
.width
-= crop
;
21761 struct glyph
*glyph
;
21762 enum glyph_row_area area
= it
->area
;
21764 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21765 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21767 glyph
->charpos
= CHARPOS (it
->position
);
21768 glyph
->object
= it
->object
;
21769 glyph
->pixel_width
= it
->pixel_width
;
21770 glyph
->ascent
= glyph_ascent
;
21771 glyph
->descent
= it
->descent
;
21772 glyph
->voffset
= it
->voffset
;
21773 glyph
->type
= IMAGE_GLYPH
;
21774 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21775 glyph
->multibyte_p
= it
->multibyte_p
;
21776 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21777 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21778 glyph
->overlaps_vertically_p
= 0;
21779 glyph
->padding_p
= 0;
21780 glyph
->glyph_not_available_p
= 0;
21781 glyph
->face_id
= it
->face_id
;
21782 glyph
->u
.img_id
= img
->id
;
21783 glyph
->slice
= slice
;
21784 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21787 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21788 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21790 glyph
->bidi_type
= it
->bidi_it
.type
;
21792 ++it
->glyph_row
->used
[area
];
21795 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21800 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21801 of the glyph, WIDTH and HEIGHT are the width and height of the
21802 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21805 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21806 int width
, int height
, int ascent
)
21808 struct glyph
*glyph
;
21809 enum glyph_row_area area
= it
->area
;
21811 xassert (ascent
>= 0 && ascent
<= height
);
21813 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21814 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21816 /* If the glyph row is reversed, we need to prepend the glyph
21817 rather than append it. */
21818 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21822 /* Make room for the additional glyph. */
21823 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21825 glyph
= it
->glyph_row
->glyphs
[area
];
21827 glyph
->charpos
= CHARPOS (it
->position
);
21828 glyph
->object
= object
;
21829 glyph
->pixel_width
= width
;
21830 glyph
->ascent
= ascent
;
21831 glyph
->descent
= height
- ascent
;
21832 glyph
->voffset
= it
->voffset
;
21833 glyph
->type
= STRETCH_GLYPH
;
21834 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21835 glyph
->multibyte_p
= it
->multibyte_p
;
21836 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21837 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21838 glyph
->overlaps_vertically_p
= 0;
21839 glyph
->padding_p
= 0;
21840 glyph
->glyph_not_available_p
= 0;
21841 glyph
->face_id
= it
->face_id
;
21842 glyph
->u
.stretch
.ascent
= ascent
;
21843 glyph
->u
.stretch
.height
= height
;
21844 glyph
->slice
= null_glyph_slice
;
21845 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21848 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21849 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21851 glyph
->bidi_type
= it
->bidi_it
.type
;
21855 glyph
->resolved_level
= 0;
21856 glyph
->bidi_type
= UNKNOWN_BT
;
21858 ++it
->glyph_row
->used
[area
];
21861 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21865 /* Produce a stretch glyph for iterator IT. IT->object is the value
21866 of the glyph property displayed. The value must be a list
21867 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21870 1. `:width WIDTH' specifies that the space should be WIDTH *
21871 canonical char width wide. WIDTH may be an integer or floating
21874 2. `:relative-width FACTOR' specifies that the width of the stretch
21875 should be computed from the width of the first character having the
21876 `glyph' property, and should be FACTOR times that width.
21878 3. `:align-to HPOS' specifies that the space should be wide enough
21879 to reach HPOS, a value in canonical character units.
21881 Exactly one of the above pairs must be present.
21883 4. `:height HEIGHT' specifies that the height of the stretch produced
21884 should be HEIGHT, measured in canonical character units.
21886 5. `:relative-height FACTOR' specifies that the height of the
21887 stretch should be FACTOR times the height of the characters having
21888 the glyph property.
21890 Either none or exactly one of 4 or 5 must be present.
21892 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21893 of the stretch should be used for the ascent of the stretch.
21894 ASCENT must be in the range 0 <= ASCENT <= 100. */
21897 produce_stretch_glyph (struct it
*it
)
21899 /* (space :width WIDTH :height HEIGHT ...) */
21900 Lisp_Object prop
, plist
;
21901 int width
= 0, height
= 0, align_to
= -1;
21902 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21905 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21906 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21908 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21910 /* List should start with `space'. */
21911 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21912 plist
= XCDR (it
->object
);
21914 /* Compute the width of the stretch. */
21915 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21916 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21918 /* Absolute width `:width WIDTH' specified and valid. */
21919 zero_width_ok_p
= 1;
21922 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21925 /* Relative width `:relative-width FACTOR' specified and valid.
21926 Compute the width of the characters having the `glyph'
21929 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21932 if (it
->multibyte_p
)
21934 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21935 - IT_BYTEPOS (*it
));
21936 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21939 it2
.c
= *p
, it2
.len
= 1;
21941 it2
.glyph_row
= NULL
;
21942 it2
.what
= IT_CHARACTER
;
21943 x_produce_glyphs (&it2
);
21944 width
= NUMVAL (prop
) * it2
.pixel_width
;
21946 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21947 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21949 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21950 align_to
= (align_to
< 0
21952 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21953 else if (align_to
< 0)
21954 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21955 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21956 zero_width_ok_p
= 1;
21959 /* Nothing specified -> width defaults to canonical char width. */
21960 width
= FRAME_COLUMN_WIDTH (it
->f
);
21962 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21965 /* Compute height. */
21966 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21967 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21970 zero_height_ok_p
= 1;
21972 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21974 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21976 height
= FONT_HEIGHT (font
);
21978 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21981 /* Compute percentage of height used for ascent. If
21982 `:ascent ASCENT' is present and valid, use that. Otherwise,
21983 derive the ascent from the font in use. */
21984 if (prop
= Fplist_get (plist
, QCascent
),
21985 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21986 ascent
= height
* NUMVAL (prop
) / 100.0;
21987 else if (!NILP (prop
)
21988 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21989 ascent
= min (max (0, (int)tem
), height
);
21991 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21993 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21994 && it
->current_x
+ width
> it
->last_visible_x
)
21995 width
= it
->last_visible_x
- it
->current_x
- 1;
21997 if (width
> 0 && height
> 0 && it
->glyph_row
)
21999 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22000 if (!STRINGP (object
))
22001 object
= it
->w
->buffer
;
22002 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22005 it
->pixel_width
= width
;
22006 it
->ascent
= it
->phys_ascent
= ascent
;
22007 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22008 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22010 take_vertical_position_into_account (it
);
22013 /* Calculate line-height and line-spacing properties.
22014 An integer value specifies explicit pixel value.
22015 A float value specifies relative value to current face height.
22016 A cons (float . face-name) specifies relative value to
22017 height of specified face font.
22019 Returns height in pixels, or nil. */
22023 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22024 int boff
, int override
)
22026 Lisp_Object face_name
= Qnil
;
22027 int ascent
, descent
, height
;
22029 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22034 face_name
= XCAR (val
);
22036 if (!NUMBERP (val
))
22037 val
= make_number (1);
22038 if (NILP (face_name
))
22040 height
= it
->ascent
+ it
->descent
;
22045 if (NILP (face_name
))
22047 font
= FRAME_FONT (it
->f
);
22048 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22050 else if (EQ (face_name
, Qt
))
22059 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22061 return make_number (-1);
22063 face
= FACE_FROM_ID (it
->f
, face_id
);
22066 return make_number (-1);
22067 boff
= font
->baseline_offset
;
22068 if (font
->vertical_centering
)
22069 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22072 ascent
= FONT_BASE (font
) + boff
;
22073 descent
= FONT_DESCENT (font
) - boff
;
22077 it
->override_ascent
= ascent
;
22078 it
->override_descent
= descent
;
22079 it
->override_boff
= boff
;
22082 height
= ascent
+ descent
;
22086 height
= (int)(XFLOAT_DATA (val
) * height
);
22087 else if (INTEGERP (val
))
22088 height
*= XINT (val
);
22090 return make_number (height
);
22095 Produce glyphs/get display metrics for the display element IT is
22096 loaded with. See the description of struct it in dispextern.h
22097 for an overview of struct it. */
22100 x_produce_glyphs (struct it
*it
)
22102 int extra_line_spacing
= it
->extra_line_spacing
;
22104 it
->glyph_not_available_p
= 0;
22106 if (it
->what
== IT_CHARACTER
)
22110 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22111 struct font_metrics
*pcm
;
22112 int font_not_found_p
;
22113 int boff
; /* baseline offset */
22114 /* We may change it->multibyte_p upon unibyte<->multibyte
22115 conversion. So, save the current value now and restore it
22118 Note: It seems that we don't have to record multibyte_p in
22119 struct glyph because the character code itself tells whether
22120 or not the character is multibyte. Thus, in the future, we
22121 must consider eliminating the field `multibyte_p' in the
22123 int saved_multibyte_p
= it
->multibyte_p
;
22125 /* Maybe translate single-byte characters to multibyte, or the
22127 it
->char_to_display
= it
->c
;
22128 if (!ASCII_BYTE_P (it
->c
)
22129 && ! it
->multibyte_p
)
22131 if (SINGLE_BYTE_CHAR_P (it
->c
)
22132 && unibyte_display_via_language_environment
)
22134 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22136 /* get_next_display_element assures that this decoding
22138 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22139 it
->multibyte_p
= 1;
22140 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22142 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22146 /* Get font to use. Encode IT->char_to_display. */
22147 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22148 &char2b
, it
->multibyte_p
, 0);
22151 font_not_found_p
= font
== NULL
;
22152 if (font_not_found_p
)
22154 /* When no suitable font found, display an empty box based
22155 on the metrics of the font of the default face (or what
22157 struct face
*no_font_face
22158 = FACE_FROM_ID (it
->f
,
22159 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22160 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22161 font
= no_font_face
->font
;
22162 boff
= font
->baseline_offset
;
22166 boff
= font
->baseline_offset
;
22167 if (font
->vertical_centering
)
22168 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22171 if (it
->char_to_display
>= ' '
22172 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22174 /* Either unibyte or ASCII. */
22179 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22181 if (it
->override_ascent
>= 0)
22183 it
->ascent
= it
->override_ascent
;
22184 it
->descent
= it
->override_descent
;
22185 boff
= it
->override_boff
;
22189 it
->ascent
= FONT_BASE (font
) + boff
;
22190 it
->descent
= FONT_DESCENT (font
) - boff
;
22195 it
->phys_ascent
= pcm
->ascent
+ boff
;
22196 it
->phys_descent
= pcm
->descent
- boff
;
22197 it
->pixel_width
= pcm
->width
;
22201 it
->glyph_not_available_p
= 1;
22202 it
->phys_ascent
= it
->ascent
;
22203 it
->phys_descent
= it
->descent
;
22204 it
->pixel_width
= FONT_WIDTH (font
);
22207 if (it
->constrain_row_ascent_descent_p
)
22209 if (it
->descent
> it
->max_descent
)
22211 it
->ascent
+= it
->descent
- it
->max_descent
;
22212 it
->descent
= it
->max_descent
;
22214 if (it
->ascent
> it
->max_ascent
)
22216 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22217 it
->ascent
= it
->max_ascent
;
22219 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22220 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22221 extra_line_spacing
= 0;
22224 /* If this is a space inside a region of text with
22225 `space-width' property, change its width. */
22226 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22228 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22230 /* If face has a box, add the box thickness to the character
22231 height. If character has a box line to the left and/or
22232 right, add the box line width to the character's width. */
22233 if (face
->box
!= FACE_NO_BOX
)
22235 int thick
= face
->box_line_width
;
22239 it
->ascent
+= thick
;
22240 it
->descent
+= thick
;
22245 if (it
->start_of_box_run_p
)
22246 it
->pixel_width
+= thick
;
22247 if (it
->end_of_box_run_p
)
22248 it
->pixel_width
+= thick
;
22251 /* If face has an overline, add the height of the overline
22252 (1 pixel) and a 1 pixel margin to the character height. */
22253 if (face
->overline_p
)
22254 it
->ascent
+= overline_margin
;
22256 if (it
->constrain_row_ascent_descent_p
)
22258 if (it
->ascent
> it
->max_ascent
)
22259 it
->ascent
= it
->max_ascent
;
22260 if (it
->descent
> it
->max_descent
)
22261 it
->descent
= it
->max_descent
;
22264 take_vertical_position_into_account (it
);
22266 /* If we have to actually produce glyphs, do it. */
22271 /* Translate a space with a `space-width' property
22272 into a stretch glyph. */
22273 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22274 / FONT_HEIGHT (font
));
22275 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22276 it
->ascent
+ it
->descent
, ascent
);
22281 /* If characters with lbearing or rbearing are displayed
22282 in this line, record that fact in a flag of the
22283 glyph row. This is used to optimize X output code. */
22284 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22285 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22287 if (! stretched_p
&& it
->pixel_width
== 0)
22288 /* We assure that all visible glyphs have at least 1-pixel
22290 it
->pixel_width
= 1;
22292 else if (it
->char_to_display
== '\n')
22294 /* A newline has no width, but we need the height of the
22295 line. But if previous part of the line sets a height,
22296 don't increase that height */
22298 Lisp_Object height
;
22299 Lisp_Object total_height
= Qnil
;
22301 it
->override_ascent
= -1;
22302 it
->pixel_width
= 0;
22305 height
= get_it_property (it
, Qline_height
);
22306 /* Split (line-height total-height) list */
22308 && CONSP (XCDR (height
))
22309 && NILP (XCDR (XCDR (height
))))
22311 total_height
= XCAR (XCDR (height
));
22312 height
= XCAR (height
);
22314 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22316 if (it
->override_ascent
>= 0)
22318 it
->ascent
= it
->override_ascent
;
22319 it
->descent
= it
->override_descent
;
22320 boff
= it
->override_boff
;
22324 it
->ascent
= FONT_BASE (font
) + boff
;
22325 it
->descent
= FONT_DESCENT (font
) - boff
;
22328 if (EQ (height
, Qt
))
22330 if (it
->descent
> it
->max_descent
)
22332 it
->ascent
+= it
->descent
- it
->max_descent
;
22333 it
->descent
= it
->max_descent
;
22335 if (it
->ascent
> it
->max_ascent
)
22337 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22338 it
->ascent
= it
->max_ascent
;
22340 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22341 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22342 it
->constrain_row_ascent_descent_p
= 1;
22343 extra_line_spacing
= 0;
22347 Lisp_Object spacing
;
22349 it
->phys_ascent
= it
->ascent
;
22350 it
->phys_descent
= it
->descent
;
22352 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22353 && face
->box
!= FACE_NO_BOX
22354 && face
->box_line_width
> 0)
22356 it
->ascent
+= face
->box_line_width
;
22357 it
->descent
+= face
->box_line_width
;
22360 && XINT (height
) > it
->ascent
+ it
->descent
)
22361 it
->ascent
= XINT (height
) - it
->descent
;
22363 if (!NILP (total_height
))
22364 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22367 spacing
= get_it_property (it
, Qline_spacing
);
22368 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22370 if (INTEGERP (spacing
))
22372 extra_line_spacing
= XINT (spacing
);
22373 if (!NILP (total_height
))
22374 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22378 else if (it
->char_to_display
== '\t')
22380 if (font
->space_width
> 0)
22382 int tab_width
= it
->tab_width
* font
->space_width
;
22383 int x
= it
->current_x
+ it
->continuation_lines_width
;
22384 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22386 /* If the distance from the current position to the next tab
22387 stop is less than a space character width, use the
22388 tab stop after that. */
22389 if (next_tab_x
- x
< font
->space_width
)
22390 next_tab_x
+= tab_width
;
22392 it
->pixel_width
= next_tab_x
- x
;
22394 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22395 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22399 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22400 it
->ascent
+ it
->descent
, it
->ascent
);
22405 it
->pixel_width
= 0;
22411 /* A multi-byte character. Assume that the display width of the
22412 character is the width of the character multiplied by the
22413 width of the font. */
22415 /* If we found a font, this font should give us the right
22416 metrics. If we didn't find a font, use the frame's
22417 default font and calculate the width of the character by
22418 multiplying the width of font by the width of the
22421 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22423 if (font_not_found_p
|| !pcm
)
22425 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22427 if (char_width
== 0)
22428 /* This is a non spacing character. But, as we are
22429 going to display an empty box, the box must occupy
22430 at least one column. */
22432 it
->glyph_not_available_p
= 1;
22433 it
->pixel_width
= font
->space_width
* char_width
;
22434 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22435 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22439 it
->pixel_width
= pcm
->width
;
22440 it
->phys_ascent
= pcm
->ascent
+ boff
;
22441 it
->phys_descent
= pcm
->descent
- boff
;
22443 && (pcm
->lbearing
< 0
22444 || pcm
->rbearing
> pcm
->width
))
22445 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22448 it
->ascent
= FONT_BASE (font
) + boff
;
22449 it
->descent
= FONT_DESCENT (font
) - boff
;
22450 if (face
->box
!= FACE_NO_BOX
)
22452 int thick
= face
->box_line_width
;
22456 it
->ascent
+= thick
;
22457 it
->descent
+= thick
;
22462 if (it
->start_of_box_run_p
)
22463 it
->pixel_width
+= thick
;
22464 if (it
->end_of_box_run_p
)
22465 it
->pixel_width
+= thick
;
22468 /* If face has an overline, add the height of the overline
22469 (1 pixel) and a 1 pixel margin to the character height. */
22470 if (face
->overline_p
)
22471 it
->ascent
+= overline_margin
;
22473 take_vertical_position_into_account (it
);
22475 if (it
->ascent
< 0)
22477 if (it
->descent
< 0)
22482 if (it
->pixel_width
== 0)
22483 /* We assure that all visible glyphs have at least 1-pixel
22485 it
->pixel_width
= 1;
22487 it
->multibyte_p
= saved_multibyte_p
;
22489 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22491 /* A static composition.
22493 Note: A composition is represented as one glyph in the
22494 glyph matrix. There are no padding glyphs.
22496 Important note: pixel_width, ascent, and descent are the
22497 values of what is drawn by draw_glyphs (i.e. the values of
22498 the overall glyphs composed). */
22499 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22500 int boff
; /* baseline offset */
22501 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22502 int glyph_len
= cmp
->glyph_len
;
22503 struct font
*font
= face
->font
;
22507 /* If we have not yet calculated pixel size data of glyphs of
22508 the composition for the current face font, calculate them
22509 now. Theoretically, we have to check all fonts for the
22510 glyphs, but that requires much time and memory space. So,
22511 here we check only the font of the first glyph. This may
22512 lead to incorrect display, but it's very rare, and C-l
22513 (recenter-top-bottom) can correct the display anyway. */
22514 if (! cmp
->font
|| cmp
->font
!= font
)
22516 /* Ascent and descent of the font of the first character
22517 of this composition (adjusted by baseline offset).
22518 Ascent and descent of overall glyphs should not be less
22519 than these, respectively. */
22520 int font_ascent
, font_descent
, font_height
;
22521 /* Bounding box of the overall glyphs. */
22522 int leftmost
, rightmost
, lowest
, highest
;
22523 int lbearing
, rbearing
;
22524 int i
, width
, ascent
, descent
;
22525 int left_padded
= 0, right_padded
= 0;
22528 struct font_metrics
*pcm
;
22529 int font_not_found_p
;
22532 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22533 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22535 if (glyph_len
< cmp
->glyph_len
)
22537 for (i
= 0; i
< glyph_len
; i
++)
22539 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22541 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22546 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22547 : IT_CHARPOS (*it
));
22548 /* If no suitable font is found, use the default font. */
22549 font_not_found_p
= font
== NULL
;
22550 if (font_not_found_p
)
22552 face
= face
->ascii_face
;
22555 boff
= font
->baseline_offset
;
22556 if (font
->vertical_centering
)
22557 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22558 font_ascent
= FONT_BASE (font
) + boff
;
22559 font_descent
= FONT_DESCENT (font
) - boff
;
22560 font_height
= FONT_HEIGHT (font
);
22562 cmp
->font
= (void *) font
;
22565 if (! font_not_found_p
)
22567 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22568 &char2b
, it
->multibyte_p
, 0);
22569 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22572 /* Initialize the bounding box. */
22575 width
= pcm
->width
;
22576 ascent
= pcm
->ascent
;
22577 descent
= pcm
->descent
;
22578 lbearing
= pcm
->lbearing
;
22579 rbearing
= pcm
->rbearing
;
22583 width
= FONT_WIDTH (font
);
22584 ascent
= FONT_BASE (font
);
22585 descent
= FONT_DESCENT (font
);
22592 lowest
= - descent
+ boff
;
22593 highest
= ascent
+ boff
;
22595 if (! font_not_found_p
22596 && font
->default_ascent
22597 && CHAR_TABLE_P (Vuse_default_ascent
)
22598 && !NILP (Faref (Vuse_default_ascent
,
22599 make_number (it
->char_to_display
))))
22600 highest
= font
->default_ascent
+ boff
;
22602 /* Draw the first glyph at the normal position. It may be
22603 shifted to right later if some other glyphs are drawn
22605 cmp
->offsets
[i
* 2] = 0;
22606 cmp
->offsets
[i
* 2 + 1] = boff
;
22607 cmp
->lbearing
= lbearing
;
22608 cmp
->rbearing
= rbearing
;
22610 /* Set cmp->offsets for the remaining glyphs. */
22611 for (i
++; i
< glyph_len
; i
++)
22613 int left
, right
, btm
, top
;
22614 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22616 struct face
*this_face
;
22621 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22622 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22623 font
= this_face
->font
;
22629 this_boff
= font
->baseline_offset
;
22630 if (font
->vertical_centering
)
22631 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22632 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22633 &char2b
, it
->multibyte_p
, 0);
22634 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22637 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22640 width
= pcm
->width
;
22641 ascent
= pcm
->ascent
;
22642 descent
= pcm
->descent
;
22643 lbearing
= pcm
->lbearing
;
22644 rbearing
= pcm
->rbearing
;
22645 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22647 /* Relative composition with or without
22648 alternate chars. */
22649 left
= (leftmost
+ rightmost
- width
) / 2;
22650 btm
= - descent
+ boff
;
22651 if (font
->relative_compose
22652 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22653 || NILP (Faref (Vignore_relative_composition
,
22654 make_number (ch
)))))
22657 if (- descent
>= font
->relative_compose
)
22658 /* One extra pixel between two glyphs. */
22660 else if (ascent
<= 0)
22661 /* One extra pixel between two glyphs. */
22662 btm
= lowest
- 1 - ascent
- descent
;
22667 /* A composition rule is specified by an integer
22668 value that encodes global and new reference
22669 points (GREF and NREF). GREF and NREF are
22670 specified by numbers as below:
22672 0---1---2 -- ascent
22676 9--10--11 -- center
22678 ---3---4---5--- baseline
22680 6---7---8 -- descent
22682 int rule
= COMPOSITION_RULE (cmp
, i
);
22683 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22685 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22686 grefx
= gref
% 3, nrefx
= nref
% 3;
22687 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22689 xoff
= font_height
* (xoff
- 128) / 256;
22691 yoff
= font_height
* (yoff
- 128) / 256;
22694 + grefx
* (rightmost
- leftmost
) / 2
22695 - nrefx
* width
/ 2
22698 btm
= ((grefy
== 0 ? highest
22700 : grefy
== 2 ? lowest
22701 : (highest
+ lowest
) / 2)
22702 - (nrefy
== 0 ? ascent
+ descent
22703 : nrefy
== 1 ? descent
- boff
22705 : (ascent
+ descent
) / 2)
22709 cmp
->offsets
[i
* 2] = left
;
22710 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22712 /* Update the bounding box of the overall glyphs. */
22715 right
= left
+ width
;
22716 if (left
< leftmost
)
22718 if (right
> rightmost
)
22721 top
= btm
+ descent
+ ascent
;
22727 if (cmp
->lbearing
> left
+ lbearing
)
22728 cmp
->lbearing
= left
+ lbearing
;
22729 if (cmp
->rbearing
< left
+ rbearing
)
22730 cmp
->rbearing
= left
+ rbearing
;
22734 /* If there are glyphs whose x-offsets are negative,
22735 shift all glyphs to the right and make all x-offsets
22739 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22740 cmp
->offsets
[i
* 2] -= leftmost
;
22741 rightmost
-= leftmost
;
22742 cmp
->lbearing
-= leftmost
;
22743 cmp
->rbearing
-= leftmost
;
22746 if (left_padded
&& cmp
->lbearing
< 0)
22748 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22749 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22750 rightmost
-= cmp
->lbearing
;
22751 cmp
->rbearing
-= cmp
->lbearing
;
22754 if (right_padded
&& rightmost
< cmp
->rbearing
)
22756 rightmost
= cmp
->rbearing
;
22759 cmp
->pixel_width
= rightmost
;
22760 cmp
->ascent
= highest
;
22761 cmp
->descent
= - lowest
;
22762 if (cmp
->ascent
< font_ascent
)
22763 cmp
->ascent
= font_ascent
;
22764 if (cmp
->descent
< font_descent
)
22765 cmp
->descent
= font_descent
;
22769 && (cmp
->lbearing
< 0
22770 || cmp
->rbearing
> cmp
->pixel_width
))
22771 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22773 it
->pixel_width
= cmp
->pixel_width
;
22774 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22775 it
->descent
= it
->phys_descent
= cmp
->descent
;
22776 if (face
->box
!= FACE_NO_BOX
)
22778 int thick
= face
->box_line_width
;
22782 it
->ascent
+= thick
;
22783 it
->descent
+= thick
;
22788 if (it
->start_of_box_run_p
)
22789 it
->pixel_width
+= thick
;
22790 if (it
->end_of_box_run_p
)
22791 it
->pixel_width
+= thick
;
22794 /* If face has an overline, add the height of the overline
22795 (1 pixel) and a 1 pixel margin to the character height. */
22796 if (face
->overline_p
)
22797 it
->ascent
+= overline_margin
;
22799 take_vertical_position_into_account (it
);
22800 if (it
->ascent
< 0)
22802 if (it
->descent
< 0)
22806 append_composite_glyph (it
);
22808 else if (it
->what
== IT_COMPOSITION
)
22810 /* A dynamic (automatic) composition. */
22811 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22812 Lisp_Object gstring
;
22813 struct font_metrics metrics
;
22815 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22817 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22820 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22821 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22822 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22823 it
->descent
= it
->phys_descent
= metrics
.descent
;
22824 if (face
->box
!= FACE_NO_BOX
)
22826 int thick
= face
->box_line_width
;
22830 it
->ascent
+= thick
;
22831 it
->descent
+= thick
;
22836 if (it
->start_of_box_run_p
)
22837 it
->pixel_width
+= thick
;
22838 if (it
->end_of_box_run_p
)
22839 it
->pixel_width
+= thick
;
22841 /* If face has an overline, add the height of the overline
22842 (1 pixel) and a 1 pixel margin to the character height. */
22843 if (face
->overline_p
)
22844 it
->ascent
+= overline_margin
;
22845 take_vertical_position_into_account (it
);
22846 if (it
->ascent
< 0)
22848 if (it
->descent
< 0)
22852 append_composite_glyph (it
);
22854 else if (it
->what
== IT_IMAGE
)
22855 produce_image_glyph (it
);
22856 else if (it
->what
== IT_STRETCH
)
22857 produce_stretch_glyph (it
);
22859 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22860 because this isn't true for images with `:ascent 100'. */
22861 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22862 if (it
->area
== TEXT_AREA
)
22863 it
->current_x
+= it
->pixel_width
;
22865 if (extra_line_spacing
> 0)
22867 it
->descent
+= extra_line_spacing
;
22868 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22869 it
->max_extra_line_spacing
= extra_line_spacing
;
22872 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22873 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22874 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22875 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22879 Output LEN glyphs starting at START at the nominal cursor position.
22880 Advance the nominal cursor over the text. The global variable
22881 updated_window contains the window being updated, updated_row is
22882 the glyph row being updated, and updated_area is the area of that
22883 row being updated. */
22886 x_write_glyphs (struct glyph
*start
, int len
)
22890 xassert (updated_window
&& updated_row
);
22893 /* Write glyphs. */
22895 hpos
= start
- updated_row
->glyphs
[updated_area
];
22896 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22897 updated_row
, updated_area
,
22899 DRAW_NORMAL_TEXT
, 0);
22901 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22902 if (updated_area
== TEXT_AREA
22903 && updated_window
->phys_cursor_on_p
22904 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22905 && updated_window
->phys_cursor
.hpos
>= hpos
22906 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22907 updated_window
->phys_cursor_on_p
= 0;
22911 /* Advance the output cursor. */
22912 output_cursor
.hpos
+= len
;
22913 output_cursor
.x
= x
;
22918 Insert LEN glyphs from START at the nominal cursor position. */
22921 x_insert_glyphs (struct glyph
*start
, int len
)
22925 int line_height
, shift_by_width
, shifted_region_width
;
22926 struct glyph_row
*row
;
22927 struct glyph
*glyph
;
22928 int frame_x
, frame_y
;
22931 xassert (updated_window
&& updated_row
);
22933 w
= updated_window
;
22934 f
= XFRAME (WINDOW_FRAME (w
));
22936 /* Get the height of the line we are in. */
22938 line_height
= row
->height
;
22940 /* Get the width of the glyphs to insert. */
22941 shift_by_width
= 0;
22942 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22943 shift_by_width
+= glyph
->pixel_width
;
22945 /* Get the width of the region to shift right. */
22946 shifted_region_width
= (window_box_width (w
, updated_area
)
22951 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22952 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22954 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22955 line_height
, shift_by_width
);
22957 /* Write the glyphs. */
22958 hpos
= start
- row
->glyphs
[updated_area
];
22959 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22961 DRAW_NORMAL_TEXT
, 0);
22963 /* Advance the output cursor. */
22964 output_cursor
.hpos
+= len
;
22965 output_cursor
.x
+= shift_by_width
;
22971 Erase the current text line from the nominal cursor position
22972 (inclusive) to pixel column TO_X (exclusive). The idea is that
22973 everything from TO_X onward is already erased.
22975 TO_X is a pixel position relative to updated_area of
22976 updated_window. TO_X == -1 means clear to the end of this area. */
22979 x_clear_end_of_line (int to_x
)
22982 struct window
*w
= updated_window
;
22983 int max_x
, min_y
, max_y
;
22984 int from_x
, from_y
, to_y
;
22986 xassert (updated_window
&& updated_row
);
22987 f
= XFRAME (w
->frame
);
22989 if (updated_row
->full_width_p
)
22990 max_x
= WINDOW_TOTAL_WIDTH (w
);
22992 max_x
= window_box_width (w
, updated_area
);
22993 max_y
= window_text_bottom_y (w
);
22995 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22996 of window. For TO_X > 0, truncate to end of drawing area. */
23002 to_x
= min (to_x
, max_x
);
23004 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23006 /* Notice if the cursor will be cleared by this operation. */
23007 if (!updated_row
->full_width_p
)
23008 notice_overwritten_cursor (w
, updated_area
,
23009 output_cursor
.x
, -1,
23011 MATRIX_ROW_BOTTOM_Y (updated_row
));
23013 from_x
= output_cursor
.x
;
23015 /* Translate to frame coordinates. */
23016 if (updated_row
->full_width_p
)
23018 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23019 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23023 int area_left
= window_box_left (w
, updated_area
);
23024 from_x
+= area_left
;
23028 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23029 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23030 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23032 /* Prevent inadvertently clearing to end of the X window. */
23033 if (to_x
> from_x
&& to_y
> from_y
)
23036 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23037 to_x
- from_x
, to_y
- from_y
);
23042 #endif /* HAVE_WINDOW_SYSTEM */
23046 /***********************************************************************
23048 ***********************************************************************/
23050 /* Value is the internal representation of the specified cursor type
23051 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23052 of the bar cursor. */
23054 static enum text_cursor_kinds
23055 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23057 enum text_cursor_kinds type
;
23062 if (EQ (arg
, Qbox
))
23063 return FILLED_BOX_CURSOR
;
23065 if (EQ (arg
, Qhollow
))
23066 return HOLLOW_BOX_CURSOR
;
23068 if (EQ (arg
, Qbar
))
23075 && EQ (XCAR (arg
), Qbar
)
23076 && INTEGERP (XCDR (arg
))
23077 && XINT (XCDR (arg
)) >= 0)
23079 *width
= XINT (XCDR (arg
));
23083 if (EQ (arg
, Qhbar
))
23086 return HBAR_CURSOR
;
23090 && EQ (XCAR (arg
), Qhbar
)
23091 && INTEGERP (XCDR (arg
))
23092 && XINT (XCDR (arg
)) >= 0)
23094 *width
= XINT (XCDR (arg
));
23095 return HBAR_CURSOR
;
23098 /* Treat anything unknown as "hollow box cursor".
23099 It was bad to signal an error; people have trouble fixing
23100 .Xdefaults with Emacs, when it has something bad in it. */
23101 type
= HOLLOW_BOX_CURSOR
;
23106 /* Set the default cursor types for specified frame. */
23108 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23113 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23114 FRAME_CURSOR_WIDTH (f
) = width
;
23116 /* By default, set up the blink-off state depending on the on-state. */
23118 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23121 FRAME_BLINK_OFF_CURSOR (f
)
23122 = get_specified_cursor_type (XCDR (tem
), &width
);
23123 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23126 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23130 /* Return the cursor we want to be displayed in window W. Return
23131 width of bar/hbar cursor through WIDTH arg. Return with
23132 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23133 (i.e. if the `system caret' should track this cursor).
23135 In a mini-buffer window, we want the cursor only to appear if we
23136 are reading input from this window. For the selected window, we
23137 want the cursor type given by the frame parameter or buffer local
23138 setting of cursor-type. If explicitly marked off, draw no cursor.
23139 In all other cases, we want a hollow box cursor. */
23141 static enum text_cursor_kinds
23142 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23143 int *active_cursor
)
23145 struct frame
*f
= XFRAME (w
->frame
);
23146 struct buffer
*b
= XBUFFER (w
->buffer
);
23147 int cursor_type
= DEFAULT_CURSOR
;
23148 Lisp_Object alt_cursor
;
23149 int non_selected
= 0;
23151 *active_cursor
= 1;
23154 if (cursor_in_echo_area
23155 && FRAME_HAS_MINIBUF_P (f
)
23156 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23158 if (w
== XWINDOW (echo_area_window
))
23160 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23162 *width
= FRAME_CURSOR_WIDTH (f
);
23163 return FRAME_DESIRED_CURSOR (f
);
23166 return get_specified_cursor_type (b
->cursor_type
, width
);
23169 *active_cursor
= 0;
23173 /* Detect a nonselected window or nonselected frame. */
23174 else if (w
!= XWINDOW (f
->selected_window
)
23175 #ifdef HAVE_WINDOW_SYSTEM
23176 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23180 *active_cursor
= 0;
23182 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23188 /* Never display a cursor in a window in which cursor-type is nil. */
23189 if (NILP (b
->cursor_type
))
23192 /* Get the normal cursor type for this window. */
23193 if (EQ (b
->cursor_type
, Qt
))
23195 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23196 *width
= FRAME_CURSOR_WIDTH (f
);
23199 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23201 /* Use cursor-in-non-selected-windows instead
23202 for non-selected window or frame. */
23205 alt_cursor
= b
->cursor_in_non_selected_windows
;
23206 if (!EQ (Qt
, alt_cursor
))
23207 return get_specified_cursor_type (alt_cursor
, width
);
23208 /* t means modify the normal cursor type. */
23209 if (cursor_type
== FILLED_BOX_CURSOR
)
23210 cursor_type
= HOLLOW_BOX_CURSOR
;
23211 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23213 return cursor_type
;
23216 /* Use normal cursor if not blinked off. */
23217 if (!w
->cursor_off_p
)
23219 #ifdef HAVE_WINDOW_SYSTEM
23220 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23222 if (cursor_type
== FILLED_BOX_CURSOR
)
23224 /* Using a block cursor on large images can be very annoying.
23225 So use a hollow cursor for "large" images.
23226 If image is not transparent (no mask), also use hollow cursor. */
23227 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23228 if (img
!= NULL
&& IMAGEP (img
->spec
))
23230 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23231 where N = size of default frame font size.
23232 This should cover most of the "tiny" icons people may use. */
23234 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23235 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23236 cursor_type
= HOLLOW_BOX_CURSOR
;
23239 else if (cursor_type
!= NO_CURSOR
)
23241 /* Display current only supports BOX and HOLLOW cursors for images.
23242 So for now, unconditionally use a HOLLOW cursor when cursor is
23243 not a solid box cursor. */
23244 cursor_type
= HOLLOW_BOX_CURSOR
;
23248 return cursor_type
;
23251 /* Cursor is blinked off, so determine how to "toggle" it. */
23253 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23254 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23255 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23257 /* Then see if frame has specified a specific blink off cursor type. */
23258 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23260 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23261 return FRAME_BLINK_OFF_CURSOR (f
);
23265 /* Some people liked having a permanently visible blinking cursor,
23266 while others had very strong opinions against it. So it was
23267 decided to remove it. KFS 2003-09-03 */
23269 /* Finally perform built-in cursor blinking:
23270 filled box <-> hollow box
23271 wide [h]bar <-> narrow [h]bar
23272 narrow [h]bar <-> no cursor
23273 other type <-> no cursor */
23275 if (cursor_type
== FILLED_BOX_CURSOR
)
23276 return HOLLOW_BOX_CURSOR
;
23278 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23281 return cursor_type
;
23289 #ifdef HAVE_WINDOW_SYSTEM
23291 /* Notice when the text cursor of window W has been completely
23292 overwritten by a drawing operation that outputs glyphs in AREA
23293 starting at X0 and ending at X1 in the line starting at Y0 and
23294 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23295 the rest of the line after X0 has been written. Y coordinates
23296 are window-relative. */
23299 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23300 int x0
, int x1
, int y0
, int y1
)
23302 int cx0
, cx1
, cy0
, cy1
;
23303 struct glyph_row
*row
;
23305 if (!w
->phys_cursor_on_p
)
23307 if (area
!= TEXT_AREA
)
23310 if (w
->phys_cursor
.vpos
< 0
23311 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23312 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23313 !(row
->enabled_p
&& row
->displays_text_p
)))
23316 if (row
->cursor_in_fringe_p
)
23318 row
->cursor_in_fringe_p
= 0;
23319 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23320 w
->phys_cursor_on_p
= 0;
23324 cx0
= w
->phys_cursor
.x
;
23325 cx1
= cx0
+ w
->phys_cursor_width
;
23326 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23329 /* The cursor image will be completely removed from the
23330 screen if the output area intersects the cursor area in
23331 y-direction. When we draw in [y0 y1[, and some part of
23332 the cursor is at y < y0, that part must have been drawn
23333 before. When scrolling, the cursor is erased before
23334 actually scrolling, so we don't come here. When not
23335 scrolling, the rows above the old cursor row must have
23336 changed, and in this case these rows must have written
23337 over the cursor image.
23339 Likewise if part of the cursor is below y1, with the
23340 exception of the cursor being in the first blank row at
23341 the buffer and window end because update_text_area
23342 doesn't draw that row. (Except when it does, but
23343 that's handled in update_text_area.) */
23345 cy0
= w
->phys_cursor
.y
;
23346 cy1
= cy0
+ w
->phys_cursor_height
;
23347 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23350 w
->phys_cursor_on_p
= 0;
23353 #endif /* HAVE_WINDOW_SYSTEM */
23356 /************************************************************************
23358 ************************************************************************/
23360 #ifdef HAVE_WINDOW_SYSTEM
23363 Fix the display of area AREA of overlapping row ROW in window W
23364 with respect to the overlapping part OVERLAPS. */
23367 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23368 enum glyph_row_area area
, int overlaps
)
23375 for (i
= 0; i
< row
->used
[area
];)
23377 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23379 int start
= i
, start_x
= x
;
23383 x
+= row
->glyphs
[area
][i
].pixel_width
;
23386 while (i
< row
->used
[area
]
23387 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23389 draw_glyphs (w
, start_x
, row
, area
,
23391 DRAW_NORMAL_TEXT
, overlaps
);
23395 x
+= row
->glyphs
[area
][i
].pixel_width
;
23405 Draw the cursor glyph of window W in glyph row ROW. See the
23406 comment of draw_glyphs for the meaning of HL. */
23409 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23410 enum draw_glyphs_face hl
)
23412 /* If cursor hpos is out of bounds, don't draw garbage. This can
23413 happen in mini-buffer windows when switching between echo area
23414 glyphs and mini-buffer. */
23415 if ((row
->reversed_p
23416 ? (w
->phys_cursor
.hpos
>= 0)
23417 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23419 int on_p
= w
->phys_cursor_on_p
;
23421 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23422 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23424 w
->phys_cursor_on_p
= on_p
;
23426 if (hl
== DRAW_CURSOR
)
23427 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23428 /* When we erase the cursor, and ROW is overlapped by other
23429 rows, make sure that these overlapping parts of other rows
23431 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23433 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23435 if (row
> w
->current_matrix
->rows
23436 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23437 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23438 OVERLAPS_ERASED_CURSOR
);
23440 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23441 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23442 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23443 OVERLAPS_ERASED_CURSOR
);
23450 Erase the image of a cursor of window W from the screen. */
23453 erase_phys_cursor (struct window
*w
)
23455 struct frame
*f
= XFRAME (w
->frame
);
23456 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23457 int hpos
= w
->phys_cursor
.hpos
;
23458 int vpos
= w
->phys_cursor
.vpos
;
23459 int mouse_face_here_p
= 0;
23460 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23461 struct glyph_row
*cursor_row
;
23462 struct glyph
*cursor_glyph
;
23463 enum draw_glyphs_face hl
;
23465 /* No cursor displayed or row invalidated => nothing to do on the
23467 if (w
->phys_cursor_type
== NO_CURSOR
)
23468 goto mark_cursor_off
;
23470 /* VPOS >= active_glyphs->nrows means that window has been resized.
23471 Don't bother to erase the cursor. */
23472 if (vpos
>= active_glyphs
->nrows
)
23473 goto mark_cursor_off
;
23475 /* If row containing cursor is marked invalid, there is nothing we
23477 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23478 if (!cursor_row
->enabled_p
)
23479 goto mark_cursor_off
;
23481 /* If line spacing is > 0, old cursor may only be partially visible in
23482 window after split-window. So adjust visible height. */
23483 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23484 window_text_bottom_y (w
) - cursor_row
->y
);
23486 /* If row is completely invisible, don't attempt to delete a cursor which
23487 isn't there. This can happen if cursor is at top of a window, and
23488 we switch to a buffer with a header line in that window. */
23489 if (cursor_row
->visible_height
<= 0)
23490 goto mark_cursor_off
;
23492 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23493 if (cursor_row
->cursor_in_fringe_p
)
23495 cursor_row
->cursor_in_fringe_p
= 0;
23496 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23497 goto mark_cursor_off
;
23500 /* This can happen when the new row is shorter than the old one.
23501 In this case, either draw_glyphs or clear_end_of_line
23502 should have cleared the cursor. Note that we wouldn't be
23503 able to erase the cursor in this case because we don't have a
23504 cursor glyph at hand. */
23505 if ((cursor_row
->reversed_p
23506 ? (w
->phys_cursor
.hpos
< 0)
23507 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23508 goto mark_cursor_off
;
23510 /* If the cursor is in the mouse face area, redisplay that when
23511 we clear the cursor. */
23512 if (! NILP (dpyinfo
->mouse_face_window
)
23513 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23514 && (vpos
> dpyinfo
->mouse_face_beg_row
23515 || (vpos
== dpyinfo
->mouse_face_beg_row
23516 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23517 && (vpos
< dpyinfo
->mouse_face_end_row
23518 || (vpos
== dpyinfo
->mouse_face_end_row
23519 && hpos
< dpyinfo
->mouse_face_end_col
))
23520 /* Don't redraw the cursor's spot in mouse face if it is at the
23521 end of a line (on a newline). The cursor appears there, but
23522 mouse highlighting does not. */
23523 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23524 mouse_face_here_p
= 1;
23526 /* Maybe clear the display under the cursor. */
23527 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23530 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23533 cursor_glyph
= get_phys_cursor_glyph (w
);
23534 if (cursor_glyph
== NULL
)
23535 goto mark_cursor_off
;
23537 width
= cursor_glyph
->pixel_width
;
23538 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23539 x
= w
->phys_cursor
.x
;
23541 width
-= left_x
- x
;
23542 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23543 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23544 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23547 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23550 /* Erase the cursor by redrawing the character underneath it. */
23551 if (mouse_face_here_p
)
23552 hl
= DRAW_MOUSE_FACE
;
23554 hl
= DRAW_NORMAL_TEXT
;
23555 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23558 w
->phys_cursor_on_p
= 0;
23559 w
->phys_cursor_type
= NO_CURSOR
;
23564 Display or clear cursor of window W. If ON is zero, clear the
23565 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23566 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23569 display_and_set_cursor (struct window
*w
, int on
,
23570 int hpos
, int vpos
, int x
, int y
)
23572 struct frame
*f
= XFRAME (w
->frame
);
23573 int new_cursor_type
;
23574 int new_cursor_width
;
23576 struct glyph_row
*glyph_row
;
23577 struct glyph
*glyph
;
23579 /* This is pointless on invisible frames, and dangerous on garbaged
23580 windows and frames; in the latter case, the frame or window may
23581 be in the midst of changing its size, and x and y may be off the
23583 if (! FRAME_VISIBLE_P (f
)
23584 || FRAME_GARBAGED_P (f
)
23585 || vpos
>= w
->current_matrix
->nrows
23586 || hpos
>= w
->current_matrix
->matrix_w
)
23589 /* If cursor is off and we want it off, return quickly. */
23590 if (!on
&& !w
->phys_cursor_on_p
)
23593 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23594 /* If cursor row is not enabled, we don't really know where to
23595 display the cursor. */
23596 if (!glyph_row
->enabled_p
)
23598 w
->phys_cursor_on_p
= 0;
23603 if (!glyph_row
->exact_window_width_line_p
23604 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23605 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23607 xassert (interrupt_input_blocked
);
23609 /* Set new_cursor_type to the cursor we want to be displayed. */
23610 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23611 &new_cursor_width
, &active_cursor
);
23613 /* If cursor is currently being shown and we don't want it to be or
23614 it is in the wrong place, or the cursor type is not what we want,
23616 if (w
->phys_cursor_on_p
23618 || w
->phys_cursor
.x
!= x
23619 || w
->phys_cursor
.y
!= y
23620 || new_cursor_type
!= w
->phys_cursor_type
23621 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23622 && new_cursor_width
!= w
->phys_cursor_width
)))
23623 erase_phys_cursor (w
);
23625 /* Don't check phys_cursor_on_p here because that flag is only set
23626 to zero in some cases where we know that the cursor has been
23627 completely erased, to avoid the extra work of erasing the cursor
23628 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23629 still not be visible, or it has only been partly erased. */
23632 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23633 w
->phys_cursor_height
= glyph_row
->height
;
23635 /* Set phys_cursor_.* before x_draw_.* is called because some
23636 of them may need the information. */
23637 w
->phys_cursor
.x
= x
;
23638 w
->phys_cursor
.y
= glyph_row
->y
;
23639 w
->phys_cursor
.hpos
= hpos
;
23640 w
->phys_cursor
.vpos
= vpos
;
23643 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23644 new_cursor_type
, new_cursor_width
,
23645 on
, active_cursor
);
23649 /* Switch the display of W's cursor on or off, according to the value
23653 update_window_cursor (struct window
*w
, int on
)
23655 /* Don't update cursor in windows whose frame is in the process
23656 of being deleted. */
23657 if (w
->current_matrix
)
23660 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23661 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23667 /* Call update_window_cursor with parameter ON_P on all leaf windows
23668 in the window tree rooted at W. */
23671 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23675 if (!NILP (w
->hchild
))
23676 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23677 else if (!NILP (w
->vchild
))
23678 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23680 update_window_cursor (w
, on_p
);
23682 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23688 Display the cursor on window W, or clear it, according to ON_P.
23689 Don't change the cursor's position. */
23692 x_update_cursor (struct frame
*f
, int on_p
)
23694 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23699 Clear the cursor of window W to background color, and mark the
23700 cursor as not shown. This is used when the text where the cursor
23701 is about to be rewritten. */
23704 x_clear_cursor (struct window
*w
)
23706 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23707 update_window_cursor (w
, 0);
23712 Display the active region described by mouse_face_* according to DRAW. */
23715 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23717 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23718 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23720 if (/* If window is in the process of being destroyed, don't bother
23722 w
->current_matrix
!= NULL
23723 /* Don't update mouse highlight if hidden */
23724 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23725 /* Recognize when we are called to operate on rows that don't exist
23726 anymore. This can happen when a window is split. */
23727 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23729 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23730 struct glyph_row
*row
, *first
, *last
;
23732 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23733 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23735 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23737 int start_hpos
, end_hpos
, start_x
;
23739 /* For all but the first row, the highlight starts at column 0. */
23742 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23743 start_x
= dpyinfo
->mouse_face_beg_x
;
23752 end_hpos
= dpyinfo
->mouse_face_end_col
;
23755 end_hpos
= row
->used
[TEXT_AREA
];
23756 if (draw
== DRAW_NORMAL_TEXT
)
23757 row
->fill_line_p
= 1; /* Clear to end of line */
23760 if (end_hpos
> start_hpos
)
23762 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23763 start_hpos
, end_hpos
,
23767 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23771 /* When we've written over the cursor, arrange for it to
23772 be displayed again. */
23773 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23776 display_and_set_cursor (w
, 1,
23777 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23778 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23783 /* Change the mouse cursor. */
23784 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23785 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23786 else if (draw
== DRAW_MOUSE_FACE
)
23787 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23789 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23793 Clear out the mouse-highlighted active region.
23794 Redraw it un-highlighted first. Value is non-zero if mouse
23795 face was actually drawn unhighlighted. */
23798 clear_mouse_face (Display_Info
*dpyinfo
)
23802 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23804 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23808 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23809 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23810 dpyinfo
->mouse_face_window
= Qnil
;
23811 dpyinfo
->mouse_face_overlay
= Qnil
;
23817 Non-zero if physical cursor of window W is within mouse face. */
23820 cursor_in_mouse_face_p (struct window
*w
)
23822 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23823 int in_mouse_face
= 0;
23825 if (WINDOWP (dpyinfo
->mouse_face_window
)
23826 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23828 int hpos
= w
->phys_cursor
.hpos
;
23829 int vpos
= w
->phys_cursor
.vpos
;
23831 if (vpos
>= dpyinfo
->mouse_face_beg_row
23832 && vpos
<= dpyinfo
->mouse_face_end_row
23833 && (vpos
> dpyinfo
->mouse_face_beg_row
23834 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23835 && (vpos
< dpyinfo
->mouse_face_end_row
23836 || hpos
< dpyinfo
->mouse_face_end_col
23837 || dpyinfo
->mouse_face_past_end
))
23841 return in_mouse_face
;
23847 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23848 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23849 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23850 for the overlay or run of text properties specifying the mouse
23851 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23852 before-string and after-string that must also be highlighted.
23853 DISPLAY_STRING, if non-nil, is a display string that may cover some
23854 or all of the highlighted text. */
23857 mouse_face_from_buffer_pos (Lisp_Object window
,
23858 Display_Info
*dpyinfo
,
23859 EMACS_INT mouse_charpos
,
23860 EMACS_INT start_charpos
,
23861 EMACS_INT end_charpos
,
23862 Lisp_Object before_string
,
23863 Lisp_Object after_string
,
23864 Lisp_Object display_string
)
23866 struct window
*w
= XWINDOW (window
);
23867 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23868 struct glyph_row
*row
;
23869 struct glyph
*glyph
, *end
;
23873 xassert (NILP (display_string
) || STRINGP (display_string
));
23874 xassert (NILP (before_string
) || STRINGP (before_string
));
23875 xassert (NILP (after_string
) || STRINGP (after_string
));
23877 /* Find the first highlighted glyph. */
23878 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23880 dpyinfo
->mouse_face_beg_col
= 0;
23881 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23882 dpyinfo
->mouse_face_beg_x
= first
->x
;
23883 dpyinfo
->mouse_face_beg_y
= first
->y
;
23887 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23889 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23891 /* If the before-string or display-string contains newlines,
23892 row_containing_pos skips to its last row. Move back. */
23893 if (!NILP (before_string
) || !NILP (display_string
))
23895 struct glyph_row
*prev
;
23896 while ((prev
= row
- 1, prev
>= first
)
23897 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23898 && prev
->used
[TEXT_AREA
] > 0)
23900 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23901 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23902 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23904 || !(EQ (glyph
->object
, before_string
)
23905 || EQ (glyph
->object
, display_string
)))
23911 glyph
= row
->glyphs
[TEXT_AREA
];
23912 end
= glyph
+ row
->used
[TEXT_AREA
];
23914 dpyinfo
->mouse_face_beg_y
= row
->y
;
23915 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23917 /* Skip truncation glyphs at the start of the glyph row. */
23918 if (row
->displays_text_p
)
23920 && INTEGERP (glyph
->object
)
23921 && glyph
->charpos
< 0;
23923 x
+= glyph
->pixel_width
;
23925 /* Scan the glyph row, stopping before BEFORE_STRING or
23926 DISPLAY_STRING or START_CHARPOS. */
23928 && !INTEGERP (glyph
->object
)
23929 && !EQ (glyph
->object
, before_string
)
23930 && !EQ (glyph
->object
, display_string
)
23931 && !(BUFFERP (glyph
->object
)
23932 && glyph
->charpos
>= start_charpos
);
23934 x
+= glyph
->pixel_width
;
23936 dpyinfo
->mouse_face_beg_x
= x
;
23937 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23940 /* Find the last highlighted glyph. */
23941 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23944 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23945 dpyinfo
->mouse_face_past_end
= 1;
23947 else if (!NILP (after_string
))
23949 /* If the after-string has newlines, advance to its last row. */
23950 struct glyph_row
*next
;
23951 struct glyph_row
*last
23952 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23954 for (next
= row
+ 1;
23956 && next
->used
[TEXT_AREA
] > 0
23957 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23962 glyph
= row
->glyphs
[TEXT_AREA
];
23963 end
= glyph
+ row
->used
[TEXT_AREA
];
23965 dpyinfo
->mouse_face_end_y
= row
->y
;
23966 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23968 /* Skip truncation glyphs at the start of the row. */
23969 if (row
->displays_text_p
)
23971 && INTEGERP (glyph
->object
)
23972 && glyph
->charpos
< 0;
23974 x
+= glyph
->pixel_width
;
23976 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23979 && !INTEGERP (glyph
->object
)
23980 && !EQ (glyph
->object
, after_string
)
23981 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23983 x
+= glyph
->pixel_width
;
23985 /* If we found AFTER_STRING, consume it and stop. */
23986 if (EQ (glyph
->object
, after_string
))
23988 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23989 x
+= glyph
->pixel_width
;
23993 /* If there's no after-string, we must check if we overshot,
23994 which might be the case if we stopped after a string glyph.
23995 That glyph may belong to a before-string or display-string
23996 associated with the end position, which must not be
23998 Lisp_Object prev_object
;
24001 while (glyph
> row
->glyphs
[TEXT_AREA
])
24003 prev_object
= (glyph
- 1)->object
;
24004 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
24007 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
24008 if (pos
&& pos
< end_charpos
)
24011 for (; glyph
> row
->glyphs
[TEXT_AREA
]
24012 && EQ ((glyph
- 1)->object
, prev_object
);
24014 x
-= (glyph
- 1)->pixel_width
;
24018 dpyinfo
->mouse_face_end_x
= x
;
24019 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24020 dpyinfo
->mouse_face_window
= window
;
24021 dpyinfo
->mouse_face_face_id
24022 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24024 !dpyinfo
->mouse_face_hidden
, -1);
24025 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24029 /* Find the position of the glyph for position POS in OBJECT in
24030 window W's current matrix, and return in *X, *Y the pixel
24031 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24033 RIGHT_P non-zero means return the position of the right edge of the
24034 glyph, RIGHT_P zero means return the left edge position.
24036 If no glyph for POS exists in the matrix, return the position of
24037 the glyph with the next smaller position that is in the matrix, if
24038 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24039 exists in the matrix, return the position of the glyph with the
24040 next larger position in OBJECT.
24042 Value is non-zero if a glyph was found. */
24045 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24046 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24048 int yb
= window_text_bottom_y (w
);
24049 struct glyph_row
*r
;
24050 struct glyph
*best_glyph
= NULL
;
24051 struct glyph_row
*best_row
= NULL
;
24054 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24055 r
->enabled_p
&& r
->y
< yb
;
24058 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24059 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24062 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24063 if (EQ (g
->object
, object
))
24065 if (g
->charpos
== pos
)
24072 else if (best_glyph
== NULL
24073 || ((eabs (g
->charpos
- pos
)
24074 < eabs (best_glyph
->charpos
- pos
))
24077 : g
->charpos
> pos
)))
24091 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24095 *x
+= best_glyph
->pixel_width
;
24100 *vpos
= best_row
- w
->current_matrix
->rows
;
24103 return best_glyph
!= NULL
;
24107 /* See if position X, Y is within a hot-spot of an image. */
24110 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24112 if (!CONSP (hot_spot
))
24115 if (EQ (XCAR (hot_spot
), Qrect
))
24117 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24118 Lisp_Object rect
= XCDR (hot_spot
);
24122 if (!CONSP (XCAR (rect
)))
24124 if (!CONSP (XCDR (rect
)))
24126 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24128 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24130 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24132 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24136 else if (EQ (XCAR (hot_spot
), Qcircle
))
24138 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24139 Lisp_Object circ
= XCDR (hot_spot
);
24140 Lisp_Object lr
, lx0
, ly0
;
24142 && CONSP (XCAR (circ
))
24143 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24144 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24145 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24147 double r
= XFLOATINT (lr
);
24148 double dx
= XINT (lx0
) - x
;
24149 double dy
= XINT (ly0
) - y
;
24150 return (dx
* dx
+ dy
* dy
<= r
* r
);
24153 else if (EQ (XCAR (hot_spot
), Qpoly
))
24155 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24156 if (VECTORP (XCDR (hot_spot
)))
24158 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24159 Lisp_Object
*poly
= v
->contents
;
24163 Lisp_Object lx
, ly
;
24166 /* Need an even number of coordinates, and at least 3 edges. */
24167 if (n
< 6 || n
& 1)
24170 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24171 If count is odd, we are inside polygon. Pixels on edges
24172 may or may not be included depending on actual geometry of the
24174 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24175 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24177 x0
= XINT (lx
), y0
= XINT (ly
);
24178 for (i
= 0; i
< n
; i
+= 2)
24180 int x1
= x0
, y1
= y0
;
24181 if ((lx
= poly
[i
], !INTEGERP (lx
))
24182 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24184 x0
= XINT (lx
), y0
= XINT (ly
);
24186 /* Does this segment cross the X line? */
24194 if (y
> y0
&& y
> y1
)
24196 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24206 find_hot_spot (Lisp_Object map
, int x
, int y
)
24208 while (CONSP (map
))
24210 if (CONSP (XCAR (map
))
24211 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24219 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24221 doc
: /* Lookup in image map MAP coordinates X and Y.
24222 An image map is an alist where each element has the format (AREA ID PLIST).
24223 An AREA is specified as either a rectangle, a circle, or a polygon:
24224 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24225 pixel coordinates of the upper left and bottom right corners.
24226 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24227 and the radius of the circle; r may be a float or integer.
24228 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24229 vector describes one corner in the polygon.
24230 Returns the alist element for the first matching AREA in MAP. */)
24231 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24239 return find_hot_spot (map
, XINT (x
), XINT (y
));
24243 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24245 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24247 /* Do not change cursor shape while dragging mouse. */
24248 if (!NILP (do_mouse_tracking
))
24251 if (!NILP (pointer
))
24253 if (EQ (pointer
, Qarrow
))
24254 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24255 else if (EQ (pointer
, Qhand
))
24256 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24257 else if (EQ (pointer
, Qtext
))
24258 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24259 else if (EQ (pointer
, intern ("hdrag")))
24260 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24261 #ifdef HAVE_X_WINDOWS
24262 else if (EQ (pointer
, intern ("vdrag")))
24263 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24265 else if (EQ (pointer
, intern ("hourglass")))
24266 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24267 else if (EQ (pointer
, Qmodeline
))
24268 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24270 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24273 if (cursor
!= No_Cursor
)
24274 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24277 /* Take proper action when mouse has moved to the mode or header line
24278 or marginal area AREA of window W, x-position X and y-position Y.
24279 X is relative to the start of the text display area of W, so the
24280 width of bitmap areas and scroll bars must be subtracted to get a
24281 position relative to the start of the mode line. */
24284 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24285 enum window_part area
)
24287 struct window
*w
= XWINDOW (window
);
24288 struct frame
*f
= XFRAME (w
->frame
);
24289 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24290 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24291 Lisp_Object pointer
= Qnil
;
24292 int charpos
, dx
, dy
, width
, height
;
24293 Lisp_Object string
, object
= Qnil
;
24294 Lisp_Object pos
, help
;
24296 Lisp_Object mouse_face
;
24297 int original_x_pixel
= x
;
24298 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24299 struct glyph_row
*row
;
24301 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24306 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24307 &object
, &dx
, &dy
, &width
, &height
);
24309 row
= (area
== ON_MODE_LINE
24310 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24311 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24314 if (row
->mode_line_p
&& row
->enabled_p
)
24316 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24317 end
= glyph
+ row
->used
[TEXT_AREA
];
24319 for (x0
= original_x_pixel
;
24320 glyph
< end
&& x0
>= glyph
->pixel_width
;
24322 x0
-= glyph
->pixel_width
;
24330 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24331 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24332 &object
, &dx
, &dy
, &width
, &height
);
24337 if (IMAGEP (object
))
24339 Lisp_Object image_map
, hotspot
;
24340 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24342 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24344 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24346 Lisp_Object area_id
, plist
;
24348 area_id
= XCAR (hotspot
);
24349 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24350 If so, we could look for mouse-enter, mouse-leave
24351 properties in PLIST (and do something...). */
24352 hotspot
= XCDR (hotspot
);
24353 if (CONSP (hotspot
)
24354 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24356 pointer
= Fplist_get (plist
, Qpointer
);
24357 if (NILP (pointer
))
24359 help
= Fplist_get (plist
, Qhelp_echo
);
24362 help_echo_string
= help
;
24363 /* Is this correct? ++kfs */
24364 XSETWINDOW (help_echo_window
, w
);
24365 help_echo_object
= w
->buffer
;
24366 help_echo_pos
= charpos
;
24370 if (NILP (pointer
))
24371 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24374 if (STRINGP (string
))
24376 pos
= make_number (charpos
);
24377 /* If we're on a string with `help-echo' text property, arrange
24378 for the help to be displayed. This is done by setting the
24379 global variable help_echo_string to the help string. */
24382 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24385 help_echo_string
= help
;
24386 XSETWINDOW (help_echo_window
, w
);
24387 help_echo_object
= string
;
24388 help_echo_pos
= charpos
;
24392 if (NILP (pointer
))
24393 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24395 /* Change the mouse pointer according to what is under X/Y. */
24396 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24399 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24400 if (!KEYMAPP (map
))
24401 map
= Fget_text_property (pos
, Qkeymap
, string
);
24402 if (!KEYMAPP (map
))
24403 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24406 /* Change the mouse face according to what is under X/Y. */
24407 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24408 if (!NILP (mouse_face
)
24409 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24414 struct glyph
* tmp_glyph
;
24418 int total_pixel_width
;
24423 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24424 Qmouse_face
, string
, Qnil
);
24426 b
= make_number (0);
24428 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24430 e
= make_number (SCHARS (string
));
24432 /* Calculate the position(glyph position: GPOS) of GLYPH in
24433 displayed string. GPOS is different from CHARPOS.
24435 CHARPOS is the position of glyph in internal string
24436 object. A mode line string format has structures which
24437 is converted to a flatten by emacs lisp interpreter.
24438 The internal string is an element of the structures.
24439 The displayed string is the flatten string. */
24441 if (glyph
> row_start_glyph
)
24443 tmp_glyph
= glyph
- 1;
24444 while (tmp_glyph
>= row_start_glyph
24445 && tmp_glyph
->charpos
>= XINT (b
)
24446 && EQ (tmp_glyph
->object
, glyph
->object
))
24453 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24454 displayed string holding GLYPH.
24456 GSEQ_LENGTH is different from SCHARS (STRING).
24457 SCHARS (STRING) returns the length of the internal string. */
24458 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24459 tmp_glyph
->charpos
< XINT (e
);
24460 tmp_glyph
++, gseq_length
++)
24462 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24466 total_pixel_width
= 0;
24467 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24468 total_pixel_width
+= tmp_glyph
->pixel_width
;
24470 /* Pre calculation of re-rendering position */
24472 hpos
= (area
== ON_MODE_LINE
24473 ? (w
->current_matrix
)->nrows
- 1
24476 /* If the re-rendering position is included in the last
24477 re-rendering area, we should do nothing. */
24478 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24479 && dpyinfo
->mouse_face_beg_col
<= vpos
24480 && vpos
< dpyinfo
->mouse_face_end_col
24481 && dpyinfo
->mouse_face_beg_row
== hpos
)
24484 if (clear_mouse_face (dpyinfo
))
24485 cursor
= No_Cursor
;
24487 dpyinfo
->mouse_face_beg_col
= vpos
;
24488 dpyinfo
->mouse_face_beg_row
= hpos
;
24490 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24491 dpyinfo
->mouse_face_beg_y
= 0;
24493 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24494 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24496 dpyinfo
->mouse_face_end_x
= 0;
24497 dpyinfo
->mouse_face_end_y
= 0;
24499 dpyinfo
->mouse_face_past_end
= 0;
24500 dpyinfo
->mouse_face_window
= window
;
24502 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24505 glyph
->face_id
, 1);
24506 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24508 if (NILP (pointer
))
24511 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24512 clear_mouse_face (dpyinfo
);
24514 define_frame_cursor1 (f
, cursor
, pointer
);
24519 Take proper action when the mouse has moved to position X, Y on
24520 frame F as regards highlighting characters that have mouse-face
24521 properties. Also de-highlighting chars where the mouse was before.
24522 X and Y can be negative or out of range. */
24525 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24527 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24528 enum window_part part
;
24529 Lisp_Object window
;
24531 Cursor cursor
= No_Cursor
;
24532 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24535 /* When a menu is active, don't highlight because this looks odd. */
24536 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24537 if (popup_activated ())
24541 if (NILP (Vmouse_highlight
)
24542 || !f
->glyphs_initialized_p
24543 || f
->pointer_invisible
)
24546 dpyinfo
->mouse_face_mouse_x
= x
;
24547 dpyinfo
->mouse_face_mouse_y
= y
;
24548 dpyinfo
->mouse_face_mouse_frame
= f
;
24550 if (dpyinfo
->mouse_face_defer
)
24553 if (gc_in_progress
)
24555 dpyinfo
->mouse_face_deferred_gc
= 1;
24559 /* Which window is that in? */
24560 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24562 /* If we were displaying active text in another window, clear that.
24563 Also clear if we move out of text area in same window. */
24564 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24565 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24566 && !NILP (dpyinfo
->mouse_face_window
)))
24567 clear_mouse_face (dpyinfo
);
24569 /* Not on a window -> return. */
24570 if (!WINDOWP (window
))
24573 /* Reset help_echo_string. It will get recomputed below. */
24574 help_echo_string
= Qnil
;
24576 /* Convert to window-relative pixel coordinates. */
24577 w
= XWINDOW (window
);
24578 frame_to_window_pixel_xy (w
, &x
, &y
);
24580 /* Handle tool-bar window differently since it doesn't display a
24582 if (EQ (window
, f
->tool_bar_window
))
24584 note_tool_bar_highlight (f
, x
, y
);
24588 /* Mouse is on the mode, header line or margin? */
24589 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24590 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24592 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24596 if (part
== ON_VERTICAL_BORDER
)
24598 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24599 help_echo_string
= build_string ("drag-mouse-1: resize");
24601 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24602 || part
== ON_SCROLL_BAR
)
24603 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24605 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24607 /* Are we in a window whose display is up to date?
24608 And verify the buffer's text has not changed. */
24609 b
= XBUFFER (w
->buffer
);
24610 if (part
== ON_TEXT
24611 && EQ (w
->window_end_valid
, w
->buffer
)
24612 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24613 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24615 int hpos
, vpos
, i
, dx
, dy
, area
;
24617 struct glyph
*glyph
;
24618 Lisp_Object object
;
24619 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24620 Lisp_Object
*overlay_vec
= NULL
;
24622 struct buffer
*obuf
;
24623 int obegv
, ozv
, same_region
;
24625 /* Find the glyph under X/Y. */
24626 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24628 /* Look for :pointer property on image. */
24629 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24631 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24632 if (img
!= NULL
&& IMAGEP (img
->spec
))
24634 Lisp_Object image_map
, hotspot
;
24635 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24637 && (hotspot
= find_hot_spot (image_map
,
24638 glyph
->slice
.x
+ dx
,
24639 glyph
->slice
.y
+ dy
),
24641 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24643 Lisp_Object area_id
, plist
;
24645 area_id
= XCAR (hotspot
);
24646 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24647 If so, we could look for mouse-enter, mouse-leave
24648 properties in PLIST (and do something...). */
24649 hotspot
= XCDR (hotspot
);
24650 if (CONSP (hotspot
)
24651 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24653 pointer
= Fplist_get (plist
, Qpointer
);
24654 if (NILP (pointer
))
24656 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24657 if (!NILP (help_echo_string
))
24659 help_echo_window
= window
;
24660 help_echo_object
= glyph
->object
;
24661 help_echo_pos
= glyph
->charpos
;
24665 if (NILP (pointer
))
24666 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24670 /* Clear mouse face if X/Y not over text. */
24672 || area
!= TEXT_AREA
24673 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24675 if (clear_mouse_face (dpyinfo
))
24676 cursor
= No_Cursor
;
24677 if (NILP (pointer
))
24679 if (area
!= TEXT_AREA
)
24680 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24682 pointer
= Vvoid_text_area_pointer
;
24687 pos
= glyph
->charpos
;
24688 object
= glyph
->object
;
24689 if (!STRINGP (object
) && !BUFFERP (object
))
24692 /* If we get an out-of-range value, return now; avoid an error. */
24693 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24696 /* Make the window's buffer temporarily current for
24697 overlays_at and compute_char_face. */
24698 obuf
= current_buffer
;
24699 current_buffer
= b
;
24705 /* Is this char mouse-active or does it have help-echo? */
24706 position
= make_number (pos
);
24708 if (BUFFERP (object
))
24710 /* Put all the overlays we want in a vector in overlay_vec. */
24711 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24712 /* Sort overlays into increasing priority order. */
24713 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24718 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24719 && vpos
>= dpyinfo
->mouse_face_beg_row
24720 && vpos
<= dpyinfo
->mouse_face_end_row
24721 && (vpos
> dpyinfo
->mouse_face_beg_row
24722 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24723 && (vpos
< dpyinfo
->mouse_face_end_row
24724 || hpos
< dpyinfo
->mouse_face_end_col
24725 || dpyinfo
->mouse_face_past_end
));
24728 cursor
= No_Cursor
;
24730 /* Check mouse-face highlighting. */
24732 /* If there exists an overlay with mouse-face overlapping
24733 the one we are currently highlighting, we have to
24734 check if we enter the overlapping overlay, and then
24735 highlight only that. */
24736 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24737 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24739 /* Find the highest priority overlay with a mouse-face. */
24741 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24743 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24744 if (!NILP (mouse_face
))
24745 overlay
= overlay_vec
[i
];
24748 /* If we're highlighting the same overlay as before, there's
24749 no need to do that again. */
24750 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24751 goto check_help_echo
;
24752 dpyinfo
->mouse_face_overlay
= overlay
;
24754 /* Clear the display of the old active region, if any. */
24755 if (clear_mouse_face (dpyinfo
))
24756 cursor
= No_Cursor
;
24758 /* If no overlay applies, get a text property. */
24759 if (NILP (overlay
))
24760 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24762 /* Next, compute the bounds of the mouse highlighting and
24764 if (!NILP (mouse_face
) && STRINGP (object
))
24766 /* The mouse-highlighting comes from a display string
24767 with a mouse-face. */
24771 b
= Fprevious_single_property_change
24772 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24773 e
= Fnext_single_property_change
24774 (position
, Qmouse_face
, object
, Qnil
);
24776 b
= make_number (0);
24778 e
= make_number (SCHARS (object
) - 1);
24780 fast_find_string_pos (w
, XINT (b
), object
,
24781 &dpyinfo
->mouse_face_beg_col
,
24782 &dpyinfo
->mouse_face_beg_row
,
24783 &dpyinfo
->mouse_face_beg_x
,
24784 &dpyinfo
->mouse_face_beg_y
, 0);
24785 fast_find_string_pos (w
, XINT (e
), object
,
24786 &dpyinfo
->mouse_face_end_col
,
24787 &dpyinfo
->mouse_face_end_row
,
24788 &dpyinfo
->mouse_face_end_x
,
24789 &dpyinfo
->mouse_face_end_y
, 1);
24790 dpyinfo
->mouse_face_past_end
= 0;
24791 dpyinfo
->mouse_face_window
= window
;
24792 dpyinfo
->mouse_face_face_id
24793 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24794 glyph
->face_id
, 1);
24795 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24796 cursor
= No_Cursor
;
24800 /* The mouse-highlighting, if any, comes from an overlay
24801 or text property in the buffer. */
24802 Lisp_Object buffer
, display_string
;
24804 if (STRINGP (object
))
24806 /* If we are on a display string with no mouse-face,
24807 check if the text under it has one. */
24808 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24809 int start
= MATRIX_ROW_START_CHARPOS (r
);
24810 pos
= string_buffer_position (w
, object
, start
);
24813 mouse_face
= get_char_property_and_overlay
24814 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24815 buffer
= w
->buffer
;
24816 display_string
= object
;
24822 display_string
= Qnil
;
24825 if (!NILP (mouse_face
))
24827 Lisp_Object before
, after
;
24828 Lisp_Object before_string
, after_string
;
24830 if (NILP (overlay
))
24832 /* Handle the text property case. */
24833 before
= Fprevious_single_property_change
24834 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24835 Fmarker_position (w
->start
));
24836 after
= Fnext_single_property_change
24837 (make_number (pos
), Qmouse_face
, buffer
,
24838 make_number (BUF_Z (XBUFFER (buffer
))
24839 - XFASTINT (w
->window_end_pos
)));
24840 before_string
= after_string
= Qnil
;
24844 /* Handle the overlay case. */
24845 before
= Foverlay_start (overlay
);
24846 after
= Foverlay_end (overlay
);
24847 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24848 after_string
= Foverlay_get (overlay
, Qafter_string
);
24850 if (!STRINGP (before_string
)) before_string
= Qnil
;
24851 if (!STRINGP (after_string
)) after_string
= Qnil
;
24854 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24857 before_string
, after_string
,
24859 cursor
= No_Cursor
;
24866 /* Look for a `help-echo' property. */
24867 if (NILP (help_echo_string
)) {
24868 Lisp_Object help
, overlay
;
24870 /* Check overlays first. */
24871 help
= overlay
= Qnil
;
24872 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24874 overlay
= overlay_vec
[i
];
24875 help
= Foverlay_get (overlay
, Qhelp_echo
);
24880 help_echo_string
= help
;
24881 help_echo_window
= window
;
24882 help_echo_object
= overlay
;
24883 help_echo_pos
= pos
;
24887 Lisp_Object object
= glyph
->object
;
24888 int charpos
= glyph
->charpos
;
24890 /* Try text properties. */
24891 if (STRINGP (object
)
24893 && charpos
< SCHARS (object
))
24895 help
= Fget_text_property (make_number (charpos
),
24896 Qhelp_echo
, object
);
24899 /* If the string itself doesn't specify a help-echo,
24900 see if the buffer text ``under'' it does. */
24901 struct glyph_row
*r
24902 = MATRIX_ROW (w
->current_matrix
, vpos
);
24903 int start
= MATRIX_ROW_START_CHARPOS (r
);
24904 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24907 help
= Fget_char_property (make_number (pos
),
24908 Qhelp_echo
, w
->buffer
);
24912 object
= w
->buffer
;
24917 else if (BUFFERP (object
)
24920 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24925 help_echo_string
= help
;
24926 help_echo_window
= window
;
24927 help_echo_object
= object
;
24928 help_echo_pos
= charpos
;
24933 /* Look for a `pointer' property. */
24934 if (NILP (pointer
))
24936 /* Check overlays first. */
24937 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24938 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24940 if (NILP (pointer
))
24942 Lisp_Object object
= glyph
->object
;
24943 int charpos
= glyph
->charpos
;
24945 /* Try text properties. */
24946 if (STRINGP (object
)
24948 && charpos
< SCHARS (object
))
24950 pointer
= Fget_text_property (make_number (charpos
),
24952 if (NILP (pointer
))
24954 /* If the string itself doesn't specify a pointer,
24955 see if the buffer text ``under'' it does. */
24956 struct glyph_row
*r
24957 = MATRIX_ROW (w
->current_matrix
, vpos
);
24958 int start
= MATRIX_ROW_START_CHARPOS (r
);
24959 EMACS_INT pos
= string_buffer_position (w
, object
,
24962 pointer
= Fget_char_property (make_number (pos
),
24963 Qpointer
, w
->buffer
);
24966 else if (BUFFERP (object
)
24969 pointer
= Fget_text_property (make_number (charpos
),
24976 current_buffer
= obuf
;
24981 define_frame_cursor1 (f
, cursor
, pointer
);
24986 Clear any mouse-face on window W. This function is part of the
24987 redisplay interface, and is called from try_window_id and similar
24988 functions to ensure the mouse-highlight is off. */
24991 x_clear_window_mouse_face (struct window
*w
)
24993 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24994 Lisp_Object window
;
24997 XSETWINDOW (window
, w
);
24998 if (EQ (window
, dpyinfo
->mouse_face_window
))
24999 clear_mouse_face (dpyinfo
);
25005 Just discard the mouse face information for frame F, if any.
25006 This is used when the size of F is changed. */
25009 cancel_mouse_face (struct frame
*f
)
25011 Lisp_Object window
;
25012 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25014 window
= dpyinfo
->mouse_face_window
;
25015 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25017 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25018 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25019 dpyinfo
->mouse_face_window
= Qnil
;
25024 #endif /* HAVE_WINDOW_SYSTEM */
25027 /***********************************************************************
25029 ***********************************************************************/
25031 #ifdef HAVE_WINDOW_SYSTEM
25033 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25034 which intersects rectangle R. R is in window-relative coordinates. */
25037 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25038 enum glyph_row_area area
)
25040 struct glyph
*first
= row
->glyphs
[area
];
25041 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25042 struct glyph
*last
;
25043 int first_x
, start_x
, x
;
25045 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25046 /* If row extends face to end of line write the whole line. */
25047 draw_glyphs (w
, 0, row
, area
,
25048 0, row
->used
[area
],
25049 DRAW_NORMAL_TEXT
, 0);
25052 /* Set START_X to the window-relative start position for drawing glyphs of
25053 AREA. The first glyph of the text area can be partially visible.
25054 The first glyphs of other areas cannot. */
25055 start_x
= window_box_left_offset (w
, area
);
25057 if (area
== TEXT_AREA
)
25060 /* Find the first glyph that must be redrawn. */
25062 && x
+ first
->pixel_width
< r
->x
)
25064 x
+= first
->pixel_width
;
25068 /* Find the last one. */
25072 && x
< r
->x
+ r
->width
)
25074 x
+= last
->pixel_width
;
25080 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25081 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25082 DRAW_NORMAL_TEXT
, 0);
25087 /* Redraw the parts of the glyph row ROW on window W intersecting
25088 rectangle R. R is in window-relative coordinates. Value is
25089 non-zero if mouse-face was overwritten. */
25092 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25094 xassert (row
->enabled_p
);
25096 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25097 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25098 0, row
->used
[TEXT_AREA
],
25099 DRAW_NORMAL_TEXT
, 0);
25102 if (row
->used
[LEFT_MARGIN_AREA
])
25103 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25104 if (row
->used
[TEXT_AREA
])
25105 expose_area (w
, row
, r
, TEXT_AREA
);
25106 if (row
->used
[RIGHT_MARGIN_AREA
])
25107 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25108 draw_row_fringe_bitmaps (w
, row
);
25111 return row
->mouse_face_p
;
25115 /* Redraw those parts of glyphs rows during expose event handling that
25116 overlap other rows. Redrawing of an exposed line writes over parts
25117 of lines overlapping that exposed line; this function fixes that.
25119 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25120 row in W's current matrix that is exposed and overlaps other rows.
25121 LAST_OVERLAPPING_ROW is the last such row. */
25124 expose_overlaps (struct window
*w
,
25125 struct glyph_row
*first_overlapping_row
,
25126 struct glyph_row
*last_overlapping_row
,
25129 struct glyph_row
*row
;
25131 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25132 if (row
->overlapping_p
)
25134 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25137 if (row
->used
[LEFT_MARGIN_AREA
])
25138 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25140 if (row
->used
[TEXT_AREA
])
25141 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25143 if (row
->used
[RIGHT_MARGIN_AREA
])
25144 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25150 /* Return non-zero if W's cursor intersects rectangle R. */
25153 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25155 XRectangle cr
, result
;
25156 struct glyph
*cursor_glyph
;
25157 struct glyph_row
*row
;
25159 if (w
->phys_cursor
.vpos
>= 0
25160 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25161 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25163 && row
->cursor_in_fringe_p
)
25165 /* Cursor is in the fringe. */
25166 cr
.x
= window_box_right_offset (w
,
25167 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25168 ? RIGHT_MARGIN_AREA
25171 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25172 cr
.height
= row
->height
;
25173 return x_intersect_rectangles (&cr
, r
, &result
);
25176 cursor_glyph
= get_phys_cursor_glyph (w
);
25179 /* r is relative to W's box, but w->phys_cursor.x is relative
25180 to left edge of W's TEXT area. Adjust it. */
25181 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25182 cr
.y
= w
->phys_cursor
.y
;
25183 cr
.width
= cursor_glyph
->pixel_width
;
25184 cr
.height
= w
->phys_cursor_height
;
25185 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25186 I assume the effect is the same -- and this is portable. */
25187 return x_intersect_rectangles (&cr
, r
, &result
);
25189 /* If we don't understand the format, pretend we're not in the hot-spot. */
25195 Draw a vertical window border to the right of window W if W doesn't
25196 have vertical scroll bars. */
25199 x_draw_vertical_border (struct window
*w
)
25201 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25203 /* We could do better, if we knew what type of scroll-bar the adjacent
25204 windows (on either side) have... But we don't :-(
25205 However, I think this works ok. ++KFS 2003-04-25 */
25207 /* Redraw borders between horizontally adjacent windows. Don't
25208 do it for frames with vertical scroll bars because either the
25209 right scroll bar of a window, or the left scroll bar of its
25210 neighbor will suffice as a border. */
25211 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25214 if (!WINDOW_RIGHTMOST_P (w
)
25215 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25217 int x0
, x1
, y0
, y1
;
25219 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25222 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25225 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25227 else if (!WINDOW_LEFTMOST_P (w
)
25228 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25230 int x0
, x1
, y0
, y1
;
25232 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25235 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25238 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25243 /* Redraw the part of window W intersection rectangle FR. Pixel
25244 coordinates in FR are frame-relative. Call this function with
25245 input blocked. Value is non-zero if the exposure overwrites
25249 expose_window (struct window
*w
, XRectangle
*fr
)
25251 struct frame
*f
= XFRAME (w
->frame
);
25253 int mouse_face_overwritten_p
= 0;
25255 /* If window is not yet fully initialized, do nothing. This can
25256 happen when toolkit scroll bars are used and a window is split.
25257 Reconfiguring the scroll bar will generate an expose for a newly
25259 if (w
->current_matrix
== NULL
)
25262 /* When we're currently updating the window, display and current
25263 matrix usually don't agree. Arrange for a thorough display
25265 if (w
== updated_window
)
25267 SET_FRAME_GARBAGED (f
);
25271 /* Frame-relative pixel rectangle of W. */
25272 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25273 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25274 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25275 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25277 if (x_intersect_rectangles (fr
, &wr
, &r
))
25279 int yb
= window_text_bottom_y (w
);
25280 struct glyph_row
*row
;
25281 int cursor_cleared_p
;
25282 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25284 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25285 r
.x
, r
.y
, r
.width
, r
.height
));
25287 /* Convert to window coordinates. */
25288 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25289 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25291 /* Turn off the cursor. */
25292 if (!w
->pseudo_window_p
25293 && phys_cursor_in_rect_p (w
, &r
))
25295 x_clear_cursor (w
);
25296 cursor_cleared_p
= 1;
25299 cursor_cleared_p
= 0;
25301 /* Update lines intersecting rectangle R. */
25302 first_overlapping_row
= last_overlapping_row
= NULL
;
25303 for (row
= w
->current_matrix
->rows
;
25308 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25310 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25311 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25312 || (r
.y
>= y0
&& r
.y
< y1
)
25313 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25315 /* A header line may be overlapping, but there is no need
25316 to fix overlapping areas for them. KFS 2005-02-12 */
25317 if (row
->overlapping_p
&& !row
->mode_line_p
)
25319 if (first_overlapping_row
== NULL
)
25320 first_overlapping_row
= row
;
25321 last_overlapping_row
= row
;
25325 if (expose_line (w
, row
, &r
))
25326 mouse_face_overwritten_p
= 1;
25329 else if (row
->overlapping_p
)
25331 /* We must redraw a row overlapping the exposed area. */
25333 ? y0
+ row
->phys_height
> r
.y
25334 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25336 if (first_overlapping_row
== NULL
)
25337 first_overlapping_row
= row
;
25338 last_overlapping_row
= row
;
25346 /* Display the mode line if there is one. */
25347 if (WINDOW_WANTS_MODELINE_P (w
)
25348 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25350 && row
->y
< r
.y
+ r
.height
)
25352 if (expose_line (w
, row
, &r
))
25353 mouse_face_overwritten_p
= 1;
25356 if (!w
->pseudo_window_p
)
25358 /* Fix the display of overlapping rows. */
25359 if (first_overlapping_row
)
25360 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25363 /* Draw border between windows. */
25364 x_draw_vertical_border (w
);
25366 /* Turn the cursor on again. */
25367 if (cursor_cleared_p
)
25368 update_window_cursor (w
, 1);
25372 return mouse_face_overwritten_p
;
25377 /* Redraw (parts) of all windows in the window tree rooted at W that
25378 intersect R. R contains frame pixel coordinates. Value is
25379 non-zero if the exposure overwrites mouse-face. */
25382 expose_window_tree (struct window
*w
, XRectangle
*r
)
25384 struct frame
*f
= XFRAME (w
->frame
);
25385 int mouse_face_overwritten_p
= 0;
25387 while (w
&& !FRAME_GARBAGED_P (f
))
25389 if (!NILP (w
->hchild
))
25390 mouse_face_overwritten_p
25391 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25392 else if (!NILP (w
->vchild
))
25393 mouse_face_overwritten_p
25394 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25396 mouse_face_overwritten_p
|= expose_window (w
, r
);
25398 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25401 return mouse_face_overwritten_p
;
25406 Redisplay an exposed area of frame F. X and Y are the upper-left
25407 corner of the exposed rectangle. W and H are width and height of
25408 the exposed area. All are pixel values. W or H zero means redraw
25409 the entire frame. */
25412 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25415 int mouse_face_overwritten_p
= 0;
25417 TRACE ((stderr
, "expose_frame "));
25419 /* No need to redraw if frame will be redrawn soon. */
25420 if (FRAME_GARBAGED_P (f
))
25422 TRACE ((stderr
, " garbaged\n"));
25426 /* If basic faces haven't been realized yet, there is no point in
25427 trying to redraw anything. This can happen when we get an expose
25428 event while Emacs is starting, e.g. by moving another window. */
25429 if (FRAME_FACE_CACHE (f
) == NULL
25430 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25432 TRACE ((stderr
, " no faces\n"));
25436 if (w
== 0 || h
== 0)
25439 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25440 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25450 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25451 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25453 if (WINDOWP (f
->tool_bar_window
))
25454 mouse_face_overwritten_p
25455 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25457 #ifdef HAVE_X_WINDOWS
25459 #ifndef USE_X_TOOLKIT
25460 if (WINDOWP (f
->menu_bar_window
))
25461 mouse_face_overwritten_p
25462 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25463 #endif /* not USE_X_TOOLKIT */
25467 /* Some window managers support a focus-follows-mouse style with
25468 delayed raising of frames. Imagine a partially obscured frame,
25469 and moving the mouse into partially obscured mouse-face on that
25470 frame. The visible part of the mouse-face will be highlighted,
25471 then the WM raises the obscured frame. With at least one WM, KDE
25472 2.1, Emacs is not getting any event for the raising of the frame
25473 (even tried with SubstructureRedirectMask), only Expose events.
25474 These expose events will draw text normally, i.e. not
25475 highlighted. Which means we must redo the highlight here.
25476 Subsume it under ``we love X''. --gerd 2001-08-15 */
25477 /* Included in Windows version because Windows most likely does not
25478 do the right thing if any third party tool offers
25479 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25480 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25482 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25483 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25485 int x
= dpyinfo
->mouse_face_mouse_x
;
25486 int y
= dpyinfo
->mouse_face_mouse_y
;
25487 clear_mouse_face (dpyinfo
);
25488 note_mouse_highlight (f
, x
, y
);
25495 Determine the intersection of two rectangles R1 and R2. Return
25496 the intersection in *RESULT. Value is non-zero if RESULT is not
25500 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25502 XRectangle
*left
, *right
;
25503 XRectangle
*upper
, *lower
;
25504 int intersection_p
= 0;
25506 /* Rearrange so that R1 is the left-most rectangle. */
25508 left
= r1
, right
= r2
;
25510 left
= r2
, right
= r1
;
25512 /* X0 of the intersection is right.x0, if this is inside R1,
25513 otherwise there is no intersection. */
25514 if (right
->x
<= left
->x
+ left
->width
)
25516 result
->x
= right
->x
;
25518 /* The right end of the intersection is the minimum of the
25519 the right ends of left and right. */
25520 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25523 /* Same game for Y. */
25525 upper
= r1
, lower
= r2
;
25527 upper
= r2
, lower
= r1
;
25529 /* The upper end of the intersection is lower.y0, if this is inside
25530 of upper. Otherwise, there is no intersection. */
25531 if (lower
->y
<= upper
->y
+ upper
->height
)
25533 result
->y
= lower
->y
;
25535 /* The lower end of the intersection is the minimum of the lower
25536 ends of upper and lower. */
25537 result
->height
= (min (lower
->y
+ lower
->height
,
25538 upper
->y
+ upper
->height
)
25540 intersection_p
= 1;
25544 return intersection_p
;
25547 #endif /* HAVE_WINDOW_SYSTEM */
25550 /***********************************************************************
25552 ***********************************************************************/
25555 syms_of_xdisp (void)
25557 Vwith_echo_area_save_vector
= Qnil
;
25558 staticpro (&Vwith_echo_area_save_vector
);
25560 Vmessage_stack
= Qnil
;
25561 staticpro (&Vmessage_stack
);
25563 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25564 staticpro (&Qinhibit_redisplay
);
25566 message_dolog_marker1
= Fmake_marker ();
25567 staticpro (&message_dolog_marker1
);
25568 message_dolog_marker2
= Fmake_marker ();
25569 staticpro (&message_dolog_marker2
);
25570 message_dolog_marker3
= Fmake_marker ();
25571 staticpro (&message_dolog_marker3
);
25574 defsubr (&Sdump_frame_glyph_matrix
);
25575 defsubr (&Sdump_glyph_matrix
);
25576 defsubr (&Sdump_glyph_row
);
25577 defsubr (&Sdump_tool_bar_row
);
25578 defsubr (&Strace_redisplay
);
25579 defsubr (&Strace_to_stderr
);
25581 #ifdef HAVE_WINDOW_SYSTEM
25582 defsubr (&Stool_bar_lines_needed
);
25583 defsubr (&Slookup_image_map
);
25585 defsubr (&Sformat_mode_line
);
25586 defsubr (&Sinvisible_p
);
25587 defsubr (&Scurrent_bidi_paragraph_direction
);
25589 staticpro (&Qmenu_bar_update_hook
);
25590 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25592 staticpro (&Qoverriding_terminal_local_map
);
25593 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25595 staticpro (&Qoverriding_local_map
);
25596 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25598 staticpro (&Qwindow_scroll_functions
);
25599 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25601 staticpro (&Qwindow_text_change_functions
);
25602 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25604 staticpro (&Qredisplay_end_trigger_functions
);
25605 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25607 staticpro (&Qinhibit_point_motion_hooks
);
25608 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25610 Qeval
= intern_c_string ("eval");
25611 staticpro (&Qeval
);
25613 QCdata
= intern_c_string (":data");
25614 staticpro (&QCdata
);
25615 Qdisplay
= intern_c_string ("display");
25616 staticpro (&Qdisplay
);
25617 Qspace_width
= intern_c_string ("space-width");
25618 staticpro (&Qspace_width
);
25619 Qraise
= intern_c_string ("raise");
25620 staticpro (&Qraise
);
25621 Qslice
= intern_c_string ("slice");
25622 staticpro (&Qslice
);
25623 Qspace
= intern_c_string ("space");
25624 staticpro (&Qspace
);
25625 Qmargin
= intern_c_string ("margin");
25626 staticpro (&Qmargin
);
25627 Qpointer
= intern_c_string ("pointer");
25628 staticpro (&Qpointer
);
25629 Qleft_margin
= intern_c_string ("left-margin");
25630 staticpro (&Qleft_margin
);
25631 Qright_margin
= intern_c_string ("right-margin");
25632 staticpro (&Qright_margin
);
25633 Qcenter
= intern_c_string ("center");
25634 staticpro (&Qcenter
);
25635 Qline_height
= intern_c_string ("line-height");
25636 staticpro (&Qline_height
);
25637 QCalign_to
= intern_c_string (":align-to");
25638 staticpro (&QCalign_to
);
25639 QCrelative_width
= intern_c_string (":relative-width");
25640 staticpro (&QCrelative_width
);
25641 QCrelative_height
= intern_c_string (":relative-height");
25642 staticpro (&QCrelative_height
);
25643 QCeval
= intern_c_string (":eval");
25644 staticpro (&QCeval
);
25645 QCpropertize
= intern_c_string (":propertize");
25646 staticpro (&QCpropertize
);
25647 QCfile
= intern_c_string (":file");
25648 staticpro (&QCfile
);
25649 Qfontified
= intern_c_string ("fontified");
25650 staticpro (&Qfontified
);
25651 Qfontification_functions
= intern_c_string ("fontification-functions");
25652 staticpro (&Qfontification_functions
);
25653 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25654 staticpro (&Qtrailing_whitespace
);
25655 Qescape_glyph
= intern_c_string ("escape-glyph");
25656 staticpro (&Qescape_glyph
);
25657 Qnobreak_space
= intern_c_string ("nobreak-space");
25658 staticpro (&Qnobreak_space
);
25659 Qimage
= intern_c_string ("image");
25660 staticpro (&Qimage
);
25661 Qtext
= intern_c_string ("text");
25662 staticpro (&Qtext
);
25663 Qboth
= intern_c_string ("both");
25664 staticpro (&Qboth
);
25665 Qboth_horiz
= intern_c_string ("both-horiz");
25666 staticpro (&Qboth_horiz
);
25667 QCmap
= intern_c_string (":map");
25668 staticpro (&QCmap
);
25669 QCpointer
= intern_c_string (":pointer");
25670 staticpro (&QCpointer
);
25671 Qrect
= intern_c_string ("rect");
25672 staticpro (&Qrect
);
25673 Qcircle
= intern_c_string ("circle");
25674 staticpro (&Qcircle
);
25675 Qpoly
= intern_c_string ("poly");
25676 staticpro (&Qpoly
);
25677 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25678 staticpro (&Qmessage_truncate_lines
);
25679 Qgrow_only
= intern_c_string ("grow-only");
25680 staticpro (&Qgrow_only
);
25681 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25682 staticpro (&Qinhibit_menubar_update
);
25683 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25684 staticpro (&Qinhibit_eval_during_redisplay
);
25685 Qposition
= intern_c_string ("position");
25686 staticpro (&Qposition
);
25687 Qbuffer_position
= intern_c_string ("buffer-position");
25688 staticpro (&Qbuffer_position
);
25689 Qobject
= intern_c_string ("object");
25690 staticpro (&Qobject
);
25691 Qbar
= intern_c_string ("bar");
25693 Qhbar
= intern_c_string ("hbar");
25694 staticpro (&Qhbar
);
25695 Qbox
= intern_c_string ("box");
25697 Qhollow
= intern_c_string ("hollow");
25698 staticpro (&Qhollow
);
25699 Qhand
= intern_c_string ("hand");
25700 staticpro (&Qhand
);
25701 Qarrow
= intern_c_string ("arrow");
25702 staticpro (&Qarrow
);
25703 Qtext
= intern_c_string ("text");
25704 staticpro (&Qtext
);
25705 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25706 staticpro (&Qrisky_local_variable
);
25707 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25708 staticpro (&Qinhibit_free_realized_faces
);
25710 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25711 Fcons (intern_c_string ("void-variable"), Qnil
)),
25713 staticpro (&list_of_error
);
25715 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25716 staticpro (&Qlast_arrow_position
);
25717 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25718 staticpro (&Qlast_arrow_string
);
25720 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25721 staticpro (&Qoverlay_arrow_string
);
25722 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25723 staticpro (&Qoverlay_arrow_bitmap
);
25725 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25726 staticpro (&echo_buffer
[0]);
25727 staticpro (&echo_buffer
[1]);
25729 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25730 staticpro (&echo_area_buffer
[0]);
25731 staticpro (&echo_area_buffer
[1]);
25733 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25734 staticpro (&Vmessages_buffer_name
);
25736 mode_line_proptrans_alist
= Qnil
;
25737 staticpro (&mode_line_proptrans_alist
);
25738 mode_line_string_list
= Qnil
;
25739 staticpro (&mode_line_string_list
);
25740 mode_line_string_face
= Qnil
;
25741 staticpro (&mode_line_string_face
);
25742 mode_line_string_face_prop
= Qnil
;
25743 staticpro (&mode_line_string_face_prop
);
25744 Vmode_line_unwind_vector
= Qnil
;
25745 staticpro (&Vmode_line_unwind_vector
);
25747 help_echo_string
= Qnil
;
25748 staticpro (&help_echo_string
);
25749 help_echo_object
= Qnil
;
25750 staticpro (&help_echo_object
);
25751 help_echo_window
= Qnil
;
25752 staticpro (&help_echo_window
);
25753 previous_help_echo_string
= Qnil
;
25754 staticpro (&previous_help_echo_string
);
25755 help_echo_pos
= -1;
25757 Qright_to_left
= intern_c_string ("right-to-left");
25758 staticpro (&Qright_to_left
);
25759 Qleft_to_right
= intern_c_string ("left-to-right");
25760 staticpro (&Qleft_to_right
);
25762 #ifdef HAVE_WINDOW_SYSTEM
25763 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25764 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25765 For example, if a block cursor is over a tab, it will be drawn as
25766 wide as that tab on the display. */);
25767 x_stretch_cursor_p
= 0;
25770 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25771 doc
: /* *Non-nil means highlight trailing whitespace.
25772 The face used for trailing whitespace is `trailing-whitespace'. */);
25773 Vshow_trailing_whitespace
= Qnil
;
25775 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25776 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25777 A value of t means highlight the character itself (for nobreak space,
25778 use face `nobreak-space').
25779 A value of nil means no highlighting.
25780 Other values mean display the escape glyph followed by an ordinary
25781 space or ordinary hyphen. */);
25782 Vnobreak_char_display
= Qt
;
25784 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25785 doc
: /* *The pointer shape to show in void text areas.
25786 A value of nil means to show the text pointer. Other options are `arrow',
25787 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25788 Vvoid_text_area_pointer
= Qarrow
;
25790 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25791 doc
: /* Non-nil means don't actually do any redisplay.
25792 This is used for internal purposes. */);
25793 Vinhibit_redisplay
= Qnil
;
25795 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25796 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25797 Vglobal_mode_string
= Qnil
;
25799 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25800 doc
: /* Marker for where to display an arrow on top of the buffer text.
25801 This must be the beginning of a line in order to work.
25802 See also `overlay-arrow-string'. */);
25803 Voverlay_arrow_position
= Qnil
;
25805 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25806 doc
: /* String to display as an arrow in non-window frames.
25807 See also `overlay-arrow-position'. */);
25808 Voverlay_arrow_string
= make_pure_c_string ("=>");
25810 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25811 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25812 The symbols on this list are examined during redisplay to determine
25813 where to display overlay arrows. */);
25814 Voverlay_arrow_variable_list
25815 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25817 DEFVAR_INT ("scroll-step", &scroll_step
,
25818 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25819 If that fails to bring point back on frame, point is centered instead.
25820 If this is zero, point is always centered after it moves off frame.
25821 If you want scrolling to always be a line at a time, you should set
25822 `scroll-conservatively' to a large value rather than set this to 1. */);
25824 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25825 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25826 If point moves off-screen, redisplay will scroll by up to
25827 `scroll-conservatively' lines in order to bring point just barely
25828 onto the screen again. If that cannot be done, then redisplay
25829 recenters point as usual.
25831 A value of zero means always recenter point if it moves off screen. */);
25832 scroll_conservatively
= 0;
25834 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25835 doc
: /* *Number of lines of margin at the top and bottom of a window.
25836 Recenter the window whenever point gets within this many lines
25837 of the top or bottom of the window. */);
25840 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25841 doc
: /* Pixels per inch value for non-window system displays.
25842 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25843 Vdisplay_pixels_per_inch
= make_float (72.0);
25846 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25849 DEFVAR_LISP ("truncate-partial-width-windows",
25850 &Vtruncate_partial_width_windows
,
25851 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25852 For an integer value, truncate lines in each window narrower than the
25853 full frame width, provided the window width is less than that integer;
25854 otherwise, respect the value of `truncate-lines'.
25856 For any other non-nil value, truncate lines in all windows that do
25857 not span the full frame width.
25859 A value of nil means to respect the value of `truncate-lines'.
25861 If `word-wrap' is enabled, you might want to reduce this. */);
25862 Vtruncate_partial_width_windows
= make_number (50);
25864 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25865 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25866 Any other value means to use the appropriate face, `mode-line',
25867 `header-line', or `menu' respectively. */);
25868 mode_line_inverse_video
= 1;
25870 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25871 doc
: /* *Maximum buffer size for which line number should be displayed.
25872 If the buffer is bigger than this, the line number does not appear
25873 in the mode line. A value of nil means no limit. */);
25874 Vline_number_display_limit
= Qnil
;
25876 DEFVAR_INT ("line-number-display-limit-width",
25877 &line_number_display_limit_width
,
25878 doc
: /* *Maximum line width (in characters) for line number display.
25879 If the average length of the lines near point is bigger than this, then the
25880 line number may be omitted from the mode line. */);
25881 line_number_display_limit_width
= 200;
25883 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25884 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25885 highlight_nonselected_windows
= 0;
25887 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25888 doc
: /* Non-nil if more than one frame is visible on this display.
25889 Minibuffer-only frames don't count, but iconified frames do.
25890 This variable is not guaranteed to be accurate except while processing
25891 `frame-title-format' and `icon-title-format'. */);
25893 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25894 doc
: /* Template for displaying the title bar of visible frames.
25895 \(Assuming the window manager supports this feature.)
25897 This variable has the same structure as `mode-line-format', except that
25898 the %c and %l constructs are ignored. It is used only on frames for
25899 which no explicit name has been set \(see `modify-frame-parameters'). */);
25901 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25902 doc
: /* Template for displaying the title bar of an iconified frame.
25903 \(Assuming the window manager supports this feature.)
25904 This variable has the same structure as `mode-line-format' (which see),
25905 and is used only on frames for which no explicit name has been set
25906 \(see `modify-frame-parameters'). */);
25908 = Vframe_title_format
25909 = pure_cons (intern_c_string ("multiple-frames"),
25910 pure_cons (make_pure_c_string ("%b"),
25911 pure_cons (pure_cons (empty_unibyte_string
,
25912 pure_cons (intern_c_string ("invocation-name"),
25913 pure_cons (make_pure_c_string ("@"),
25914 pure_cons (intern_c_string ("system-name"),
25918 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25919 doc
: /* Maximum number of lines to keep in the message log buffer.
25920 If nil, disable message logging. If t, log messages but don't truncate
25921 the buffer when it becomes large. */);
25922 Vmessage_log_max
= make_number (100);
25924 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25925 doc
: /* Functions called before redisplay, if window sizes have changed.
25926 The value should be a list of functions that take one argument.
25927 Just before redisplay, for each frame, if any of its windows have changed
25928 size since the last redisplay, or have been split or deleted,
25929 all the functions in the list are called, with the frame as argument. */);
25930 Vwindow_size_change_functions
= Qnil
;
25932 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25933 doc
: /* List of functions to call before redisplaying a window with scrolling.
25934 Each function is called with two arguments, the window and its new
25935 display-start position. Note that these functions are also called by
25936 `set-window-buffer'. Also note that the value of `window-end' is not
25937 valid when these functions are called. */);
25938 Vwindow_scroll_functions
= Qnil
;
25940 DEFVAR_LISP ("window-text-change-functions",
25941 &Vwindow_text_change_functions
,
25942 doc
: /* Functions to call in redisplay when text in the window might change. */);
25943 Vwindow_text_change_functions
= Qnil
;
25945 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25946 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25947 Each function is called with two arguments, the window and the end trigger value.
25948 See `set-window-redisplay-end-trigger'. */);
25949 Vredisplay_end_trigger_functions
= Qnil
;
25951 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25952 doc
: /* *Non-nil means autoselect window with mouse pointer.
25953 If nil, do not autoselect windows.
25954 A positive number means delay autoselection by that many seconds: a
25955 window is autoselected only after the mouse has remained in that
25956 window for the duration of the delay.
25957 A negative number has a similar effect, but causes windows to be
25958 autoselected only after the mouse has stopped moving. \(Because of
25959 the way Emacs compares mouse events, you will occasionally wait twice
25960 that time before the window gets selected.\)
25961 Any other value means to autoselect window instantaneously when the
25962 mouse pointer enters it.
25964 Autoselection selects the minibuffer only if it is active, and never
25965 unselects the minibuffer if it is active.
25967 When customizing this variable make sure that the actual value of
25968 `focus-follows-mouse' matches the behavior of your window manager. */);
25969 Vmouse_autoselect_window
= Qnil
;
25971 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25972 doc
: /* *Non-nil means automatically resize tool-bars.
25973 This dynamically changes the tool-bar's height to the minimum height
25974 that is needed to make all tool-bar items visible.
25975 If value is `grow-only', the tool-bar's height is only increased
25976 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25977 Vauto_resize_tool_bars
= Qt
;
25979 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25980 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25981 auto_raise_tool_bar_buttons_p
= 1;
25983 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25984 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25985 make_cursor_line_fully_visible_p
= 1;
25987 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25988 doc
: /* *Border below tool-bar in pixels.
25989 If an integer, use it as the height of the border.
25990 If it is one of `internal-border-width' or `border-width', use the
25991 value of the corresponding frame parameter.
25992 Otherwise, no border is added below the tool-bar. */);
25993 Vtool_bar_border
= Qinternal_border_width
;
25995 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25996 doc
: /* *Margin around tool-bar buttons in pixels.
25997 If an integer, use that for both horizontal and vertical margins.
25998 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25999 HORZ specifying the horizontal margin, and VERT specifying the
26000 vertical margin. */);
26001 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26003 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
26004 doc
: /* *Relief thickness of tool-bar buttons. */);
26005 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26007 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
26008 doc
: /* *Tool bar style to use.
26010 image - show images only
26011 text - show text only
26012 both - show both, text under image
26013 both-horiz - show text to the right of the image
26014 any other - use system default or image if no system default. */);
26015 Vtool_bar_style
= Qnil
;
26017 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26018 doc
: /* *Maximum number of characters a label can have to be shown.
26019 The tool bar style must also show labels for this to have any effect, see
26020 `tool-bar-style'. */);
26021 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26023 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26024 doc
: /* List of functions to call to fontify regions of text.
26025 Each function is called with one argument POS. Functions must
26026 fontify a region starting at POS in the current buffer, and give
26027 fontified regions the property `fontified'. */);
26028 Vfontification_functions
= Qnil
;
26029 Fmake_variable_buffer_local (Qfontification_functions
);
26031 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26032 &unibyte_display_via_language_environment
,
26033 doc
: /* *Non-nil means display unibyte text according to language environment.
26034 Specifically, this means that raw bytes in the range 160-255 decimal
26035 are displayed by converting them to the equivalent multibyte characters
26036 according to the current language environment. As a result, they are
26037 displayed according to the current fontset.
26039 Note that this variable affects only how these bytes are displayed,
26040 but does not change the fact they are interpreted as raw bytes. */);
26041 unibyte_display_via_language_environment
= 0;
26043 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26044 doc
: /* *Maximum height for resizing mini-windows.
26045 If a float, it specifies a fraction of the mini-window frame's height.
26046 If an integer, it specifies a number of lines. */);
26047 Vmax_mini_window_height
= make_float (0.25);
26049 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26050 doc
: /* *How to resize mini-windows.
26051 A value of nil means don't automatically resize mini-windows.
26052 A value of t means resize them to fit the text displayed in them.
26053 A value of `grow-only', the default, means let mini-windows grow
26054 only, until their display becomes empty, at which point the windows
26055 go back to their normal size. */);
26056 Vresize_mini_windows
= Qgrow_only
;
26058 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26059 doc
: /* Alist specifying how to blink the cursor off.
26060 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26061 `cursor-type' frame-parameter or variable equals ON-STATE,
26062 comparing using `equal', Emacs uses OFF-STATE to specify
26063 how to blink it off. ON-STATE and OFF-STATE are values for
26064 the `cursor-type' frame parameter.
26066 If a frame's ON-STATE has no entry in this list,
26067 the frame's other specifications determine how to blink the cursor off. */);
26068 Vblink_cursor_alist
= Qnil
;
26070 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26071 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26072 automatic_hscrolling_p
= 1;
26073 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26074 staticpro (&Qauto_hscroll_mode
);
26076 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26077 doc
: /* *How many columns away from the window edge point is allowed to get
26078 before automatic hscrolling will horizontally scroll the window. */);
26079 hscroll_margin
= 5;
26081 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26082 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26083 When point is less than `hscroll-margin' columns from the window
26084 edge, automatic hscrolling will scroll the window by the amount of columns
26085 determined by this variable. If its value is a positive integer, scroll that
26086 many columns. If it's a positive floating-point number, it specifies the
26087 fraction of the window's width to scroll. If it's nil or zero, point will be
26088 centered horizontally after the scroll. Any other value, including negative
26089 numbers, are treated as if the value were zero.
26091 Automatic hscrolling always moves point outside the scroll margin, so if
26092 point was more than scroll step columns inside the margin, the window will
26093 scroll more than the value given by the scroll step.
26095 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26096 and `scroll-right' overrides this variable's effect. */);
26097 Vhscroll_step
= make_number (0);
26099 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26100 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26101 Bind this around calls to `message' to let it take effect. */);
26102 message_truncate_lines
= 0;
26104 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26105 doc
: /* Normal hook run to update the menu bar definitions.
26106 Redisplay runs this hook before it redisplays the menu bar.
26107 This is used to update submenus such as Buffers,
26108 whose contents depend on various data. */);
26109 Vmenu_bar_update_hook
= Qnil
;
26111 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26112 doc
: /* Frame for which we are updating a menu.
26113 The enable predicate for a menu binding should check this variable. */);
26114 Vmenu_updating_frame
= Qnil
;
26116 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26117 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26118 inhibit_menubar_update
= 0;
26120 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26121 doc
: /* Prefix prepended to all continuation lines at display time.
26122 The value may be a string, an image, or a stretch-glyph; it is
26123 interpreted in the same way as the value of a `display' text property.
26125 This variable is overridden by any `wrap-prefix' text or overlay
26128 To add a prefix to non-continuation lines, use `line-prefix'. */);
26129 Vwrap_prefix
= Qnil
;
26130 staticpro (&Qwrap_prefix
);
26131 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26132 Fmake_variable_buffer_local (Qwrap_prefix
);
26134 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26135 doc
: /* Prefix prepended to all non-continuation lines at display time.
26136 The value may be a string, an image, or a stretch-glyph; it is
26137 interpreted in the same way as the value of a `display' text property.
26139 This variable is overridden by any `line-prefix' text or overlay
26142 To add a prefix to continuation lines, use `wrap-prefix'. */);
26143 Vline_prefix
= Qnil
;
26144 staticpro (&Qline_prefix
);
26145 Qline_prefix
= intern_c_string ("line-prefix");
26146 Fmake_variable_buffer_local (Qline_prefix
);
26148 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26149 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26150 inhibit_eval_during_redisplay
= 0;
26152 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26153 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26154 inhibit_free_realized_faces
= 0;
26157 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26158 doc
: /* Inhibit try_window_id display optimization. */);
26159 inhibit_try_window_id
= 0;
26161 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26162 doc
: /* Inhibit try_window_reusing display optimization. */);
26163 inhibit_try_window_reusing
= 0;
26165 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26166 doc
: /* Inhibit try_cursor_movement display optimization. */);
26167 inhibit_try_cursor_movement
= 0;
26168 #endif /* GLYPH_DEBUG */
26170 DEFVAR_INT ("overline-margin", &overline_margin
,
26171 doc
: /* *Space between overline and text, in pixels.
26172 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26173 margin to the caracter height. */);
26174 overline_margin
= 2;
26176 DEFVAR_INT ("underline-minimum-offset",
26177 &underline_minimum_offset
,
26178 doc
: /* Minimum distance between baseline and underline.
26179 This can improve legibility of underlined text at small font sizes,
26180 particularly when using variable `x-use-underline-position-properties'
26181 with fonts that specify an UNDERLINE_POSITION relatively close to the
26182 baseline. The default value is 1. */);
26183 underline_minimum_offset
= 1;
26185 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26186 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26187 display_hourglass_p
= 1;
26189 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26190 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26191 Value must be an integer or float. */);
26192 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26194 hourglass_atimer
= NULL
;
26195 hourglass_shown_p
= 0;
26199 /* Initialize this module when Emacs starts. */
26204 Lisp_Object root_window
;
26205 struct window
*mini_w
;
26207 current_header_line_height
= current_mode_line_height
= -1;
26209 CHARPOS (this_line_start_pos
) = 0;
26211 mini_w
= XWINDOW (minibuf_window
);
26212 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26214 if (!noninteractive
)
26216 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26219 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26220 set_window_height (root_window
,
26221 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26223 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26224 set_window_height (minibuf_window
, 1, 0);
26226 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26227 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26229 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26230 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26231 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26233 /* The default ellipsis glyphs `...'. */
26234 for (i
= 0; i
< 3; ++i
)
26235 default_invis_vector
[i
] = make_number ('.');
26239 /* Allocate the buffer for frame titles.
26240 Also used for `format-mode-line'. */
26242 mode_line_noprop_buf
= (char *) xmalloc (size
);
26243 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26244 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26245 mode_line_target
= MODE_LINE_DISPLAY
;
26248 help_echo_showing_p
= 0;
26251 /* Since w32 does not support atimers, it defines its own implementation of
26252 the following three functions in w32fns.c. */
26255 /* Platform-independent portion of hourglass implementation. */
26257 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26259 hourglass_started (void)
26261 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26264 /* Cancel a currently active hourglass timer, and start a new one. */
26266 start_hourglass (void)
26268 #if defined (HAVE_WINDOW_SYSTEM)
26270 int secs
, usecs
= 0;
26272 cancel_hourglass ();
26274 if (INTEGERP (Vhourglass_delay
)
26275 && XINT (Vhourglass_delay
) > 0)
26276 secs
= XFASTINT (Vhourglass_delay
);
26277 else if (FLOATP (Vhourglass_delay
)
26278 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26281 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26282 secs
= XFASTINT (tem
);
26283 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26286 secs
= DEFAULT_HOURGLASS_DELAY
;
26288 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26289 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26290 show_hourglass
, NULL
);
26295 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26298 cancel_hourglass (void)
26300 #if defined (HAVE_WINDOW_SYSTEM)
26301 if (hourglass_atimer
)
26303 cancel_atimer (hourglass_atimer
);
26304 hourglass_atimer
= NULL
;
26307 if (hourglass_shown_p
)
26311 #endif /* ! WINDOWSNT */
26313 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26314 (do not change this comment) */