1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code.
37 The following diagram shows how redisplay code is invoked. As you
38 can see, Lisp calls redisplay and vice versa. Under window systems
39 like X, some portions of the redisplay code are also called
40 asynchronously during mouse movement or expose events. It is very
41 important that these code parts do NOT use the C library (malloc,
42 free) because many C libraries under Unix are not reentrant. They
43 may also NOT call functions of the Lisp interpreter which could
44 change the interpreter's state. If you don't follow these rules,
45 you will encounter bugs which are very hard to explain.
47 +--------------+ redisplay +----------------+
48 | Lisp machine |---------------->| Redisplay code |<--+
49 +--------------+ (xdisp.c) +----------------+ |
51 +----------------------------------+ |
52 Don't use this path when called |
55 expose_window (asynchronous) |
57 X expose events -----+
59 What does redisplay do? Obviously, it has to figure out somehow what
60 has been changed since the last time the display has been updated,
61 and to make these changes visible. Preferably it would do that in
62 a moderately intelligent way, i.e. fast.
64 Changes in buffer text can be deduced from window and buffer
65 structures, and from some global variables like `beg_unchanged' and
66 `end_unchanged'. The contents of the display are additionally
67 recorded in a `glyph matrix', a two-dimensional matrix of glyph
68 structures. Each row in such a matrix corresponds to a line on the
69 display, and each glyph in a row corresponds to a column displaying
70 a character, an image, or what else. This matrix is called the
71 `current glyph matrix' or `current matrix' in redisplay
74 For buffer parts that have been changed since the last update, a
75 second glyph matrix is constructed, the so called `desired glyph
76 matrix' or short `desired matrix'. Current and desired matrix are
77 then compared to find a cheap way to update the display, e.g. by
78 reusing part of the display by scrolling lines.
80 You will find a lot of redisplay optimizations when you start
81 looking at the innards of redisplay. The overall goal of all these
82 optimizations is to make redisplay fast because it is done
83 frequently. Some of these optimizations are implemented by the
88 This function tries to update the display if the text in the
89 window did not change and did not scroll, only point moved, and
90 it did not move off the displayed portion of the text.
92 . try_window_reusing_current_matrix
94 This function reuses the current matrix of a window when text
95 has not changed, but the window start changed (e.g., due to
100 This function attempts to redisplay a window by reusing parts of
101 its existing display. It finds and reuses the part that was not
102 changed, and redraws the rest.
106 This function performs the full redisplay of a single window
107 assuming that its fonts were not changed and that the cursor
108 will not end up in the scroll margins. (Loading fonts requires
109 re-adjustment of dimensions of glyph matrices, which makes this
110 method impossible to use.)
112 These optimizations are tried in sequence (some can be skipped if
113 it is known that they are not applicable). If none of the
114 optimizations were successful, redisplay calls redisplay_windows,
115 which performs a full redisplay of all windows.
119 Desired matrices are always built per Emacs window. The function
120 `display_line' is the central function to look at if you are
121 interested. It constructs one row in a desired matrix given an
122 iterator structure containing both a buffer position and a
123 description of the environment in which the text is to be
124 displayed. But this is too early, read on.
126 Characters and pixmaps displayed for a range of buffer text depend
127 on various settings of buffers and windows, on overlays and text
128 properties, on display tables, on selective display. The good news
129 is that all this hairy stuff is hidden behind a small set of
130 interface functions taking an iterator structure (struct it)
133 Iteration over things to be displayed is then simple. It is
134 started by initializing an iterator with a call to init_iterator.
135 Calls to get_next_display_element fill the iterator structure with
136 relevant information about the next thing to display. Calls to
137 set_iterator_to_next move the iterator to the next thing.
139 Besides this, an iterator also contains information about the
140 display environment in which glyphs for display elements are to be
141 produced. It has fields for the width and height of the display,
142 the information whether long lines are truncated or continued, a
143 current X and Y position, and lots of other stuff you can better
146 Glyphs in a desired matrix are normally constructed in a loop
147 calling get_next_display_element and then PRODUCE_GLYPHS. The call
148 to PRODUCE_GLYPHS will fill the iterator structure with pixel
149 information about the element being displayed and at the same time
150 produce glyphs for it. If the display element fits on the line
151 being displayed, set_iterator_to_next is called next, otherwise the
152 glyphs produced are discarded. The function display_line is the
153 workhorse of filling glyph rows in the desired matrix with glyphs.
154 In addition to producing glyphs, it also handles line truncation
155 and continuation, word wrap, and cursor positioning (for the
156 latter, see also set_cursor_from_row).
160 That just couldn't be all, could it? What about terminal types not
161 supporting operations on sub-windows of the screen? To update the
162 display on such a terminal, window-based glyph matrices are not
163 well suited. To be able to reuse part of the display (scrolling
164 lines up and down), we must instead have a view of the whole
165 screen. This is what `frame matrices' are for. They are a trick.
167 Frames on terminals like above have a glyph pool. Windows on such
168 a frame sub-allocate their glyph memory from their frame's glyph
169 pool. The frame itself is given its own glyph matrices. By
170 coincidence---or maybe something else---rows in window glyph
171 matrices are slices of corresponding rows in frame matrices. Thus
172 writing to window matrices implicitly updates a frame matrix which
173 provides us with the view of the whole screen that we originally
174 wanted to have without having to move many bytes around. To be
175 honest, there is a little bit more done, but not much more. If you
176 plan to extend that code, take a look at dispnew.c. The function
177 build_frame_matrix is a good starting point.
179 Bidirectional display.
181 Bidirectional display adds quite some hair to this already complex
182 design. The good news are that a large portion of that hairy stuff
183 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
184 reordering engine which is called by set_iterator_to_next and
185 returns the next character to display in the visual order. See
186 commentary on bidi.c for more details. As far as redisplay is
187 concerned, the effect of calling bidi_get_next_char_visually, the
188 main interface of the reordering engine, is that the iterator gets
189 magically placed on the buffer or string position that is to be
190 displayed next. In other words, a linear iteration through the
191 buffer/string is replaced with a non-linear one. All the rest of
192 the redisplay is oblivious to the bidi reordering.
194 Well, almost oblivious---there are still complications, most of
195 them due to the fact that buffer and string positions no longer
196 change monotonously with glyph indices in a glyph row. Moreover,
197 for continued lines, the buffer positions may not even be
198 monotonously changing with vertical positions. Also, accounting
199 for face changes, overlays, etc. becomes more complex because
200 non-linear iteration could potentially skip many positions with
201 changes, and then cross them again on the way back...
203 One other prominent effect of bidirectional display is that some
204 paragraphs of text need to be displayed starting at the right
205 margin of the window---the so-called right-to-left, or R2L
206 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
207 which have their reversed_p flag set. The bidi reordering engine
208 produces characters in such rows starting from the character which
209 should be the rightmost on display. PRODUCE_GLYPHS then reverses
210 the order, when it fills up the glyph row whose reversed_p flag is
211 set, by prepending each new glyph to what is already there, instead
212 of appending it. When the glyph row is complete, the function
213 extend_face_to_end_of_line fills the empty space to the left of the
214 leftmost character with special glyphs, which will display as,
215 well, empty. On text terminals, these special glyphs are simply
216 blank characters. On graphics terminals, there's a single stretch
217 glyph with suitably computed width. Both the blanks and the
218 stretch glyph are given the face of the background of the line.
219 This way, the terminal-specific back-end can still draw the glyphs
220 left to right, even for R2L lines. */
228 #include "keyboard.h"
231 #include "termchar.h"
232 #include "dispextern.h"
234 #include "character.h"
237 #include "commands.h"
241 #include "termhooks.h"
242 #include "intervals.h"
245 #include "region-cache.h"
248 #include "blockinput.h"
250 #ifdef HAVE_X_WINDOWS
265 #ifndef FRAME_X_OUTPUT
266 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
269 #define INFINITY 10000000
271 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
272 || defined(HAVE_NS) || defined (USE_GTK)
273 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
274 extern int pending_menu_activation
;
277 extern int interrupt_input
;
278 extern int command_loop_level
;
280 extern Lisp_Object do_mouse_tracking
;
282 extern int minibuffer_auto_raise
;
283 extern Lisp_Object Vminibuffer_list
;
285 extern Lisp_Object Qface
;
286 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
288 extern Lisp_Object Voverriding_local_map
;
289 extern Lisp_Object Voverriding_local_map_menu_flag
;
290 extern Lisp_Object Qmenu_item
;
291 extern Lisp_Object Qwhen
;
292 extern Lisp_Object Qhelp_echo
;
293 extern Lisp_Object Qbefore_string
, Qafter_string
;
295 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
296 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
297 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
298 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
299 Lisp_Object Qinhibit_point_motion_hooks
;
300 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
301 Lisp_Object Qfontified
;
302 Lisp_Object Qgrow_only
;
303 Lisp_Object Qinhibit_eval_during_redisplay
;
304 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
305 Lisp_Object Qright_to_left
, Qleft_to_right
;
308 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
311 Lisp_Object Qarrow
, Qhand
, Qtext
;
313 Lisp_Object Qrisky_local_variable
;
315 /* Holds the list (error). */
316 Lisp_Object list_of_error
;
318 /* Functions called to fontify regions of text. */
320 Lisp_Object Vfontification_functions
;
321 Lisp_Object Qfontification_functions
;
323 /* Non-nil means automatically select any window when the mouse
324 cursor moves into it. */
325 Lisp_Object Vmouse_autoselect_window
;
327 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
328 Lisp_Object Vline_prefix
, Qline_prefix
;
330 /* Non-zero means draw tool bar buttons raised when the mouse moves
333 int auto_raise_tool_bar_buttons_p
;
335 /* Non-zero means to reposition window if cursor line is only partially visible. */
337 int make_cursor_line_fully_visible_p
;
339 /* Margin below tool bar in pixels. 0 or nil means no margin.
340 If value is `internal-border-width' or `border-width',
341 the corresponding frame parameter is used. */
343 Lisp_Object Vtool_bar_border
;
345 /* Margin around tool bar buttons in pixels. */
347 Lisp_Object Vtool_bar_button_margin
;
349 /* Thickness of shadow to draw around tool bar buttons. */
351 EMACS_INT tool_bar_button_relief
;
353 /* Non-nil means automatically resize tool-bars so that all tool-bar
354 items are visible, and no blank lines remain.
356 If value is `grow-only', only make tool-bar bigger. */
358 Lisp_Object Vauto_resize_tool_bars
;
360 /* Type of tool bar. Can be symbols image, text, both or both-hroiz. */
362 Lisp_Object Vtool_bar_style
;
364 /* Maximum number of characters a label can have to be shown. */
366 EMACS_INT tool_bar_max_label_size
;
368 /* Non-zero means draw block and hollow cursor as wide as the glyph
369 under it. For example, if a block cursor is over a tab, it will be
370 drawn as wide as that tab on the display. */
372 int x_stretch_cursor_p
;
374 /* Non-nil means don't actually do any redisplay. */
376 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
378 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
380 int inhibit_eval_during_redisplay
;
382 /* Names of text properties relevant for redisplay. */
384 Lisp_Object Qdisplay
;
385 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
387 /* Symbols used in text property values. */
389 Lisp_Object Vdisplay_pixels_per_inch
;
390 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
391 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
394 Lisp_Object Qmargin
, Qpointer
;
395 Lisp_Object Qline_height
;
396 extern Lisp_Object Qheight
;
397 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
398 extern Lisp_Object Qscroll_bar
;
399 extern Lisp_Object Qcursor
;
401 /* Non-nil means highlight trailing whitespace. */
403 Lisp_Object Vshow_trailing_whitespace
;
405 /* Non-nil means escape non-break space and hyphens. */
407 Lisp_Object Vnobreak_char_display
;
409 #ifdef HAVE_WINDOW_SYSTEM
410 extern Lisp_Object Voverflow_newline_into_fringe
;
412 /* Test if overflow newline into fringe. Called with iterator IT
413 at or past right window margin, and with IT->current_x set. */
415 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
416 (!NILP (Voverflow_newline_into_fringe) \
417 && FRAME_WINDOW_P ((IT)->f) \
418 && ((IT)->bidi_it.paragraph_dir == R2L \
419 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
420 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
421 && (IT)->current_x == (IT)->last_visible_x \
422 && (IT)->line_wrap != WORD_WRAP)
424 #else /* !HAVE_WINDOW_SYSTEM */
425 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
426 #endif /* HAVE_WINDOW_SYSTEM */
428 /* Test if the display element loaded in IT is a space or tab
429 character. This is used to determine word wrapping. */
431 #define IT_DISPLAYING_WHITESPACE(it) \
432 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
434 /* Non-nil means show the text cursor in void text areas
435 i.e. in blank areas after eol and eob. This used to be
436 the default in 21.3. */
438 Lisp_Object Vvoid_text_area_pointer
;
440 /* Name of the face used to highlight trailing whitespace. */
442 Lisp_Object Qtrailing_whitespace
;
444 /* Name and number of the face used to highlight escape glyphs. */
446 Lisp_Object Qescape_glyph
;
448 /* Name and number of the face used to highlight non-breaking spaces. */
450 Lisp_Object Qnobreak_space
;
452 /* The symbol `image' which is the car of the lists used to represent
453 images in Lisp. Also a tool bar style. */
457 /* The image map types. */
458 Lisp_Object QCmap
, QCpointer
;
459 Lisp_Object Qrect
, Qcircle
, Qpoly
;
461 /* Tool bar styles */
462 Lisp_Object Qtext
, Qboth
, Qboth_horiz
;
464 /* Non-zero means print newline to stdout before next mini-buffer
467 int noninteractive_need_newline
;
469 /* Non-zero means print newline to message log before next message. */
471 static int message_log_need_newline
;
473 /* Three markers that message_dolog uses.
474 It could allocate them itself, but that causes trouble
475 in handling memory-full errors. */
476 static Lisp_Object message_dolog_marker1
;
477 static Lisp_Object message_dolog_marker2
;
478 static Lisp_Object message_dolog_marker3
;
480 /* The buffer position of the first character appearing entirely or
481 partially on the line of the selected window which contains the
482 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
483 redisplay optimization in redisplay_internal. */
485 static struct text_pos this_line_start_pos
;
487 /* Number of characters past the end of the line above, including the
488 terminating newline. */
490 static struct text_pos this_line_end_pos
;
492 /* The vertical positions and the height of this line. */
494 static int this_line_vpos
;
495 static int this_line_y
;
496 static int this_line_pixel_height
;
498 /* X position at which this display line starts. Usually zero;
499 negative if first character is partially visible. */
501 static int this_line_start_x
;
503 /* Buffer that this_line_.* variables are referring to. */
505 static struct buffer
*this_line_buffer
;
507 /* Nonzero means truncate lines in all windows less wide than the
510 Lisp_Object Vtruncate_partial_width_windows
;
512 /* A flag to control how to display unibyte 8-bit character. */
514 int unibyte_display_via_language_environment
;
516 /* Nonzero means we have more than one non-mini-buffer-only frame.
517 Not guaranteed to be accurate except while parsing
518 frame-title-format. */
522 Lisp_Object Vglobal_mode_string
;
525 /* List of variables (symbols) which hold markers for overlay arrows.
526 The symbols on this list are examined during redisplay to determine
527 where to display overlay arrows. */
529 Lisp_Object Voverlay_arrow_variable_list
;
531 /* Marker for where to display an arrow on top of the buffer text. */
533 Lisp_Object Voverlay_arrow_position
;
535 /* String to display for the arrow. Only used on terminal frames. */
537 Lisp_Object Voverlay_arrow_string
;
539 /* Values of those variables at last redisplay are stored as
540 properties on `overlay-arrow-position' symbol. However, if
541 Voverlay_arrow_position is a marker, last-arrow-position is its
542 numerical position. */
544 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
546 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
547 properties on a symbol in overlay-arrow-variable-list. */
549 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
551 /* Like mode-line-format, but for the title bar on a visible frame. */
553 Lisp_Object Vframe_title_format
;
555 /* Like mode-line-format, but for the title bar on an iconified frame. */
557 Lisp_Object Vicon_title_format
;
559 /* List of functions to call when a window's size changes. These
560 functions get one arg, a frame on which one or more windows' sizes
563 static Lisp_Object Vwindow_size_change_functions
;
565 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
567 /* Nonzero if an overlay arrow has been displayed in this window. */
569 static int overlay_arrow_seen
;
571 /* Nonzero means highlight the region even in nonselected windows. */
573 int highlight_nonselected_windows
;
575 /* If cursor motion alone moves point off frame, try scrolling this
576 many lines up or down if that will bring it back. */
578 static EMACS_INT scroll_step
;
580 /* Nonzero means scroll just far enough to bring point back on the
581 screen, when appropriate. */
583 static EMACS_INT scroll_conservatively
;
585 /* Recenter the window whenever point gets within this many lines of
586 the top or bottom of the window. This value is translated into a
587 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
588 that there is really a fixed pixel height scroll margin. */
590 EMACS_INT scroll_margin
;
592 /* Number of windows showing the buffer of the selected window (or
593 another buffer with the same base buffer). keyboard.c refers to
598 /* Vector containing glyphs for an ellipsis `...'. */
600 static Lisp_Object default_invis_vector
[3];
602 /* Zero means display the mode-line/header-line/menu-bar in the default face
603 (this slightly odd definition is for compatibility with previous versions
604 of emacs), non-zero means display them using their respective faces.
606 This variable is deprecated. */
608 int mode_line_inverse_video
;
610 /* Prompt to display in front of the mini-buffer contents. */
612 Lisp_Object minibuf_prompt
;
614 /* Width of current mini-buffer prompt. Only set after display_line
615 of the line that contains the prompt. */
617 int minibuf_prompt_width
;
619 /* This is the window where the echo area message was displayed. It
620 is always a mini-buffer window, but it may not be the same window
621 currently active as a mini-buffer. */
623 Lisp_Object echo_area_window
;
625 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
626 pushes the current message and the value of
627 message_enable_multibyte on the stack, the function restore_message
628 pops the stack and displays MESSAGE again. */
630 Lisp_Object Vmessage_stack
;
632 /* Nonzero means multibyte characters were enabled when the echo area
633 message was specified. */
635 int message_enable_multibyte
;
637 /* Nonzero if we should redraw the mode lines on the next redisplay. */
639 int update_mode_lines
;
641 /* Nonzero if window sizes or contents have changed since last
642 redisplay that finished. */
644 int windows_or_buffers_changed
;
646 /* Nonzero means a frame's cursor type has been changed. */
648 int cursor_type_changed
;
650 /* Nonzero after display_mode_line if %l was used and it displayed a
653 int line_number_displayed
;
655 /* Maximum buffer size for which to display line numbers. */
657 Lisp_Object Vline_number_display_limit
;
659 /* Line width to consider when repositioning for line number display. */
661 static EMACS_INT line_number_display_limit_width
;
663 /* Number of lines to keep in the message log buffer. t means
664 infinite. nil means don't log at all. */
666 Lisp_Object Vmessage_log_max
;
668 /* The name of the *Messages* buffer, a string. */
670 static Lisp_Object Vmessages_buffer_name
;
672 /* Current, index 0, and last displayed echo area message. Either
673 buffers from echo_buffers, or nil to indicate no message. */
675 Lisp_Object echo_area_buffer
[2];
677 /* The buffers referenced from echo_area_buffer. */
679 static Lisp_Object echo_buffer
[2];
681 /* A vector saved used in with_area_buffer to reduce consing. */
683 static Lisp_Object Vwith_echo_area_save_vector
;
685 /* Non-zero means display_echo_area should display the last echo area
686 message again. Set by redisplay_preserve_echo_area. */
688 static int display_last_displayed_message_p
;
690 /* Nonzero if echo area is being used by print; zero if being used by
693 int message_buf_print
;
695 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
697 Lisp_Object Qinhibit_menubar_update
;
698 int inhibit_menubar_update
;
700 /* When evaluating expressions from menu bar items (enable conditions,
701 for instance), this is the frame they are being processed for. */
703 Lisp_Object Vmenu_updating_frame
;
705 /* Maximum height for resizing mini-windows. Either a float
706 specifying a fraction of the available height, or an integer
707 specifying a number of lines. */
709 Lisp_Object Vmax_mini_window_height
;
711 /* Non-zero means messages should be displayed with truncated
712 lines instead of being continued. */
714 int message_truncate_lines
;
715 Lisp_Object Qmessage_truncate_lines
;
717 /* Set to 1 in clear_message to make redisplay_internal aware
718 of an emptied echo area. */
720 static int message_cleared_p
;
722 /* How to blink the default frame cursor off. */
723 Lisp_Object Vblink_cursor_alist
;
725 /* A scratch glyph row with contents used for generating truncation
726 glyphs. Also used in direct_output_for_insert. */
728 #define MAX_SCRATCH_GLYPHS 100
729 struct glyph_row scratch_glyph_row
;
730 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
732 /* Ascent and height of the last line processed by move_it_to. */
734 static int last_max_ascent
, last_height
;
736 /* Non-zero if there's a help-echo in the echo area. */
738 int help_echo_showing_p
;
740 /* If >= 0, computed, exact values of mode-line and header-line height
741 to use in the macros CURRENT_MODE_LINE_HEIGHT and
742 CURRENT_HEADER_LINE_HEIGHT. */
744 int current_mode_line_height
, current_header_line_height
;
746 /* The maximum distance to look ahead for text properties. Values
747 that are too small let us call compute_char_face and similar
748 functions too often which is expensive. Values that are too large
749 let us call compute_char_face and alike too often because we
750 might not be interested in text properties that far away. */
752 #define TEXT_PROP_DISTANCE_LIMIT 100
756 /* Variables to turn off display optimizations from Lisp. */
758 int inhibit_try_window_id
, inhibit_try_window_reusing
;
759 int inhibit_try_cursor_movement
;
761 /* Non-zero means print traces of redisplay if compiled with
764 int trace_redisplay_p
;
766 #endif /* GLYPH_DEBUG */
768 #ifdef DEBUG_TRACE_MOVE
769 /* Non-zero means trace with TRACE_MOVE to stderr. */
772 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
774 #define TRACE_MOVE(x) (void) 0
777 /* Non-zero means automatically scroll windows horizontally to make
780 int automatic_hscrolling_p
;
781 Lisp_Object Qauto_hscroll_mode
;
783 /* How close to the margin can point get before the window is scrolled
785 EMACS_INT hscroll_margin
;
787 /* How much to scroll horizontally when point is inside the above margin. */
788 Lisp_Object Vhscroll_step
;
790 /* The variable `resize-mini-windows'. If nil, don't resize
791 mini-windows. If t, always resize them to fit the text they
792 display. If `grow-only', let mini-windows grow only until they
795 Lisp_Object Vresize_mini_windows
;
797 /* Buffer being redisplayed -- for redisplay_window_error. */
799 struct buffer
*displayed_buffer
;
801 /* Space between overline and text. */
803 EMACS_INT overline_margin
;
805 /* Require underline to be at least this many screen pixels below baseline
806 This to avoid underline "merging" with the base of letters at small
807 font sizes, particularly when x_use_underline_position_properties is on. */
809 EMACS_INT underline_minimum_offset
;
811 /* Value returned from text property handlers (see below). */
816 HANDLED_RECOMPUTE_PROPS
,
817 HANDLED_OVERLAY_STRING_CONSUMED
,
821 /* A description of text properties that redisplay is interested
826 /* The name of the property. */
829 /* A unique index for the property. */
832 /* A handler function called to set up iterator IT from the property
833 at IT's current position. Value is used to steer handle_stop. */
834 enum prop_handled (*handler
) P_ ((struct it
*it
));
837 static enum prop_handled handle_face_prop
P_ ((struct it
*));
838 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
839 static enum prop_handled handle_display_prop
P_ ((struct it
*));
840 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
841 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
842 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
844 /* Properties handled by iterators. */
846 static struct props it_props
[] =
848 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
849 /* Handle `face' before `display' because some sub-properties of
850 `display' need to know the face. */
851 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
852 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
853 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
854 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
858 /* Value is the position described by X. If X is a marker, value is
859 the marker_position of X. Otherwise, value is X. */
861 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
863 /* Enumeration returned by some move_it_.* functions internally. */
867 /* Not used. Undefined value. */
870 /* Move ended at the requested buffer position or ZV. */
871 MOVE_POS_MATCH_OR_ZV
,
873 /* Move ended at the requested X pixel position. */
876 /* Move within a line ended at the end of a line that must be
880 /* Move within a line ended at the end of a line that would
881 be displayed truncated. */
884 /* Move within a line ended at a line end. */
888 /* This counter is used to clear the face cache every once in a while
889 in redisplay_internal. It is incremented for each redisplay.
890 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
893 #define CLEAR_FACE_CACHE_COUNT 500
894 static int clear_face_cache_count
;
896 /* Similarly for the image cache. */
898 #ifdef HAVE_WINDOW_SYSTEM
899 #define CLEAR_IMAGE_CACHE_COUNT 101
900 static int clear_image_cache_count
;
903 /* Non-zero while redisplay_internal is in progress. */
907 /* Non-zero means don't free realized faces. Bound while freeing
908 realized faces is dangerous because glyph matrices might still
911 int inhibit_free_realized_faces
;
912 Lisp_Object Qinhibit_free_realized_faces
;
914 /* If a string, XTread_socket generates an event to display that string.
915 (The display is done in read_char.) */
917 Lisp_Object help_echo_string
;
918 Lisp_Object help_echo_window
;
919 Lisp_Object help_echo_object
;
922 /* Temporary variable for XTread_socket. */
924 Lisp_Object previous_help_echo_string
;
926 /* Null glyph slice */
928 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
930 /* Platform-independent portion of hourglass implementation. */
932 /* Non-zero means we're allowed to display a hourglass pointer. */
933 int display_hourglass_p
;
935 /* Non-zero means an hourglass cursor is currently shown. */
936 int hourglass_shown_p
;
938 /* If non-null, an asynchronous timer that, when it expires, displays
939 an hourglass cursor on all frames. */
940 struct atimer
*hourglass_atimer
;
942 /* Number of seconds to wait before displaying an hourglass cursor. */
943 Lisp_Object Vhourglass_delay
;
945 /* Default number of seconds to wait before displaying an hourglass
947 #define DEFAULT_HOURGLASS_DELAY 1
950 /* Function prototypes. */
952 static void setup_for_ellipsis
P_ ((struct it
*, int));
953 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
954 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
955 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
956 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
957 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
958 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
960 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
962 static void handle_line_prefix
P_ ((struct it
*));
964 static void pint2str
P_ ((char *, int, int));
965 static void pint2hrstr
P_ ((char *, int, int));
966 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
968 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
969 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
970 static void store_mode_line_noprop_char
P_ ((char));
971 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
972 static void x_consider_frame_title
P_ ((Lisp_Object
));
973 static void handle_stop
P_ ((struct it
*));
974 static void handle_stop_backwards
P_ ((struct it
*, EMACS_INT
));
975 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
976 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
977 static void ensure_echo_area_buffers
P_ ((void));
978 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
979 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
980 static int with_echo_area_buffer
P_ ((struct window
*, int,
981 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
982 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
983 static void clear_garbaged_frames
P_ ((void));
984 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
985 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
986 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
987 static int display_echo_area
P_ ((struct window
*));
988 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
989 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
990 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
991 static int string_char_and_length
P_ ((const unsigned char *, int *));
992 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
994 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
995 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
996 static void insert_left_trunc_glyphs
P_ ((struct it
*));
997 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
999 static void extend_face_to_end_of_line
P_ ((struct it
*));
1000 static int append_space_for_newline
P_ ((struct it
*, int));
1001 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
1002 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
1003 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
1004 static int trailing_whitespace_p
P_ ((int));
1005 static int message_log_check_duplicate
P_ ((int, int, int, int));
1006 static void push_it
P_ ((struct it
*));
1007 static void pop_it
P_ ((struct it
*));
1008 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
1009 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
1010 static void redisplay_internal
P_ ((int));
1011 static int echo_area_display
P_ ((int));
1012 static void redisplay_windows
P_ ((Lisp_Object
));
1013 static void redisplay_window
P_ ((Lisp_Object
, int));
1014 static Lisp_Object
redisplay_window_error ();
1015 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
1016 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
1017 static int update_menu_bar
P_ ((struct frame
*, int, int));
1018 static int try_window_reusing_current_matrix
P_ ((struct window
*));
1019 static int try_window_id
P_ ((struct window
*));
1020 static int display_line
P_ ((struct it
*));
1021 static int display_mode_lines
P_ ((struct window
*));
1022 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
1023 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
1024 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
1025 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
1027 static void display_menu_bar
P_ ((struct window
*));
1028 static int display_count_lines
P_ ((int, int, int, int, int *));
1029 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
1030 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
1031 static void compute_line_metrics
P_ ((struct it
*));
1032 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
1033 static int get_overlay_strings
P_ ((struct it
*, int));
1034 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
1035 static void next_overlay_string
P_ ((struct it
*));
1036 static void reseat
P_ ((struct it
*, struct text_pos
, int));
1037 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
1038 static void back_to_previous_visible_line_start
P_ ((struct it
*));
1039 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
1040 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
1041 static int next_element_from_ellipsis
P_ ((struct it
*));
1042 static int next_element_from_display_vector
P_ ((struct it
*));
1043 static int next_element_from_string
P_ ((struct it
*));
1044 static int next_element_from_c_string
P_ ((struct it
*));
1045 static int next_element_from_buffer
P_ ((struct it
*));
1046 static int next_element_from_composition
P_ ((struct it
*));
1047 static int next_element_from_image
P_ ((struct it
*));
1048 static int next_element_from_stretch
P_ ((struct it
*));
1049 static void load_overlay_strings
P_ ((struct it
*, int));
1050 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
1051 struct display_pos
*));
1052 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
1053 Lisp_Object
, int, int, int, int));
1054 static enum move_it_result
1055 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
1056 enum move_operation_enum
);
1057 void move_it_vertically_backward
P_ ((struct it
*, int));
1058 static void init_to_row_start
P_ ((struct it
*, struct window
*,
1059 struct glyph_row
*));
1060 static int init_to_row_end
P_ ((struct it
*, struct window
*,
1061 struct glyph_row
*));
1062 static void back_to_previous_line_start
P_ ((struct it
*));
1063 static int forward_to_next_line_start
P_ ((struct it
*, int *));
1064 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
1066 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
1067 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
1068 static int number_of_chars
P_ ((unsigned char *, int));
1069 static void compute_stop_pos
P_ ((struct it
*));
1070 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1072 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1073 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1074 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1075 Lisp_Object
, Lisp_Object
,
1076 struct text_pos
*, int));
1077 static int underlying_face_id
P_ ((struct it
*));
1078 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1081 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1082 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1084 #ifdef HAVE_WINDOW_SYSTEM
1086 static void update_tool_bar
P_ ((struct frame
*, int));
1087 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1088 static int redisplay_tool_bar
P_ ((struct frame
*));
1089 static void display_tool_bar_line
P_ ((struct it
*, int));
1090 static void notice_overwritten_cursor
P_ ((struct window
*,
1091 enum glyph_row_area
,
1092 int, int, int, int));
1093 static void append_stretch_glyph
P_ ((struct it
*, Lisp_Object
,
1098 #endif /* HAVE_WINDOW_SYSTEM */
1101 /***********************************************************************
1102 Window display dimensions
1103 ***********************************************************************/
1105 /* Return the bottom boundary y-position for text lines in window W.
1106 This is the first y position at which a line cannot start.
1107 It is relative to the top of the window.
1109 This is the height of W minus the height of a mode line, if any. */
1112 window_text_bottom_y (w
)
1115 int height
= WINDOW_TOTAL_HEIGHT (w
);
1117 if (WINDOW_WANTS_MODELINE_P (w
))
1118 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1122 /* Return the pixel width of display area AREA of window W. AREA < 0
1123 means return the total width of W, not including fringes to
1124 the left and right of the window. */
1127 window_box_width (w
, area
)
1131 int cols
= XFASTINT (w
->total_cols
);
1134 if (!w
->pseudo_window_p
)
1136 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1138 if (area
== TEXT_AREA
)
1140 if (INTEGERP (w
->left_margin_cols
))
1141 cols
-= XFASTINT (w
->left_margin_cols
);
1142 if (INTEGERP (w
->right_margin_cols
))
1143 cols
-= XFASTINT (w
->right_margin_cols
);
1144 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1146 else if (area
== LEFT_MARGIN_AREA
)
1148 cols
= (INTEGERP (w
->left_margin_cols
)
1149 ? XFASTINT (w
->left_margin_cols
) : 0);
1152 else if (area
== RIGHT_MARGIN_AREA
)
1154 cols
= (INTEGERP (w
->right_margin_cols
)
1155 ? XFASTINT (w
->right_margin_cols
) : 0);
1160 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1164 /* Return the pixel height of the display area of window W, not
1165 including mode lines of W, if any. */
1168 window_box_height (w
)
1171 struct frame
*f
= XFRAME (w
->frame
);
1172 int height
= WINDOW_TOTAL_HEIGHT (w
);
1174 xassert (height
>= 0);
1176 /* Note: the code below that determines the mode-line/header-line
1177 height is essentially the same as that contained in the macro
1178 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1179 the appropriate glyph row has its `mode_line_p' flag set,
1180 and if it doesn't, uses estimate_mode_line_height instead. */
1182 if (WINDOW_WANTS_MODELINE_P (w
))
1184 struct glyph_row
*ml_row
1185 = (w
->current_matrix
&& w
->current_matrix
->rows
1186 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1188 if (ml_row
&& ml_row
->mode_line_p
)
1189 height
-= ml_row
->height
;
1191 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1194 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1196 struct glyph_row
*hl_row
1197 = (w
->current_matrix
&& w
->current_matrix
->rows
1198 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1200 if (hl_row
&& hl_row
->mode_line_p
)
1201 height
-= hl_row
->height
;
1203 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1206 /* With a very small font and a mode-line that's taller than
1207 default, we might end up with a negative height. */
1208 return max (0, height
);
1211 /* Return the window-relative coordinate of the left edge of display
1212 area AREA of window W. AREA < 0 means return the left edge of the
1213 whole window, to the right of the left fringe of W. */
1216 window_box_left_offset (w
, area
)
1222 if (w
->pseudo_window_p
)
1225 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1227 if (area
== TEXT_AREA
)
1228 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1229 + window_box_width (w
, LEFT_MARGIN_AREA
));
1230 else if (area
== RIGHT_MARGIN_AREA
)
1231 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1232 + window_box_width (w
, LEFT_MARGIN_AREA
)
1233 + window_box_width (w
, TEXT_AREA
)
1234 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1236 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1237 else if (area
== LEFT_MARGIN_AREA
1238 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1239 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1245 /* Return the window-relative coordinate of the right edge of display
1246 area AREA of window W. AREA < 0 means return the left edge of the
1247 whole window, to the left of the right fringe of W. */
1250 window_box_right_offset (w
, area
)
1254 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1257 /* Return the frame-relative coordinate of the left edge of display
1258 area AREA of window W. AREA < 0 means return the left edge of the
1259 whole window, to the right of the left fringe of W. */
1262 window_box_left (w
, area
)
1266 struct frame
*f
= XFRAME (w
->frame
);
1269 if (w
->pseudo_window_p
)
1270 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1272 x
= (WINDOW_LEFT_EDGE_X (w
)
1273 + window_box_left_offset (w
, area
));
1279 /* Return the frame-relative coordinate of the right edge of display
1280 area AREA of window W. AREA < 0 means return the left edge of the
1281 whole window, to the left of the right fringe of W. */
1284 window_box_right (w
, area
)
1288 return window_box_left (w
, area
) + window_box_width (w
, area
);
1291 /* Get the bounding box of the display area AREA of window W, without
1292 mode lines, in frame-relative coordinates. AREA < 0 means the
1293 whole window, not including the left and right fringes of
1294 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1295 coordinates of the upper-left corner of the box. Return in
1296 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1299 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1302 int *box_x
, *box_y
, *box_width
, *box_height
;
1305 *box_width
= window_box_width (w
, area
);
1307 *box_height
= window_box_height (w
);
1309 *box_x
= window_box_left (w
, area
);
1312 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1313 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1314 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1319 /* Get the bounding box of the display area AREA of window W, without
1320 mode lines. AREA < 0 means the whole window, not including the
1321 left and right fringe of the window. Return in *TOP_LEFT_X
1322 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1323 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1324 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1328 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1329 bottom_right_x
, bottom_right_y
)
1332 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1334 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1336 *bottom_right_x
+= *top_left_x
;
1337 *bottom_right_y
+= *top_left_y
;
1342 /***********************************************************************
1344 ***********************************************************************/
1346 /* Return the bottom y-position of the line the iterator IT is in.
1347 This can modify IT's settings. */
1353 int line_height
= it
->max_ascent
+ it
->max_descent
;
1354 int line_top_y
= it
->current_y
;
1356 if (line_height
== 0)
1359 line_height
= last_height
;
1360 else if (IT_CHARPOS (*it
) < ZV
)
1362 move_it_by_lines (it
, 1, 1);
1363 line_height
= (it
->max_ascent
|| it
->max_descent
1364 ? it
->max_ascent
+ it
->max_descent
1369 struct glyph_row
*row
= it
->glyph_row
;
1371 /* Use the default character height. */
1372 it
->glyph_row
= NULL
;
1373 it
->what
= IT_CHARACTER
;
1376 PRODUCE_GLYPHS (it
);
1377 line_height
= it
->ascent
+ it
->descent
;
1378 it
->glyph_row
= row
;
1382 return line_top_y
+ line_height
;
1386 /* Return 1 if position CHARPOS is visible in window W.
1387 CHARPOS < 0 means return info about WINDOW_END position.
1388 If visible, set *X and *Y to pixel coordinates of top left corner.
1389 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1390 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1393 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1395 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1398 struct text_pos top
;
1400 struct buffer
*old_buffer
= NULL
;
1402 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1405 if (XBUFFER (w
->buffer
) != current_buffer
)
1407 old_buffer
= current_buffer
;
1408 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1411 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1413 /* Compute exact mode line heights. */
1414 if (WINDOW_WANTS_MODELINE_P (w
))
1415 current_mode_line_height
1416 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1417 current_buffer
->mode_line_format
);
1419 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1420 current_header_line_height
1421 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1422 current_buffer
->header_line_format
);
1424 start_display (&it
, w
, top
);
1425 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1426 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1428 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1430 /* We have reached CHARPOS, or passed it. How the call to
1431 move_it_to can overshoot: (i) If CHARPOS is on invisible
1432 text, move_it_to stops at the end of the invisible text,
1433 after CHARPOS. (ii) If CHARPOS is in a display vector,
1434 move_it_to stops on its last glyph. */
1435 int top_x
= it
.current_x
;
1436 int top_y
= it
.current_y
;
1437 enum it_method it_method
= it
.method
;
1438 /* Calling line_bottom_y may change it.method, it.position, etc. */
1439 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1440 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1442 if (top_y
< window_top_y
)
1443 visible_p
= bottom_y
> window_top_y
;
1444 else if (top_y
< it
.last_visible_y
)
1448 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1450 /* We stopped on the last glyph of a display vector.
1451 Try and recompute. Hack alert! */
1452 if (charpos
< 2 || top
.charpos
>= charpos
)
1453 top_x
= it
.glyph_row
->x
;
1457 start_display (&it2
, w
, top
);
1458 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1459 get_next_display_element (&it2
);
1460 PRODUCE_GLYPHS (&it2
);
1461 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1462 || it2
.current_x
> it2
.last_visible_x
)
1463 top_x
= it
.glyph_row
->x
;
1466 top_x
= it2
.current_x
;
1467 top_y
= it2
.current_y
;
1473 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1474 *rtop
= max (0, window_top_y
- top_y
);
1475 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1476 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1477 - max (top_y
, window_top_y
)));
1486 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1487 move_it_by_lines (&it
, 1, 0);
1488 if (charpos
< IT_CHARPOS (it
)
1489 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1492 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1494 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1495 *rtop
= max (0, -it2
.current_y
);
1496 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1497 - it
.last_visible_y
));
1498 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1500 - max (it2
.current_y
,
1501 WINDOW_HEADER_LINE_HEIGHT (w
))));
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR which is MAXLEN bytes long.
1528 Return in *LEN the length of the character. This is like
1529 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1530 we find one, we return a `?', but with the length of the invalid
1534 string_char_and_length (str
, len
)
1535 const unsigned char *str
;
1540 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1541 if (!CHAR_VALID_P (c
, 1))
1542 /* We may not change the length here because other places in Emacs
1543 don't use this function, i.e. they silently accept invalid
1552 /* Given a position POS containing a valid character and byte position
1553 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1555 static struct text_pos
1556 string_pos_nchars_ahead (pos
, string
, nchars
)
1557 struct text_pos pos
;
1561 xassert (STRINGP (string
) && nchars
>= 0);
1563 if (STRING_MULTIBYTE (string
))
1565 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1566 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1571 string_char_and_length (p
, &len
);
1572 p
+= len
, rest
-= len
;
1573 xassert (rest
>= 0);
1575 BYTEPOS (pos
) += len
;
1579 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1585 /* Value is the text position, i.e. character and byte position,
1586 for character position CHARPOS in STRING. */
1588 static INLINE
struct text_pos
1589 string_pos (charpos
, string
)
1593 struct text_pos pos
;
1594 xassert (STRINGP (string
));
1595 xassert (charpos
>= 0);
1596 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1601 /* Value is a text position, i.e. character and byte position, for
1602 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1603 means recognize multibyte characters. */
1605 static struct text_pos
1606 c_string_pos (charpos
, s
, multibyte_p
)
1611 struct text_pos pos
;
1613 xassert (s
!= NULL
);
1614 xassert (charpos
>= 0);
1618 int rest
= strlen (s
), len
;
1620 SET_TEXT_POS (pos
, 0, 0);
1623 string_char_and_length (s
, &len
);
1624 s
+= len
, rest
-= len
;
1625 xassert (rest
>= 0);
1627 BYTEPOS (pos
) += len
;
1631 SET_TEXT_POS (pos
, charpos
, charpos
);
1637 /* Value is the number of characters in C string S. MULTIBYTE_P
1638 non-zero means recognize multibyte characters. */
1641 number_of_chars (s
, multibyte_p
)
1649 int rest
= strlen (s
), len
;
1650 unsigned char *p
= (unsigned char *) s
;
1652 for (nchars
= 0; rest
> 0; ++nchars
)
1654 string_char_and_length (p
, &len
);
1655 rest
-= len
, p
+= len
;
1659 nchars
= strlen (s
);
1665 /* Compute byte position NEWPOS->bytepos corresponding to
1666 NEWPOS->charpos. POS is a known position in string STRING.
1667 NEWPOS->charpos must be >= POS.charpos. */
1670 compute_string_pos (newpos
, pos
, string
)
1671 struct text_pos
*newpos
, pos
;
1674 xassert (STRINGP (string
));
1675 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1677 if (STRING_MULTIBYTE (string
))
1678 *newpos
= string_pos_nchars_ahead (pos
, string
,
1679 CHARPOS (*newpos
) - CHARPOS (pos
));
1681 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1685 Return an estimation of the pixel height of mode or header lines on
1686 frame F. FACE_ID specifies what line's height to estimate. */
1689 estimate_mode_line_height (f
, face_id
)
1691 enum face_id face_id
;
1693 #ifdef HAVE_WINDOW_SYSTEM
1694 if (FRAME_WINDOW_P (f
))
1696 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1698 /* This function is called so early when Emacs starts that the face
1699 cache and mode line face are not yet initialized. */
1700 if (FRAME_FACE_CACHE (f
))
1702 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1706 height
= FONT_HEIGHT (face
->font
);
1707 if (face
->box_line_width
> 0)
1708 height
+= 2 * face
->box_line_width
;
1719 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1720 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1721 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1722 not force the value into range. */
1725 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1727 register int pix_x
, pix_y
;
1729 NativeRectangle
*bounds
;
1733 #ifdef HAVE_WINDOW_SYSTEM
1734 if (FRAME_WINDOW_P (f
))
1736 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1737 even for negative values. */
1739 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1741 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1743 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1744 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1747 STORE_NATIVE_RECT (*bounds
,
1748 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1749 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1750 FRAME_COLUMN_WIDTH (f
) - 1,
1751 FRAME_LINE_HEIGHT (f
) - 1);
1757 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1758 pix_x
= FRAME_TOTAL_COLS (f
);
1762 else if (pix_y
> FRAME_LINES (f
))
1763 pix_y
= FRAME_LINES (f
);
1773 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1774 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1775 can't tell the positions because W's display is not up to date,
1779 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1782 int *frame_x
, *frame_y
;
1784 #ifdef HAVE_WINDOW_SYSTEM
1785 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1789 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1790 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1792 if (display_completed
)
1794 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1795 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1796 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1802 hpos
+= glyph
->pixel_width
;
1806 /* If first glyph is partially visible, its first visible position is still 0. */
1818 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1819 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1830 #ifdef HAVE_WINDOW_SYSTEM
1832 /* Find the glyph under window-relative coordinates X/Y in window W.
1833 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1834 strings. Return in *HPOS and *VPOS the row and column number of
1835 the glyph found. Return in *AREA the glyph area containing X.
1836 Value is a pointer to the glyph found or null if X/Y is not on
1837 text, or we can't tell because W's current matrix is not up to
1842 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1845 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1847 struct glyph
*glyph
, *end
;
1848 struct glyph_row
*row
= NULL
;
1851 /* Find row containing Y. Give up if some row is not enabled. */
1852 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1854 row
= MATRIX_ROW (w
->current_matrix
, i
);
1855 if (!row
->enabled_p
)
1857 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1864 /* Give up if Y is not in the window. */
1865 if (i
== w
->current_matrix
->nrows
)
1868 /* Get the glyph area containing X. */
1869 if (w
->pseudo_window_p
)
1876 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1878 *area
= LEFT_MARGIN_AREA
;
1879 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1881 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1884 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1888 *area
= RIGHT_MARGIN_AREA
;
1889 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1893 /* Find glyph containing X. */
1894 glyph
= row
->glyphs
[*area
];
1895 end
= glyph
+ row
->used
[*area
];
1897 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1899 x
-= glyph
->pixel_width
;
1909 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1912 *hpos
= glyph
- row
->glyphs
[*area
];
1918 Convert frame-relative x/y to coordinates relative to window W.
1919 Takes pseudo-windows into account. */
1922 frame_to_window_pixel_xy (w
, x
, y
)
1926 if (w
->pseudo_window_p
)
1928 /* A pseudo-window is always full-width, and starts at the
1929 left edge of the frame, plus a frame border. */
1930 struct frame
*f
= XFRAME (w
->frame
);
1931 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1932 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1936 *x
-= WINDOW_LEFT_EDGE_X (w
);
1937 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1942 Return in RECTS[] at most N clipping rectangles for glyph string S.
1943 Return the number of stored rectangles. */
1946 get_glyph_string_clip_rects (s
, rects
, n
)
1947 struct glyph_string
*s
;
1948 NativeRectangle
*rects
;
1956 if (s
->row
->full_width_p
)
1958 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1959 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1960 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1962 /* Unless displaying a mode or menu bar line, which are always
1963 fully visible, clip to the visible part of the row. */
1964 if (s
->w
->pseudo_window_p
)
1965 r
.height
= s
->row
->visible_height
;
1967 r
.height
= s
->height
;
1971 /* This is a text line that may be partially visible. */
1972 r
.x
= window_box_left (s
->w
, s
->area
);
1973 r
.width
= window_box_width (s
->w
, s
->area
);
1974 r
.height
= s
->row
->visible_height
;
1978 if (r
.x
< s
->clip_head
->x
)
1980 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1981 r
.width
-= s
->clip_head
->x
- r
.x
;
1984 r
.x
= s
->clip_head
->x
;
1987 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1989 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1990 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1995 /* If S draws overlapping rows, it's sufficient to use the top and
1996 bottom of the window for clipping because this glyph string
1997 intentionally draws over other lines. */
1998 if (s
->for_overlaps
)
2000 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2001 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2003 /* Alas, the above simple strategy does not work for the
2004 environments with anti-aliased text: if the same text is
2005 drawn onto the same place multiple times, it gets thicker.
2006 If the overlap we are processing is for the erased cursor, we
2007 take the intersection with the rectagle of the cursor. */
2008 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2010 XRectangle rc
, r_save
= r
;
2012 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2013 rc
.y
= s
->w
->phys_cursor
.y
;
2014 rc
.width
= s
->w
->phys_cursor_width
;
2015 rc
.height
= s
->w
->phys_cursor_height
;
2017 x_intersect_rectangles (&r_save
, &rc
, &r
);
2022 /* Don't use S->y for clipping because it doesn't take partially
2023 visible lines into account. For example, it can be negative for
2024 partially visible lines at the top of a window. */
2025 if (!s
->row
->full_width_p
2026 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2027 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2029 r
.y
= max (0, s
->row
->y
);
2032 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2034 /* If drawing the cursor, don't let glyph draw outside its
2035 advertised boundaries. Cleartype does this under some circumstances. */
2036 if (s
->hl
== DRAW_CURSOR
)
2038 struct glyph
*glyph
= s
->first_glyph
;
2043 r
.width
-= s
->x
- r
.x
;
2046 r
.width
= min (r
.width
, glyph
->pixel_width
);
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height
= min (glyph
->ascent
+ glyph
->descent
,
2050 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2051 max_y
= window_text_bottom_y (s
->w
) - height
;
2052 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2053 if (s
->ybase
- glyph
->ascent
> max_y
)
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2062 if (height
< r
.height
)
2064 max_y
= r
.y
+ r
.height
;
2065 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2066 r
.height
= min (max_y
- r
.y
, height
);
2073 XRectangle r_save
= r
;
2075 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2079 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2080 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r
, *rects
);
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2098 XRectangle
*rs
= rects
;
2100 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2102 if (s
->for_overlaps
& OVERLAPS_PRED
)
2105 if (r
.y
+ r
.height
> row_y
)
2108 rs
[i
].height
= row_y
- r
.y
;
2114 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2117 if (r
.y
< row_y
+ s
->row
->visible_height
)
2119 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2121 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2122 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i
= 0; i
< n
; i
++)
2133 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2140 Return in *NR the clipping rectangle for glyph string S. */
2143 get_glyph_string_clip_rect (s
, nr
)
2144 struct glyph_string
*s
;
2145 NativeRectangle
*nr
;
2147 get_glyph_string_clip_rects (s
, nr
, 1);
2152 Return the position and height of the phys cursor in window W.
2153 Set w->phys_cursor_width to width of phys cursor.
2157 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2159 struct glyph_row
*row
;
2160 struct glyph
*glyph
;
2161 int *xp
, *yp
, *heightp
;
2163 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2164 int x
, y
, wd
, h
, h0
, y0
;
2166 /* Compute the width of the rectangle to draw. If on a stretch
2167 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2168 rectangle as wide as the glyph, but use a canonical character
2170 wd
= glyph
->pixel_width
- 1;
2171 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2175 x
= w
->phys_cursor
.x
;
2182 if (glyph
->type
== STRETCH_GLYPH
2183 && !x_stretch_cursor_p
)
2184 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2185 w
->phys_cursor_width
= wd
;
2187 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2192 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2193 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2195 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2198 h
= max (h
- (y0
- y
) + 1, h0
);
2203 y0
= window_text_bottom_y (w
) - h0
;
2211 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2212 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2217 * Remember which glyph the mouse is over.
2221 remember_mouse_glyph (f
, gx
, gy
, rect
)
2224 NativeRectangle
*rect
;
2228 struct glyph_row
*r
, *gr
, *end_row
;
2229 enum window_part part
;
2230 enum glyph_row_area area
;
2231 int x
, y
, width
, height
;
2233 /* Try to determine frame pixel position and size of the glyph under
2234 frame pixel coordinates X/Y on frame F. */
2236 if (!f
->glyphs_initialized_p
2237 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2240 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2241 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2245 w
= XWINDOW (window
);
2246 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2247 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2249 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2250 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2252 if (w
->pseudo_window_p
)
2255 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2261 case ON_LEFT_MARGIN
:
2262 area
= LEFT_MARGIN_AREA
;
2265 case ON_RIGHT_MARGIN
:
2266 area
= RIGHT_MARGIN_AREA
;
2269 case ON_HEADER_LINE
:
2271 gr
= (part
== ON_HEADER_LINE
2272 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2273 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2276 goto text_glyph_row_found
;
2283 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2284 if (r
->y
+ r
->height
> y
)
2290 text_glyph_row_found
:
2293 struct glyph
*g
= gr
->glyphs
[area
];
2294 struct glyph
*end
= g
+ gr
->used
[area
];
2296 height
= gr
->height
;
2297 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2298 if (gx
+ g
->pixel_width
> x
)
2303 if (g
->type
== IMAGE_GLYPH
)
2305 /* Don't remember when mouse is over image, as
2306 image may have hot-spots. */
2307 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2310 width
= g
->pixel_width
;
2314 /* Use nominal char spacing at end of line. */
2316 gx
+= (x
/ width
) * width
;
2319 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2320 gx
+= window_box_left_offset (w
, area
);
2324 /* Use nominal line height at end of window. */
2325 gx
= (x
/ width
) * width
;
2327 gy
+= (y
/ height
) * height
;
2331 case ON_LEFT_FRINGE
:
2332 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2333 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2334 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2335 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2338 case ON_RIGHT_FRINGE
:
2339 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2340 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2341 : window_box_right_offset (w
, TEXT_AREA
));
2342 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2346 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2348 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2349 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2350 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2352 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2356 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2357 if (r
->y
+ r
->height
> y
)
2364 height
= gr
->height
;
2367 /* Use nominal line height at end of window. */
2369 gy
+= (y
/ height
) * height
;
2376 /* If there is no glyph under the mouse, then we divide the screen
2377 into a grid of the smallest glyph in the frame, and use that
2380 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2381 round down even for negative values. */
2387 gx
= (gx
/ width
) * width
;
2388 gy
= (gy
/ height
) * height
;
2393 gx
+= WINDOW_LEFT_EDGE_X (w
);
2394 gy
+= WINDOW_TOP_EDGE_Y (w
);
2397 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2399 /* Visible feedback for debugging. */
2402 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2403 f
->output_data
.x
->normal_gc
,
2404 gx
, gy
, width
, height
);
2410 #endif /* HAVE_WINDOW_SYSTEM */
2413 /***********************************************************************
2414 Lisp form evaluation
2415 ***********************************************************************/
2417 /* Error handler for safe_eval and safe_call. */
2420 safe_eval_handler (arg
)
2423 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2428 /* Evaluate SEXPR and return the result, or nil if something went
2429 wrong. Prevent redisplay during the evaluation. */
2431 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2432 Return the result, or nil if something went wrong. Prevent
2433 redisplay during the evaluation. */
2436 safe_call (nargs
, args
)
2442 if (inhibit_eval_during_redisplay
)
2446 int count
= SPECPDL_INDEX ();
2447 struct gcpro gcpro1
;
2450 gcpro1
.nvars
= nargs
;
2451 specbind (Qinhibit_redisplay
, Qt
);
2452 /* Use Qt to ensure debugger does not run,
2453 so there is no possibility of wanting to redisplay. */
2454 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2457 val
= unbind_to (count
, val
);
2464 /* Call function FN with one argument ARG.
2465 Return the result, or nil if something went wrong. */
2468 safe_call1 (fn
, arg
)
2469 Lisp_Object fn
, arg
;
2471 Lisp_Object args
[2];
2474 return safe_call (2, args
);
2477 static Lisp_Object Qeval
;
2480 safe_eval (Lisp_Object sexpr
)
2482 return safe_call1 (Qeval
, sexpr
);
2485 /* Call function FN with one argument ARG.
2486 Return the result, or nil if something went wrong. */
2489 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2491 Lisp_Object args
[3];
2495 return safe_call (3, args
);
2500 /***********************************************************************
2502 ***********************************************************************/
2506 /* Define CHECK_IT to perform sanity checks on iterators.
2507 This is for debugging. It is too slow to do unconditionally. */
2513 if (it
->method
== GET_FROM_STRING
)
2515 xassert (STRINGP (it
->string
));
2516 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2520 xassert (IT_STRING_CHARPOS (*it
) < 0);
2521 if (it
->method
== GET_FROM_BUFFER
)
2523 /* Check that character and byte positions agree. */
2524 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2529 xassert (it
->current
.dpvec_index
>= 0);
2531 xassert (it
->current
.dpvec_index
< 0);
2534 #define CHECK_IT(IT) check_it ((IT))
2538 #define CHECK_IT(IT) (void) 0
2545 /* Check that the window end of window W is what we expect it
2546 to be---the last row in the current matrix displaying text. */
2549 check_window_end (w
)
2552 if (!MINI_WINDOW_P (w
)
2553 && !NILP (w
->window_end_valid
))
2555 struct glyph_row
*row
;
2556 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2557 XFASTINT (w
->window_end_vpos
)),
2559 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2560 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2564 #define CHECK_WINDOW_END(W) check_window_end ((W))
2566 #else /* not GLYPH_DEBUG */
2568 #define CHECK_WINDOW_END(W) (void) 0
2570 #endif /* not GLYPH_DEBUG */
2574 /***********************************************************************
2575 Iterator initialization
2576 ***********************************************************************/
2578 /* Initialize IT for displaying current_buffer in window W, starting
2579 at character position CHARPOS. CHARPOS < 0 means that no buffer
2580 position is specified which is useful when the iterator is assigned
2581 a position later. BYTEPOS is the byte position corresponding to
2582 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2584 If ROW is not null, calls to produce_glyphs with IT as parameter
2585 will produce glyphs in that row.
2587 BASE_FACE_ID is the id of a base face to use. It must be one of
2588 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2589 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2590 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2592 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2593 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2594 will be initialized to use the corresponding mode line glyph row of
2595 the desired matrix of W. */
2598 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2601 int charpos
, bytepos
;
2602 struct glyph_row
*row
;
2603 enum face_id base_face_id
;
2605 int highlight_region_p
;
2606 enum face_id remapped_base_face_id
= base_face_id
;
2608 /* Some precondition checks. */
2609 xassert (w
!= NULL
&& it
!= NULL
);
2610 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2613 /* If face attributes have been changed since the last redisplay,
2614 free realized faces now because they depend on face definitions
2615 that might have changed. Don't free faces while there might be
2616 desired matrices pending which reference these faces. */
2617 if (face_change_count
&& !inhibit_free_realized_faces
)
2619 face_change_count
= 0;
2620 free_all_realized_faces (Qnil
);
2623 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2624 if (! NILP (Vface_remapping_alist
))
2625 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2627 /* Use one of the mode line rows of W's desired matrix if
2631 if (base_face_id
== MODE_LINE_FACE_ID
2632 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2633 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2634 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2635 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2639 bzero (it
, sizeof *it
);
2640 it
->current
.overlay_string_index
= -1;
2641 it
->current
.dpvec_index
= -1;
2642 it
->base_face_id
= remapped_base_face_id
;
2644 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2646 /* The window in which we iterate over current_buffer: */
2647 XSETWINDOW (it
->window
, w
);
2649 it
->f
= XFRAME (w
->frame
);
2653 /* Extra space between lines (on window systems only). */
2654 if (base_face_id
== DEFAULT_FACE_ID
2655 && FRAME_WINDOW_P (it
->f
))
2657 if (NATNUMP (current_buffer
->extra_line_spacing
))
2658 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2659 else if (FLOATP (current_buffer
->extra_line_spacing
))
2660 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2661 * FRAME_LINE_HEIGHT (it
->f
));
2662 else if (it
->f
->extra_line_spacing
> 0)
2663 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2664 it
->max_extra_line_spacing
= 0;
2667 /* If realized faces have been removed, e.g. because of face
2668 attribute changes of named faces, recompute them. When running
2669 in batch mode, the face cache of the initial frame is null. If
2670 we happen to get called, make a dummy face cache. */
2671 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2672 init_frame_faces (it
->f
);
2673 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2674 recompute_basic_faces (it
->f
);
2676 /* Current value of the `slice', `space-width', and 'height' properties. */
2677 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2678 it
->space_width
= Qnil
;
2679 it
->font_height
= Qnil
;
2680 it
->override_ascent
= -1;
2682 /* Are control characters displayed as `^C'? */
2683 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2685 /* -1 means everything between a CR and the following line end
2686 is invisible. >0 means lines indented more than this value are
2688 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2689 ? XFASTINT (current_buffer
->selective_display
)
2690 : (!NILP (current_buffer
->selective_display
)
2692 it
->selective_display_ellipsis_p
2693 = !NILP (current_buffer
->selective_display_ellipses
);
2695 /* Display table to use. */
2696 it
->dp
= window_display_table (w
);
2698 /* Are multibyte characters enabled in current_buffer? */
2699 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2701 /* Do we need to reorder bidirectional text? */
2702 it
->bidi_p
= !NILP (current_buffer
->bidi_display_reordering
);
2704 /* Non-zero if we should highlight the region. */
2706 = (!NILP (Vtransient_mark_mode
)
2707 && !NILP (current_buffer
->mark_active
)
2708 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2710 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2711 start and end of a visible region in window IT->w. Set both to
2712 -1 to indicate no region. */
2713 if (highlight_region_p
2714 /* Maybe highlight only in selected window. */
2715 && (/* Either show region everywhere. */
2716 highlight_nonselected_windows
2717 /* Or show region in the selected window. */
2718 || w
== XWINDOW (selected_window
)
2719 /* Or show the region if we are in the mini-buffer and W is
2720 the window the mini-buffer refers to. */
2721 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2722 && WINDOWP (minibuf_selected_window
)
2723 && w
== XWINDOW (minibuf_selected_window
))))
2725 int charpos
= marker_position (current_buffer
->mark
);
2726 it
->region_beg_charpos
= min (PT
, charpos
);
2727 it
->region_end_charpos
= max (PT
, charpos
);
2730 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2732 /* Get the position at which the redisplay_end_trigger hook should
2733 be run, if it is to be run at all. */
2734 if (MARKERP (w
->redisplay_end_trigger
)
2735 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2736 it
->redisplay_end_trigger_charpos
2737 = marker_position (w
->redisplay_end_trigger
);
2738 else if (INTEGERP (w
->redisplay_end_trigger
))
2739 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2741 /* Correct bogus values of tab_width. */
2742 it
->tab_width
= XINT (current_buffer
->tab_width
);
2743 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2746 /* Are lines in the display truncated? */
2747 if (base_face_id
!= DEFAULT_FACE_ID
2748 || XINT (it
->w
->hscroll
)
2749 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2750 && ((!NILP (Vtruncate_partial_width_windows
)
2751 && !INTEGERP (Vtruncate_partial_width_windows
))
2752 || (INTEGERP (Vtruncate_partial_width_windows
)
2753 && (WINDOW_TOTAL_COLS (it
->w
)
2754 < XINT (Vtruncate_partial_width_windows
))))))
2755 it
->line_wrap
= TRUNCATE
;
2756 else if (NILP (current_buffer
->truncate_lines
))
2757 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2758 ? WINDOW_WRAP
: WORD_WRAP
;
2760 it
->line_wrap
= TRUNCATE
;
2762 /* Get dimensions of truncation and continuation glyphs. These are
2763 displayed as fringe bitmaps under X, so we don't need them for such
2765 if (!FRAME_WINDOW_P (it
->f
))
2767 if (it
->line_wrap
== TRUNCATE
)
2769 /* We will need the truncation glyph. */
2770 xassert (it
->glyph_row
== NULL
);
2771 produce_special_glyphs (it
, IT_TRUNCATION
);
2772 it
->truncation_pixel_width
= it
->pixel_width
;
2776 /* We will need the continuation glyph. */
2777 xassert (it
->glyph_row
== NULL
);
2778 produce_special_glyphs (it
, IT_CONTINUATION
);
2779 it
->continuation_pixel_width
= it
->pixel_width
;
2782 /* Reset these values to zero because the produce_special_glyphs
2783 above has changed them. */
2784 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2785 it
->phys_ascent
= it
->phys_descent
= 0;
2788 /* Set this after getting the dimensions of truncation and
2789 continuation glyphs, so that we don't produce glyphs when calling
2790 produce_special_glyphs, above. */
2791 it
->glyph_row
= row
;
2792 it
->area
= TEXT_AREA
;
2794 /* Forget any previous info about this row being reversed. */
2796 it
->glyph_row
->reversed_p
= 0;
2798 /* Get the dimensions of the display area. The display area
2799 consists of the visible window area plus a horizontally scrolled
2800 part to the left of the window. All x-values are relative to the
2801 start of this total display area. */
2802 if (base_face_id
!= DEFAULT_FACE_ID
)
2804 /* Mode lines, menu bar in terminal frames. */
2805 it
->first_visible_x
= 0;
2806 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2811 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2812 it
->last_visible_x
= (it
->first_visible_x
2813 + window_box_width (w
, TEXT_AREA
));
2815 /* If we truncate lines, leave room for the truncator glyph(s) at
2816 the right margin. Otherwise, leave room for the continuation
2817 glyph(s). Truncation and continuation glyphs are not inserted
2818 for window-based redisplay. */
2819 if (!FRAME_WINDOW_P (it
->f
))
2821 if (it
->line_wrap
== TRUNCATE
)
2822 it
->last_visible_x
-= it
->truncation_pixel_width
;
2824 it
->last_visible_x
-= it
->continuation_pixel_width
;
2827 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2828 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2831 /* Leave room for a border glyph. */
2832 if (!FRAME_WINDOW_P (it
->f
)
2833 && !WINDOW_RIGHTMOST_P (it
->w
))
2834 it
->last_visible_x
-= 1;
2836 it
->last_visible_y
= window_text_bottom_y (w
);
2838 /* For mode lines and alike, arrange for the first glyph having a
2839 left box line if the face specifies a box. */
2840 if (base_face_id
!= DEFAULT_FACE_ID
)
2844 it
->face_id
= remapped_base_face_id
;
2846 /* If we have a boxed mode line, make the first character appear
2847 with a left box line. */
2848 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2849 if (face
->box
!= FACE_NO_BOX
)
2850 it
->start_of_box_run_p
= 1;
2853 /* If we are to reorder bidirectional text, init the bidi
2857 /* Note the paragraph direction that this buffer wants to
2859 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2860 it
->paragraph_embedding
= L2R
;
2861 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2862 it
->paragraph_embedding
= R2L
;
2864 it
->paragraph_embedding
= NEUTRAL_DIR
;
2865 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->end_charpos
= ZV
;
2874 IT_CHARPOS (*it
) = charpos
;
2876 /* Compute byte position if not specified. */
2877 if (bytepos
< charpos
)
2878 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2880 IT_BYTEPOS (*it
) = bytepos
;
2882 it
->start
= it
->current
;
2884 /* Compute faces etc. */
2885 reseat (it
, it
->current
.pos
, 1);
2892 /* Initialize IT for the display of window W with window start POS. */
2895 start_display (it
, w
, pos
)
2898 struct text_pos pos
;
2900 struct glyph_row
*row
;
2901 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2903 row
= w
->desired_matrix
->rows
+ first_vpos
;
2904 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2905 it
->first_vpos
= first_vpos
;
2907 /* Don't reseat to previous visible line start if current start
2908 position is in a string or image. */
2909 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2911 int start_at_line_beg_p
;
2912 int first_y
= it
->current_y
;
2914 /* If window start is not at a line start, skip forward to POS to
2915 get the correct continuation lines width. */
2916 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2917 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2918 if (!start_at_line_beg_p
)
2922 reseat_at_previous_visible_line_start (it
);
2923 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2925 new_x
= it
->current_x
+ it
->pixel_width
;
2927 /* If lines are continued, this line may end in the middle
2928 of a multi-glyph character (e.g. a control character
2929 displayed as \003, or in the middle of an overlay
2930 string). In this case move_it_to above will not have
2931 taken us to the start of the continuation line but to the
2932 end of the continued line. */
2933 if (it
->current_x
> 0
2934 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2935 && (/* And glyph doesn't fit on the line. */
2936 new_x
> it
->last_visible_x
2937 /* Or it fits exactly and we're on a window
2939 || (new_x
== it
->last_visible_x
2940 && FRAME_WINDOW_P (it
->f
))))
2942 if (it
->current
.dpvec_index
>= 0
2943 || it
->current
.overlay_string_index
>= 0)
2945 set_iterator_to_next (it
, 1);
2946 move_it_in_display_line_to (it
, -1, -1, 0);
2949 it
->continuation_lines_width
+= it
->current_x
;
2952 /* We're starting a new display line, not affected by the
2953 height of the continued line, so clear the appropriate
2954 fields in the iterator structure. */
2955 it
->max_ascent
= it
->max_descent
= 0;
2956 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2958 it
->current_y
= first_y
;
2960 it
->current_x
= it
->hpos
= 0;
2966 /* Return 1 if POS is a position in ellipses displayed for invisible
2967 text. W is the window we display, for text property lookup. */
2970 in_ellipses_for_invisible_text_p (pos
, w
)
2971 struct display_pos
*pos
;
2974 Lisp_Object prop
, window
;
2976 int charpos
= CHARPOS (pos
->pos
);
2978 /* If POS specifies a position in a display vector, this might
2979 be for an ellipsis displayed for invisible text. We won't
2980 get the iterator set up for delivering that ellipsis unless
2981 we make sure that it gets aware of the invisible text. */
2982 if (pos
->dpvec_index
>= 0
2983 && pos
->overlay_string_index
< 0
2984 && CHARPOS (pos
->string_pos
) < 0
2986 && (XSETWINDOW (window
, w
),
2987 prop
= Fget_char_property (make_number (charpos
),
2988 Qinvisible
, window
),
2989 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2991 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2993 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3000 /* Initialize IT for stepping through current_buffer in window W,
3001 starting at position POS that includes overlay string and display
3002 vector/ control character translation position information. Value
3003 is zero if there are overlay strings with newlines at POS. */
3006 init_from_display_pos (it
, w
, pos
)
3009 struct display_pos
*pos
;
3011 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3012 int i
, overlay_strings_with_newlines
= 0;
3014 /* If POS specifies a position in a display vector, this might
3015 be for an ellipsis displayed for invisible text. We won't
3016 get the iterator set up for delivering that ellipsis unless
3017 we make sure that it gets aware of the invisible text. */
3018 if (in_ellipses_for_invisible_text_p (pos
, w
))
3024 /* Keep in mind: the call to reseat in init_iterator skips invisible
3025 text, so we might end up at a position different from POS. This
3026 is only a problem when POS is a row start after a newline and an
3027 overlay starts there with an after-string, and the overlay has an
3028 invisible property. Since we don't skip invisible text in
3029 display_line and elsewhere immediately after consuming the
3030 newline before the row start, such a POS will not be in a string,
3031 but the call to init_iterator below will move us to the
3033 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3035 /* This only scans the current chunk -- it should scan all chunks.
3036 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3037 to 16 in 22.1 to make this a lesser problem. */
3038 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3040 const char *s
= SDATA (it
->overlay_strings
[i
]);
3041 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3043 while (s
< e
&& *s
!= '\n')
3048 overlay_strings_with_newlines
= 1;
3053 /* If position is within an overlay string, set up IT to the right
3055 if (pos
->overlay_string_index
>= 0)
3059 /* If the first overlay string happens to have a `display'
3060 property for an image, the iterator will be set up for that
3061 image, and we have to undo that setup first before we can
3062 correct the overlay string index. */
3063 if (it
->method
== GET_FROM_IMAGE
)
3066 /* We already have the first chunk of overlay strings in
3067 IT->overlay_strings. Load more until the one for
3068 pos->overlay_string_index is in IT->overlay_strings. */
3069 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3071 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3072 it
->current
.overlay_string_index
= 0;
3075 load_overlay_strings (it
, 0);
3076 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3080 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3081 relative_index
= (it
->current
.overlay_string_index
3082 % OVERLAY_STRING_CHUNK_SIZE
);
3083 it
->string
= it
->overlay_strings
[relative_index
];
3084 xassert (STRINGP (it
->string
));
3085 it
->current
.string_pos
= pos
->string_pos
;
3086 it
->method
= GET_FROM_STRING
;
3089 if (CHARPOS (pos
->string_pos
) >= 0)
3091 /* Recorded position is not in an overlay string, but in another
3092 string. This can only be a string from a `display' property.
3093 IT should already be filled with that string. */
3094 it
->current
.string_pos
= pos
->string_pos
;
3095 xassert (STRINGP (it
->string
));
3098 /* Restore position in display vector translations, control
3099 character translations or ellipses. */
3100 if (pos
->dpvec_index
>= 0)
3102 if (it
->dpvec
== NULL
)
3103 get_next_display_element (it
);
3104 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3105 it
->current
.dpvec_index
= pos
->dpvec_index
;
3109 return !overlay_strings_with_newlines
;
3113 /* Initialize IT for stepping through current_buffer in window W
3114 starting at ROW->start. */
3117 init_to_row_start (it
, w
, row
)
3120 struct glyph_row
*row
;
3122 init_from_display_pos (it
, w
, &row
->start
);
3123 it
->start
= row
->start
;
3124 it
->continuation_lines_width
= row
->continuation_lines_width
;
3129 /* Initialize IT for stepping through current_buffer in window W
3130 starting in the line following ROW, i.e. starting at ROW->end.
3131 Value is zero if there are overlay strings with newlines at ROW's
3135 init_to_row_end (it
, w
, row
)
3138 struct glyph_row
*row
;
3142 if (init_from_display_pos (it
, w
, &row
->end
))
3144 if (row
->continued_p
)
3145 it
->continuation_lines_width
3146 = row
->continuation_lines_width
+ row
->pixel_width
;
3157 /***********************************************************************
3159 ***********************************************************************/
3161 /* Called when IT reaches IT->stop_charpos. Handle text property and
3162 overlay changes. Set IT->stop_charpos to the next position where
3169 enum prop_handled handled
;
3170 int handle_overlay_change_p
;
3174 it
->current
.dpvec_index
= -1;
3175 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3176 it
->ignore_overlay_strings_at_pos_p
= 0;
3179 /* Use face of preceding text for ellipsis (if invisible) */
3180 if (it
->selective_display_ellipsis_p
)
3181 it
->saved_face_id
= it
->face_id
;
3185 handled
= HANDLED_NORMALLY
;
3187 /* Call text property handlers. */
3188 for (p
= it_props
; p
->handler
; ++p
)
3190 handled
= p
->handler (it
);
3192 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3194 else if (handled
== HANDLED_RETURN
)
3196 /* We still want to show before and after strings from
3197 overlays even if the actual buffer text is replaced. */
3198 if (!handle_overlay_change_p
3200 || !get_overlay_strings_1 (it
, 0, 0))
3203 setup_for_ellipsis (it
, 0);
3204 /* When handling a display spec, we might load an
3205 empty string. In that case, discard it here. We
3206 used to discard it in handle_single_display_spec,
3207 but that causes get_overlay_strings_1, above, to
3208 ignore overlay strings that we must check. */
3209 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3213 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3217 it
->ignore_overlay_strings_at_pos_p
= 1;
3218 it
->string_from_display_prop_p
= 0;
3219 handle_overlay_change_p
= 0;
3221 handled
= HANDLED_RECOMPUTE_PROPS
;
3224 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3225 handle_overlay_change_p
= 0;
3228 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3230 /* Don't check for overlay strings below when set to deliver
3231 characters from a display vector. */
3232 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3233 handle_overlay_change_p
= 0;
3235 /* Handle overlay changes.
3236 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3237 if it finds overlays. */
3238 if (handle_overlay_change_p
)
3239 handled
= handle_overlay_change (it
);
3244 setup_for_ellipsis (it
, 0);
3248 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3250 /* Determine where to stop next. */
3251 if (handled
== HANDLED_NORMALLY
)
3252 compute_stop_pos (it
);
3256 /* Compute IT->stop_charpos from text property and overlay change
3257 information for IT's current position. */
3260 compute_stop_pos (it
)
3263 register INTERVAL iv
, next_iv
;
3264 Lisp_Object object
, limit
, position
;
3265 EMACS_INT charpos
, bytepos
;
3267 /* If nowhere else, stop at the end. */
3268 it
->stop_charpos
= it
->end_charpos
;
3270 if (STRINGP (it
->string
))
3272 /* Strings are usually short, so don't limit the search for
3274 object
= it
->string
;
3276 charpos
= IT_STRING_CHARPOS (*it
);
3277 bytepos
= IT_STRING_BYTEPOS (*it
);
3283 /* If next overlay change is in front of the current stop pos
3284 (which is IT->end_charpos), stop there. Note: value of
3285 next_overlay_change is point-max if no overlay change
3287 charpos
= IT_CHARPOS (*it
);
3288 bytepos
= IT_BYTEPOS (*it
);
3289 pos
= next_overlay_change (charpos
);
3290 if (pos
< it
->stop_charpos
)
3291 it
->stop_charpos
= pos
;
3293 /* If showing the region, we have to stop at the region
3294 start or end because the face might change there. */
3295 if (it
->region_beg_charpos
> 0)
3297 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3298 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3299 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3300 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3303 /* Set up variables for computing the stop position from text
3304 property changes. */
3305 XSETBUFFER (object
, current_buffer
);
3306 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3309 /* Get the interval containing IT's position. Value is a null
3310 interval if there isn't such an interval. */
3311 position
= make_number (charpos
);
3312 iv
= validate_interval_range (object
, &position
, &position
, 0);
3313 if (!NULL_INTERVAL_P (iv
))
3315 Lisp_Object values_here
[LAST_PROP_IDX
];
3318 /* Get properties here. */
3319 for (p
= it_props
; p
->handler
; ++p
)
3320 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3322 /* Look for an interval following iv that has different
3324 for (next_iv
= next_interval (iv
);
3325 (!NULL_INTERVAL_P (next_iv
)
3327 || XFASTINT (limit
) > next_iv
->position
));
3328 next_iv
= next_interval (next_iv
))
3330 for (p
= it_props
; p
->handler
; ++p
)
3332 Lisp_Object new_value
;
3334 new_value
= textget (next_iv
->plist
, *p
->name
);
3335 if (!EQ (values_here
[p
->idx
], new_value
))
3343 if (!NULL_INTERVAL_P (next_iv
))
3345 if (INTEGERP (limit
)
3346 && next_iv
->position
>= XFASTINT (limit
))
3347 /* No text property change up to limit. */
3348 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3350 /* Text properties change in next_iv. */
3351 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3355 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3356 it
->stop_charpos
, it
->string
);
3358 xassert (STRINGP (it
->string
)
3359 || (it
->stop_charpos
>= BEGV
3360 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3364 /* Return the position of the next overlay change after POS in
3365 current_buffer. Value is point-max if no overlay change
3366 follows. This is like `next-overlay-change' but doesn't use
3370 next_overlay_change (pos
)
3375 Lisp_Object
*overlays
;
3378 /* Get all overlays at the given position. */
3379 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3381 /* If any of these overlays ends before endpos,
3382 use its ending point instead. */
3383 for (i
= 0; i
< noverlays
; ++i
)
3388 oend
= OVERLAY_END (overlays
[i
]);
3389 oendpos
= OVERLAY_POSITION (oend
);
3390 endpos
= min (endpos
, oendpos
);
3398 /***********************************************************************
3400 ***********************************************************************/
3402 /* Handle changes in the `fontified' property of the current buffer by
3403 calling hook functions from Qfontification_functions to fontify
3406 static enum prop_handled
3407 handle_fontified_prop (it
)
3410 Lisp_Object prop
, pos
;
3411 enum prop_handled handled
= HANDLED_NORMALLY
;
3413 if (!NILP (Vmemory_full
))
3416 /* Get the value of the `fontified' property at IT's current buffer
3417 position. (The `fontified' property doesn't have a special
3418 meaning in strings.) If the value is nil, call functions from
3419 Qfontification_functions. */
3420 if (!STRINGP (it
->string
)
3422 && !NILP (Vfontification_functions
)
3423 && !NILP (Vrun_hooks
)
3424 && (pos
= make_number (IT_CHARPOS (*it
)),
3425 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3426 /* Ignore the special cased nil value always present at EOB since
3427 no amount of fontifying will be able to change it. */
3428 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3430 int count
= SPECPDL_INDEX ();
3433 val
= Vfontification_functions
;
3434 specbind (Qfontification_functions
, Qnil
);
3436 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3437 safe_call1 (val
, pos
);
3440 Lisp_Object globals
, fn
;
3441 struct gcpro gcpro1
, gcpro2
;
3444 GCPRO2 (val
, globals
);
3446 for (; CONSP (val
); val
= XCDR (val
))
3452 /* A value of t indicates this hook has a local
3453 binding; it means to run the global binding too.
3454 In a global value, t should not occur. If it
3455 does, we must ignore it to avoid an endless
3457 for (globals
= Fdefault_value (Qfontification_functions
);
3459 globals
= XCDR (globals
))
3461 fn
= XCAR (globals
);
3463 safe_call1 (fn
, pos
);
3467 safe_call1 (fn
, pos
);
3473 unbind_to (count
, Qnil
);
3475 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3476 something. This avoids an endless loop if they failed to
3477 fontify the text for which reason ever. */
3478 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3479 handled
= HANDLED_RECOMPUTE_PROPS
;
3487 /***********************************************************************
3489 ***********************************************************************/
3491 /* Set up iterator IT from face properties at its current position.
3492 Called from handle_stop. */
3494 static enum prop_handled
3495 handle_face_prop (it
)
3499 EMACS_INT next_stop
;
3501 if (!STRINGP (it
->string
))
3504 = face_at_buffer_position (it
->w
,
3506 it
->region_beg_charpos
,
3507 it
->region_end_charpos
,
3510 + TEXT_PROP_DISTANCE_LIMIT
),
3511 0, it
->base_face_id
);
3513 /* Is this a start of a run of characters with box face?
3514 Caveat: this can be called for a freshly initialized
3515 iterator; face_id is -1 in this case. We know that the new
3516 face will not change until limit, i.e. if the new face has a
3517 box, all characters up to limit will have one. But, as
3518 usual, we don't know whether limit is really the end. */
3519 if (new_face_id
!= it
->face_id
)
3521 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3523 /* If new face has a box but old face has not, this is
3524 the start of a run of characters with box, i.e. it has
3525 a shadow on the left side. The value of face_id of the
3526 iterator will be -1 if this is the initial call that gets
3527 the face. In this case, we have to look in front of IT's
3528 position and see whether there is a face != new_face_id. */
3529 it
->start_of_box_run_p
3530 = (new_face
->box
!= FACE_NO_BOX
3531 && (it
->face_id
>= 0
3532 || IT_CHARPOS (*it
) == BEG
3533 || new_face_id
!= face_before_it_pos (it
)));
3534 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3539 int base_face_id
, bufpos
;
3541 Lisp_Object from_overlay
3542 = (it
->current
.overlay_string_index
>= 0
3543 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3546 /* See if we got to this string directly or indirectly from
3547 an overlay property. That includes the before-string or
3548 after-string of an overlay, strings in display properties
3549 provided by an overlay, their text properties, etc.
3551 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3552 if (! NILP (from_overlay
))
3553 for (i
= it
->sp
- 1; i
>= 0; i
--)
3555 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3557 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3558 else if (! NILP (it
->stack
[i
].from_overlay
))
3559 from_overlay
= it
->stack
[i
].from_overlay
;
3561 if (!NILP (from_overlay
))
3565 if (! NILP (from_overlay
))
3567 bufpos
= IT_CHARPOS (*it
);
3568 /* For a string from an overlay, the base face depends
3569 only on text properties and ignores overlays. */
3571 = face_for_overlay_string (it
->w
,
3573 it
->region_beg_charpos
,
3574 it
->region_end_charpos
,
3577 + TEXT_PROP_DISTANCE_LIMIT
),
3585 /* For strings from a `display' property, use the face at
3586 IT's current buffer position as the base face to merge
3587 with, so that overlay strings appear in the same face as
3588 surrounding text, unless they specify their own
3590 base_face_id
= underlying_face_id (it
);
3593 new_face_id
= face_at_string_position (it
->w
,
3595 IT_STRING_CHARPOS (*it
),
3597 it
->region_beg_charpos
,
3598 it
->region_end_charpos
,
3602 /* Is this a start of a run of characters with box? Caveat:
3603 this can be called for a freshly allocated iterator; face_id
3604 is -1 is this case. We know that the new face will not
3605 change until the next check pos, i.e. if the new face has a
3606 box, all characters up to that position will have a
3607 box. But, as usual, we don't know whether that position
3608 is really the end. */
3609 if (new_face_id
!= it
->face_id
)
3611 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3612 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3614 /* If new face has a box but old face hasn't, this is the
3615 start of a run of characters with box, i.e. it has a
3616 shadow on the left side. */
3617 it
->start_of_box_run_p
3618 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3619 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3623 it
->face_id
= new_face_id
;
3624 return HANDLED_NORMALLY
;
3628 /* Return the ID of the face ``underlying'' IT's current position,
3629 which is in a string. If the iterator is associated with a
3630 buffer, return the face at IT's current buffer position.
3631 Otherwise, use the iterator's base_face_id. */
3634 underlying_face_id (it
)
3637 int face_id
= it
->base_face_id
, i
;
3639 xassert (STRINGP (it
->string
));
3641 for (i
= it
->sp
- 1; i
>= 0; --i
)
3642 if (NILP (it
->stack
[i
].string
))
3643 face_id
= it
->stack
[i
].face_id
;
3649 /* Compute the face one character before or after the current position
3650 of IT. BEFORE_P non-zero means get the face in front of IT's
3651 position. Value is the id of the face. */
3654 face_before_or_after_it_pos (it
, before_p
)
3659 EMACS_INT next_check_charpos
;
3660 struct text_pos pos
;
3662 xassert (it
->s
== NULL
);
3664 if (STRINGP (it
->string
))
3666 int bufpos
, base_face_id
;
3668 /* No face change past the end of the string (for the case
3669 we are padding with spaces). No face change before the
3671 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3672 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3675 /* Set pos to the position before or after IT's current position. */
3677 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3679 /* For composition, we must check the character after the
3681 pos
= (it
->what
== IT_COMPOSITION
3682 ? string_pos (IT_STRING_CHARPOS (*it
)
3683 + it
->cmp_it
.nchars
, it
->string
)
3684 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3686 if (it
->current
.overlay_string_index
>= 0)
3687 bufpos
= IT_CHARPOS (*it
);
3691 base_face_id
= underlying_face_id (it
);
3693 /* Get the face for ASCII, or unibyte. */
3694 face_id
= face_at_string_position (it
->w
,
3698 it
->region_beg_charpos
,
3699 it
->region_end_charpos
,
3700 &next_check_charpos
,
3703 /* Correct the face for charsets different from ASCII. Do it
3704 for the multibyte case only. The face returned above is
3705 suitable for unibyte text if IT->string is unibyte. */
3706 if (STRING_MULTIBYTE (it
->string
))
3708 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3709 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3711 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3713 c
= string_char_and_length (p
, &len
);
3714 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3719 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3720 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3723 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3724 pos
= it
->current
.pos
;
3727 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3730 if (it
->what
== IT_COMPOSITION
)
3731 /* For composition, we must check the position after the
3733 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3735 INC_TEXT_POS (pos
, it
->multibyte_p
);
3738 /* Determine face for CHARSET_ASCII, or unibyte. */
3739 face_id
= face_at_buffer_position (it
->w
,
3741 it
->region_beg_charpos
,
3742 it
->region_end_charpos
,
3743 &next_check_charpos
,
3746 /* Correct the face for charsets different from ASCII. Do it
3747 for the multibyte case only. The face returned above is
3748 suitable for unibyte text if current_buffer is unibyte. */
3749 if (it
->multibyte_p
)
3751 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3752 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3753 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3762 /***********************************************************************
3764 ***********************************************************************/
3766 /* Set up iterator IT from invisible properties at its current
3767 position. Called from handle_stop. */
3769 static enum prop_handled
3770 handle_invisible_prop (it
)
3773 enum prop_handled handled
= HANDLED_NORMALLY
;
3775 if (STRINGP (it
->string
))
3777 extern Lisp_Object Qinvisible
;
3778 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3780 /* Get the value of the invisible text property at the
3781 current position. Value will be nil if there is no such
3783 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3784 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3787 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3789 handled
= HANDLED_RECOMPUTE_PROPS
;
3791 /* Get the position at which the next change of the
3792 invisible text property can be found in IT->string.
3793 Value will be nil if the property value is the same for
3794 all the rest of IT->string. */
3795 XSETINT (limit
, SCHARS (it
->string
));
3796 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3799 /* Text at current position is invisible. The next
3800 change in the property is at position end_charpos.
3801 Move IT's current position to that position. */
3802 if (INTEGERP (end_charpos
)
3803 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3805 struct text_pos old
;
3806 old
= it
->current
.string_pos
;
3807 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3808 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3812 /* The rest of the string is invisible. If this is an
3813 overlay string, proceed with the next overlay string
3814 or whatever comes and return a character from there. */
3815 if (it
->current
.overlay_string_index
>= 0)
3817 next_overlay_string (it
);
3818 /* Don't check for overlay strings when we just
3819 finished processing them. */
3820 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3824 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3825 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3833 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3834 Lisp_Object pos
, prop
, overlay
;
3836 /* First of all, is there invisible text at this position? */
3837 tem
= start_charpos
= IT_CHARPOS (*it
);
3838 pos
= make_number (tem
);
3839 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3841 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3843 /* If we are on invisible text, skip over it. */
3844 if (invis_p
&& start_charpos
< it
->end_charpos
)
3846 /* Record whether we have to display an ellipsis for the
3848 int display_ellipsis_p
= invis_p
== 2;
3850 handled
= HANDLED_RECOMPUTE_PROPS
;
3852 /* Loop skipping over invisible text. The loop is left at
3853 ZV or with IT on the first char being visible again. */
3856 /* Try to skip some invisible text. Return value is the
3857 position reached which can be equal to where we start
3858 if there is nothing invisible there. This skips both
3859 over invisible text properties and overlays with
3860 invisible property. */
3861 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3863 /* If we skipped nothing at all we weren't at invisible
3864 text in the first place. If everything to the end of
3865 the buffer was skipped, end the loop. */
3866 if (newpos
== tem
|| newpos
>= ZV
)
3870 /* We skipped some characters but not necessarily
3871 all there are. Check if we ended up on visible
3872 text. Fget_char_property returns the property of
3873 the char before the given position, i.e. if we
3874 get invis_p = 0, this means that the char at
3875 newpos is visible. */
3876 pos
= make_number (newpos
);
3877 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3878 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3881 /* If we ended up on invisible text, proceed to
3882 skip starting with next_stop. */
3886 /* If there are adjacent invisible texts, don't lose the
3887 second one's ellipsis. */
3889 display_ellipsis_p
= 1;
3893 /* The position newpos is now either ZV or on visible text. */
3894 if (it
->bidi_p
&& newpos
< ZV
)
3896 /* With bidi iteration, the region of invisible text
3897 could start and/or end in the middle of a non-base
3898 embedding level. Therefore, we need to skip
3899 invisible text using the bidi iterator, starting at
3900 IT's current position, until we find ourselves
3901 outside the invisible text. Skipping invisible text
3902 _after_ bidi iteration avoids affecting the visual
3903 order of the displayed text when invisible properties
3904 are added or removed. */
3905 if (it
->bidi_it
.first_elt
)
3907 /* If we were `reseat'ed to a new paragraph,
3908 determine the paragraph base direction. We need
3909 to do it now because next_element_from_buffer may
3910 not have a chance to do it, if we are going to
3911 skip any text at the beginning, which resets the
3913 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3917 bidi_get_next_char_visually (&it
->bidi_it
);
3919 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3920 && it
->bidi_it
.charpos
< newpos
);
3921 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3922 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3923 /* If we overstepped NEWPOS, record its position in the
3924 iterator, so that we skip invisible text if later the
3925 bidi iteration lands us in the invisible region
3927 if (IT_CHARPOS (*it
) >= newpos
)
3928 it
->prev_stop
= newpos
;
3932 IT_CHARPOS (*it
) = newpos
;
3933 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3936 /* If there are before-strings at the start of invisible
3937 text, and the text is invisible because of a text
3938 property, arrange to show before-strings because 20.x did
3939 it that way. (If the text is invisible because of an
3940 overlay property instead of a text property, this is
3941 already handled in the overlay code.) */
3943 && get_overlay_strings (it
, it
->stop_charpos
))
3945 handled
= HANDLED_RECOMPUTE_PROPS
;
3946 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3948 else if (display_ellipsis_p
)
3950 /* Make sure that the glyphs of the ellipsis will get
3951 correct `charpos' values. If we would not update
3952 it->position here, the glyphs would belong to the
3953 last visible character _before_ the invisible
3954 text, which confuses `set_cursor_from_row'.
3956 We use the last invisible position instead of the
3957 first because this way the cursor is always drawn on
3958 the first "." of the ellipsis, whenever PT is inside
3959 the invisible text. Otherwise the cursor would be
3960 placed _after_ the ellipsis when the point is after the
3961 first invisible character. */
3962 if (!STRINGP (it
->object
))
3964 it
->position
.charpos
= newpos
- 1;
3965 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3968 /* Let the ellipsis display before
3969 considering any properties of the following char.
3970 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3971 handled
= HANDLED_RETURN
;
3980 /* Make iterator IT return `...' next.
3981 Replaces LEN characters from buffer. */
3984 setup_for_ellipsis (it
, len
)
3988 /* Use the display table definition for `...'. Invalid glyphs
3989 will be handled by the method returning elements from dpvec. */
3990 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3992 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3993 it
->dpvec
= v
->contents
;
3994 it
->dpend
= v
->contents
+ v
->size
;
3998 /* Default `...'. */
3999 it
->dpvec
= default_invis_vector
;
4000 it
->dpend
= default_invis_vector
+ 3;
4003 it
->dpvec_char_len
= len
;
4004 it
->current
.dpvec_index
= 0;
4005 it
->dpvec_face_id
= -1;
4007 /* Remember the current face id in case glyphs specify faces.
4008 IT's face is restored in set_iterator_to_next.
4009 saved_face_id was set to preceding char's face in handle_stop. */
4010 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4011 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4013 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4019 /***********************************************************************
4021 ***********************************************************************/
4023 /* Set up iterator IT from `display' property at its current position.
4024 Called from handle_stop.
4025 We return HANDLED_RETURN if some part of the display property
4026 overrides the display of the buffer text itself.
4027 Otherwise we return HANDLED_NORMALLY. */
4029 static enum prop_handled
4030 handle_display_prop (it
)
4033 Lisp_Object prop
, object
, overlay
;
4034 struct text_pos
*position
;
4035 /* Nonzero if some property replaces the display of the text itself. */
4036 int display_replaced_p
= 0;
4038 if (STRINGP (it
->string
))
4040 object
= it
->string
;
4041 position
= &it
->current
.string_pos
;
4045 XSETWINDOW (object
, it
->w
);
4046 position
= &it
->current
.pos
;
4049 /* Reset those iterator values set from display property values. */
4050 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4051 it
->space_width
= Qnil
;
4052 it
->font_height
= Qnil
;
4055 /* We don't support recursive `display' properties, i.e. string
4056 values that have a string `display' property, that have a string
4057 `display' property etc. */
4058 if (!it
->string_from_display_prop_p
)
4059 it
->area
= TEXT_AREA
;
4061 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
4062 Qdisplay
, object
, &overlay
);
4064 return HANDLED_NORMALLY
;
4065 /* Now OVERLAY is the overlay that gave us this property, or nil
4066 if it was a text property. */
4068 if (!STRINGP (it
->string
))
4069 object
= it
->w
->buffer
;
4072 /* Simple properties. */
4073 && !EQ (XCAR (prop
), Qimage
)
4074 && !EQ (XCAR (prop
), Qspace
)
4075 && !EQ (XCAR (prop
), Qwhen
)
4076 && !EQ (XCAR (prop
), Qslice
)
4077 && !EQ (XCAR (prop
), Qspace_width
)
4078 && !EQ (XCAR (prop
), Qheight
)
4079 && !EQ (XCAR (prop
), Qraise
)
4080 /* Marginal area specifications. */
4081 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
4082 && !EQ (XCAR (prop
), Qleft_fringe
)
4083 && !EQ (XCAR (prop
), Qright_fringe
)
4084 && !NILP (XCAR (prop
)))
4086 for (; CONSP (prop
); prop
= XCDR (prop
))
4088 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4089 position
, display_replaced_p
))
4091 display_replaced_p
= 1;
4092 /* If some text in a string is replaced, `position' no
4093 longer points to the position of `object'. */
4094 if (STRINGP (object
))
4099 else if (VECTORP (prop
))
4102 for (i
= 0; i
< ASIZE (prop
); ++i
)
4103 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4104 position
, display_replaced_p
))
4106 display_replaced_p
= 1;
4107 /* If some text in a string is replaced, `position' no
4108 longer points to the position of `object'. */
4109 if (STRINGP (object
))
4115 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4117 display_replaced_p
= 1;
4120 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4124 /* Value is the position of the end of the `display' property starting
4125 at START_POS in OBJECT. */
4127 static struct text_pos
4128 display_prop_end (it
, object
, start_pos
)
4131 struct text_pos start_pos
;
4134 struct text_pos end_pos
;
4136 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4137 Qdisplay
, object
, Qnil
);
4138 CHARPOS (end_pos
) = XFASTINT (end
);
4139 if (STRINGP (object
))
4140 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4142 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4148 /* Set up IT from a single `display' specification PROP. OBJECT
4149 is the object in which the `display' property was found. *POSITION
4150 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4151 means that we previously saw a display specification which already
4152 replaced text display with something else, for example an image;
4153 we ignore such properties after the first one has been processed.
4155 OVERLAY is the overlay this `display' property came from,
4156 or nil if it was a text property.
4158 If PROP is a `space' or `image' specification, and in some other
4159 cases too, set *POSITION to the position where the `display'
4162 Value is non-zero if something was found which replaces the display
4163 of buffer or string text. */
4166 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4167 display_replaced_before_p
)
4171 Lisp_Object overlay
;
4172 struct text_pos
*position
;
4173 int display_replaced_before_p
;
4176 Lisp_Object location
, value
;
4177 struct text_pos start_pos
, save_pos
;
4180 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4181 If the result is non-nil, use VALUE instead of SPEC. */
4183 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4192 if (!NILP (form
) && !EQ (form
, Qt
))
4194 int count
= SPECPDL_INDEX ();
4195 struct gcpro gcpro1
;
4197 /* Bind `object' to the object having the `display' property, a
4198 buffer or string. Bind `position' to the position in the
4199 object where the property was found, and `buffer-position'
4200 to the current position in the buffer. */
4201 specbind (Qobject
, object
);
4202 specbind (Qposition
, make_number (CHARPOS (*position
)));
4203 specbind (Qbuffer_position
,
4204 make_number (STRINGP (object
)
4205 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4207 form
= safe_eval (form
);
4209 unbind_to (count
, Qnil
);
4215 /* Handle `(height HEIGHT)' specifications. */
4217 && EQ (XCAR (spec
), Qheight
)
4218 && CONSP (XCDR (spec
)))
4220 if (!FRAME_WINDOW_P (it
->f
))
4223 it
->font_height
= XCAR (XCDR (spec
));
4224 if (!NILP (it
->font_height
))
4226 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4227 int new_height
= -1;
4229 if (CONSP (it
->font_height
)
4230 && (EQ (XCAR (it
->font_height
), Qplus
)
4231 || EQ (XCAR (it
->font_height
), Qminus
))
4232 && CONSP (XCDR (it
->font_height
))
4233 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4235 /* `(+ N)' or `(- N)' where N is an integer. */
4236 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4237 if (EQ (XCAR (it
->font_height
), Qplus
))
4239 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4241 else if (FUNCTIONP (it
->font_height
))
4243 /* Call function with current height as argument.
4244 Value is the new height. */
4246 height
= safe_call1 (it
->font_height
,
4247 face
->lface
[LFACE_HEIGHT_INDEX
]);
4248 if (NUMBERP (height
))
4249 new_height
= XFLOATINT (height
);
4251 else if (NUMBERP (it
->font_height
))
4253 /* Value is a multiple of the canonical char height. */
4256 face
= FACE_FROM_ID (it
->f
,
4257 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4258 new_height
= (XFLOATINT (it
->font_height
)
4259 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4263 /* Evaluate IT->font_height with `height' bound to the
4264 current specified height to get the new height. */
4265 int count
= SPECPDL_INDEX ();
4267 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4268 value
= safe_eval (it
->font_height
);
4269 unbind_to (count
, Qnil
);
4271 if (NUMBERP (value
))
4272 new_height
= XFLOATINT (value
);
4276 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4282 /* Handle `(space-width WIDTH)'. */
4284 && EQ (XCAR (spec
), Qspace_width
)
4285 && CONSP (XCDR (spec
)))
4287 if (!FRAME_WINDOW_P (it
->f
))
4290 value
= XCAR (XCDR (spec
));
4291 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4292 it
->space_width
= value
;
4297 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4299 && EQ (XCAR (spec
), Qslice
))
4303 if (!FRAME_WINDOW_P (it
->f
))
4306 if (tem
= XCDR (spec
), CONSP (tem
))
4308 it
->slice
.x
= XCAR (tem
);
4309 if (tem
= XCDR (tem
), CONSP (tem
))
4311 it
->slice
.y
= XCAR (tem
);
4312 if (tem
= XCDR (tem
), CONSP (tem
))
4314 it
->slice
.width
= XCAR (tem
);
4315 if (tem
= XCDR (tem
), CONSP (tem
))
4316 it
->slice
.height
= XCAR (tem
);
4324 /* Handle `(raise FACTOR)'. */
4326 && EQ (XCAR (spec
), Qraise
)
4327 && CONSP (XCDR (spec
)))
4329 if (!FRAME_WINDOW_P (it
->f
))
4332 #ifdef HAVE_WINDOW_SYSTEM
4333 value
= XCAR (XCDR (spec
));
4334 if (NUMBERP (value
))
4336 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4337 it
->voffset
= - (XFLOATINT (value
)
4338 * (FONT_HEIGHT (face
->font
)));
4340 #endif /* HAVE_WINDOW_SYSTEM */
4345 /* Don't handle the other kinds of display specifications
4346 inside a string that we got from a `display' property. */
4347 if (it
->string_from_display_prop_p
)
4350 /* Characters having this form of property are not displayed, so
4351 we have to find the end of the property. */
4352 start_pos
= *position
;
4353 *position
= display_prop_end (it
, object
, start_pos
);
4356 /* Stop the scan at that end position--we assume that all
4357 text properties change there. */
4358 it
->stop_charpos
= position
->charpos
;
4360 /* Handle `(left-fringe BITMAP [FACE])'
4361 and `(right-fringe BITMAP [FACE])'. */
4363 && (EQ (XCAR (spec
), Qleft_fringe
)
4364 || EQ (XCAR (spec
), Qright_fringe
))
4365 && CONSP (XCDR (spec
)))
4367 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4370 if (!FRAME_WINDOW_P (it
->f
))
4371 /* If we return here, POSITION has been advanced
4372 across the text with this property. */
4375 #ifdef HAVE_WINDOW_SYSTEM
4376 value
= XCAR (XCDR (spec
));
4377 if (!SYMBOLP (value
)
4378 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4379 /* If we return here, POSITION has been advanced
4380 across the text with this property. */
4383 if (CONSP (XCDR (XCDR (spec
))))
4385 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4386 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4392 /* Save current settings of IT so that we can restore them
4393 when we are finished with the glyph property value. */
4395 save_pos
= it
->position
;
4396 it
->position
= *position
;
4398 it
->position
= save_pos
;
4400 it
->area
= TEXT_AREA
;
4401 it
->what
= IT_IMAGE
;
4402 it
->image_id
= -1; /* no image */
4403 it
->position
= start_pos
;
4404 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4405 it
->method
= GET_FROM_IMAGE
;
4406 it
->from_overlay
= Qnil
;
4407 it
->face_id
= face_id
;
4409 /* Say that we haven't consumed the characters with
4410 `display' property yet. The call to pop_it in
4411 set_iterator_to_next will clean this up. */
4412 *position
= start_pos
;
4414 if (EQ (XCAR (spec
), Qleft_fringe
))
4416 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4417 it
->left_user_fringe_face_id
= face_id
;
4421 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4422 it
->right_user_fringe_face_id
= face_id
;
4424 #endif /* HAVE_WINDOW_SYSTEM */
4428 /* Prepare to handle `((margin left-margin) ...)',
4429 `((margin right-margin) ...)' and `((margin nil) ...)'
4430 prefixes for display specifications. */
4431 location
= Qunbound
;
4432 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4436 value
= XCDR (spec
);
4438 value
= XCAR (value
);
4441 if (EQ (XCAR (tem
), Qmargin
)
4442 && (tem
= XCDR (tem
),
4443 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4445 || EQ (tem
, Qleft_margin
)
4446 || EQ (tem
, Qright_margin
))))
4450 if (EQ (location
, Qunbound
))
4456 /* After this point, VALUE is the property after any
4457 margin prefix has been stripped. It must be a string,
4458 an image specification, or `(space ...)'.
4460 LOCATION specifies where to display: `left-margin',
4461 `right-margin' or nil. */
4463 valid_p
= (STRINGP (value
)
4464 #ifdef HAVE_WINDOW_SYSTEM
4465 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4466 #endif /* not HAVE_WINDOW_SYSTEM */
4467 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4469 if (valid_p
&& !display_replaced_before_p
)
4471 /* Save current settings of IT so that we can restore them
4472 when we are finished with the glyph property value. */
4473 save_pos
= it
->position
;
4474 it
->position
= *position
;
4476 it
->position
= save_pos
;
4477 it
->from_overlay
= overlay
;
4479 if (NILP (location
))
4480 it
->area
= TEXT_AREA
;
4481 else if (EQ (location
, Qleft_margin
))
4482 it
->area
= LEFT_MARGIN_AREA
;
4484 it
->area
= RIGHT_MARGIN_AREA
;
4486 if (STRINGP (value
))
4489 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4490 it
->current
.overlay_string_index
= -1;
4491 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4492 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4493 it
->method
= GET_FROM_STRING
;
4494 it
->stop_charpos
= 0;
4495 it
->string_from_display_prop_p
= 1;
4496 /* Say that we haven't consumed the characters with
4497 `display' property yet. The call to pop_it in
4498 set_iterator_to_next will clean this up. */
4499 if (BUFFERP (object
))
4500 *position
= start_pos
;
4502 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4504 it
->method
= GET_FROM_STRETCH
;
4506 *position
= it
->position
= start_pos
;
4508 #ifdef HAVE_WINDOW_SYSTEM
4511 it
->what
= IT_IMAGE
;
4512 it
->image_id
= lookup_image (it
->f
, value
);
4513 it
->position
= start_pos
;
4514 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4515 it
->method
= GET_FROM_IMAGE
;
4517 /* Say that we haven't consumed the characters with
4518 `display' property yet. The call to pop_it in
4519 set_iterator_to_next will clean this up. */
4520 *position
= start_pos
;
4522 #endif /* HAVE_WINDOW_SYSTEM */
4527 /* Invalid property or property not supported. Restore
4528 POSITION to what it was before. */
4529 *position
= start_pos
;
4534 /* Check if SPEC is a display sub-property value whose text should be
4535 treated as intangible. */
4538 single_display_spec_intangible_p (prop
)
4541 /* Skip over `when FORM'. */
4542 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4556 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4557 we don't need to treat text as intangible. */
4558 if (EQ (XCAR (prop
), Qmargin
))
4566 || EQ (XCAR (prop
), Qleft_margin
)
4567 || EQ (XCAR (prop
), Qright_margin
))
4571 return (CONSP (prop
)
4572 && (EQ (XCAR (prop
), Qimage
)
4573 || EQ (XCAR (prop
), Qspace
)));
4577 /* Check if PROP is a display property value whose text should be
4578 treated as intangible. */
4581 display_prop_intangible_p (prop
)
4585 && CONSP (XCAR (prop
))
4586 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4588 /* A list of sub-properties. */
4589 while (CONSP (prop
))
4591 if (single_display_spec_intangible_p (XCAR (prop
)))
4596 else if (VECTORP (prop
))
4598 /* A vector of sub-properties. */
4600 for (i
= 0; i
< ASIZE (prop
); ++i
)
4601 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4605 return single_display_spec_intangible_p (prop
);
4611 /* Return 1 if PROP is a display sub-property value containing STRING. */
4614 single_display_spec_string_p (prop
, string
)
4615 Lisp_Object prop
, string
;
4617 if (EQ (string
, prop
))
4620 /* Skip over `when FORM'. */
4621 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4630 /* Skip over `margin LOCATION'. */
4631 if (EQ (XCAR (prop
), Qmargin
))
4642 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4646 /* Return 1 if STRING appears in the `display' property PROP. */
4649 display_prop_string_p (prop
, string
)
4650 Lisp_Object prop
, string
;
4653 && CONSP (XCAR (prop
))
4654 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4656 /* A list of sub-properties. */
4657 while (CONSP (prop
))
4659 if (single_display_spec_string_p (XCAR (prop
), string
))
4664 else if (VECTORP (prop
))
4666 /* A vector of sub-properties. */
4668 for (i
= 0; i
< ASIZE (prop
); ++i
)
4669 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4673 return single_display_spec_string_p (prop
, string
);
4678 /* Look for STRING in overlays and text properties in W's buffer,
4679 between character positions FROM and TO (excluding TO).
4680 BACK_P non-zero means look back (in this case, TO is supposed to be
4682 Value is the first character position where STRING was found, or
4683 zero if it wasn't found before hitting TO.
4685 W's buffer must be current.
4687 This function may only use code that doesn't eval because it is
4688 called asynchronously from note_mouse_highlight. */
4691 string_buffer_position_lim (w
, string
, from
, to
, back_p
)
4697 Lisp_Object limit
, prop
, pos
;
4700 pos
= make_number (from
);
4702 if (!back_p
) /* looking forward */
4704 limit
= make_number (min (to
, ZV
));
4705 while (!found
&& !EQ (pos
, limit
))
4707 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4708 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4711 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4715 else /* looking back */
4717 limit
= make_number (max (to
, BEGV
));
4718 while (!found
&& !EQ (pos
, limit
))
4720 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4721 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4724 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4729 return found
? XINT (pos
) : 0;
4732 /* Determine which buffer position in W's buffer STRING comes from.
4733 AROUND_CHARPOS is an approximate position where it could come from.
4734 Value is the buffer position or 0 if it couldn't be determined.
4736 W's buffer must be current.
4738 This function is necessary because we don't record buffer positions
4739 in glyphs generated from strings (to keep struct glyph small).
4740 This function may only use code that doesn't eval because it is
4741 called asynchronously from note_mouse_highlight. */
4744 string_buffer_position (w
, string
, around_charpos
)
4747 EMACS_INT around_charpos
;
4749 Lisp_Object limit
, prop
, pos
;
4750 const int MAX_DISTANCE
= 1000;
4751 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4752 around_charpos
+ MAX_DISTANCE
,
4756 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4757 around_charpos
- MAX_DISTANCE
, 1);
4763 /***********************************************************************
4764 `composition' property
4765 ***********************************************************************/
4767 /* Set up iterator IT from `composition' property at its current
4768 position. Called from handle_stop. */
4770 static enum prop_handled
4771 handle_composition_prop (it
)
4774 Lisp_Object prop
, string
;
4775 EMACS_INT pos
, pos_byte
, start
, end
;
4777 if (STRINGP (it
->string
))
4781 pos
= IT_STRING_CHARPOS (*it
);
4782 pos_byte
= IT_STRING_BYTEPOS (*it
);
4783 string
= it
->string
;
4784 s
= SDATA (string
) + pos_byte
;
4785 it
->c
= STRING_CHAR (s
);
4789 pos
= IT_CHARPOS (*it
);
4790 pos_byte
= IT_BYTEPOS (*it
);
4792 it
->c
= FETCH_CHAR (pos_byte
);
4795 /* If there's a valid composition and point is not inside of the
4796 composition (in the case that the composition is from the current
4797 buffer), draw a glyph composed from the composition components. */
4798 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4799 && COMPOSITION_VALID_P (start
, end
, prop
)
4800 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4804 if (STRINGP (it
->string
))
4805 pos_byte
= string_char_to_byte (it
->string
, start
);
4807 pos_byte
= CHAR_TO_BYTE (start
);
4809 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4812 if (it
->cmp_it
.id
>= 0)
4815 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4816 it
->cmp_it
.nglyphs
= -1;
4820 return HANDLED_NORMALLY
;
4825 /***********************************************************************
4827 ***********************************************************************/
4829 /* The following structure is used to record overlay strings for
4830 later sorting in load_overlay_strings. */
4832 struct overlay_entry
4834 Lisp_Object overlay
;
4841 /* Set up iterator IT from overlay strings at its current position.
4842 Called from handle_stop. */
4844 static enum prop_handled
4845 handle_overlay_change (it
)
4848 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4849 return HANDLED_RECOMPUTE_PROPS
;
4851 return HANDLED_NORMALLY
;
4855 /* Set up the next overlay string for delivery by IT, if there is an
4856 overlay string to deliver. Called by set_iterator_to_next when the
4857 end of the current overlay string is reached. If there are more
4858 overlay strings to display, IT->string and
4859 IT->current.overlay_string_index are set appropriately here.
4860 Otherwise IT->string is set to nil. */
4863 next_overlay_string (it
)
4866 ++it
->current
.overlay_string_index
;
4867 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4869 /* No more overlay strings. Restore IT's settings to what
4870 they were before overlay strings were processed, and
4871 continue to deliver from current_buffer. */
4873 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4876 || (NILP (it
->string
)
4877 && it
->method
== GET_FROM_BUFFER
4878 && it
->stop_charpos
>= BEGV
4879 && it
->stop_charpos
<= it
->end_charpos
));
4880 it
->current
.overlay_string_index
= -1;
4881 it
->n_overlay_strings
= 0;
4883 /* If we're at the end of the buffer, record that we have
4884 processed the overlay strings there already, so that
4885 next_element_from_buffer doesn't try it again. */
4886 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4887 it
->overlay_strings_at_end_processed_p
= 1;
4891 /* There are more overlay strings to process. If
4892 IT->current.overlay_string_index has advanced to a position
4893 where we must load IT->overlay_strings with more strings, do
4895 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4897 if (it
->current
.overlay_string_index
&& i
== 0)
4898 load_overlay_strings (it
, 0);
4900 /* Initialize IT to deliver display elements from the overlay
4902 it
->string
= it
->overlay_strings
[i
];
4903 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4904 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4905 it
->method
= GET_FROM_STRING
;
4906 it
->stop_charpos
= 0;
4907 if (it
->cmp_it
.stop_pos
>= 0)
4908 it
->cmp_it
.stop_pos
= 0;
4915 /* Compare two overlay_entry structures E1 and E2. Used as a
4916 comparison function for qsort in load_overlay_strings. Overlay
4917 strings for the same position are sorted so that
4919 1. All after-strings come in front of before-strings, except
4920 when they come from the same overlay.
4922 2. Within after-strings, strings are sorted so that overlay strings
4923 from overlays with higher priorities come first.
4925 2. Within before-strings, strings are sorted so that overlay
4926 strings from overlays with higher priorities come last.
4928 Value is analogous to strcmp. */
4932 compare_overlay_entries (e1
, e2
)
4935 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4936 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4939 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4941 /* Let after-strings appear in front of before-strings if
4942 they come from different overlays. */
4943 if (EQ (entry1
->overlay
, entry2
->overlay
))
4944 result
= entry1
->after_string_p
? 1 : -1;
4946 result
= entry1
->after_string_p
? -1 : 1;
4948 else if (entry1
->after_string_p
)
4949 /* After-strings sorted in order of decreasing priority. */
4950 result
= entry2
->priority
- entry1
->priority
;
4952 /* Before-strings sorted in order of increasing priority. */
4953 result
= entry1
->priority
- entry2
->priority
;
4959 /* Load the vector IT->overlay_strings with overlay strings from IT's
4960 current buffer position, or from CHARPOS if that is > 0. Set
4961 IT->n_overlays to the total number of overlay strings found.
4963 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4964 a time. On entry into load_overlay_strings,
4965 IT->current.overlay_string_index gives the number of overlay
4966 strings that have already been loaded by previous calls to this
4969 IT->add_overlay_start contains an additional overlay start
4970 position to consider for taking overlay strings from, if non-zero.
4971 This position comes into play when the overlay has an `invisible'
4972 property, and both before and after-strings. When we've skipped to
4973 the end of the overlay, because of its `invisible' property, we
4974 nevertheless want its before-string to appear.
4975 IT->add_overlay_start will contain the overlay start position
4978 Overlay strings are sorted so that after-string strings come in
4979 front of before-string strings. Within before and after-strings,
4980 strings are sorted by overlay priority. See also function
4981 compare_overlay_entries. */
4984 load_overlay_strings (it
, charpos
)
4988 extern Lisp_Object Qwindow
, Qpriority
;
4989 Lisp_Object overlay
, window
, str
, invisible
;
4990 struct Lisp_Overlay
*ov
;
4993 int n
= 0, i
, j
, invis_p
;
4994 struct overlay_entry
*entries
4995 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4998 charpos
= IT_CHARPOS (*it
);
5000 /* Append the overlay string STRING of overlay OVERLAY to vector
5001 `entries' which has size `size' and currently contains `n'
5002 elements. AFTER_P non-zero means STRING is an after-string of
5004 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5007 Lisp_Object priority; \
5011 int new_size = 2 * size; \
5012 struct overlay_entry *old = entries; \
5014 (struct overlay_entry *) alloca (new_size \
5015 * sizeof *entries); \
5016 bcopy (old, entries, size * sizeof *entries); \
5020 entries[n].string = (STRING); \
5021 entries[n].overlay = (OVERLAY); \
5022 priority = Foverlay_get ((OVERLAY), Qpriority); \
5023 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5024 entries[n].after_string_p = (AFTER_P); \
5029 /* Process overlay before the overlay center. */
5030 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5032 XSETMISC (overlay
, ov
);
5033 xassert (OVERLAYP (overlay
));
5034 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5035 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5040 /* Skip this overlay if it doesn't start or end at IT's current
5042 if (end
!= charpos
&& start
!= charpos
)
5045 /* Skip this overlay if it doesn't apply to IT->w. */
5046 window
= Foverlay_get (overlay
, Qwindow
);
5047 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5050 /* If the text ``under'' the overlay is invisible, both before-
5051 and after-strings from this overlay are visible; start and
5052 end position are indistinguishable. */
5053 invisible
= Foverlay_get (overlay
, Qinvisible
);
5054 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5056 /* If overlay has a non-empty before-string, record it. */
5057 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5058 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5060 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5062 /* If overlay has a non-empty after-string, record it. */
5063 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5064 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5066 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5069 /* Process overlays after the overlay center. */
5070 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5072 XSETMISC (overlay
, ov
);
5073 xassert (OVERLAYP (overlay
));
5074 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5075 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5077 if (start
> charpos
)
5080 /* Skip this overlay if it doesn't start or end at IT's current
5082 if (end
!= charpos
&& start
!= charpos
)
5085 /* Skip this overlay if it doesn't apply to IT->w. */
5086 window
= Foverlay_get (overlay
, Qwindow
);
5087 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5090 /* If the text ``under'' the overlay is invisible, it has a zero
5091 dimension, and both before- and after-strings apply. */
5092 invisible
= Foverlay_get (overlay
, Qinvisible
);
5093 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5095 /* If overlay has a non-empty before-string, record it. */
5096 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5097 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5099 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5101 /* If overlay has a non-empty after-string, record it. */
5102 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5103 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5105 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5108 #undef RECORD_OVERLAY_STRING
5112 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5114 /* Record the total number of strings to process. */
5115 it
->n_overlay_strings
= n
;
5117 /* IT->current.overlay_string_index is the number of overlay strings
5118 that have already been consumed by IT. Copy some of the
5119 remaining overlay strings to IT->overlay_strings. */
5121 j
= it
->current
.overlay_string_index
;
5122 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5124 it
->overlay_strings
[i
] = entries
[j
].string
;
5125 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5132 /* Get the first chunk of overlay strings at IT's current buffer
5133 position, or at CHARPOS if that is > 0. Value is non-zero if at
5134 least one overlay string was found. */
5137 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5142 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5143 process. This fills IT->overlay_strings with strings, and sets
5144 IT->n_overlay_strings to the total number of strings to process.
5145 IT->pos.overlay_string_index has to be set temporarily to zero
5146 because load_overlay_strings needs this; it must be set to -1
5147 when no overlay strings are found because a zero value would
5148 indicate a position in the first overlay string. */
5149 it
->current
.overlay_string_index
= 0;
5150 load_overlay_strings (it
, charpos
);
5152 /* If we found overlay strings, set up IT to deliver display
5153 elements from the first one. Otherwise set up IT to deliver
5154 from current_buffer. */
5155 if (it
->n_overlay_strings
)
5157 /* Make sure we know settings in current_buffer, so that we can
5158 restore meaningful values when we're done with the overlay
5161 compute_stop_pos (it
);
5162 xassert (it
->face_id
>= 0);
5164 /* Save IT's settings. They are restored after all overlay
5165 strings have been processed. */
5166 xassert (!compute_stop_p
|| it
->sp
== 0);
5168 /* When called from handle_stop, there might be an empty display
5169 string loaded. In that case, don't bother saving it. */
5170 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5173 /* Set up IT to deliver display elements from the first overlay
5175 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5176 it
->string
= it
->overlay_strings
[0];
5177 it
->from_overlay
= Qnil
;
5178 it
->stop_charpos
= 0;
5179 xassert (STRINGP (it
->string
));
5180 it
->end_charpos
= SCHARS (it
->string
);
5181 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5182 it
->method
= GET_FROM_STRING
;
5186 it
->current
.overlay_string_index
= -1;
5191 get_overlay_strings (it
, charpos
)
5196 it
->method
= GET_FROM_BUFFER
;
5198 (void) get_overlay_strings_1 (it
, charpos
, 1);
5202 /* Value is non-zero if we found at least one overlay string. */
5203 return STRINGP (it
->string
);
5208 /***********************************************************************
5209 Saving and restoring state
5210 ***********************************************************************/
5212 /* Save current settings of IT on IT->stack. Called, for example,
5213 before setting up IT for an overlay string, to be able to restore
5214 IT's settings to what they were after the overlay string has been
5221 struct iterator_stack_entry
*p
;
5223 xassert (it
->sp
< IT_STACK_SIZE
);
5224 p
= it
->stack
+ it
->sp
;
5226 p
->stop_charpos
= it
->stop_charpos
;
5227 p
->prev_stop
= it
->prev_stop
;
5228 p
->base_level_stop
= it
->base_level_stop
;
5229 p
->cmp_it
= it
->cmp_it
;
5230 xassert (it
->face_id
>= 0);
5231 p
->face_id
= it
->face_id
;
5232 p
->string
= it
->string
;
5233 p
->method
= it
->method
;
5234 p
->from_overlay
= it
->from_overlay
;
5237 case GET_FROM_IMAGE
:
5238 p
->u
.image
.object
= it
->object
;
5239 p
->u
.image
.image_id
= it
->image_id
;
5240 p
->u
.image
.slice
= it
->slice
;
5242 case GET_FROM_STRETCH
:
5243 p
->u
.stretch
.object
= it
->object
;
5246 p
->position
= it
->position
;
5247 p
->current
= it
->current
;
5248 p
->end_charpos
= it
->end_charpos
;
5249 p
->string_nchars
= it
->string_nchars
;
5251 p
->multibyte_p
= it
->multibyte_p
;
5252 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5253 p
->space_width
= it
->space_width
;
5254 p
->font_height
= it
->font_height
;
5255 p
->voffset
= it
->voffset
;
5256 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5257 p
->display_ellipsis_p
= 0;
5258 p
->line_wrap
= it
->line_wrap
;
5263 iterate_out_of_display_property (it
)
5266 /* Maybe initialize paragraph direction. If we are at the beginning
5267 of a new paragraph, next_element_from_buffer may not have a
5268 chance to do that. */
5269 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5270 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5271 /* prev_stop can be zero, so check against BEGV as well. */
5272 while (it
->bidi_it
.charpos
>= BEGV
5273 && it
->prev_stop
<= it
->bidi_it
.charpos
5274 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5275 bidi_get_next_char_visually (&it
->bidi_it
);
5276 /* Record the stop_pos we just crossed, for when we cross it
5278 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5279 it
->prev_stop
= CHARPOS (it
->position
);
5280 /* If we ended up not where pop_it put us, resync IT's
5281 positional members with the bidi iterator. */
5282 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5284 SET_TEXT_POS (it
->position
,
5285 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5286 it
->current
.pos
= it
->position
;
5290 /* Restore IT's settings from IT->stack. Called, for example, when no
5291 more overlay strings must be processed, and we return to delivering
5292 display elements from a buffer, or when the end of a string from a
5293 `display' property is reached and we return to delivering display
5294 elements from an overlay string, or from a buffer. */
5300 struct iterator_stack_entry
*p
;
5302 xassert (it
->sp
> 0);
5304 p
= it
->stack
+ it
->sp
;
5305 it
->stop_charpos
= p
->stop_charpos
;
5306 it
->prev_stop
= p
->prev_stop
;
5307 it
->base_level_stop
= p
->base_level_stop
;
5308 it
->cmp_it
= p
->cmp_it
;
5309 it
->face_id
= p
->face_id
;
5310 it
->current
= p
->current
;
5311 it
->position
= p
->position
;
5312 it
->string
= p
->string
;
5313 it
->from_overlay
= p
->from_overlay
;
5314 if (NILP (it
->string
))
5315 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5316 it
->method
= p
->method
;
5319 case GET_FROM_IMAGE
:
5320 it
->image_id
= p
->u
.image
.image_id
;
5321 it
->object
= p
->u
.image
.object
;
5322 it
->slice
= p
->u
.image
.slice
;
5324 case GET_FROM_STRETCH
:
5325 it
->object
= p
->u
.comp
.object
;
5327 case GET_FROM_BUFFER
:
5328 it
->object
= it
->w
->buffer
;
5331 /* Bidi-iterate until we get out of the portion of text, if
5332 any, covered by a `display' text property or an overlay
5333 with `display' property. (We cannot just jump there,
5334 because the internal coherency of the bidi iterator state
5335 can not be preserved across such jumps.) We also must
5336 determine the paragraph base direction if the overlay we
5337 just processed is at the beginning of a new
5339 iterate_out_of_display_property (it
);
5342 case GET_FROM_STRING
:
5343 it
->object
= it
->string
;
5345 case GET_FROM_DISPLAY_VECTOR
:
5347 it
->method
= GET_FROM_C_STRING
;
5348 else if (STRINGP (it
->string
))
5349 it
->method
= GET_FROM_STRING
;
5352 it
->method
= GET_FROM_BUFFER
;
5353 it
->object
= it
->w
->buffer
;
5356 it
->end_charpos
= p
->end_charpos
;
5357 it
->string_nchars
= p
->string_nchars
;
5359 it
->multibyte_p
= p
->multibyte_p
;
5360 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5361 it
->space_width
= p
->space_width
;
5362 it
->font_height
= p
->font_height
;
5363 it
->voffset
= p
->voffset
;
5364 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5365 it
->line_wrap
= p
->line_wrap
;
5370 /***********************************************************************
5372 ***********************************************************************/
5374 /* Set IT's current position to the previous line start. */
5377 back_to_previous_line_start (it
)
5380 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5381 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5385 /* Move IT to the next line start.
5387 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5388 we skipped over part of the text (as opposed to moving the iterator
5389 continuously over the text). Otherwise, don't change the value
5392 Newlines may come from buffer text, overlay strings, or strings
5393 displayed via the `display' property. That's the reason we can't
5394 simply use find_next_newline_no_quit.
5396 Note that this function may not skip over invisible text that is so
5397 because of text properties and immediately follows a newline. If
5398 it would, function reseat_at_next_visible_line_start, when called
5399 from set_iterator_to_next, would effectively make invisible
5400 characters following a newline part of the wrong glyph row, which
5401 leads to wrong cursor motion. */
5404 forward_to_next_line_start (it
, skipped_p
)
5408 int old_selective
, newline_found_p
, n
;
5409 const int MAX_NEWLINE_DISTANCE
= 500;
5411 /* If already on a newline, just consume it to avoid unintended
5412 skipping over invisible text below. */
5413 if (it
->what
== IT_CHARACTER
5415 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5417 set_iterator_to_next (it
, 0);
5422 /* Don't handle selective display in the following. It's (a)
5423 unnecessary because it's done by the caller, and (b) leads to an
5424 infinite recursion because next_element_from_ellipsis indirectly
5425 calls this function. */
5426 old_selective
= it
->selective
;
5429 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5430 from buffer text. */
5431 for (n
= newline_found_p
= 0;
5432 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5433 n
+= STRINGP (it
->string
) ? 0 : 1)
5435 if (!get_next_display_element (it
))
5437 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5438 set_iterator_to_next (it
, 0);
5441 /* If we didn't find a newline near enough, see if we can use a
5443 if (!newline_found_p
)
5445 int start
= IT_CHARPOS (*it
);
5446 int limit
= find_next_newline_no_quit (start
, 1);
5449 xassert (!STRINGP (it
->string
));
5451 /* If there isn't any `display' property in sight, and no
5452 overlays, we can just use the position of the newline in
5454 if (it
->stop_charpos
>= limit
5455 || ((pos
= Fnext_single_property_change (make_number (start
),
5457 Qnil
, make_number (limit
)),
5459 && next_overlay_change (start
) == ZV
))
5461 IT_CHARPOS (*it
) = limit
;
5462 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5463 *skipped_p
= newline_found_p
= 1;
5467 while (get_next_display_element (it
)
5468 && !newline_found_p
)
5470 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5471 set_iterator_to_next (it
, 0);
5476 it
->selective
= old_selective
;
5477 return newline_found_p
;
5481 /* Set IT's current position to the previous visible line start. Skip
5482 invisible text that is so either due to text properties or due to
5483 selective display. Caution: this does not change IT->current_x and
5487 back_to_previous_visible_line_start (it
)
5490 while (IT_CHARPOS (*it
) > BEGV
)
5492 back_to_previous_line_start (it
);
5494 if (IT_CHARPOS (*it
) <= BEGV
)
5497 /* If selective > 0, then lines indented more than its value are
5499 if (it
->selective
> 0
5500 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5501 (double) it
->selective
)) /* iftc */
5504 /* Check the newline before point for invisibility. */
5507 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5508 Qinvisible
, it
->window
);
5509 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5513 if (IT_CHARPOS (*it
) <= BEGV
)
5520 Lisp_Object val
, overlay
;
5522 /* If newline is part of a composition, continue from start of composition */
5523 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5524 && beg
< IT_CHARPOS (*it
))
5527 /* If newline is replaced by a display property, find start of overlay
5528 or interval and continue search from that point. */
5530 pos
= --IT_CHARPOS (it2
);
5533 it2
.string_from_display_prop_p
= 0;
5534 if (handle_display_prop (&it2
) == HANDLED_RETURN
5535 && !NILP (val
= get_char_property_and_overlay
5536 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5537 && (OVERLAYP (overlay
)
5538 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5539 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5542 /* Newline is not replaced by anything -- so we are done. */
5548 IT_CHARPOS (*it
) = beg
;
5549 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5553 it
->continuation_lines_width
= 0;
5555 xassert (IT_CHARPOS (*it
) >= BEGV
);
5556 xassert (IT_CHARPOS (*it
) == BEGV
5557 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5562 /* Reseat iterator IT at the previous visible line start. Skip
5563 invisible text that is so either due to text properties or due to
5564 selective display. At the end, update IT's overlay information,
5565 face information etc. */
5568 reseat_at_previous_visible_line_start (it
)
5571 back_to_previous_visible_line_start (it
);
5572 reseat (it
, it
->current
.pos
, 1);
5577 /* Reseat iterator IT on the next visible line start in the current
5578 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5579 preceding the line start. Skip over invisible text that is so
5580 because of selective display. Compute faces, overlays etc at the
5581 new position. Note that this function does not skip over text that
5582 is invisible because of text properties. */
5585 reseat_at_next_visible_line_start (it
, on_newline_p
)
5589 int newline_found_p
, skipped_p
= 0;
5591 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5593 /* Skip over lines that are invisible because they are indented
5594 more than the value of IT->selective. */
5595 if (it
->selective
> 0)
5596 while (IT_CHARPOS (*it
) < ZV
5597 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5598 (double) it
->selective
)) /* iftc */
5600 xassert (IT_BYTEPOS (*it
) == BEGV
5601 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5602 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5605 /* Position on the newline if that's what's requested. */
5606 if (on_newline_p
&& newline_found_p
)
5608 if (STRINGP (it
->string
))
5610 if (IT_STRING_CHARPOS (*it
) > 0)
5612 --IT_STRING_CHARPOS (*it
);
5613 --IT_STRING_BYTEPOS (*it
);
5616 else if (IT_CHARPOS (*it
) > BEGV
)
5620 reseat (it
, it
->current
.pos
, 0);
5624 reseat (it
, it
->current
.pos
, 0);
5631 /***********************************************************************
5632 Changing an iterator's position
5633 ***********************************************************************/
5635 /* Change IT's current position to POS in current_buffer. If FORCE_P
5636 is non-zero, always check for text properties at the new position.
5637 Otherwise, text properties are only looked up if POS >=
5638 IT->check_charpos of a property. */
5641 reseat (it
, pos
, force_p
)
5643 struct text_pos pos
;
5646 int original_pos
= IT_CHARPOS (*it
);
5648 reseat_1 (it
, pos
, 0);
5650 /* Determine where to check text properties. Avoid doing it
5651 where possible because text property lookup is very expensive. */
5653 || CHARPOS (pos
) > it
->stop_charpos
5654 || CHARPOS (pos
) < original_pos
)
5658 /* For bidi iteration, we need to prime prev_stop and
5659 base_level_stop with our best estimations. */
5660 if (CHARPOS (pos
) < it
->prev_stop
)
5662 handle_stop_backwards (it
, BEGV
);
5663 if (CHARPOS (pos
) < it
->base_level_stop
)
5664 it
->base_level_stop
= 0;
5666 else if (CHARPOS (pos
) > it
->stop_charpos
5667 && it
->stop_charpos
>= BEGV
)
5668 handle_stop_backwards (it
, it
->stop_charpos
);
5675 it
->prev_stop
= it
->base_level_stop
= 0;
5684 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5685 IT->stop_pos to POS, also. */
5688 reseat_1 (it
, pos
, set_stop_p
)
5690 struct text_pos pos
;
5693 /* Don't call this function when scanning a C string. */
5694 xassert (it
->s
== NULL
);
5696 /* POS must be a reasonable value. */
5697 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5699 it
->current
.pos
= it
->position
= pos
;
5700 it
->end_charpos
= ZV
;
5702 it
->current
.dpvec_index
= -1;
5703 it
->current
.overlay_string_index
= -1;
5704 IT_STRING_CHARPOS (*it
) = -1;
5705 IT_STRING_BYTEPOS (*it
) = -1;
5707 it
->string_from_display_prop_p
= 0;
5708 it
->method
= GET_FROM_BUFFER
;
5709 it
->object
= it
->w
->buffer
;
5710 it
->area
= TEXT_AREA
;
5711 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5713 it
->string_from_display_prop_p
= 0;
5714 it
->face_before_selective_p
= 0;
5716 it
->bidi_it
.first_elt
= 1;
5720 it
->stop_charpos
= CHARPOS (pos
);
5721 it
->base_level_stop
= CHARPOS (pos
);
5726 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5727 If S is non-null, it is a C string to iterate over. Otherwise,
5728 STRING gives a Lisp string to iterate over.
5730 If PRECISION > 0, don't return more then PRECISION number of
5731 characters from the string.
5733 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5734 characters have been returned. FIELD_WIDTH < 0 means an infinite
5737 MULTIBYTE = 0 means disable processing of multibyte characters,
5738 MULTIBYTE > 0 means enable it,
5739 MULTIBYTE < 0 means use IT->multibyte_p.
5741 IT must be initialized via a prior call to init_iterator before
5742 calling this function. */
5745 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5750 int precision
, field_width
, multibyte
;
5752 /* No region in strings. */
5753 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5755 /* No text property checks performed by default, but see below. */
5756 it
->stop_charpos
= -1;
5758 /* Set iterator position and end position. */
5759 bzero (&it
->current
, sizeof it
->current
);
5760 it
->current
.overlay_string_index
= -1;
5761 it
->current
.dpvec_index
= -1;
5762 xassert (charpos
>= 0);
5764 /* If STRING is specified, use its multibyteness, otherwise use the
5765 setting of MULTIBYTE, if specified. */
5767 it
->multibyte_p
= multibyte
> 0;
5771 xassert (STRINGP (string
));
5772 it
->string
= string
;
5774 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5775 it
->method
= GET_FROM_STRING
;
5776 it
->current
.string_pos
= string_pos (charpos
, string
);
5783 /* Note that we use IT->current.pos, not it->current.string_pos,
5784 for displaying C strings. */
5785 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5786 if (it
->multibyte_p
)
5788 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5789 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5793 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5794 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5797 it
->method
= GET_FROM_C_STRING
;
5800 /* PRECISION > 0 means don't return more than PRECISION characters
5802 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5803 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5805 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5806 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5807 FIELD_WIDTH < 0 means infinite field width. This is useful for
5808 padding with `-' at the end of a mode line. */
5809 if (field_width
< 0)
5810 field_width
= INFINITY
;
5811 if (field_width
> it
->end_charpos
- charpos
)
5812 it
->end_charpos
= charpos
+ field_width
;
5814 /* Use the standard display table for displaying strings. */
5815 if (DISP_TABLE_P (Vstandard_display_table
))
5816 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5818 it
->stop_charpos
= charpos
;
5819 if (s
== NULL
&& it
->multibyte_p
)
5821 EMACS_INT endpos
= SCHARS (it
->string
);
5822 if (endpos
> it
->end_charpos
)
5823 endpos
= it
->end_charpos
;
5824 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5832 /***********************************************************************
5834 ***********************************************************************/
5836 /* Map enum it_method value to corresponding next_element_from_* function. */
5838 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5840 next_element_from_buffer
,
5841 next_element_from_display_vector
,
5842 next_element_from_string
,
5843 next_element_from_c_string
,
5844 next_element_from_image
,
5845 next_element_from_stretch
5848 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5851 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5852 (possibly with the following characters). */
5854 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5855 ((IT)->cmp_it.id >= 0 \
5856 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5857 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5858 END_CHARPOS, (IT)->w, \
5859 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5863 /* Load IT's display element fields with information about the next
5864 display element from the current position of IT. Value is zero if
5865 end of buffer (or C string) is reached. */
5867 static struct frame
*last_escape_glyph_frame
= NULL
;
5868 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5869 static int last_escape_glyph_merged_face_id
= 0;
5872 get_next_display_element (it
)
5875 /* Non-zero means that we found a display element. Zero means that
5876 we hit the end of what we iterate over. Performance note: the
5877 function pointer `method' used here turns out to be faster than
5878 using a sequence of if-statements. */
5882 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5884 if (it
->what
== IT_CHARACTER
)
5886 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5887 and only if (a) the resolved directionality of that character
5889 /* FIXME: Do we need an exception for characters from display
5891 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5892 it
->c
= bidi_mirror_char (it
->c
);
5893 /* Map via display table or translate control characters.
5894 IT->c, IT->len etc. have been set to the next character by
5895 the function call above. If we have a display table, and it
5896 contains an entry for IT->c, translate it. Don't do this if
5897 IT->c itself comes from a display table, otherwise we could
5898 end up in an infinite recursion. (An alternative could be to
5899 count the recursion depth of this function and signal an
5900 error when a certain maximum depth is reached.) Is it worth
5902 if (success_p
&& it
->dpvec
== NULL
)
5905 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5906 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5907 nbsp_or_shy
= char_is_other
;
5908 int decoded
= it
->c
;
5911 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5914 struct Lisp_Vector
*v
= XVECTOR (dv
);
5916 /* Return the first character from the display table
5917 entry, if not empty. If empty, don't display the
5918 current character. */
5921 it
->dpvec_char_len
= it
->len
;
5922 it
->dpvec
= v
->contents
;
5923 it
->dpend
= v
->contents
+ v
->size
;
5924 it
->current
.dpvec_index
= 0;
5925 it
->dpvec_face_id
= -1;
5926 it
->saved_face_id
= it
->face_id
;
5927 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5932 set_iterator_to_next (it
, 0);
5937 if (unibyte_display_via_language_environment
5938 && !ASCII_CHAR_P (it
->c
))
5939 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5941 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5943 if (it
->multibyte_p
)
5944 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5945 : it
->c
== 0xAD ? char_is_soft_hyphen
5947 else if (unibyte_display_via_language_environment
)
5948 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5949 : decoded
== 0xAD ? char_is_soft_hyphen
5953 /* Translate control characters into `\003' or `^C' form.
5954 Control characters coming from a display table entry are
5955 currently not translated because we use IT->dpvec to hold
5956 the translation. This could easily be changed but I
5957 don't believe that it is worth doing.
5959 If it->multibyte_p is nonzero, non-printable non-ASCII
5960 characters are also translated to octal form.
5962 If it->multibyte_p is zero, eight-bit characters that
5963 don't have corresponding multibyte char code are also
5964 translated to octal form. */
5966 ? (it
->area
!= TEXT_AREA
5967 /* In mode line, treat \n, \t like other crl chars. */
5970 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5971 || (it
->c
!= '\n' && it
->c
!= '\t'))
5974 ? ! CHAR_PRINTABLE_P (it
->c
)
5975 : (! unibyte_display_via_language_environment
5977 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5979 /* IT->c is a control character which must be displayed
5980 either as '\003' or as `^C' where the '\\' and '^'
5981 can be defined in the display table. Fill
5982 IT->ctl_chars with glyphs for what we have to
5983 display. Then, set IT->dpvec to these glyphs. */
5986 int face_id
, lface_id
= 0 ;
5989 /* Handle control characters with ^. */
5991 if (it
->c
< 128 && it
->ctl_arrow_p
)
5995 g
= '^'; /* default glyph for Control */
5996 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5998 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5999 && GLYPH_CODE_CHAR_VALID_P (gc
))
6001 g
= GLYPH_CODE_CHAR (gc
);
6002 lface_id
= GLYPH_CODE_FACE (gc
);
6006 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6008 else if (it
->f
== last_escape_glyph_frame
6009 && it
->face_id
== last_escape_glyph_face_id
)
6011 face_id
= last_escape_glyph_merged_face_id
;
6015 /* Merge the escape-glyph face into the current face. */
6016 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6018 last_escape_glyph_frame
= it
->f
;
6019 last_escape_glyph_face_id
= it
->face_id
;
6020 last_escape_glyph_merged_face_id
= face_id
;
6023 XSETINT (it
->ctl_chars
[0], g
);
6024 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
6026 goto display_control
;
6029 /* Handle non-break space in the mode where it only gets
6032 if (EQ (Vnobreak_char_display
, Qt
)
6033 && nbsp_or_shy
== char_is_nbsp
)
6035 /* Merge the no-break-space face into the current face. */
6036 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6040 XSETINT (it
->ctl_chars
[0], ' ');
6042 goto display_control
;
6045 /* Handle sequences that start with the "escape glyph". */
6047 /* the default escape glyph is \. */
6048 escape_glyph
= '\\';
6051 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6052 && GLYPH_CODE_CHAR_VALID_P (gc
))
6054 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6055 lface_id
= GLYPH_CODE_FACE (gc
);
6059 /* The display table specified a face.
6060 Merge it into face_id and also into escape_glyph. */
6061 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6064 else if (it
->f
== last_escape_glyph_frame
6065 && it
->face_id
== last_escape_glyph_face_id
)
6067 face_id
= last_escape_glyph_merged_face_id
;
6071 /* Merge the escape-glyph face into the current face. */
6072 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6074 last_escape_glyph_frame
= it
->f
;
6075 last_escape_glyph_face_id
= it
->face_id
;
6076 last_escape_glyph_merged_face_id
= face_id
;
6079 /* Handle soft hyphens in the mode where they only get
6082 if (EQ (Vnobreak_char_display
, Qt
)
6083 && nbsp_or_shy
== char_is_soft_hyphen
)
6086 XSETINT (it
->ctl_chars
[0], '-');
6088 goto display_control
;
6091 /* Handle non-break space and soft hyphen
6092 with the escape glyph. */
6096 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6097 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6098 XSETINT (it
->ctl_chars
[1], it
->c
);
6100 goto display_control
;
6104 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6108 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
6109 if (CHAR_BYTE8_P (it
->c
))
6111 str
[0] = CHAR_TO_BYTE8 (it
->c
);
6114 else if (it
->c
< 256)
6121 /* It's an invalid character, which shouldn't
6122 happen actually, but due to bugs it may
6123 happen. Let's print the char as is, there's
6124 not much meaningful we can do with it. */
6126 str
[1] = it
->c
>> 8;
6127 str
[2] = it
->c
>> 16;
6128 str
[3] = it
->c
>> 24;
6132 for (i
= 0; i
< len
; i
++)
6135 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6136 /* Insert three more glyphs into IT->ctl_chars for
6137 the octal display of the character. */
6138 g
= ((str
[i
] >> 6) & 7) + '0';
6139 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6140 g
= ((str
[i
] >> 3) & 7) + '0';
6141 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6142 g
= (str
[i
] & 7) + '0';
6143 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6149 /* Set up IT->dpvec and return first character from it. */
6150 it
->dpvec_char_len
= it
->len
;
6151 it
->dpvec
= it
->ctl_chars
;
6152 it
->dpend
= it
->dpvec
+ ctl_len
;
6153 it
->current
.dpvec_index
= 0;
6154 it
->dpvec_face_id
= face_id
;
6155 it
->saved_face_id
= it
->face_id
;
6156 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6163 #ifdef HAVE_WINDOW_SYSTEM
6164 /* Adjust face id for a multibyte character. There are no multibyte
6165 character in unibyte text. */
6166 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6169 && FRAME_WINDOW_P (it
->f
))
6171 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6173 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6175 /* Automatic composition with glyph-string. */
6176 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6178 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6182 int pos
= (it
->s
? -1
6183 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6184 : IT_CHARPOS (*it
));
6186 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6191 /* Is this character the last one of a run of characters with
6192 box? If yes, set IT->end_of_box_run_p to 1. */
6196 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6198 int face_id
= underlying_face_id (it
);
6199 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6203 if (face
->box
== FACE_NO_BOX
)
6205 /* If the box comes from face properties in a
6206 display string, check faces in that string. */
6207 int string_face_id
= face_after_it_pos (it
);
6208 it
->end_of_box_run_p
6209 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6212 /* Otherwise, the box comes from the underlying face.
6213 If this is the last string character displayed, check
6214 the next buffer location. */
6215 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6216 && (it
->current
.overlay_string_index
6217 == it
->n_overlay_strings
- 1))
6221 struct text_pos pos
= it
->current
.pos
;
6222 INC_TEXT_POS (pos
, it
->multibyte_p
);
6224 next_face_id
= face_at_buffer_position
6225 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6226 it
->region_end_charpos
, &ignore
,
6227 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6229 it
->end_of_box_run_p
6230 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6237 int face_id
= face_after_it_pos (it
);
6238 it
->end_of_box_run_p
6239 = (face_id
!= it
->face_id
6240 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6244 /* Value is 0 if end of buffer or string reached. */
6249 /* Move IT to the next display element.
6251 RESEAT_P non-zero means if called on a newline in buffer text,
6252 skip to the next visible line start.
6254 Functions get_next_display_element and set_iterator_to_next are
6255 separate because I find this arrangement easier to handle than a
6256 get_next_display_element function that also increments IT's
6257 position. The way it is we can first look at an iterator's current
6258 display element, decide whether it fits on a line, and if it does,
6259 increment the iterator position. The other way around we probably
6260 would either need a flag indicating whether the iterator has to be
6261 incremented the next time, or we would have to implement a
6262 decrement position function which would not be easy to write. */
6265 set_iterator_to_next (it
, reseat_p
)
6269 /* Reset flags indicating start and end of a sequence of characters
6270 with box. Reset them at the start of this function because
6271 moving the iterator to a new position might set them. */
6272 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6276 case GET_FROM_BUFFER
:
6277 /* The current display element of IT is a character from
6278 current_buffer. Advance in the buffer, and maybe skip over
6279 invisible lines that are so because of selective display. */
6280 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6281 reseat_at_next_visible_line_start (it
, 0);
6282 else if (it
->cmp_it
.id
>= 0)
6284 /* We are currently getting glyphs from a composition. */
6289 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6290 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6291 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6293 it
->cmp_it
.from
= it
->cmp_it
.to
;
6298 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6300 it
->stop_charpos
, Qnil
);
6303 else if (! it
->cmp_it
.reversed_p
)
6305 /* Composition created while scanning forward. */
6306 /* Update IT's char/byte positions to point the first
6307 character of the next grapheme cluster, or to the
6308 character visually after the current composition. */
6310 /* Is it ok to do this directly? */
6311 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6312 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6314 /* Or do we have to call bidi_get_next_char_visually
6315 repeatedly (perhaps not to confuse some internal
6316 state of bidi_it)? At least we must do this if we
6317 have consumed all grapheme clusters in the current
6318 composition because the next character will be in the
6319 different bidi level. */
6320 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6321 bidi_get_next_char_visually (&it
->bidi_it
);
6322 /* BTW, it seems that the name
6323 bidi_get_next_char_visually is confusing because
6324 it sounds like not advancing character position.
6325 How about bidi_set_iterator_to_next? */
6326 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6327 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6329 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6331 /* Proceed to the next grapheme cluster. */
6332 it
->cmp_it
.from
= it
->cmp_it
.to
;
6336 /* No more grapheme cluster in this composition.
6337 Find the next stop position. */
6338 EMACS_INT stop
= it
->stop_charpos
;
6339 if (it
->bidi_it
.scan_dir
< 0)
6340 /* Now we are scanning backward and don't know
6343 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6344 IT_BYTEPOS (*it
), stop
, Qnil
);
6349 /* Composition created while scanning backward. */
6350 /* Update IT's char/byte positions to point the last
6351 character of the previous grapheme cluster, or the
6352 character visually after the current composition. */
6353 bidi_get_next_char_visually (&it
->bidi_it
);
6354 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6355 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6357 if (it
->cmp_it
.from
> 0)
6359 /* Proceed to the previous grapheme cluster. */
6360 it
->cmp_it
.to
= it
->cmp_it
.from
;
6364 /* No more grapheme cluster in this composition.
6365 Find the next stop position. */
6366 EMACS_INT stop
= it
->stop_charpos
;
6367 if (it
->bidi_it
.scan_dir
< 0)
6368 /* Now we are scanning backward and don't know
6371 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6372 IT_BYTEPOS (*it
), stop
, Qnil
);
6378 xassert (it
->len
!= 0);
6382 IT_BYTEPOS (*it
) += it
->len
;
6383 IT_CHARPOS (*it
) += 1;
6387 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6388 /* If this is a new paragraph, determine its base
6389 direction (a.k.a. its base embedding level). */
6390 if (it
->bidi_it
.new_paragraph
)
6391 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6392 bidi_get_next_char_visually (&it
->bidi_it
);
6393 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6394 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6395 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6397 /* As scan direction was changed, we must re-compute
6398 the stop position for composition. */
6399 EMACS_INT stop
= it
->stop_charpos
;
6400 if (it
->bidi_it
.scan_dir
< 0)
6402 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6403 IT_BYTEPOS (*it
), stop
, Qnil
);
6406 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6410 case GET_FROM_C_STRING
:
6411 /* Current display element of IT is from a C string. */
6412 IT_BYTEPOS (*it
) += it
->len
;
6413 IT_CHARPOS (*it
) += 1;
6416 case GET_FROM_DISPLAY_VECTOR
:
6417 /* Current display element of IT is from a display table entry.
6418 Advance in the display table definition. Reset it to null if
6419 end reached, and continue with characters from buffers/
6421 ++it
->current
.dpvec_index
;
6423 /* Restore face of the iterator to what they were before the
6424 display vector entry (these entries may contain faces). */
6425 it
->face_id
= it
->saved_face_id
;
6427 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6429 int recheck_faces
= it
->ellipsis_p
;
6432 it
->method
= GET_FROM_C_STRING
;
6433 else if (STRINGP (it
->string
))
6434 it
->method
= GET_FROM_STRING
;
6437 it
->method
= GET_FROM_BUFFER
;
6438 it
->object
= it
->w
->buffer
;
6442 it
->current
.dpvec_index
= -1;
6444 /* Skip over characters which were displayed via IT->dpvec. */
6445 if (it
->dpvec_char_len
< 0)
6446 reseat_at_next_visible_line_start (it
, 1);
6447 else if (it
->dpvec_char_len
> 0)
6449 if (it
->method
== GET_FROM_STRING
6450 && it
->n_overlay_strings
> 0)
6451 it
->ignore_overlay_strings_at_pos_p
= 1;
6452 it
->len
= it
->dpvec_char_len
;
6453 set_iterator_to_next (it
, reseat_p
);
6456 /* Maybe recheck faces after display vector */
6458 it
->stop_charpos
= IT_CHARPOS (*it
);
6462 case GET_FROM_STRING
:
6463 /* Current display element is a character from a Lisp string. */
6464 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6465 if (it
->cmp_it
.id
>= 0)
6467 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6468 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6469 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6470 it
->cmp_it
.from
= it
->cmp_it
.to
;
6474 composition_compute_stop_pos (&it
->cmp_it
,
6475 IT_STRING_CHARPOS (*it
),
6476 IT_STRING_BYTEPOS (*it
),
6477 it
->stop_charpos
, it
->string
);
6482 IT_STRING_BYTEPOS (*it
) += it
->len
;
6483 IT_STRING_CHARPOS (*it
) += 1;
6486 consider_string_end
:
6488 if (it
->current
.overlay_string_index
>= 0)
6490 /* IT->string is an overlay string. Advance to the
6491 next, if there is one. */
6492 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6495 next_overlay_string (it
);
6497 setup_for_ellipsis (it
, 0);
6502 /* IT->string is not an overlay string. If we reached
6503 its end, and there is something on IT->stack, proceed
6504 with what is on the stack. This can be either another
6505 string, this time an overlay string, or a buffer. */
6506 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6510 if (it
->method
== GET_FROM_STRING
)
6511 goto consider_string_end
;
6516 case GET_FROM_IMAGE
:
6517 case GET_FROM_STRETCH
:
6518 /* The position etc with which we have to proceed are on
6519 the stack. The position may be at the end of a string,
6520 if the `display' property takes up the whole string. */
6521 xassert (it
->sp
> 0);
6523 if (it
->method
== GET_FROM_STRING
)
6524 goto consider_string_end
;
6528 /* There are no other methods defined, so this should be a bug. */
6532 xassert (it
->method
!= GET_FROM_STRING
6533 || (STRINGP (it
->string
)
6534 && IT_STRING_CHARPOS (*it
) >= 0));
6537 /* Load IT's display element fields with information about the next
6538 display element which comes from a display table entry or from the
6539 result of translating a control character to one of the forms `^C'
6542 IT->dpvec holds the glyphs to return as characters.
6543 IT->saved_face_id holds the face id before the display vector--it
6544 is restored into IT->face_id in set_iterator_to_next. */
6547 next_element_from_display_vector (it
)
6553 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6555 it
->face_id
= it
->saved_face_id
;
6557 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6558 That seemed totally bogus - so I changed it... */
6559 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6561 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6563 it
->c
= GLYPH_CODE_CHAR (gc
);
6564 it
->len
= CHAR_BYTES (it
->c
);
6566 /* The entry may contain a face id to use. Such a face id is
6567 the id of a Lisp face, not a realized face. A face id of
6568 zero means no face is specified. */
6569 if (it
->dpvec_face_id
>= 0)
6570 it
->face_id
= it
->dpvec_face_id
;
6573 int lface_id
= GLYPH_CODE_FACE (gc
);
6575 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6580 /* Display table entry is invalid. Return a space. */
6581 it
->c
= ' ', it
->len
= 1;
6583 /* Don't change position and object of the iterator here. They are
6584 still the values of the character that had this display table
6585 entry or was translated, and that's what we want. */
6586 it
->what
= IT_CHARACTER
;
6591 /* Load IT with the next display element from Lisp string IT->string.
6592 IT->current.string_pos is the current position within the string.
6593 If IT->current.overlay_string_index >= 0, the Lisp string is an
6597 next_element_from_string (it
)
6600 struct text_pos position
;
6602 xassert (STRINGP (it
->string
));
6603 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6604 position
= it
->current
.string_pos
;
6606 /* Time to check for invisible text? */
6607 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6608 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6612 /* Since a handler may have changed IT->method, we must
6614 return GET_NEXT_DISPLAY_ELEMENT (it
);
6617 if (it
->current
.overlay_string_index
>= 0)
6619 /* Get the next character from an overlay string. In overlay
6620 strings, There is no field width or padding with spaces to
6622 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6627 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6628 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6629 && next_element_from_composition (it
))
6633 else if (STRING_MULTIBYTE (it
->string
))
6635 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6636 const unsigned char *s
= (SDATA (it
->string
)
6637 + IT_STRING_BYTEPOS (*it
));
6638 it
->c
= string_char_and_length (s
, &it
->len
);
6642 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6648 /* Get the next character from a Lisp string that is not an
6649 overlay string. Such strings come from the mode line, for
6650 example. We may have to pad with spaces, or truncate the
6651 string. See also next_element_from_c_string. */
6652 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6657 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6659 /* Pad with spaces. */
6660 it
->c
= ' ', it
->len
= 1;
6661 CHARPOS (position
) = BYTEPOS (position
) = -1;
6663 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6664 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6665 && next_element_from_composition (it
))
6669 else if (STRING_MULTIBYTE (it
->string
))
6671 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6672 const unsigned char *s
= (SDATA (it
->string
)
6673 + IT_STRING_BYTEPOS (*it
));
6674 it
->c
= string_char_and_length (s
, &it
->len
);
6678 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6683 /* Record what we have and where it came from. */
6684 it
->what
= IT_CHARACTER
;
6685 it
->object
= it
->string
;
6686 it
->position
= position
;
6691 /* Load IT with next display element from C string IT->s.
6692 IT->string_nchars is the maximum number of characters to return
6693 from the string. IT->end_charpos may be greater than
6694 IT->string_nchars when this function is called, in which case we
6695 may have to return padding spaces. Value is zero if end of string
6696 reached, including padding spaces. */
6699 next_element_from_c_string (it
)
6705 it
->what
= IT_CHARACTER
;
6706 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6709 /* IT's position can be greater IT->string_nchars in case a field
6710 width or precision has been specified when the iterator was
6712 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6714 /* End of the game. */
6718 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6720 /* Pad with spaces. */
6721 it
->c
= ' ', it
->len
= 1;
6722 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6724 else if (it
->multibyte_p
)
6726 /* Implementation note: The calls to strlen apparently aren't a
6727 performance problem because there is no noticeable performance
6728 difference between Emacs running in unibyte or multibyte mode. */
6729 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6730 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6733 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6739 /* Set up IT to return characters from an ellipsis, if appropriate.
6740 The definition of the ellipsis glyphs may come from a display table
6741 entry. This function fills IT with the first glyph from the
6742 ellipsis if an ellipsis is to be displayed. */
6745 next_element_from_ellipsis (it
)
6748 if (it
->selective_display_ellipsis_p
)
6749 setup_for_ellipsis (it
, it
->len
);
6752 /* The face at the current position may be different from the
6753 face we find after the invisible text. Remember what it
6754 was in IT->saved_face_id, and signal that it's there by
6755 setting face_before_selective_p. */
6756 it
->saved_face_id
= it
->face_id
;
6757 it
->method
= GET_FROM_BUFFER
;
6758 it
->object
= it
->w
->buffer
;
6759 reseat_at_next_visible_line_start (it
, 1);
6760 it
->face_before_selective_p
= 1;
6763 return GET_NEXT_DISPLAY_ELEMENT (it
);
6767 /* Deliver an image display element. The iterator IT is already
6768 filled with image information (done in handle_display_prop). Value
6773 next_element_from_image (it
)
6776 it
->what
= IT_IMAGE
;
6781 /* Fill iterator IT with next display element from a stretch glyph
6782 property. IT->object is the value of the text property. Value is
6786 next_element_from_stretch (it
)
6789 it
->what
= IT_STRETCH
;
6793 /* Scan forward from CHARPOS in the current buffer, until we find a
6794 stop position > current IT's position. Then handle the stop
6795 position before that. This is called when we bump into a stop
6796 position while reordering bidirectional text. CHARPOS should be
6797 the last previously processed stop_pos (or BEGV, if none were
6798 processed yet) whose position is less that IT's current
6802 handle_stop_backwards (it
, charpos
)
6806 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6807 struct display_pos save_current
= it
->current
;
6808 struct text_pos save_position
= it
->position
;
6809 struct text_pos pos1
;
6810 EMACS_INT next_stop
;
6812 /* Scan in strict logical order. */
6816 it
->prev_stop
= charpos
;
6817 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6818 reseat_1 (it
, pos1
, 0);
6819 compute_stop_pos (it
);
6820 /* We must advance forward, right? */
6821 if (it
->stop_charpos
<= it
->prev_stop
)
6823 charpos
= it
->stop_charpos
;
6825 while (charpos
<= where_we_are
);
6827 next_stop
= it
->stop_charpos
;
6828 it
->stop_charpos
= it
->prev_stop
;
6830 it
->current
= save_current
;
6831 it
->position
= save_position
;
6833 it
->stop_charpos
= next_stop
;
6836 /* Load IT with the next display element from current_buffer. Value
6837 is zero if end of buffer reached. IT->stop_charpos is the next
6838 position at which to stop and check for text properties or buffer
6842 next_element_from_buffer (it
)
6847 xassert (IT_CHARPOS (*it
) >= BEGV
);
6849 /* With bidi reordering, the character to display might not be the
6850 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6851 we were reseat()ed to a new buffer position, which is potentially
6852 a different paragraph. */
6853 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6855 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6856 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6857 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6859 /* Nothing to do, but reset the FIRST_ELT flag, like
6860 bidi_paragraph_init does, because we are not going to
6862 it
->bidi_it
.first_elt
= 0;
6864 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6865 /* FIXME: Should support all Unicode line separators. */
6866 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6867 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6869 /* If we are at the beginning of a line, we can produce the
6870 next element right away. */
6871 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6872 bidi_get_next_char_visually (&it
->bidi_it
);
6876 int orig_bytepos
= IT_BYTEPOS (*it
);
6878 /* We need to prime the bidi iterator starting at the line's
6879 beginning, before we will be able to produce the next
6881 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6882 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6883 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6884 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6885 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6888 /* Now return to buffer position where we were asked to
6889 get the next display element, and produce that. */
6890 bidi_get_next_char_visually (&it
->bidi_it
);
6892 while (it
->bidi_it
.bytepos
!= orig_bytepos
6893 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6896 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6897 /* Adjust IT's position information to where we ended up. */
6898 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6899 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6900 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6902 EMACS_INT stop
= it
->stop_charpos
;
6903 if (it
->bidi_it
.scan_dir
< 0)
6905 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6906 IT_BYTEPOS (*it
), stop
, Qnil
);
6910 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6912 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6914 int overlay_strings_follow_p
;
6916 /* End of the game, except when overlay strings follow that
6917 haven't been returned yet. */
6918 if (it
->overlay_strings_at_end_processed_p
)
6919 overlay_strings_follow_p
= 0;
6922 it
->overlay_strings_at_end_processed_p
= 1;
6923 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6926 if (overlay_strings_follow_p
)
6927 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6931 it
->position
= it
->current
.pos
;
6935 else if (!(!it
->bidi_p
6936 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6937 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6939 /* With bidi non-linear iteration, we could find ourselves
6940 far beyond the last computed stop_charpos, with several
6941 other stop positions in between that we missed. Scan
6942 them all now, in buffer's logical order, until we find
6943 and handle the last stop_charpos that precedes our
6944 current position. */
6945 handle_stop_backwards (it
, it
->stop_charpos
);
6946 return GET_NEXT_DISPLAY_ELEMENT (it
);
6952 /* Take note of the stop position we just moved across,
6953 for when we will move back across it. */
6954 it
->prev_stop
= it
->stop_charpos
;
6955 /* If we are at base paragraph embedding level, take
6956 note of the last stop position seen at this
6958 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6959 it
->base_level_stop
= it
->stop_charpos
;
6962 return GET_NEXT_DISPLAY_ELEMENT (it
);
6966 /* We can sometimes back up for reasons that have nothing
6967 to do with bidi reordering. E.g., compositions. The
6968 code below is only needed when we are above the base
6969 embedding level, so test for that explicitly. */
6970 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6971 && IT_CHARPOS (*it
) < it
->prev_stop
)
6973 if (it
->base_level_stop
<= 0)
6974 it
->base_level_stop
= BEGV
;
6975 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6977 handle_stop_backwards (it
, it
->base_level_stop
);
6978 return GET_NEXT_DISPLAY_ELEMENT (it
);
6982 /* No face changes, overlays etc. in sight, so just return a
6983 character from current_buffer. */
6987 /* Maybe run the redisplay end trigger hook. Performance note:
6988 This doesn't seem to cost measurable time. */
6989 if (it
->redisplay_end_trigger_charpos
6991 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6992 run_redisplay_end_trigger_hook (it
);
6994 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6995 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6997 && next_element_from_composition (it
))
7002 /* Get the next character, maybe multibyte. */
7003 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7004 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7005 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7007 it
->c
= *p
, it
->len
= 1;
7009 /* Record what we have and where it came from. */
7010 it
->what
= IT_CHARACTER
;
7011 it
->object
= it
->w
->buffer
;
7012 it
->position
= it
->current
.pos
;
7014 /* Normally we return the character found above, except when we
7015 really want to return an ellipsis for selective display. */
7020 /* A value of selective > 0 means hide lines indented more
7021 than that number of columns. */
7022 if (it
->selective
> 0
7023 && IT_CHARPOS (*it
) + 1 < ZV
7024 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7025 IT_BYTEPOS (*it
) + 1,
7026 (double) it
->selective
)) /* iftc */
7028 success_p
= next_element_from_ellipsis (it
);
7029 it
->dpvec_char_len
= -1;
7032 else if (it
->c
== '\r' && it
->selective
== -1)
7034 /* A value of selective == -1 means that everything from the
7035 CR to the end of the line is invisible, with maybe an
7036 ellipsis displayed for it. */
7037 success_p
= next_element_from_ellipsis (it
);
7038 it
->dpvec_char_len
= -1;
7043 /* Value is zero if end of buffer reached. */
7044 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7049 /* Run the redisplay end trigger hook for IT. */
7052 run_redisplay_end_trigger_hook (it
)
7055 Lisp_Object args
[3];
7057 /* IT->glyph_row should be non-null, i.e. we should be actually
7058 displaying something, or otherwise we should not run the hook. */
7059 xassert (it
->glyph_row
);
7061 /* Set up hook arguments. */
7062 args
[0] = Qredisplay_end_trigger_functions
;
7063 args
[1] = it
->window
;
7064 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7065 it
->redisplay_end_trigger_charpos
= 0;
7067 /* Since we are *trying* to run these functions, don't try to run
7068 them again, even if they get an error. */
7069 it
->w
->redisplay_end_trigger
= Qnil
;
7070 Frun_hook_with_args (3, args
);
7072 /* Notice if it changed the face of the character we are on. */
7073 handle_face_prop (it
);
7077 /* Deliver a composition display element. Unlike the other
7078 next_element_from_XXX, this function is not registered in the array
7079 get_next_element[]. It is called from next_element_from_buffer and
7080 next_element_from_string when necessary. */
7083 next_element_from_composition (it
)
7086 it
->what
= IT_COMPOSITION
;
7087 it
->len
= it
->cmp_it
.nbytes
;
7088 if (STRINGP (it
->string
))
7092 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7093 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7096 it
->position
= it
->current
.string_pos
;
7097 it
->object
= it
->string
;
7098 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7099 IT_STRING_BYTEPOS (*it
), it
->string
);
7105 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7106 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7109 if (it
->bidi_it
.new_paragraph
)
7110 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
7111 /* Resync the bidi iterator with IT's new position.
7112 FIXME: this doesn't support bidirectional text. */
7113 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7114 bidi_get_next_char_visually (&it
->bidi_it
);
7118 it
->position
= it
->current
.pos
;
7119 it
->object
= it
->w
->buffer
;
7120 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7121 IT_BYTEPOS (*it
), Qnil
);
7122 if (it
->cmp_it
.reversed_p
)
7124 /* Now it->position points the last character of the current
7125 grapheme cluster. Adjust it to point the first one. We
7126 have to do it here so that append_composite_glyph sets
7127 correct (struct glyph)->charpos. */
7129 for (i
= 0; i
< it
->cmp_it
.nchars
- 1; i
++)
7130 bidi_get_next_char_visually (&it
->bidi_it
);
7131 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7132 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7133 it
->position
= it
->current
.pos
;
7141 /***********************************************************************
7142 Moving an iterator without producing glyphs
7143 ***********************************************************************/
7145 /* Check if iterator is at a position corresponding to a valid buffer
7146 position after some move_it_ call. */
7148 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7149 ((it)->method == GET_FROM_STRING \
7150 ? IT_STRING_CHARPOS (*it) == 0 \
7154 /* Move iterator IT to a specified buffer or X position within one
7155 line on the display without producing glyphs.
7157 OP should be a bit mask including some or all of these bits:
7158 MOVE_TO_X: Stop upon reaching x-position TO_X.
7159 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7160 Regardless of OP's value, stop upon reaching the end of the display line.
7162 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7163 This means, in particular, that TO_X includes window's horizontal
7166 The return value has several possible values that
7167 say what condition caused the scan to stop:
7169 MOVE_POS_MATCH_OR_ZV
7170 - when TO_POS or ZV was reached.
7173 -when TO_X was reached before TO_POS or ZV were reached.
7176 - when we reached the end of the display area and the line must
7180 - when we reached the end of the display area and the line is
7184 - when we stopped at a line end, i.e. a newline or a CR and selective
7187 static enum move_it_result
7188 move_it_in_display_line_to (struct it
*it
,
7189 EMACS_INT to_charpos
, int to_x
,
7190 enum move_operation_enum op
)
7192 enum move_it_result result
= MOVE_UNDEFINED
;
7193 struct glyph_row
*saved_glyph_row
;
7194 struct it wrap_it
, atpos_it
, atx_it
;
7196 enum it_method prev_method
= it
->method
;
7197 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7199 /* Don't produce glyphs in produce_glyphs. */
7200 saved_glyph_row
= it
->glyph_row
;
7201 it
->glyph_row
= NULL
;
7203 /* Use wrap_it to save a copy of IT wherever a word wrap could
7204 occur. Use atpos_it to save a copy of IT at the desired buffer
7205 position, if found, so that we can scan ahead and check if the
7206 word later overshoots the window edge. Use atx_it similarly, for
7212 #define BUFFER_POS_REACHED_P() \
7213 ((op & MOVE_TO_POS) != 0 \
7214 && BUFFERP (it->object) \
7215 && (IT_CHARPOS (*it) == to_charpos \
7216 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7217 && (it->method == GET_FROM_BUFFER \
7218 || (it->method == GET_FROM_DISPLAY_VECTOR \
7219 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7221 /* If there's a line-/wrap-prefix, handle it. */
7222 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7223 && it
->current_y
< it
->last_visible_y
)
7224 handle_line_prefix (it
);
7228 int x
, i
, ascent
= 0, descent
= 0;
7230 /* Utility macro to reset an iterator with x, ascent, and descent. */
7231 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7232 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7233 (IT)->max_descent = descent)
7235 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7237 if ((op
& MOVE_TO_POS
) != 0
7238 && BUFFERP (it
->object
)
7239 && it
->method
== GET_FROM_BUFFER
7240 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7242 && (prev_method
== GET_FROM_IMAGE
7243 || prev_method
== GET_FROM_STRETCH
)
7244 /* Passed TO_CHARPOS from left to right. */
7245 && ((prev_pos
< to_charpos
7246 && IT_CHARPOS (*it
) > to_charpos
)
7247 /* Passed TO_CHARPOS from right to left. */
7248 || (prev_pos
> to_charpos
7249 && IT_CHARPOS (*it
) < to_charpos
)))))
7251 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7253 result
= MOVE_POS_MATCH_OR_ZV
;
7256 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7257 /* If wrap_it is valid, the current position might be in a
7258 word that is wrapped. So, save the iterator in
7259 atpos_it and continue to see if wrapping happens. */
7263 prev_method
= it
->method
;
7264 if (it
->method
== GET_FROM_BUFFER
)
7265 prev_pos
= IT_CHARPOS (*it
);
7266 /* Stop when ZV reached.
7267 We used to stop here when TO_CHARPOS reached as well, but that is
7268 too soon if this glyph does not fit on this line. So we handle it
7269 explicitly below. */
7270 if (!get_next_display_element (it
))
7272 result
= MOVE_POS_MATCH_OR_ZV
;
7276 if (it
->line_wrap
== TRUNCATE
)
7278 if (BUFFER_POS_REACHED_P ())
7280 result
= MOVE_POS_MATCH_OR_ZV
;
7286 if (it
->line_wrap
== WORD_WRAP
)
7288 if (IT_DISPLAYING_WHITESPACE (it
))
7292 /* We have reached a glyph that follows one or more
7293 whitespace characters. If the position is
7294 already found, we are done. */
7295 if (atpos_it
.sp
>= 0)
7298 result
= MOVE_POS_MATCH_OR_ZV
;
7304 result
= MOVE_X_REACHED
;
7307 /* Otherwise, we can wrap here. */
7314 /* Remember the line height for the current line, in case
7315 the next element doesn't fit on the line. */
7316 ascent
= it
->max_ascent
;
7317 descent
= it
->max_descent
;
7319 /* The call to produce_glyphs will get the metrics of the
7320 display element IT is loaded with. Record the x-position
7321 before this display element, in case it doesn't fit on the
7325 PRODUCE_GLYPHS (it
);
7327 if (it
->area
!= TEXT_AREA
)
7329 set_iterator_to_next (it
, 1);
7333 /* The number of glyphs we get back in IT->nglyphs will normally
7334 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7335 character on a terminal frame, or (iii) a line end. For the
7336 second case, IT->nglyphs - 1 padding glyphs will be present.
7337 (On X frames, there is only one glyph produced for a
7338 composite character.)
7340 The behavior implemented below means, for continuation lines,
7341 that as many spaces of a TAB as fit on the current line are
7342 displayed there. For terminal frames, as many glyphs of a
7343 multi-glyph character are displayed in the current line, too.
7344 This is what the old redisplay code did, and we keep it that
7345 way. Under X, the whole shape of a complex character must
7346 fit on the line or it will be completely displayed in the
7349 Note that both for tabs and padding glyphs, all glyphs have
7353 /* More than one glyph or glyph doesn't fit on line. All
7354 glyphs have the same width. */
7355 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7357 int x_before_this_char
= x
;
7358 int hpos_before_this_char
= it
->hpos
;
7360 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7362 new_x
= x
+ single_glyph_width
;
7364 /* We want to leave anything reaching TO_X to the caller. */
7365 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7367 if (BUFFER_POS_REACHED_P ())
7369 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7370 goto buffer_pos_reached
;
7371 if (atpos_it
.sp
< 0)
7374 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7379 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7382 result
= MOVE_X_REACHED
;
7388 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7393 if (/* Lines are continued. */
7394 it
->line_wrap
!= TRUNCATE
7395 && (/* And glyph doesn't fit on the line. */
7396 new_x
> it
->last_visible_x
7397 /* Or it fits exactly and we're on a window
7399 || (new_x
== it
->last_visible_x
7400 && FRAME_WINDOW_P (it
->f
))))
7402 if (/* IT->hpos == 0 means the very first glyph
7403 doesn't fit on the line, e.g. a wide image. */
7405 || (new_x
== it
->last_visible_x
7406 && FRAME_WINDOW_P (it
->f
)))
7409 it
->current_x
= new_x
;
7411 /* The character's last glyph just barely fits
7413 if (i
== it
->nglyphs
- 1)
7415 /* If this is the destination position,
7416 return a position *before* it in this row,
7417 now that we know it fits in this row. */
7418 if (BUFFER_POS_REACHED_P ())
7420 if (it
->line_wrap
!= WORD_WRAP
7423 it
->hpos
= hpos_before_this_char
;
7424 it
->current_x
= x_before_this_char
;
7425 result
= MOVE_POS_MATCH_OR_ZV
;
7428 if (it
->line_wrap
== WORD_WRAP
7432 atpos_it
.current_x
= x_before_this_char
;
7433 atpos_it
.hpos
= hpos_before_this_char
;
7437 set_iterator_to_next (it
, 1);
7438 /* On graphical terminals, newlines may
7439 "overflow" into the fringe if
7440 overflow-newline-into-fringe is non-nil.
7441 On text-only terminals, newlines may
7442 overflow into the last glyph on the
7444 if (!FRAME_WINDOW_P (it
->f
)
7445 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7447 if (!get_next_display_element (it
))
7449 result
= MOVE_POS_MATCH_OR_ZV
;
7452 if (BUFFER_POS_REACHED_P ())
7454 if (ITERATOR_AT_END_OF_LINE_P (it
))
7455 result
= MOVE_POS_MATCH_OR_ZV
;
7457 result
= MOVE_LINE_CONTINUED
;
7460 if (ITERATOR_AT_END_OF_LINE_P (it
))
7462 result
= MOVE_NEWLINE_OR_CR
;
7469 IT_RESET_X_ASCENT_DESCENT (it
);
7471 if (wrap_it
.sp
>= 0)
7478 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7480 result
= MOVE_LINE_CONTINUED
;
7484 if (BUFFER_POS_REACHED_P ())
7486 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7487 goto buffer_pos_reached
;
7488 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7491 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7495 if (new_x
> it
->first_visible_x
)
7497 /* Glyph is visible. Increment number of glyphs that
7498 would be displayed. */
7503 if (result
!= MOVE_UNDEFINED
)
7506 else if (BUFFER_POS_REACHED_P ())
7509 IT_RESET_X_ASCENT_DESCENT (it
);
7510 result
= MOVE_POS_MATCH_OR_ZV
;
7513 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7515 /* Stop when TO_X specified and reached. This check is
7516 necessary here because of lines consisting of a line end,
7517 only. The line end will not produce any glyphs and we
7518 would never get MOVE_X_REACHED. */
7519 xassert (it
->nglyphs
== 0);
7520 result
= MOVE_X_REACHED
;
7524 /* Is this a line end? If yes, we're done. */
7525 if (ITERATOR_AT_END_OF_LINE_P (it
))
7527 result
= MOVE_NEWLINE_OR_CR
;
7531 if (it
->method
== GET_FROM_BUFFER
)
7532 prev_pos
= IT_CHARPOS (*it
);
7533 /* The current display element has been consumed. Advance
7535 set_iterator_to_next (it
, 1);
7537 /* Stop if lines are truncated and IT's current x-position is
7538 past the right edge of the window now. */
7539 if (it
->line_wrap
== TRUNCATE
7540 && it
->current_x
>= it
->last_visible_x
)
7542 if (!FRAME_WINDOW_P (it
->f
)
7543 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7545 if (!get_next_display_element (it
)
7546 || BUFFER_POS_REACHED_P ())
7548 result
= MOVE_POS_MATCH_OR_ZV
;
7551 if (ITERATOR_AT_END_OF_LINE_P (it
))
7553 result
= MOVE_NEWLINE_OR_CR
;
7557 result
= MOVE_LINE_TRUNCATED
;
7560 #undef IT_RESET_X_ASCENT_DESCENT
7563 #undef BUFFER_POS_REACHED_P
7565 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7566 restore the saved iterator. */
7567 if (atpos_it
.sp
>= 0)
7569 else if (atx_it
.sp
>= 0)
7574 /* Restore the iterator settings altered at the beginning of this
7576 it
->glyph_row
= saved_glyph_row
;
7580 /* For external use. */
7582 move_it_in_display_line (struct it
*it
,
7583 EMACS_INT to_charpos
, int to_x
,
7584 enum move_operation_enum op
)
7586 if (it
->line_wrap
== WORD_WRAP
7587 && (op
& MOVE_TO_X
))
7589 struct it save_it
= *it
;
7590 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7591 /* When word-wrap is on, TO_X may lie past the end
7592 of a wrapped line. Then it->current is the
7593 character on the next line, so backtrack to the
7594 space before the wrap point. */
7595 if (skip
== MOVE_LINE_CONTINUED
)
7597 int prev_x
= max (it
->current_x
- 1, 0);
7599 move_it_in_display_line_to
7600 (it
, -1, prev_x
, MOVE_TO_X
);
7604 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7608 /* Move IT forward until it satisfies one or more of the criteria in
7609 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7611 OP is a bit-mask that specifies where to stop, and in particular,
7612 which of those four position arguments makes a difference. See the
7613 description of enum move_operation_enum.
7615 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7616 screen line, this function will set IT to the next position >
7620 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7622 int to_charpos
, to_x
, to_y
, to_vpos
;
7625 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7626 int line_height
, line_start_x
= 0, reached
= 0;
7630 if (op
& MOVE_TO_VPOS
)
7632 /* If no TO_CHARPOS and no TO_X specified, stop at the
7633 start of the line TO_VPOS. */
7634 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7636 if (it
->vpos
== to_vpos
)
7642 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7646 /* TO_VPOS >= 0 means stop at TO_X in the line at
7647 TO_VPOS, or at TO_POS, whichever comes first. */
7648 if (it
->vpos
== to_vpos
)
7654 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7656 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7661 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7663 /* We have reached TO_X but not in the line we want. */
7664 skip
= move_it_in_display_line_to (it
, to_charpos
,
7666 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7674 else if (op
& MOVE_TO_Y
)
7676 struct it it_backup
;
7678 if (it
->line_wrap
== WORD_WRAP
)
7681 /* TO_Y specified means stop at TO_X in the line containing
7682 TO_Y---or at TO_CHARPOS if this is reached first. The
7683 problem is that we can't really tell whether the line
7684 contains TO_Y before we have completely scanned it, and
7685 this may skip past TO_X. What we do is to first scan to
7688 If TO_X is not specified, use a TO_X of zero. The reason
7689 is to make the outcome of this function more predictable.
7690 If we didn't use TO_X == 0, we would stop at the end of
7691 the line which is probably not what a caller would expect
7693 skip
= move_it_in_display_line_to
7694 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7695 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7697 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7698 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7700 else if (skip
== MOVE_X_REACHED
)
7702 /* If TO_X was reached, we want to know whether TO_Y is
7703 in the line. We know this is the case if the already
7704 scanned glyphs make the line tall enough. Otherwise,
7705 we must check by scanning the rest of the line. */
7706 line_height
= it
->max_ascent
+ it
->max_descent
;
7707 if (to_y
>= it
->current_y
7708 && to_y
< it
->current_y
+ line_height
)
7714 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7715 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7717 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7718 line_height
= it
->max_ascent
+ it
->max_descent
;
7719 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7721 if (to_y
>= it
->current_y
7722 && to_y
< it
->current_y
+ line_height
)
7724 /* If TO_Y is in this line and TO_X was reached
7725 above, we scanned too far. We have to restore
7726 IT's settings to the ones before skipping. */
7733 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7739 /* Check whether TO_Y is in this line. */
7740 line_height
= it
->max_ascent
+ it
->max_descent
;
7741 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7743 if (to_y
>= it
->current_y
7744 && to_y
< it
->current_y
+ line_height
)
7746 /* When word-wrap is on, TO_X may lie past the end
7747 of a wrapped line. Then it->current is the
7748 character on the next line, so backtrack to the
7749 space before the wrap point. */
7750 if (skip
== MOVE_LINE_CONTINUED
7751 && it
->line_wrap
== WORD_WRAP
)
7753 int prev_x
= max (it
->current_x
- 1, 0);
7755 skip
= move_it_in_display_line_to
7756 (it
, -1, prev_x
, MOVE_TO_X
);
7765 else if (BUFFERP (it
->object
)
7766 && (it
->method
== GET_FROM_BUFFER
7767 || it
->method
== GET_FROM_STRETCH
)
7768 && IT_CHARPOS (*it
) >= to_charpos
)
7769 skip
= MOVE_POS_MATCH_OR_ZV
;
7771 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7775 case MOVE_POS_MATCH_OR_ZV
:
7779 case MOVE_NEWLINE_OR_CR
:
7780 set_iterator_to_next (it
, 1);
7781 it
->continuation_lines_width
= 0;
7784 case MOVE_LINE_TRUNCATED
:
7785 it
->continuation_lines_width
= 0;
7786 reseat_at_next_visible_line_start (it
, 0);
7787 if ((op
& MOVE_TO_POS
) != 0
7788 && IT_CHARPOS (*it
) > to_charpos
)
7795 case MOVE_LINE_CONTINUED
:
7796 /* For continued lines ending in a tab, some of the glyphs
7797 associated with the tab are displayed on the current
7798 line. Since it->current_x does not include these glyphs,
7799 we use it->last_visible_x instead. */
7802 it
->continuation_lines_width
+= it
->last_visible_x
;
7803 /* When moving by vpos, ensure that the iterator really
7804 advances to the next line (bug#847, bug#969). Fixme:
7805 do we need to do this in other circumstances? */
7806 if (it
->current_x
!= it
->last_visible_x
7807 && (op
& MOVE_TO_VPOS
)
7808 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7810 line_start_x
= it
->current_x
+ it
->pixel_width
7811 - it
->last_visible_x
;
7812 set_iterator_to_next (it
, 0);
7816 it
->continuation_lines_width
+= it
->current_x
;
7823 /* Reset/increment for the next run. */
7824 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7825 it
->current_x
= line_start_x
;
7828 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7830 last_height
= it
->max_ascent
+ it
->max_descent
;
7831 last_max_ascent
= it
->max_ascent
;
7832 it
->max_ascent
= it
->max_descent
= 0;
7837 /* On text terminals, we may stop at the end of a line in the middle
7838 of a multi-character glyph. If the glyph itself is continued,
7839 i.e. it is actually displayed on the next line, don't treat this
7840 stopping point as valid; move to the next line instead (unless
7841 that brings us offscreen). */
7842 if (!FRAME_WINDOW_P (it
->f
)
7844 && IT_CHARPOS (*it
) == to_charpos
7845 && it
->what
== IT_CHARACTER
7847 && it
->line_wrap
== WINDOW_WRAP
7848 && it
->current_x
== it
->last_visible_x
- 1
7851 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7853 it
->continuation_lines_width
+= it
->current_x
;
7854 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7855 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7857 last_height
= it
->max_ascent
+ it
->max_descent
;
7858 last_max_ascent
= it
->max_ascent
;
7861 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7865 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7867 If DY > 0, move IT backward at least that many pixels. DY = 0
7868 means move IT backward to the preceding line start or BEGV. This
7869 function may move over more than DY pixels if IT->current_y - DY
7870 ends up in the middle of a line; in this case IT->current_y will be
7871 set to the top of the line moved to. */
7874 move_it_vertically_backward (it
, dy
)
7885 start_pos
= IT_CHARPOS (*it
);
7887 /* Estimate how many newlines we must move back. */
7888 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7890 /* Set the iterator's position that many lines back. */
7891 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7892 back_to_previous_visible_line_start (it
);
7894 /* Reseat the iterator here. When moving backward, we don't want
7895 reseat to skip forward over invisible text, set up the iterator
7896 to deliver from overlay strings at the new position etc. So,
7897 use reseat_1 here. */
7898 reseat_1 (it
, it
->current
.pos
, 1);
7900 /* We are now surely at a line start. */
7901 it
->current_x
= it
->hpos
= 0;
7902 it
->continuation_lines_width
= 0;
7904 /* Move forward and see what y-distance we moved. First move to the
7905 start of the next line so that we get its height. We need this
7906 height to be able to tell whether we reached the specified
7909 it2
.max_ascent
= it2
.max_descent
= 0;
7912 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7913 MOVE_TO_POS
| MOVE_TO_VPOS
);
7915 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7916 xassert (IT_CHARPOS (*it
) >= BEGV
);
7919 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7920 xassert (IT_CHARPOS (*it
) >= BEGV
);
7921 /* H is the actual vertical distance from the position in *IT
7922 and the starting position. */
7923 h
= it2
.current_y
- it
->current_y
;
7924 /* NLINES is the distance in number of lines. */
7925 nlines
= it2
.vpos
- it
->vpos
;
7927 /* Correct IT's y and vpos position
7928 so that they are relative to the starting point. */
7934 /* DY == 0 means move to the start of the screen line. The
7935 value of nlines is > 0 if continuation lines were involved. */
7937 move_it_by_lines (it
, nlines
, 1);
7941 /* The y-position we try to reach, relative to *IT.
7942 Note that H has been subtracted in front of the if-statement. */
7943 int target_y
= it
->current_y
+ h
- dy
;
7944 int y0
= it3
.current_y
;
7945 int y1
= line_bottom_y (&it3
);
7946 int line_height
= y1
- y0
;
7948 /* If we did not reach target_y, try to move further backward if
7949 we can. If we moved too far backward, try to move forward. */
7950 if (target_y
< it
->current_y
7951 /* This is heuristic. In a window that's 3 lines high, with
7952 a line height of 13 pixels each, recentering with point
7953 on the bottom line will try to move -39/2 = 19 pixels
7954 backward. Try to avoid moving into the first line. */
7955 && (it
->current_y
- target_y
7956 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7957 && IT_CHARPOS (*it
) > BEGV
)
7959 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7960 target_y
- it
->current_y
));
7961 dy
= it
->current_y
- target_y
;
7962 goto move_further_back
;
7964 else if (target_y
>= it
->current_y
+ line_height
7965 && IT_CHARPOS (*it
) < ZV
)
7967 /* Should move forward by at least one line, maybe more.
7969 Note: Calling move_it_by_lines can be expensive on
7970 terminal frames, where compute_motion is used (via
7971 vmotion) to do the job, when there are very long lines
7972 and truncate-lines is nil. That's the reason for
7973 treating terminal frames specially here. */
7975 if (!FRAME_WINDOW_P (it
->f
))
7976 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7981 move_it_by_lines (it
, 1, 1);
7983 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7990 /* Move IT by a specified amount of pixel lines DY. DY negative means
7991 move backwards. DY = 0 means move to start of screen line. At the
7992 end, IT will be on the start of a screen line. */
7995 move_it_vertically (it
, dy
)
8000 move_it_vertically_backward (it
, -dy
);
8003 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8004 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8005 MOVE_TO_POS
| MOVE_TO_Y
);
8006 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8008 /* If buffer ends in ZV without a newline, move to the start of
8009 the line to satisfy the post-condition. */
8010 if (IT_CHARPOS (*it
) == ZV
8012 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8013 move_it_by_lines (it
, 0, 0);
8018 /* Move iterator IT past the end of the text line it is in. */
8021 move_it_past_eol (it
)
8024 enum move_it_result rc
;
8026 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8027 if (rc
== MOVE_NEWLINE_OR_CR
)
8028 set_iterator_to_next (it
, 0);
8032 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8033 negative means move up. DVPOS == 0 means move to the start of the
8034 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
8035 NEED_Y_P is zero, IT->current_y will be left unchanged.
8037 Further optimization ideas: If we would know that IT->f doesn't use
8038 a face with proportional font, we could be faster for
8039 truncate-lines nil. */
8042 move_it_by_lines (it
, dvpos
, need_y_p
)
8044 int dvpos
, need_y_p
;
8046 struct position pos
;
8048 /* The commented-out optimization uses vmotion on terminals. This
8049 gives bad results, because elements like it->what, on which
8050 callers such as pos_visible_p rely, aren't updated. */
8051 /* if (!FRAME_WINDOW_P (it->f))
8053 struct text_pos textpos;
8055 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8056 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8057 reseat (it, textpos, 1);
8058 it->vpos += pos.vpos;
8059 it->current_y += pos.vpos;
8065 /* DVPOS == 0 means move to the start of the screen line. */
8066 move_it_vertically_backward (it
, 0);
8067 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8068 /* Let next call to line_bottom_y calculate real line height */
8073 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8074 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8075 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8080 int start_charpos
, i
;
8082 /* Start at the beginning of the screen line containing IT's
8083 position. This may actually move vertically backwards,
8084 in case of overlays, so adjust dvpos accordingly. */
8086 move_it_vertically_backward (it
, 0);
8089 /* Go back -DVPOS visible lines and reseat the iterator there. */
8090 start_charpos
= IT_CHARPOS (*it
);
8091 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8092 back_to_previous_visible_line_start (it
);
8093 reseat (it
, it
->current
.pos
, 1);
8095 /* Move further back if we end up in a string or an image. */
8096 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8098 /* First try to move to start of display line. */
8100 move_it_vertically_backward (it
, 0);
8102 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8104 /* If start of line is still in string or image,
8105 move further back. */
8106 back_to_previous_visible_line_start (it
);
8107 reseat (it
, it
->current
.pos
, 1);
8111 it
->current_x
= it
->hpos
= 0;
8113 /* Above call may have moved too far if continuation lines
8114 are involved. Scan forward and see if it did. */
8116 it2
.vpos
= it2
.current_y
= 0;
8117 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8118 it
->vpos
-= it2
.vpos
;
8119 it
->current_y
-= it2
.current_y
;
8120 it
->current_x
= it
->hpos
= 0;
8122 /* If we moved too far back, move IT some lines forward. */
8123 if (it2
.vpos
> -dvpos
)
8125 int delta
= it2
.vpos
+ dvpos
;
8127 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8128 /* Move back again if we got too far ahead. */
8129 if (IT_CHARPOS (*it
) >= start_charpos
)
8135 /* Return 1 if IT points into the middle of a display vector. */
8138 in_display_vector_p (it
)
8141 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8142 && it
->current
.dpvec_index
> 0
8143 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8147 /***********************************************************************
8149 ***********************************************************************/
8152 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8156 add_to_log (format
, arg1
, arg2
)
8158 Lisp_Object arg1
, arg2
;
8160 Lisp_Object args
[3];
8161 Lisp_Object msg
, fmt
;
8164 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8167 /* Do nothing if called asynchronously. Inserting text into
8168 a buffer may call after-change-functions and alike and
8169 that would means running Lisp asynchronously. */
8170 if (handling_signal
)
8174 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8176 args
[0] = fmt
= build_string (format
);
8179 msg
= Fformat (3, args
);
8181 len
= SBYTES (msg
) + 1;
8182 SAFE_ALLOCA (buffer
, char *, len
);
8183 bcopy (SDATA (msg
), buffer
, len
);
8185 message_dolog (buffer
, len
- 1, 1, 0);
8192 /* Output a newline in the *Messages* buffer if "needs" one. */
8195 message_log_maybe_newline ()
8197 if (message_log_need_newline
)
8198 message_dolog ("", 0, 1, 0);
8202 /* Add a string M of length NBYTES to the message log, optionally
8203 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8204 nonzero, means interpret the contents of M as multibyte. This
8205 function calls low-level routines in order to bypass text property
8206 hooks, etc. which might not be safe to run.
8208 This may GC (insert may run before/after change hooks),
8209 so the buffer M must NOT point to a Lisp string. */
8212 message_dolog (m
, nbytes
, nlflag
, multibyte
)
8214 int nbytes
, nlflag
, multibyte
;
8216 if (!NILP (Vmemory_full
))
8219 if (!NILP (Vmessage_log_max
))
8221 struct buffer
*oldbuf
;
8222 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8223 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8224 int point_at_end
= 0;
8226 Lisp_Object old_deactivate_mark
, tem
;
8227 struct gcpro gcpro1
;
8229 old_deactivate_mark
= Vdeactivate_mark
;
8230 oldbuf
= current_buffer
;
8231 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8232 current_buffer
->undo_list
= Qt
;
8234 oldpoint
= message_dolog_marker1
;
8235 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8236 oldbegv
= message_dolog_marker2
;
8237 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8238 oldzv
= message_dolog_marker3
;
8239 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8240 GCPRO1 (old_deactivate_mark
);
8248 BEGV_BYTE
= BEG_BYTE
;
8251 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8253 /* Insert the string--maybe converting multibyte to single byte
8254 or vice versa, so that all the text fits the buffer. */
8256 && NILP (current_buffer
->enable_multibyte_characters
))
8258 int i
, c
, char_bytes
;
8259 unsigned char work
[1];
8261 /* Convert a multibyte string to single-byte
8262 for the *Message* buffer. */
8263 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8265 c
= string_char_and_length (m
+ i
, &char_bytes
);
8266 work
[0] = (ASCII_CHAR_P (c
)
8268 : multibyte_char_to_unibyte (c
, Qnil
));
8269 insert_1_both (work
, 1, 1, 1, 0, 0);
8272 else if (! multibyte
8273 && ! NILP (current_buffer
->enable_multibyte_characters
))
8275 int i
, c
, char_bytes
;
8276 unsigned char *msg
= (unsigned char *) m
;
8277 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8278 /* Convert a single-byte string to multibyte
8279 for the *Message* buffer. */
8280 for (i
= 0; i
< nbytes
; i
++)
8283 MAKE_CHAR_MULTIBYTE (c
);
8284 char_bytes
= CHAR_STRING (c
, str
);
8285 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8289 insert_1 (m
, nbytes
, 1, 0, 0);
8293 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8294 insert_1 ("\n", 1, 1, 0, 0);
8296 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8298 this_bol_byte
= PT_BYTE
;
8300 /* See if this line duplicates the previous one.
8301 If so, combine duplicates. */
8304 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8306 prev_bol_byte
= PT_BYTE
;
8308 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8309 this_bol
, this_bol_byte
);
8312 del_range_both (prev_bol
, prev_bol_byte
,
8313 this_bol
, this_bol_byte
, 0);
8319 /* If you change this format, don't forget to also
8320 change message_log_check_duplicate. */
8321 sprintf (dupstr
, " [%d times]", dup
);
8322 duplen
= strlen (dupstr
);
8323 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8324 insert_1 (dupstr
, duplen
, 1, 0, 1);
8329 /* If we have more than the desired maximum number of lines
8330 in the *Messages* buffer now, delete the oldest ones.
8331 This is safe because we don't have undo in this buffer. */
8333 if (NATNUMP (Vmessage_log_max
))
8335 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8336 -XFASTINT (Vmessage_log_max
) - 1, 0);
8337 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8340 BEGV
= XMARKER (oldbegv
)->charpos
;
8341 BEGV_BYTE
= marker_byte_position (oldbegv
);
8350 ZV
= XMARKER (oldzv
)->charpos
;
8351 ZV_BYTE
= marker_byte_position (oldzv
);
8355 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8357 /* We can't do Fgoto_char (oldpoint) because it will run some
8359 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8360 XMARKER (oldpoint
)->bytepos
);
8363 unchain_marker (XMARKER (oldpoint
));
8364 unchain_marker (XMARKER (oldbegv
));
8365 unchain_marker (XMARKER (oldzv
));
8367 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8368 set_buffer_internal (oldbuf
);
8370 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8371 message_log_need_newline
= !nlflag
;
8372 Vdeactivate_mark
= old_deactivate_mark
;
8377 /* We are at the end of the buffer after just having inserted a newline.
8378 (Note: We depend on the fact we won't be crossing the gap.)
8379 Check to see if the most recent message looks a lot like the previous one.
8380 Return 0 if different, 1 if the new one should just replace it, or a
8381 value N > 1 if we should also append " [N times]". */
8384 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8385 int prev_bol
, this_bol
;
8386 int prev_bol_byte
, this_bol_byte
;
8389 int len
= Z_BYTE
- 1 - this_bol_byte
;
8391 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8392 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8394 for (i
= 0; i
< len
; i
++)
8396 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8404 if (*p1
++ == ' ' && *p1
++ == '[')
8407 while (*p1
>= '0' && *p1
<= '9')
8408 n
= n
* 10 + *p1
++ - '0';
8409 if (strncmp (p1
, " times]\n", 8) == 0)
8416 /* Display an echo area message M with a specified length of NBYTES
8417 bytes. The string may include null characters. If M is 0, clear
8418 out any existing message, and let the mini-buffer text show
8421 This may GC, so the buffer M must NOT point to a Lisp string. */
8424 message2 (m
, nbytes
, multibyte
)
8429 /* First flush out any partial line written with print. */
8430 message_log_maybe_newline ();
8432 message_dolog (m
, nbytes
, 1, multibyte
);
8433 message2_nolog (m
, nbytes
, multibyte
);
8437 /* The non-logging counterpart of message2. */
8440 message2_nolog (m
, nbytes
, multibyte
)
8442 int nbytes
, multibyte
;
8444 struct frame
*sf
= SELECTED_FRAME ();
8445 message_enable_multibyte
= multibyte
;
8447 if (FRAME_INITIAL_P (sf
))
8449 if (noninteractive_need_newline
)
8450 putc ('\n', stderr
);
8451 noninteractive_need_newline
= 0;
8453 fwrite (m
, nbytes
, 1, stderr
);
8454 if (cursor_in_echo_area
== 0)
8455 fprintf (stderr
, "\n");
8458 /* A null message buffer means that the frame hasn't really been
8459 initialized yet. Error messages get reported properly by
8460 cmd_error, so this must be just an informative message; toss it. */
8461 else if (INTERACTIVE
8462 && sf
->glyphs_initialized_p
8463 && FRAME_MESSAGE_BUF (sf
))
8465 Lisp_Object mini_window
;
8468 /* Get the frame containing the mini-buffer
8469 that the selected frame is using. */
8470 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8471 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8473 FRAME_SAMPLE_VISIBILITY (f
);
8474 if (FRAME_VISIBLE_P (sf
)
8475 && ! FRAME_VISIBLE_P (f
))
8476 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8480 set_message (m
, Qnil
, nbytes
, multibyte
);
8481 if (minibuffer_auto_raise
)
8482 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8485 clear_message (1, 1);
8487 do_pending_window_change (0);
8488 echo_area_display (1);
8489 do_pending_window_change (0);
8490 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8491 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8496 /* Display an echo area message M with a specified length of NBYTES
8497 bytes. The string may include null characters. If M is not a
8498 string, clear out any existing message, and let the mini-buffer
8501 This function cancels echoing. */
8504 message3 (m
, nbytes
, multibyte
)
8509 struct gcpro gcpro1
;
8512 clear_message (1,1);
8515 /* First flush out any partial line written with print. */
8516 message_log_maybe_newline ();
8522 SAFE_ALLOCA (buffer
, char *, nbytes
);
8523 bcopy (SDATA (m
), buffer
, nbytes
);
8524 message_dolog (buffer
, nbytes
, 1, multibyte
);
8527 message3_nolog (m
, nbytes
, multibyte
);
8533 /* The non-logging version of message3.
8534 This does not cancel echoing, because it is used for echoing.
8535 Perhaps we need to make a separate function for echoing
8536 and make this cancel echoing. */
8539 message3_nolog (m
, nbytes
, multibyte
)
8541 int nbytes
, multibyte
;
8543 struct frame
*sf
= SELECTED_FRAME ();
8544 message_enable_multibyte
= multibyte
;
8546 if (FRAME_INITIAL_P (sf
))
8548 if (noninteractive_need_newline
)
8549 putc ('\n', stderr
);
8550 noninteractive_need_newline
= 0;
8552 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8553 if (cursor_in_echo_area
== 0)
8554 fprintf (stderr
, "\n");
8557 /* A null message buffer means that the frame hasn't really been
8558 initialized yet. Error messages get reported properly by
8559 cmd_error, so this must be just an informative message; toss it. */
8560 else if (INTERACTIVE
8561 && sf
->glyphs_initialized_p
8562 && FRAME_MESSAGE_BUF (sf
))
8564 Lisp_Object mini_window
;
8568 /* Get the frame containing the mini-buffer
8569 that the selected frame is using. */
8570 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8571 frame
= XWINDOW (mini_window
)->frame
;
8574 FRAME_SAMPLE_VISIBILITY (f
);
8575 if (FRAME_VISIBLE_P (sf
)
8576 && !FRAME_VISIBLE_P (f
))
8577 Fmake_frame_visible (frame
);
8579 if (STRINGP (m
) && SCHARS (m
) > 0)
8581 set_message (NULL
, m
, nbytes
, multibyte
);
8582 if (minibuffer_auto_raise
)
8583 Fraise_frame (frame
);
8584 /* Assume we are not echoing.
8585 (If we are, echo_now will override this.) */
8586 echo_message_buffer
= Qnil
;
8589 clear_message (1, 1);
8591 do_pending_window_change (0);
8592 echo_area_display (1);
8593 do_pending_window_change (0);
8594 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8595 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8600 /* Display a null-terminated echo area message M. If M is 0, clear
8601 out any existing message, and let the mini-buffer text show through.
8603 The buffer M must continue to exist until after the echo area gets
8604 cleared or some other message gets displayed there. Do not pass
8605 text that is stored in a Lisp string. Do not pass text in a buffer
8606 that was alloca'd. */
8612 message2 (m
, (m
? strlen (m
) : 0), 0);
8616 /* The non-logging counterpart of message1. */
8622 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8625 /* Display a message M which contains a single %s
8626 which gets replaced with STRING. */
8629 message_with_string (m
, string
, log
)
8634 CHECK_STRING (string
);
8640 if (noninteractive_need_newline
)
8641 putc ('\n', stderr
);
8642 noninteractive_need_newline
= 0;
8643 fprintf (stderr
, m
, SDATA (string
));
8644 if (!cursor_in_echo_area
)
8645 fprintf (stderr
, "\n");
8649 else if (INTERACTIVE
)
8651 /* The frame whose minibuffer we're going to display the message on.
8652 It may be larger than the selected frame, so we need
8653 to use its buffer, not the selected frame's buffer. */
8654 Lisp_Object mini_window
;
8655 struct frame
*f
, *sf
= SELECTED_FRAME ();
8657 /* Get the frame containing the minibuffer
8658 that the selected frame is using. */
8659 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8660 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8662 /* A null message buffer means that the frame hasn't really been
8663 initialized yet. Error messages get reported properly by
8664 cmd_error, so this must be just an informative message; toss it. */
8665 if (FRAME_MESSAGE_BUF (f
))
8667 Lisp_Object args
[2], message
;
8668 struct gcpro gcpro1
, gcpro2
;
8670 args
[0] = build_string (m
);
8671 args
[1] = message
= string
;
8672 GCPRO2 (args
[0], message
);
8675 message
= Fformat (2, args
);
8678 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8680 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8684 /* Print should start at the beginning of the message
8685 buffer next time. */
8686 message_buf_print
= 0;
8692 /* Dump an informative message to the minibuf. If M is 0, clear out
8693 any existing message, and let the mini-buffer text show through. */
8697 message (m
, a1
, a2
, a3
)
8699 EMACS_INT a1
, a2
, a3
;
8705 if (noninteractive_need_newline
)
8706 putc ('\n', stderr
);
8707 noninteractive_need_newline
= 0;
8708 fprintf (stderr
, m
, a1
, a2
, a3
);
8709 if (cursor_in_echo_area
== 0)
8710 fprintf (stderr
, "\n");
8714 else if (INTERACTIVE
)
8716 /* The frame whose mini-buffer we're going to display the message
8717 on. It may be larger than the selected frame, so we need to
8718 use its buffer, not the selected frame's buffer. */
8719 Lisp_Object mini_window
;
8720 struct frame
*f
, *sf
= SELECTED_FRAME ();
8722 /* Get the frame containing the mini-buffer
8723 that the selected frame is using. */
8724 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8725 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8727 /* A null message buffer means that the frame hasn't really been
8728 initialized yet. Error messages get reported properly by
8729 cmd_error, so this must be just an informative message; toss
8731 if (FRAME_MESSAGE_BUF (f
))
8741 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8742 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8744 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8749 /* Print should start at the beginning of the message
8750 buffer next time. */
8751 message_buf_print
= 0;
8757 /* The non-logging version of message. */
8760 message_nolog (m
, a1
, a2
, a3
)
8762 EMACS_INT a1
, a2
, a3
;
8764 Lisp_Object old_log_max
;
8765 old_log_max
= Vmessage_log_max
;
8766 Vmessage_log_max
= Qnil
;
8767 message (m
, a1
, a2
, a3
);
8768 Vmessage_log_max
= old_log_max
;
8772 /* Display the current message in the current mini-buffer. This is
8773 only called from error handlers in process.c, and is not time
8779 if (!NILP (echo_area_buffer
[0]))
8782 string
= Fcurrent_message ();
8783 message3 (string
, SBYTES (string
),
8784 !NILP (current_buffer
->enable_multibyte_characters
));
8789 /* Make sure echo area buffers in `echo_buffers' are live.
8790 If they aren't, make new ones. */
8793 ensure_echo_area_buffers ()
8797 for (i
= 0; i
< 2; ++i
)
8798 if (!BUFFERP (echo_buffer
[i
])
8799 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8802 Lisp_Object old_buffer
;
8805 old_buffer
= echo_buffer
[i
];
8806 sprintf (name
, " *Echo Area %d*", i
);
8807 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8808 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8809 /* to force word wrap in echo area -
8810 it was decided to postpone this*/
8811 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8813 for (j
= 0; j
< 2; ++j
)
8814 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8815 echo_area_buffer
[j
] = echo_buffer
[i
];
8820 /* Call FN with args A1..A4 with either the current or last displayed
8821 echo_area_buffer as current buffer.
8823 WHICH zero means use the current message buffer
8824 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8825 from echo_buffer[] and clear it.
8827 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8828 suitable buffer from echo_buffer[] and clear it.
8830 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8831 that the current message becomes the last displayed one, make
8832 choose a suitable buffer for echo_area_buffer[0], and clear it.
8834 Value is what FN returns. */
8837 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8840 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8846 int this_one
, the_other
, clear_buffer_p
, rc
;
8847 int count
= SPECPDL_INDEX ();
8849 /* If buffers aren't live, make new ones. */
8850 ensure_echo_area_buffers ();
8855 this_one
= 0, the_other
= 1;
8857 this_one
= 1, the_other
= 0;
8860 this_one
= 0, the_other
= 1;
8863 /* We need a fresh one in case the current echo buffer equals
8864 the one containing the last displayed echo area message. */
8865 if (!NILP (echo_area_buffer
[this_one
])
8866 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8867 echo_area_buffer
[this_one
] = Qnil
;
8870 /* Choose a suitable buffer from echo_buffer[] is we don't
8872 if (NILP (echo_area_buffer
[this_one
]))
8874 echo_area_buffer
[this_one
]
8875 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8876 ? echo_buffer
[the_other
]
8877 : echo_buffer
[this_one
]);
8881 buffer
= echo_area_buffer
[this_one
];
8883 /* Don't get confused by reusing the buffer used for echoing
8884 for a different purpose. */
8885 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8888 record_unwind_protect (unwind_with_echo_area_buffer
,
8889 with_echo_area_buffer_unwind_data (w
));
8891 /* Make the echo area buffer current. Note that for display
8892 purposes, it is not necessary that the displayed window's buffer
8893 == current_buffer, except for text property lookup. So, let's
8894 only set that buffer temporarily here without doing a full
8895 Fset_window_buffer. We must also change w->pointm, though,
8896 because otherwise an assertions in unshow_buffer fails, and Emacs
8898 set_buffer_internal_1 (XBUFFER (buffer
));
8902 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8905 current_buffer
->undo_list
= Qt
;
8906 current_buffer
->read_only
= Qnil
;
8907 specbind (Qinhibit_read_only
, Qt
);
8908 specbind (Qinhibit_modification_hooks
, Qt
);
8910 if (clear_buffer_p
&& Z
> BEG
)
8913 xassert (BEGV
>= BEG
);
8914 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8916 rc
= fn (a1
, a2
, a3
, a4
);
8918 xassert (BEGV
>= BEG
);
8919 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8921 unbind_to (count
, Qnil
);
8926 /* Save state that should be preserved around the call to the function
8927 FN called in with_echo_area_buffer. */
8930 with_echo_area_buffer_unwind_data (w
)
8934 Lisp_Object vector
, tmp
;
8936 /* Reduce consing by keeping one vector in
8937 Vwith_echo_area_save_vector. */
8938 vector
= Vwith_echo_area_save_vector
;
8939 Vwith_echo_area_save_vector
= Qnil
;
8942 vector
= Fmake_vector (make_number (7), Qnil
);
8944 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8945 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8946 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8950 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8951 ASET (vector
, i
, w
->buffer
); ++i
;
8952 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8953 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8958 for (; i
< end
; ++i
)
8959 ASET (vector
, i
, Qnil
);
8962 xassert (i
== ASIZE (vector
));
8967 /* Restore global state from VECTOR which was created by
8968 with_echo_area_buffer_unwind_data. */
8971 unwind_with_echo_area_buffer (vector
)
8974 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8975 Vdeactivate_mark
= AREF (vector
, 1);
8976 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8978 if (WINDOWP (AREF (vector
, 3)))
8981 Lisp_Object buffer
, charpos
, bytepos
;
8983 w
= XWINDOW (AREF (vector
, 3));
8984 buffer
= AREF (vector
, 4);
8985 charpos
= AREF (vector
, 5);
8986 bytepos
= AREF (vector
, 6);
8989 set_marker_both (w
->pointm
, buffer
,
8990 XFASTINT (charpos
), XFASTINT (bytepos
));
8993 Vwith_echo_area_save_vector
= vector
;
8998 /* Set up the echo area for use by print functions. MULTIBYTE_P
8999 non-zero means we will print multibyte. */
9002 setup_echo_area_for_printing (multibyte_p
)
9005 /* If we can't find an echo area any more, exit. */
9006 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9009 ensure_echo_area_buffers ();
9011 if (!message_buf_print
)
9013 /* A message has been output since the last time we printed.
9014 Choose a fresh echo area buffer. */
9015 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9016 echo_area_buffer
[0] = echo_buffer
[1];
9018 echo_area_buffer
[0] = echo_buffer
[0];
9020 /* Switch to that buffer and clear it. */
9021 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9022 current_buffer
->truncate_lines
= Qnil
;
9026 int count
= SPECPDL_INDEX ();
9027 specbind (Qinhibit_read_only
, Qt
);
9028 /* Note that undo recording is always disabled. */
9030 unbind_to (count
, Qnil
);
9032 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9034 /* Set up the buffer for the multibyteness we need. */
9036 != !NILP (current_buffer
->enable_multibyte_characters
))
9037 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9039 /* Raise the frame containing the echo area. */
9040 if (minibuffer_auto_raise
)
9042 struct frame
*sf
= SELECTED_FRAME ();
9043 Lisp_Object mini_window
;
9044 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9045 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9048 message_log_maybe_newline ();
9049 message_buf_print
= 1;
9053 if (NILP (echo_area_buffer
[0]))
9055 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9056 echo_area_buffer
[0] = echo_buffer
[1];
9058 echo_area_buffer
[0] = echo_buffer
[0];
9061 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9063 /* Someone switched buffers between print requests. */
9064 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9065 current_buffer
->truncate_lines
= Qnil
;
9071 /* Display an echo area message in window W. Value is non-zero if W's
9072 height is changed. If display_last_displayed_message_p is
9073 non-zero, display the message that was last displayed, otherwise
9074 display the current message. */
9077 display_echo_area (w
)
9080 int i
, no_message_p
, window_height_changed_p
, count
;
9082 /* Temporarily disable garbage collections while displaying the echo
9083 area. This is done because a GC can print a message itself.
9084 That message would modify the echo area buffer's contents while a
9085 redisplay of the buffer is going on, and seriously confuse
9087 count
= inhibit_garbage_collection ();
9089 /* If there is no message, we must call display_echo_area_1
9090 nevertheless because it resizes the window. But we will have to
9091 reset the echo_area_buffer in question to nil at the end because
9092 with_echo_area_buffer will sets it to an empty buffer. */
9093 i
= display_last_displayed_message_p
? 1 : 0;
9094 no_message_p
= NILP (echo_area_buffer
[i
]);
9096 window_height_changed_p
9097 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9098 display_echo_area_1
,
9099 (EMACS_INT
) w
, Qnil
, 0, 0);
9102 echo_area_buffer
[i
] = Qnil
;
9104 unbind_to (count
, Qnil
);
9105 return window_height_changed_p
;
9109 /* Helper for display_echo_area. Display the current buffer which
9110 contains the current echo area message in window W, a mini-window,
9111 a pointer to which is passed in A1. A2..A4 are currently not used.
9112 Change the height of W so that all of the message is displayed.
9113 Value is non-zero if height of W was changed. */
9116 display_echo_area_1 (a1
, a2
, a3
, a4
)
9121 struct window
*w
= (struct window
*) a1
;
9123 struct text_pos start
;
9124 int window_height_changed_p
= 0;
9126 /* Do this before displaying, so that we have a large enough glyph
9127 matrix for the display. If we can't get enough space for the
9128 whole text, display the last N lines. That works by setting w->start. */
9129 window_height_changed_p
= resize_mini_window (w
, 0);
9131 /* Use the starting position chosen by resize_mini_window. */
9132 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9135 clear_glyph_matrix (w
->desired_matrix
);
9136 XSETWINDOW (window
, w
);
9137 try_window (window
, start
, 0);
9139 return window_height_changed_p
;
9143 /* Resize the echo area window to exactly the size needed for the
9144 currently displayed message, if there is one. If a mini-buffer
9145 is active, don't shrink it. */
9148 resize_echo_area_exactly ()
9150 if (BUFFERP (echo_area_buffer
[0])
9151 && WINDOWP (echo_area_window
))
9153 struct window
*w
= XWINDOW (echo_area_window
);
9155 Lisp_Object resize_exactly
;
9157 if (minibuf_level
== 0)
9158 resize_exactly
= Qt
;
9160 resize_exactly
= Qnil
;
9162 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9163 (EMACS_INT
) w
, resize_exactly
, 0, 0);
9166 ++windows_or_buffers_changed
;
9167 ++update_mode_lines
;
9168 redisplay_internal (0);
9174 /* Callback function for with_echo_area_buffer, when used from
9175 resize_echo_area_exactly. A1 contains a pointer to the window to
9176 resize, EXACTLY non-nil means resize the mini-window exactly to the
9177 size of the text displayed. A3 and A4 are not used. Value is what
9178 resize_mini_window returns. */
9181 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
9183 Lisp_Object exactly
;
9186 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
9190 /* Resize mini-window W to fit the size of its contents. EXACT_P
9191 means size the window exactly to the size needed. Otherwise, it's
9192 only enlarged until W's buffer is empty.
9194 Set W->start to the right place to begin display. If the whole
9195 contents fit, start at the beginning. Otherwise, start so as
9196 to make the end of the contents appear. This is particularly
9197 important for y-or-n-p, but seems desirable generally.
9199 Value is non-zero if the window height has been changed. */
9202 resize_mini_window (w
, exact_p
)
9206 struct frame
*f
= XFRAME (w
->frame
);
9207 int window_height_changed_p
= 0;
9209 xassert (MINI_WINDOW_P (w
));
9211 /* By default, start display at the beginning. */
9212 set_marker_both (w
->start
, w
->buffer
,
9213 BUF_BEGV (XBUFFER (w
->buffer
)),
9214 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9216 /* Don't resize windows while redisplaying a window; it would
9217 confuse redisplay functions when the size of the window they are
9218 displaying changes from under them. Such a resizing can happen,
9219 for instance, when which-func prints a long message while
9220 we are running fontification-functions. We're running these
9221 functions with safe_call which binds inhibit-redisplay to t. */
9222 if (!NILP (Vinhibit_redisplay
))
9225 /* Nil means don't try to resize. */
9226 if (NILP (Vresize_mini_windows
)
9227 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9230 if (!FRAME_MINIBUF_ONLY_P (f
))
9233 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9234 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9235 int height
, max_height
;
9236 int unit
= FRAME_LINE_HEIGHT (f
);
9237 struct text_pos start
;
9238 struct buffer
*old_current_buffer
= NULL
;
9240 if (current_buffer
!= XBUFFER (w
->buffer
))
9242 old_current_buffer
= current_buffer
;
9243 set_buffer_internal (XBUFFER (w
->buffer
));
9246 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9248 /* Compute the max. number of lines specified by the user. */
9249 if (FLOATP (Vmax_mini_window_height
))
9250 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9251 else if (INTEGERP (Vmax_mini_window_height
))
9252 max_height
= XINT (Vmax_mini_window_height
);
9254 max_height
= total_height
/ 4;
9256 /* Correct that max. height if it's bogus. */
9257 max_height
= max (1, max_height
);
9258 max_height
= min (total_height
, max_height
);
9260 /* Find out the height of the text in the window. */
9261 if (it
.line_wrap
== TRUNCATE
)
9266 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9267 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9268 height
= it
.current_y
+ last_height
;
9270 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9271 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9272 height
= (height
+ unit
- 1) / unit
;
9275 /* Compute a suitable window start. */
9276 if (height
> max_height
)
9278 height
= max_height
;
9279 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9280 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9281 start
= it
.current
.pos
;
9284 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9285 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9287 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9289 /* Let it grow only, until we display an empty message, in which
9290 case the window shrinks again. */
9291 if (height
> WINDOW_TOTAL_LINES (w
))
9293 int old_height
= WINDOW_TOTAL_LINES (w
);
9294 freeze_window_starts (f
, 1);
9295 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9296 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9298 else if (height
< WINDOW_TOTAL_LINES (w
)
9299 && (exact_p
|| BEGV
== ZV
))
9301 int old_height
= WINDOW_TOTAL_LINES (w
);
9302 freeze_window_starts (f
, 0);
9303 shrink_mini_window (w
);
9304 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9309 /* Always resize to exact size needed. */
9310 if (height
> WINDOW_TOTAL_LINES (w
))
9312 int old_height
= WINDOW_TOTAL_LINES (w
);
9313 freeze_window_starts (f
, 1);
9314 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9315 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9317 else if (height
< WINDOW_TOTAL_LINES (w
))
9319 int old_height
= WINDOW_TOTAL_LINES (w
);
9320 freeze_window_starts (f
, 0);
9321 shrink_mini_window (w
);
9325 freeze_window_starts (f
, 1);
9326 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9329 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9333 if (old_current_buffer
)
9334 set_buffer_internal (old_current_buffer
);
9337 return window_height_changed_p
;
9341 /* Value is the current message, a string, or nil if there is no
9349 if (!BUFFERP (echo_area_buffer
[0]))
9353 with_echo_area_buffer (0, 0, current_message_1
,
9354 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9356 echo_area_buffer
[0] = Qnil
;
9364 current_message_1 (a1
, a2
, a3
, a4
)
9369 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9372 *msg
= make_buffer_string (BEG
, Z
, 1);
9379 /* Push the current message on Vmessage_stack for later restauration
9380 by restore_message. Value is non-zero if the current message isn't
9381 empty. This is a relatively infrequent operation, so it's not
9382 worth optimizing. */
9388 msg
= current_message ();
9389 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9390 return STRINGP (msg
);
9394 /* Restore message display from the top of Vmessage_stack. */
9401 xassert (CONSP (Vmessage_stack
));
9402 msg
= XCAR (Vmessage_stack
);
9404 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9406 message3_nolog (msg
, 0, 0);
9410 /* Handler for record_unwind_protect calling pop_message. */
9413 pop_message_unwind (dummy
)
9420 /* Pop the top-most entry off Vmessage_stack. */
9425 xassert (CONSP (Vmessage_stack
));
9426 Vmessage_stack
= XCDR (Vmessage_stack
);
9430 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9431 exits. If the stack is not empty, we have a missing pop_message
9435 check_message_stack ()
9437 if (!NILP (Vmessage_stack
))
9442 /* Truncate to NCHARS what will be displayed in the echo area the next
9443 time we display it---but don't redisplay it now. */
9446 truncate_echo_area (nchars
)
9450 echo_area_buffer
[0] = Qnil
;
9451 /* A null message buffer means that the frame hasn't really been
9452 initialized yet. Error messages get reported properly by
9453 cmd_error, so this must be just an informative message; toss it. */
9454 else if (!noninteractive
9456 && !NILP (echo_area_buffer
[0]))
9458 struct frame
*sf
= SELECTED_FRAME ();
9459 if (FRAME_MESSAGE_BUF (sf
))
9460 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9465 /* Helper function for truncate_echo_area. Truncate the current
9466 message to at most NCHARS characters. */
9469 truncate_message_1 (nchars
, a2
, a3
, a4
)
9474 if (BEG
+ nchars
< Z
)
9475 del_range (BEG
+ nchars
, Z
);
9477 echo_area_buffer
[0] = Qnil
;
9482 /* Set the current message to a substring of S or STRING.
9484 If STRING is a Lisp string, set the message to the first NBYTES
9485 bytes from STRING. NBYTES zero means use the whole string. If
9486 STRING is multibyte, the message will be displayed multibyte.
9488 If S is not null, set the message to the first LEN bytes of S. LEN
9489 zero means use the whole string. MULTIBYTE_P non-zero means S is
9490 multibyte. Display the message multibyte in that case.
9492 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9493 to t before calling set_message_1 (which calls insert).
9497 set_message (s
, string
, nbytes
, multibyte_p
)
9500 int nbytes
, multibyte_p
;
9502 message_enable_multibyte
9503 = ((s
&& multibyte_p
)
9504 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9506 with_echo_area_buffer (0, -1, set_message_1
,
9507 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9508 message_buf_print
= 0;
9509 help_echo_showing_p
= 0;
9513 /* Helper function for set_message. Arguments have the same meaning
9514 as there, with A1 corresponding to S and A2 corresponding to STRING
9515 This function is called with the echo area buffer being
9519 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9522 EMACS_INT nbytes
, multibyte_p
;
9524 const char *s
= (const char *) a1
;
9525 Lisp_Object string
= a2
;
9527 /* Change multibyteness of the echo buffer appropriately. */
9528 if (message_enable_multibyte
9529 != !NILP (current_buffer
->enable_multibyte_characters
))
9530 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9532 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9534 /* Insert new message at BEG. */
9535 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9537 if (STRINGP (string
))
9542 nbytes
= SBYTES (string
);
9543 nchars
= string_byte_to_char (string
, nbytes
);
9545 /* This function takes care of single/multibyte conversion. We
9546 just have to ensure that the echo area buffer has the right
9547 setting of enable_multibyte_characters. */
9548 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9553 nbytes
= strlen (s
);
9555 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9557 /* Convert from multi-byte to single-byte. */
9559 unsigned char work
[1];
9561 /* Convert a multibyte string to single-byte. */
9562 for (i
= 0; i
< nbytes
; i
+= n
)
9564 c
= string_char_and_length (s
+ i
, &n
);
9565 work
[0] = (ASCII_CHAR_P (c
)
9567 : multibyte_char_to_unibyte (c
, Qnil
));
9568 insert_1_both (work
, 1, 1, 1, 0, 0);
9571 else if (!multibyte_p
9572 && !NILP (current_buffer
->enable_multibyte_characters
))
9574 /* Convert from single-byte to multi-byte. */
9576 const unsigned char *msg
= (const unsigned char *) s
;
9577 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9579 /* Convert a single-byte string to multibyte. */
9580 for (i
= 0; i
< nbytes
; i
++)
9583 MAKE_CHAR_MULTIBYTE (c
);
9584 n
= CHAR_STRING (c
, str
);
9585 insert_1_both (str
, 1, n
, 1, 0, 0);
9589 insert_1 (s
, nbytes
, 1, 0, 0);
9596 /* Clear messages. CURRENT_P non-zero means clear the current
9597 message. LAST_DISPLAYED_P non-zero means clear the message
9601 clear_message (current_p
, last_displayed_p
)
9602 int current_p
, last_displayed_p
;
9606 echo_area_buffer
[0] = Qnil
;
9607 message_cleared_p
= 1;
9610 if (last_displayed_p
)
9611 echo_area_buffer
[1] = Qnil
;
9613 message_buf_print
= 0;
9616 /* Clear garbaged frames.
9618 This function is used where the old redisplay called
9619 redraw_garbaged_frames which in turn called redraw_frame which in
9620 turn called clear_frame. The call to clear_frame was a source of
9621 flickering. I believe a clear_frame is not necessary. It should
9622 suffice in the new redisplay to invalidate all current matrices,
9623 and ensure a complete redisplay of all windows. */
9626 clear_garbaged_frames ()
9630 Lisp_Object tail
, frame
;
9631 int changed_count
= 0;
9633 FOR_EACH_FRAME (tail
, frame
)
9635 struct frame
*f
= XFRAME (frame
);
9637 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9641 Fredraw_frame (frame
);
9642 f
->force_flush_display_p
= 1;
9644 clear_current_matrices (f
);
9653 ++windows_or_buffers_changed
;
9658 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9659 is non-zero update selected_frame. Value is non-zero if the
9660 mini-windows height has been changed. */
9663 echo_area_display (update_frame_p
)
9666 Lisp_Object mini_window
;
9669 int window_height_changed_p
= 0;
9670 struct frame
*sf
= SELECTED_FRAME ();
9672 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9673 w
= XWINDOW (mini_window
);
9674 f
= XFRAME (WINDOW_FRAME (w
));
9676 /* Don't display if frame is invisible or not yet initialized. */
9677 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9680 #ifdef HAVE_WINDOW_SYSTEM
9681 /* When Emacs starts, selected_frame may be the initial terminal
9682 frame. If we let this through, a message would be displayed on
9684 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9686 #endif /* HAVE_WINDOW_SYSTEM */
9688 /* Redraw garbaged frames. */
9690 clear_garbaged_frames ();
9692 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9694 echo_area_window
= mini_window
;
9695 window_height_changed_p
= display_echo_area (w
);
9696 w
->must_be_updated_p
= 1;
9698 /* Update the display, unless called from redisplay_internal.
9699 Also don't update the screen during redisplay itself. The
9700 update will happen at the end of redisplay, and an update
9701 here could cause confusion. */
9702 if (update_frame_p
&& !redisplaying_p
)
9706 /* If the display update has been interrupted by pending
9707 input, update mode lines in the frame. Due to the
9708 pending input, it might have been that redisplay hasn't
9709 been called, so that mode lines above the echo area are
9710 garbaged. This looks odd, so we prevent it here. */
9711 if (!display_completed
)
9712 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9714 if (window_height_changed_p
9715 /* Don't do this if Emacs is shutting down. Redisplay
9716 needs to run hooks. */
9717 && !NILP (Vrun_hooks
))
9719 /* Must update other windows. Likewise as in other
9720 cases, don't let this update be interrupted by
9722 int count
= SPECPDL_INDEX ();
9723 specbind (Qredisplay_dont_pause
, Qt
);
9724 windows_or_buffers_changed
= 1;
9725 redisplay_internal (0);
9726 unbind_to (count
, Qnil
);
9728 else if (FRAME_WINDOW_P (f
) && n
== 0)
9730 /* Window configuration is the same as before.
9731 Can do with a display update of the echo area,
9732 unless we displayed some mode lines. */
9733 update_single_window (w
, 1);
9734 FRAME_RIF (f
)->flush_display (f
);
9737 update_frame (f
, 1, 1);
9739 /* If cursor is in the echo area, make sure that the next
9740 redisplay displays the minibuffer, so that the cursor will
9741 be replaced with what the minibuffer wants. */
9742 if (cursor_in_echo_area
)
9743 ++windows_or_buffers_changed
;
9746 else if (!EQ (mini_window
, selected_window
))
9747 windows_or_buffers_changed
++;
9749 /* Last displayed message is now the current message. */
9750 echo_area_buffer
[1] = echo_area_buffer
[0];
9751 /* Inform read_char that we're not echoing. */
9752 echo_message_buffer
= Qnil
;
9754 /* Prevent redisplay optimization in redisplay_internal by resetting
9755 this_line_start_pos. This is done because the mini-buffer now
9756 displays the message instead of its buffer text. */
9757 if (EQ (mini_window
, selected_window
))
9758 CHARPOS (this_line_start_pos
) = 0;
9760 return window_height_changed_p
;
9765 /***********************************************************************
9766 Mode Lines and Frame Titles
9767 ***********************************************************************/
9769 /* A buffer for constructing non-propertized mode-line strings and
9770 frame titles in it; allocated from the heap in init_xdisp and
9771 resized as needed in store_mode_line_noprop_char. */
9773 static char *mode_line_noprop_buf
;
9775 /* The buffer's end, and a current output position in it. */
9777 static char *mode_line_noprop_buf_end
;
9778 static char *mode_line_noprop_ptr
;
9780 #define MODE_LINE_NOPROP_LEN(start) \
9781 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9784 MODE_LINE_DISPLAY
= 0,
9790 /* Alist that caches the results of :propertize.
9791 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9792 static Lisp_Object mode_line_proptrans_alist
;
9794 /* List of strings making up the mode-line. */
9795 static Lisp_Object mode_line_string_list
;
9797 /* Base face property when building propertized mode line string. */
9798 static Lisp_Object mode_line_string_face
;
9799 static Lisp_Object mode_line_string_face_prop
;
9802 /* Unwind data for mode line strings */
9804 static Lisp_Object Vmode_line_unwind_vector
;
9807 format_mode_line_unwind_data (struct buffer
*obuf
,
9811 Lisp_Object vector
, tmp
;
9813 /* Reduce consing by keeping one vector in
9814 Vwith_echo_area_save_vector. */
9815 vector
= Vmode_line_unwind_vector
;
9816 Vmode_line_unwind_vector
= Qnil
;
9819 vector
= Fmake_vector (make_number (8), Qnil
);
9821 ASET (vector
, 0, make_number (mode_line_target
));
9822 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9823 ASET (vector
, 2, mode_line_string_list
);
9824 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9825 ASET (vector
, 4, mode_line_string_face
);
9826 ASET (vector
, 5, mode_line_string_face_prop
);
9829 XSETBUFFER (tmp
, obuf
);
9832 ASET (vector
, 6, tmp
);
9833 ASET (vector
, 7, owin
);
9839 unwind_format_mode_line (vector
)
9842 mode_line_target
= XINT (AREF (vector
, 0));
9843 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9844 mode_line_string_list
= AREF (vector
, 2);
9845 if (! EQ (AREF (vector
, 3), Qt
))
9846 mode_line_proptrans_alist
= AREF (vector
, 3);
9847 mode_line_string_face
= AREF (vector
, 4);
9848 mode_line_string_face_prop
= AREF (vector
, 5);
9850 if (!NILP (AREF (vector
, 7)))
9851 /* Select window before buffer, since it may change the buffer. */
9852 Fselect_window (AREF (vector
, 7), Qt
);
9854 if (!NILP (AREF (vector
, 6)))
9856 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9857 ASET (vector
, 6, Qnil
);
9860 Vmode_line_unwind_vector
= vector
;
9865 /* Store a single character C for the frame title in mode_line_noprop_buf.
9866 Re-allocate mode_line_noprop_buf if necessary. */
9870 store_mode_line_noprop_char (char c
)
9872 store_mode_line_noprop_char (c
)
9876 /* If output position has reached the end of the allocated buffer,
9877 double the buffer's size. */
9878 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9880 int len
= MODE_LINE_NOPROP_LEN (0);
9881 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9882 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9883 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9884 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9887 *mode_line_noprop_ptr
++ = c
;
9891 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9892 mode_line_noprop_ptr. STR is the string to store. Do not copy
9893 characters that yield more columns than PRECISION; PRECISION <= 0
9894 means copy the whole string. Pad with spaces until FIELD_WIDTH
9895 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9896 pad. Called from display_mode_element when it is used to build a
9900 store_mode_line_noprop (str
, field_width
, precision
)
9901 const unsigned char *str
;
9902 int field_width
, precision
;
9907 /* Copy at most PRECISION chars from STR. */
9908 nbytes
= strlen (str
);
9909 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9911 store_mode_line_noprop_char (*str
++);
9913 /* Fill up with spaces until FIELD_WIDTH reached. */
9914 while (field_width
> 0
9917 store_mode_line_noprop_char (' ');
9924 /***********************************************************************
9926 ***********************************************************************/
9928 #ifdef HAVE_WINDOW_SYSTEM
9930 /* Set the title of FRAME, if it has changed. The title format is
9931 Vicon_title_format if FRAME is iconified, otherwise it is
9932 frame_title_format. */
9935 x_consider_frame_title (frame
)
9938 struct frame
*f
= XFRAME (frame
);
9940 if (FRAME_WINDOW_P (f
)
9941 || FRAME_MINIBUF_ONLY_P (f
)
9942 || f
->explicit_name
)
9944 /* Do we have more than one visible frame on this X display? */
9951 int count
= SPECPDL_INDEX ();
9953 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9955 Lisp_Object other_frame
= XCAR (tail
);
9956 struct frame
*tf
= XFRAME (other_frame
);
9959 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9960 && !FRAME_MINIBUF_ONLY_P (tf
)
9961 && !EQ (other_frame
, tip_frame
)
9962 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9966 /* Set global variable indicating that multiple frames exist. */
9967 multiple_frames
= CONSP (tail
);
9969 /* Switch to the buffer of selected window of the frame. Set up
9970 mode_line_target so that display_mode_element will output into
9971 mode_line_noprop_buf; then display the title. */
9972 record_unwind_protect (unwind_format_mode_line
,
9973 format_mode_line_unwind_data
9974 (current_buffer
, selected_window
, 0));
9976 Fselect_window (f
->selected_window
, Qt
);
9977 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9978 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9980 mode_line_target
= MODE_LINE_TITLE
;
9981 title_start
= MODE_LINE_NOPROP_LEN (0);
9982 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9983 NULL
, DEFAULT_FACE_ID
);
9984 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9985 len
= MODE_LINE_NOPROP_LEN (title_start
);
9986 title
= mode_line_noprop_buf
+ title_start
;
9987 unbind_to (count
, Qnil
);
9989 /* Set the title only if it's changed. This avoids consing in
9990 the common case where it hasn't. (If it turns out that we've
9991 already wasted too much time by walking through the list with
9992 display_mode_element, then we might need to optimize at a
9993 higher level than this.) */
9994 if (! STRINGP (f
->name
)
9995 || SBYTES (f
->name
) != len
9996 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9997 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10001 #endif /* not HAVE_WINDOW_SYSTEM */
10006 /***********************************************************************
10008 ***********************************************************************/
10011 /* Prepare for redisplay by updating menu-bar item lists when
10012 appropriate. This can call eval. */
10015 prepare_menu_bars ()
10018 struct gcpro gcpro1
, gcpro2
;
10020 Lisp_Object tooltip_frame
;
10022 #ifdef HAVE_WINDOW_SYSTEM
10023 tooltip_frame
= tip_frame
;
10025 tooltip_frame
= Qnil
;
10028 /* Update all frame titles based on their buffer names, etc. We do
10029 this before the menu bars so that the buffer-menu will show the
10030 up-to-date frame titles. */
10031 #ifdef HAVE_WINDOW_SYSTEM
10032 if (windows_or_buffers_changed
|| update_mode_lines
)
10034 Lisp_Object tail
, frame
;
10036 FOR_EACH_FRAME (tail
, frame
)
10038 f
= XFRAME (frame
);
10039 if (!EQ (frame
, tooltip_frame
)
10040 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10041 x_consider_frame_title (frame
);
10044 #endif /* HAVE_WINDOW_SYSTEM */
10046 /* Update the menu bar item lists, if appropriate. This has to be
10047 done before any actual redisplay or generation of display lines. */
10048 all_windows
= (update_mode_lines
10049 || buffer_shared
> 1
10050 || windows_or_buffers_changed
);
10053 Lisp_Object tail
, frame
;
10054 int count
= SPECPDL_INDEX ();
10055 /* 1 means that update_menu_bar has run its hooks
10056 so any further calls to update_menu_bar shouldn't do so again. */
10057 int menu_bar_hooks_run
= 0;
10059 record_unwind_save_match_data ();
10061 FOR_EACH_FRAME (tail
, frame
)
10063 f
= XFRAME (frame
);
10065 /* Ignore tooltip frame. */
10066 if (EQ (frame
, tooltip_frame
))
10069 /* If a window on this frame changed size, report that to
10070 the user and clear the size-change flag. */
10071 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10073 Lisp_Object functions
;
10075 /* Clear flag first in case we get an error below. */
10076 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10077 functions
= Vwindow_size_change_functions
;
10078 GCPRO2 (tail
, functions
);
10080 while (CONSP (functions
))
10082 if (!EQ (XCAR (functions
), Qt
))
10083 call1 (XCAR (functions
), frame
);
10084 functions
= XCDR (functions
);
10090 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10091 #ifdef HAVE_WINDOW_SYSTEM
10092 update_tool_bar (f
, 0);
10095 if (windows_or_buffers_changed
10097 ns_set_doc_edited (f
, Fbuffer_modified_p
10098 (XWINDOW (f
->selected_window
)->buffer
));
10103 unbind_to (count
, Qnil
);
10107 struct frame
*sf
= SELECTED_FRAME ();
10108 update_menu_bar (sf
, 1, 0);
10109 #ifdef HAVE_WINDOW_SYSTEM
10110 update_tool_bar (sf
, 1);
10114 /* Motif needs this. See comment in xmenu.c. Turn it off when
10115 pending_menu_activation is not defined. */
10116 #ifdef USE_X_TOOLKIT
10117 pending_menu_activation
= 0;
10122 /* Update the menu bar item list for frame F. This has to be done
10123 before we start to fill in any display lines, because it can call
10126 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10128 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10129 already ran the menu bar hooks for this redisplay, so there
10130 is no need to run them again. The return value is the
10131 updated value of this flag, to pass to the next call. */
10134 update_menu_bar (f
, save_match_data
, hooks_run
)
10136 int save_match_data
;
10139 Lisp_Object window
;
10140 register struct window
*w
;
10142 /* If called recursively during a menu update, do nothing. This can
10143 happen when, for instance, an activate-menubar-hook causes a
10145 if (inhibit_menubar_update
)
10148 window
= FRAME_SELECTED_WINDOW (f
);
10149 w
= XWINDOW (window
);
10151 if (FRAME_WINDOW_P (f
)
10153 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10154 || defined (HAVE_NS) || defined (USE_GTK)
10155 FRAME_EXTERNAL_MENU_BAR (f
)
10157 FRAME_MENU_BAR_LINES (f
) > 0
10159 : FRAME_MENU_BAR_LINES (f
) > 0)
10161 /* If the user has switched buffers or windows, we need to
10162 recompute to reflect the new bindings. But we'll
10163 recompute when update_mode_lines is set too; that means
10164 that people can use force-mode-line-update to request
10165 that the menu bar be recomputed. The adverse effect on
10166 the rest of the redisplay algorithm is about the same as
10167 windows_or_buffers_changed anyway. */
10168 if (windows_or_buffers_changed
10169 /* This used to test w->update_mode_line, but we believe
10170 there is no need to recompute the menu in that case. */
10171 || update_mode_lines
10172 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10173 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10174 != !NILP (w
->last_had_star
))
10175 || ((!NILP (Vtransient_mark_mode
)
10176 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10177 != !NILP (w
->region_showing
)))
10179 struct buffer
*prev
= current_buffer
;
10180 int count
= SPECPDL_INDEX ();
10182 specbind (Qinhibit_menubar_update
, Qt
);
10184 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10185 if (save_match_data
)
10186 record_unwind_save_match_data ();
10187 if (NILP (Voverriding_local_map_menu_flag
))
10189 specbind (Qoverriding_terminal_local_map
, Qnil
);
10190 specbind (Qoverriding_local_map
, Qnil
);
10195 /* Run the Lucid hook. */
10196 safe_run_hooks (Qactivate_menubar_hook
);
10198 /* If it has changed current-menubar from previous value,
10199 really recompute the menu-bar from the value. */
10200 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10201 call0 (Qrecompute_lucid_menubar
);
10203 safe_run_hooks (Qmenu_bar_update_hook
);
10208 XSETFRAME (Vmenu_updating_frame
, f
);
10209 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10211 /* Redisplay the menu bar in case we changed it. */
10212 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10213 || defined (HAVE_NS) || defined (USE_GTK)
10214 if (FRAME_WINDOW_P (f
))
10216 #if defined (HAVE_NS)
10217 /* All frames on Mac OS share the same menubar. So only
10218 the selected frame should be allowed to set it. */
10219 if (f
== SELECTED_FRAME ())
10221 set_frame_menubar (f
, 0, 0);
10224 /* On a terminal screen, the menu bar is an ordinary screen
10225 line, and this makes it get updated. */
10226 w
->update_mode_line
= Qt
;
10227 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10228 /* In the non-toolkit version, the menu bar is an ordinary screen
10229 line, and this makes it get updated. */
10230 w
->update_mode_line
= Qt
;
10231 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10233 unbind_to (count
, Qnil
);
10234 set_buffer_internal_1 (prev
);
10243 /***********************************************************************
10245 ***********************************************************************/
10247 #ifdef HAVE_WINDOW_SYSTEM
10250 Nominal cursor position -- where to draw output.
10251 HPOS and VPOS are window relative glyph matrix coordinates.
10252 X and Y are window relative pixel coordinates. */
10254 struct cursor_pos output_cursor
;
10258 Set the global variable output_cursor to CURSOR. All cursor
10259 positions are relative to updated_window. */
10262 set_output_cursor (cursor
)
10263 struct cursor_pos
*cursor
;
10265 output_cursor
.hpos
= cursor
->hpos
;
10266 output_cursor
.vpos
= cursor
->vpos
;
10267 output_cursor
.x
= cursor
->x
;
10268 output_cursor
.y
= cursor
->y
;
10273 Set a nominal cursor position.
10275 HPOS and VPOS are column/row positions in a window glyph matrix. X
10276 and Y are window text area relative pixel positions.
10278 If this is done during an update, updated_window will contain the
10279 window that is being updated and the position is the future output
10280 cursor position for that window. If updated_window is null, use
10281 selected_window and display the cursor at the given position. */
10284 x_cursor_to (vpos
, hpos
, y
, x
)
10285 int vpos
, hpos
, y
, x
;
10289 /* If updated_window is not set, work on selected_window. */
10290 if (updated_window
)
10291 w
= updated_window
;
10293 w
= XWINDOW (selected_window
);
10295 /* Set the output cursor. */
10296 output_cursor
.hpos
= hpos
;
10297 output_cursor
.vpos
= vpos
;
10298 output_cursor
.x
= x
;
10299 output_cursor
.y
= y
;
10301 /* If not called as part of an update, really display the cursor.
10302 This will also set the cursor position of W. */
10303 if (updated_window
== NULL
)
10306 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10307 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10308 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10313 #endif /* HAVE_WINDOW_SYSTEM */
10316 /***********************************************************************
10318 ***********************************************************************/
10320 #ifdef HAVE_WINDOW_SYSTEM
10322 /* Where the mouse was last time we reported a mouse event. */
10324 FRAME_PTR last_mouse_frame
;
10326 /* Tool-bar item index of the item on which a mouse button was pressed
10329 int last_tool_bar_item
;
10333 update_tool_bar_unwind (frame
)
10336 selected_frame
= frame
;
10340 /* Update the tool-bar item list for frame F. This has to be done
10341 before we start to fill in any display lines. Called from
10342 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10343 and restore it here. */
10346 update_tool_bar (f
, save_match_data
)
10348 int save_match_data
;
10350 #if defined (USE_GTK) || defined (HAVE_NS)
10351 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10353 int do_update
= WINDOWP (f
->tool_bar_window
)
10354 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10359 Lisp_Object window
;
10362 window
= FRAME_SELECTED_WINDOW (f
);
10363 w
= XWINDOW (window
);
10365 /* If the user has switched buffers or windows, we need to
10366 recompute to reflect the new bindings. But we'll
10367 recompute when update_mode_lines is set too; that means
10368 that people can use force-mode-line-update to request
10369 that the menu bar be recomputed. The adverse effect on
10370 the rest of the redisplay algorithm is about the same as
10371 windows_or_buffers_changed anyway. */
10372 if (windows_or_buffers_changed
10373 || !NILP (w
->update_mode_line
)
10374 || update_mode_lines
10375 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10376 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10377 != !NILP (w
->last_had_star
))
10378 || ((!NILP (Vtransient_mark_mode
)
10379 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10380 != !NILP (w
->region_showing
)))
10382 struct buffer
*prev
= current_buffer
;
10383 int count
= SPECPDL_INDEX ();
10384 Lisp_Object frame
, new_tool_bar
;
10385 int new_n_tool_bar
;
10386 struct gcpro gcpro1
;
10388 /* Set current_buffer to the buffer of the selected
10389 window of the frame, so that we get the right local
10391 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10393 /* Save match data, if we must. */
10394 if (save_match_data
)
10395 record_unwind_save_match_data ();
10397 /* Make sure that we don't accidentally use bogus keymaps. */
10398 if (NILP (Voverriding_local_map_menu_flag
))
10400 specbind (Qoverriding_terminal_local_map
, Qnil
);
10401 specbind (Qoverriding_local_map
, Qnil
);
10404 GCPRO1 (new_tool_bar
);
10406 /* We must temporarily set the selected frame to this frame
10407 before calling tool_bar_items, because the calculation of
10408 the tool-bar keymap uses the selected frame (see
10409 `tool-bar-make-keymap' in tool-bar.el). */
10410 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10411 XSETFRAME (frame
, f
);
10412 selected_frame
= frame
;
10414 /* Build desired tool-bar items from keymaps. */
10415 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10418 /* Redisplay the tool-bar if we changed it. */
10419 if (new_n_tool_bar
!= f
->n_tool_bar_items
10420 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10422 /* Redisplay that happens asynchronously due to an expose event
10423 may access f->tool_bar_items. Make sure we update both
10424 variables within BLOCK_INPUT so no such event interrupts. */
10426 f
->tool_bar_items
= new_tool_bar
;
10427 f
->n_tool_bar_items
= new_n_tool_bar
;
10428 w
->update_mode_line
= Qt
;
10434 unbind_to (count
, Qnil
);
10435 set_buffer_internal_1 (prev
);
10441 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10442 F's desired tool-bar contents. F->tool_bar_items must have
10443 been set up previously by calling prepare_menu_bars. */
10446 build_desired_tool_bar_string (f
)
10449 int i
, size
, size_needed
;
10450 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10451 Lisp_Object image
, plist
, props
;
10453 image
= plist
= props
= Qnil
;
10454 GCPRO3 (image
, plist
, props
);
10456 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10457 Otherwise, make a new string. */
10459 /* The size of the string we might be able to reuse. */
10460 size
= (STRINGP (f
->desired_tool_bar_string
)
10461 ? SCHARS (f
->desired_tool_bar_string
)
10464 /* We need one space in the string for each image. */
10465 size_needed
= f
->n_tool_bar_items
;
10467 /* Reuse f->desired_tool_bar_string, if possible. */
10468 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10469 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10470 make_number (' '));
10473 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10474 Fremove_text_properties (make_number (0), make_number (size
),
10475 props
, f
->desired_tool_bar_string
);
10478 /* Put a `display' property on the string for the images to display,
10479 put a `menu_item' property on tool-bar items with a value that
10480 is the index of the item in F's tool-bar item vector. */
10481 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10483 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10485 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10486 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10487 int hmargin
, vmargin
, relief
, idx
, end
;
10488 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10490 /* If image is a vector, choose the image according to the
10492 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10493 if (VECTORP (image
))
10497 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10498 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10501 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10502 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10504 xassert (ASIZE (image
) >= idx
);
10505 image
= AREF (image
, idx
);
10510 /* Ignore invalid image specifications. */
10511 if (!valid_image_p (image
))
10514 /* Display the tool-bar button pressed, or depressed. */
10515 plist
= Fcopy_sequence (XCDR (image
));
10517 /* Compute margin and relief to draw. */
10518 relief
= (tool_bar_button_relief
>= 0
10519 ? tool_bar_button_relief
10520 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10521 hmargin
= vmargin
= relief
;
10523 if (INTEGERP (Vtool_bar_button_margin
)
10524 && XINT (Vtool_bar_button_margin
) > 0)
10526 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10527 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10529 else if (CONSP (Vtool_bar_button_margin
))
10531 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10532 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10533 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10535 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10536 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10537 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10540 if (auto_raise_tool_bar_buttons_p
)
10542 /* Add a `:relief' property to the image spec if the item is
10546 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10553 /* If image is selected, display it pressed, i.e. with a
10554 negative relief. If it's not selected, display it with a
10556 plist
= Fplist_put (plist
, QCrelief
,
10558 ? make_number (-relief
)
10559 : make_number (relief
)));
10564 /* Put a margin around the image. */
10565 if (hmargin
|| vmargin
)
10567 if (hmargin
== vmargin
)
10568 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10570 plist
= Fplist_put (plist
, QCmargin
,
10571 Fcons (make_number (hmargin
),
10572 make_number (vmargin
)));
10575 /* If button is not enabled, and we don't have special images
10576 for the disabled state, make the image appear disabled by
10577 applying an appropriate algorithm to it. */
10578 if (!enabled_p
&& idx
< 0)
10579 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10581 /* Put a `display' text property on the string for the image to
10582 display. Put a `menu-item' property on the string that gives
10583 the start of this item's properties in the tool-bar items
10585 image
= Fcons (Qimage
, plist
);
10586 props
= list4 (Qdisplay
, image
,
10587 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10589 /* Let the last image hide all remaining spaces in the tool bar
10590 string. The string can be longer than needed when we reuse a
10591 previous string. */
10592 if (i
+ 1 == f
->n_tool_bar_items
)
10593 end
= SCHARS (f
->desired_tool_bar_string
);
10596 Fadd_text_properties (make_number (i
), make_number (end
),
10597 props
, f
->desired_tool_bar_string
);
10605 /* Display one line of the tool-bar of frame IT->f.
10607 HEIGHT specifies the desired height of the tool-bar line.
10608 If the actual height of the glyph row is less than HEIGHT, the
10609 row's height is increased to HEIGHT, and the icons are centered
10610 vertically in the new height.
10612 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10613 count a final empty row in case the tool-bar width exactly matches
10618 display_tool_bar_line (it
, height
)
10622 struct glyph_row
*row
= it
->glyph_row
;
10623 int max_x
= it
->last_visible_x
;
10624 struct glyph
*last
;
10626 prepare_desired_row (row
);
10627 row
->y
= it
->current_y
;
10629 /* Note that this isn't made use of if the face hasn't a box,
10630 so there's no need to check the face here. */
10631 it
->start_of_box_run_p
= 1;
10633 while (it
->current_x
< max_x
)
10635 int x
, n_glyphs_before
, i
, nglyphs
;
10636 struct it it_before
;
10638 /* Get the next display element. */
10639 if (!get_next_display_element (it
))
10641 /* Don't count empty row if we are counting needed tool-bar lines. */
10642 if (height
< 0 && !it
->hpos
)
10647 /* Produce glyphs. */
10648 n_glyphs_before
= row
->used
[TEXT_AREA
];
10651 PRODUCE_GLYPHS (it
);
10653 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10655 x
= it_before
.current_x
;
10656 while (i
< nglyphs
)
10658 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10660 if (x
+ glyph
->pixel_width
> max_x
)
10662 /* Glyph doesn't fit on line. Backtrack. */
10663 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10665 /* If this is the only glyph on this line, it will never fit on the
10666 toolbar, so skip it. But ensure there is at least one glyph,
10667 so we don't accidentally disable the tool-bar. */
10668 if (n_glyphs_before
== 0
10669 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10675 x
+= glyph
->pixel_width
;
10679 /* Stop at line ends. */
10680 if (ITERATOR_AT_END_OF_LINE_P (it
))
10683 set_iterator_to_next (it
, 1);
10688 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10690 /* Use default face for the border below the tool bar.
10692 FIXME: When auto-resize-tool-bars is grow-only, there is
10693 no additional border below the possibly empty tool-bar lines.
10694 So to make the extra empty lines look "normal", we have to
10695 use the tool-bar face for the border too. */
10696 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10697 it
->face_id
= DEFAULT_FACE_ID
;
10699 extend_face_to_end_of_line (it
);
10700 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10701 last
->right_box_line_p
= 1;
10702 if (last
== row
->glyphs
[TEXT_AREA
])
10703 last
->left_box_line_p
= 1;
10705 /* Make line the desired height and center it vertically. */
10706 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10708 /* Don't add more than one line height. */
10709 height
%= FRAME_LINE_HEIGHT (it
->f
);
10710 it
->max_ascent
+= height
/ 2;
10711 it
->max_descent
+= (height
+ 1) / 2;
10714 compute_line_metrics (it
);
10716 /* If line is empty, make it occupy the rest of the tool-bar. */
10717 if (!row
->displays_text_p
)
10719 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10720 row
->visible_height
= row
->height
;
10721 row
->ascent
= row
->phys_ascent
= 0;
10722 row
->extra_line_spacing
= 0;
10725 row
->full_width_p
= 1;
10726 row
->continued_p
= 0;
10727 row
->truncated_on_left_p
= 0;
10728 row
->truncated_on_right_p
= 0;
10730 it
->current_x
= it
->hpos
= 0;
10731 it
->current_y
+= row
->height
;
10737 /* Max tool-bar height. */
10739 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10740 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10742 /* Value is the number of screen lines needed to make all tool-bar
10743 items of frame F visible. The number of actual rows needed is
10744 returned in *N_ROWS if non-NULL. */
10747 tool_bar_lines_needed (f
, n_rows
)
10751 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10753 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10754 the desired matrix, so use (unused) mode-line row as temporary row to
10755 avoid destroying the first tool-bar row. */
10756 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10758 /* Initialize an iterator for iteration over
10759 F->desired_tool_bar_string in the tool-bar window of frame F. */
10760 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10761 it
.first_visible_x
= 0;
10762 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10763 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10765 while (!ITERATOR_AT_END_P (&it
))
10767 clear_glyph_row (temp_row
);
10768 it
.glyph_row
= temp_row
;
10769 display_tool_bar_line (&it
, -1);
10771 clear_glyph_row (temp_row
);
10773 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10775 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10777 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10781 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10783 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10792 frame
= selected_frame
;
10794 CHECK_FRAME (frame
);
10795 f
= XFRAME (frame
);
10797 if (WINDOWP (f
->tool_bar_window
)
10798 || (w
= XWINDOW (f
->tool_bar_window
),
10799 WINDOW_TOTAL_LINES (w
) > 0))
10801 update_tool_bar (f
, 1);
10802 if (f
->n_tool_bar_items
)
10804 build_desired_tool_bar_string (f
);
10805 nlines
= tool_bar_lines_needed (f
, NULL
);
10809 return make_number (nlines
);
10813 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10814 height should be changed. */
10817 redisplay_tool_bar (f
)
10822 struct glyph_row
*row
;
10824 #if defined (USE_GTK) || defined (HAVE_NS)
10825 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10826 update_frame_tool_bar (f
);
10830 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10831 do anything. This means you must start with tool-bar-lines
10832 non-zero to get the auto-sizing effect. Or in other words, you
10833 can turn off tool-bars by specifying tool-bar-lines zero. */
10834 if (!WINDOWP (f
->tool_bar_window
)
10835 || (w
= XWINDOW (f
->tool_bar_window
),
10836 WINDOW_TOTAL_LINES (w
) == 0))
10839 /* Set up an iterator for the tool-bar window. */
10840 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10841 it
.first_visible_x
= 0;
10842 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10843 row
= it
.glyph_row
;
10845 /* Build a string that represents the contents of the tool-bar. */
10846 build_desired_tool_bar_string (f
);
10847 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10849 if (f
->n_tool_bar_rows
== 0)
10853 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10854 nlines
!= WINDOW_TOTAL_LINES (w
)))
10856 extern Lisp_Object Qtool_bar_lines
;
10858 int old_height
= WINDOW_TOTAL_LINES (w
);
10860 XSETFRAME (frame
, f
);
10861 Fmodify_frame_parameters (frame
,
10862 Fcons (Fcons (Qtool_bar_lines
,
10863 make_number (nlines
)),
10865 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10867 clear_glyph_matrix (w
->desired_matrix
);
10868 fonts_changed_p
= 1;
10874 /* Display as many lines as needed to display all tool-bar items. */
10876 if (f
->n_tool_bar_rows
> 0)
10878 int border
, rows
, height
, extra
;
10880 if (INTEGERP (Vtool_bar_border
))
10881 border
= XINT (Vtool_bar_border
);
10882 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10883 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10884 else if (EQ (Vtool_bar_border
, Qborder_width
))
10885 border
= f
->border_width
;
10891 rows
= f
->n_tool_bar_rows
;
10892 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10893 extra
= it
.last_visible_y
- border
- height
* rows
;
10895 while (it
.current_y
< it
.last_visible_y
)
10898 if (extra
> 0 && rows
-- > 0)
10900 h
= (extra
+ rows
- 1) / rows
;
10903 display_tool_bar_line (&it
, height
+ h
);
10908 while (it
.current_y
< it
.last_visible_y
)
10909 display_tool_bar_line (&it
, 0);
10912 /* It doesn't make much sense to try scrolling in the tool-bar
10913 window, so don't do it. */
10914 w
->desired_matrix
->no_scrolling_p
= 1;
10915 w
->must_be_updated_p
= 1;
10917 if (!NILP (Vauto_resize_tool_bars
))
10919 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10920 int change_height_p
= 0;
10922 /* If we couldn't display everything, change the tool-bar's
10923 height if there is room for more. */
10924 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10925 && it
.current_y
< max_tool_bar_height
)
10926 change_height_p
= 1;
10928 row
= it
.glyph_row
- 1;
10930 /* If there are blank lines at the end, except for a partially
10931 visible blank line at the end that is smaller than
10932 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10933 if (!row
->displays_text_p
10934 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10935 change_height_p
= 1;
10937 /* If row displays tool-bar items, but is partially visible,
10938 change the tool-bar's height. */
10939 if (row
->displays_text_p
10940 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10941 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10942 change_height_p
= 1;
10944 /* Resize windows as needed by changing the `tool-bar-lines'
10945 frame parameter. */
10946 if (change_height_p
)
10948 extern Lisp_Object Qtool_bar_lines
;
10950 int old_height
= WINDOW_TOTAL_LINES (w
);
10952 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10954 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10955 && !f
->minimize_tool_bar_window_p
)
10956 ? (nlines
> old_height
)
10957 : (nlines
!= old_height
));
10958 f
->minimize_tool_bar_window_p
= 0;
10960 if (change_height_p
)
10962 XSETFRAME (frame
, f
);
10963 Fmodify_frame_parameters (frame
,
10964 Fcons (Fcons (Qtool_bar_lines
,
10965 make_number (nlines
)),
10967 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10969 clear_glyph_matrix (w
->desired_matrix
);
10970 f
->n_tool_bar_rows
= nrows
;
10971 fonts_changed_p
= 1;
10978 f
->minimize_tool_bar_window_p
= 0;
10983 /* Get information about the tool-bar item which is displayed in GLYPH
10984 on frame F. Return in *PROP_IDX the index where tool-bar item
10985 properties start in F->tool_bar_items. Value is zero if
10986 GLYPH doesn't display a tool-bar item. */
10989 tool_bar_item_info (f
, glyph
, prop_idx
)
10991 struct glyph
*glyph
;
10998 /* This function can be called asynchronously, which means we must
10999 exclude any possibility that Fget_text_property signals an
11001 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11002 charpos
= max (0, charpos
);
11004 /* Get the text property `menu-item' at pos. The value of that
11005 property is the start index of this item's properties in
11006 F->tool_bar_items. */
11007 prop
= Fget_text_property (make_number (charpos
),
11008 Qmenu_item
, f
->current_tool_bar_string
);
11009 if (INTEGERP (prop
))
11011 *prop_idx
= XINT (prop
);
11021 /* Get information about the tool-bar item at position X/Y on frame F.
11022 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11023 the current matrix of the tool-bar window of F, or NULL if not
11024 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11025 item in F->tool_bar_items. Value is
11027 -1 if X/Y is not on a tool-bar item
11028 0 if X/Y is on the same item that was highlighted before.
11032 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
11035 struct glyph
**glyph
;
11036 int *hpos
, *vpos
, *prop_idx
;
11038 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11039 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11042 /* Find the glyph under X/Y. */
11043 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11044 if (*glyph
== NULL
)
11047 /* Get the start of this tool-bar item's properties in
11048 f->tool_bar_items. */
11049 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11052 /* Is mouse on the highlighted item? */
11053 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
11054 && *vpos
>= dpyinfo
->mouse_face_beg_row
11055 && *vpos
<= dpyinfo
->mouse_face_end_row
11056 && (*vpos
> dpyinfo
->mouse_face_beg_row
11057 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
11058 && (*vpos
< dpyinfo
->mouse_face_end_row
11059 || *hpos
< dpyinfo
->mouse_face_end_col
11060 || dpyinfo
->mouse_face_past_end
))
11068 Handle mouse button event on the tool-bar of frame F, at
11069 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11070 0 for button release. MODIFIERS is event modifiers for button
11074 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
11077 unsigned int modifiers
;
11079 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11080 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11081 int hpos
, vpos
, prop_idx
;
11082 struct glyph
*glyph
;
11083 Lisp_Object enabled_p
;
11085 /* If not on the highlighted tool-bar item, return. */
11086 frame_to_window_pixel_xy (w
, &x
, &y
);
11087 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11090 /* If item is disabled, do nothing. */
11091 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11092 if (NILP (enabled_p
))
11097 /* Show item in pressed state. */
11098 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
11099 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11100 last_tool_bar_item
= prop_idx
;
11104 Lisp_Object key
, frame
;
11105 struct input_event event
;
11106 EVENT_INIT (event
);
11108 /* Show item in released state. */
11109 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
11110 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11112 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11114 XSETFRAME (frame
, f
);
11115 event
.kind
= TOOL_BAR_EVENT
;
11116 event
.frame_or_window
= frame
;
11118 kbd_buffer_store_event (&event
);
11120 event
.kind
= TOOL_BAR_EVENT
;
11121 event
.frame_or_window
= frame
;
11123 event
.modifiers
= modifiers
;
11124 kbd_buffer_store_event (&event
);
11125 last_tool_bar_item
= -1;
11130 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11131 tool-bar window-relative coordinates X/Y. Called from
11132 note_mouse_highlight. */
11135 note_tool_bar_highlight (f
, x
, y
)
11139 Lisp_Object window
= f
->tool_bar_window
;
11140 struct window
*w
= XWINDOW (window
);
11141 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11143 struct glyph
*glyph
;
11144 struct glyph_row
*row
;
11146 Lisp_Object enabled_p
;
11148 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11149 int mouse_down_p
, rc
;
11151 /* Function note_mouse_highlight is called with negative x(y
11152 values when mouse moves outside of the frame. */
11153 if (x
<= 0 || y
<= 0)
11155 clear_mouse_face (dpyinfo
);
11159 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11162 /* Not on tool-bar item. */
11163 clear_mouse_face (dpyinfo
);
11167 /* On same tool-bar item as before. */
11168 goto set_help_echo
;
11170 clear_mouse_face (dpyinfo
);
11172 /* Mouse is down, but on different tool-bar item? */
11173 mouse_down_p
= (dpyinfo
->grabbed
11174 && f
== last_mouse_frame
11175 && FRAME_LIVE_P (f
));
11177 && last_tool_bar_item
!= prop_idx
)
11180 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11181 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11183 /* If tool-bar item is not enabled, don't highlight it. */
11184 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11185 if (!NILP (enabled_p
))
11187 /* Compute the x-position of the glyph. In front and past the
11188 image is a space. We include this in the highlighted area. */
11189 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11190 for (i
= x
= 0; i
< hpos
; ++i
)
11191 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11193 /* Record this as the current active region. */
11194 dpyinfo
->mouse_face_beg_col
= hpos
;
11195 dpyinfo
->mouse_face_beg_row
= vpos
;
11196 dpyinfo
->mouse_face_beg_x
= x
;
11197 dpyinfo
->mouse_face_beg_y
= row
->y
;
11198 dpyinfo
->mouse_face_past_end
= 0;
11200 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
11201 dpyinfo
->mouse_face_end_row
= vpos
;
11202 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11203 dpyinfo
->mouse_face_end_y
= row
->y
;
11204 dpyinfo
->mouse_face_window
= window
;
11205 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11207 /* Display it as active. */
11208 show_mouse_face (dpyinfo
, draw
);
11209 dpyinfo
->mouse_face_image_state
= draw
;
11214 /* Set help_echo_string to a help string to display for this tool-bar item.
11215 XTread_socket does the rest. */
11216 help_echo_object
= help_echo_window
= Qnil
;
11217 help_echo_pos
= -1;
11218 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11219 if (NILP (help_echo_string
))
11220 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11223 #endif /* HAVE_WINDOW_SYSTEM */
11227 /************************************************************************
11228 Horizontal scrolling
11229 ************************************************************************/
11231 static int hscroll_window_tree
P_ ((Lisp_Object
));
11232 static int hscroll_windows
P_ ((Lisp_Object
));
11234 /* For all leaf windows in the window tree rooted at WINDOW, set their
11235 hscroll value so that PT is (i) visible in the window, and (ii) so
11236 that it is not within a certain margin at the window's left and
11237 right border. Value is non-zero if any window's hscroll has been
11241 hscroll_window_tree (window
)
11242 Lisp_Object window
;
11244 int hscrolled_p
= 0;
11245 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11246 int hscroll_step_abs
= 0;
11247 double hscroll_step_rel
= 0;
11249 if (hscroll_relative_p
)
11251 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11252 if (hscroll_step_rel
< 0)
11254 hscroll_relative_p
= 0;
11255 hscroll_step_abs
= 0;
11258 else if (INTEGERP (Vhscroll_step
))
11260 hscroll_step_abs
= XINT (Vhscroll_step
);
11261 if (hscroll_step_abs
< 0)
11262 hscroll_step_abs
= 0;
11265 hscroll_step_abs
= 0;
11267 while (WINDOWP (window
))
11269 struct window
*w
= XWINDOW (window
);
11271 if (WINDOWP (w
->hchild
))
11272 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11273 else if (WINDOWP (w
->vchild
))
11274 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11275 else if (w
->cursor
.vpos
>= 0)
11278 int text_area_width
;
11279 struct glyph_row
*current_cursor_row
11280 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11281 struct glyph_row
*desired_cursor_row
11282 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11283 struct glyph_row
*cursor_row
11284 = (desired_cursor_row
->enabled_p
11285 ? desired_cursor_row
11286 : current_cursor_row
);
11288 text_area_width
= window_box_width (w
, TEXT_AREA
);
11290 /* Scroll when cursor is inside this scroll margin. */
11291 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11293 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11294 && ((XFASTINT (w
->hscroll
)
11295 && w
->cursor
.x
<= h_margin
)
11296 || (cursor_row
->enabled_p
11297 && cursor_row
->truncated_on_right_p
11298 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11302 struct buffer
*saved_current_buffer
;
11306 /* Find point in a display of infinite width. */
11307 saved_current_buffer
= current_buffer
;
11308 current_buffer
= XBUFFER (w
->buffer
);
11310 if (w
== XWINDOW (selected_window
))
11311 pt
= BUF_PT (current_buffer
);
11314 pt
= marker_position (w
->pointm
);
11315 pt
= max (BEGV
, pt
);
11319 /* Move iterator to pt starting at cursor_row->start in
11320 a line with infinite width. */
11321 init_to_row_start (&it
, w
, cursor_row
);
11322 it
.last_visible_x
= INFINITY
;
11323 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11324 current_buffer
= saved_current_buffer
;
11326 /* Position cursor in window. */
11327 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11328 hscroll
= max (0, (it
.current_x
11329 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11330 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11331 : (text_area_width
/ 2))))
11332 / FRAME_COLUMN_WIDTH (it
.f
);
11333 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11335 if (hscroll_relative_p
)
11336 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11339 wanted_x
= text_area_width
11340 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11343 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11347 if (hscroll_relative_p
)
11348 wanted_x
= text_area_width
* hscroll_step_rel
11351 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11354 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11356 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11358 /* Don't call Fset_window_hscroll if value hasn't
11359 changed because it will prevent redisplay
11361 if (XFASTINT (w
->hscroll
) != hscroll
)
11363 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11364 w
->hscroll
= make_number (hscroll
);
11373 /* Value is non-zero if hscroll of any leaf window has been changed. */
11374 return hscrolled_p
;
11378 /* Set hscroll so that cursor is visible and not inside horizontal
11379 scroll margins for all windows in the tree rooted at WINDOW. See
11380 also hscroll_window_tree above. Value is non-zero if any window's
11381 hscroll has been changed. If it has, desired matrices on the frame
11382 of WINDOW are cleared. */
11385 hscroll_windows (window
)
11386 Lisp_Object window
;
11388 int hscrolled_p
= hscroll_window_tree (window
);
11390 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11391 return hscrolled_p
;
11396 /************************************************************************
11398 ************************************************************************/
11400 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11401 to a non-zero value. This is sometimes handy to have in a debugger
11406 /* First and last unchanged row for try_window_id. */
11408 int debug_first_unchanged_at_end_vpos
;
11409 int debug_last_unchanged_at_beg_vpos
;
11411 /* Delta vpos and y. */
11413 int debug_dvpos
, debug_dy
;
11415 /* Delta in characters and bytes for try_window_id. */
11417 int debug_delta
, debug_delta_bytes
;
11419 /* Values of window_end_pos and window_end_vpos at the end of
11422 EMACS_INT debug_end_pos
, debug_end_vpos
;
11424 /* Append a string to W->desired_matrix->method. FMT is a printf
11425 format string. A1...A9 are a supplement for a variable-length
11426 argument list. If trace_redisplay_p is non-zero also printf the
11427 resulting string to stderr. */
11430 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11433 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11436 char *method
= w
->desired_matrix
->method
;
11437 int len
= strlen (method
);
11438 int size
= sizeof w
->desired_matrix
->method
;
11439 int remaining
= size
- len
- 1;
11441 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11442 if (len
&& remaining
)
11445 --remaining
, ++len
;
11448 strncpy (method
+ len
, buffer
, remaining
);
11450 if (trace_redisplay_p
)
11451 fprintf (stderr
, "%p (%s): %s\n",
11453 ((BUFFERP (w
->buffer
)
11454 && STRINGP (XBUFFER (w
->buffer
)->name
))
11455 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11460 #endif /* GLYPH_DEBUG */
11463 /* Value is non-zero if all changes in window W, which displays
11464 current_buffer, are in the text between START and END. START is a
11465 buffer position, END is given as a distance from Z. Used in
11466 redisplay_internal for display optimization. */
11469 text_outside_line_unchanged_p (w
, start
, end
)
11473 int unchanged_p
= 1;
11475 /* If text or overlays have changed, see where. */
11476 if (XFASTINT (w
->last_modified
) < MODIFF
11477 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11479 /* Gap in the line? */
11480 if (GPT
< start
|| Z
- GPT
< end
)
11483 /* Changes start in front of the line, or end after it? */
11485 && (BEG_UNCHANGED
< start
- 1
11486 || END_UNCHANGED
< end
))
11489 /* If selective display, can't optimize if changes start at the
11490 beginning of the line. */
11492 && INTEGERP (current_buffer
->selective_display
)
11493 && XINT (current_buffer
->selective_display
) > 0
11494 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11497 /* If there are overlays at the start or end of the line, these
11498 may have overlay strings with newlines in them. A change at
11499 START, for instance, may actually concern the display of such
11500 overlay strings as well, and they are displayed on different
11501 lines. So, quickly rule out this case. (For the future, it
11502 might be desirable to implement something more telling than
11503 just BEG/END_UNCHANGED.) */
11506 if (BEG
+ BEG_UNCHANGED
== start
11507 && overlay_touches_p (start
))
11509 if (END_UNCHANGED
== end
11510 && overlay_touches_p (Z
- end
))
11514 /* Under bidi reordering, adding or deleting a character in the
11515 beginning of a paragraph, before the first strong directional
11516 character, can change the base direction of the paragraph (unless
11517 the buffer specifies a fixed paragraph direction), which will
11518 require to redisplay the whole paragraph. It might be worthwhile
11519 to find the paragraph limits and widen the range of redisplayed
11520 lines to that, but for now just give up this optimization. */
11521 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11522 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11526 return unchanged_p
;
11530 /* Do a frame update, taking possible shortcuts into account. This is
11531 the main external entry point for redisplay.
11533 If the last redisplay displayed an echo area message and that message
11534 is no longer requested, we clear the echo area or bring back the
11535 mini-buffer if that is in use. */
11540 redisplay_internal (0);
11545 overlay_arrow_string_or_property (var
)
11550 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11553 return Voverlay_arrow_string
;
11556 /* Return 1 if there are any overlay-arrows in current_buffer. */
11558 overlay_arrow_in_current_buffer_p ()
11562 for (vlist
= Voverlay_arrow_variable_list
;
11564 vlist
= XCDR (vlist
))
11566 Lisp_Object var
= XCAR (vlist
);
11569 if (!SYMBOLP (var
))
11571 val
= find_symbol_value (var
);
11573 && current_buffer
== XMARKER (val
)->buffer
)
11580 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11584 overlay_arrows_changed_p ()
11588 for (vlist
= Voverlay_arrow_variable_list
;
11590 vlist
= XCDR (vlist
))
11592 Lisp_Object var
= XCAR (vlist
);
11593 Lisp_Object val
, pstr
;
11595 if (!SYMBOLP (var
))
11597 val
= find_symbol_value (var
);
11598 if (!MARKERP (val
))
11600 if (! EQ (COERCE_MARKER (val
),
11601 Fget (var
, Qlast_arrow_position
))
11602 || ! (pstr
= overlay_arrow_string_or_property (var
),
11603 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11609 /* Mark overlay arrows to be updated on next redisplay. */
11612 update_overlay_arrows (up_to_date
)
11617 for (vlist
= Voverlay_arrow_variable_list
;
11619 vlist
= XCDR (vlist
))
11621 Lisp_Object var
= XCAR (vlist
);
11623 if (!SYMBOLP (var
))
11626 if (up_to_date
> 0)
11628 Lisp_Object val
= find_symbol_value (var
);
11629 Fput (var
, Qlast_arrow_position
,
11630 COERCE_MARKER (val
));
11631 Fput (var
, Qlast_arrow_string
,
11632 overlay_arrow_string_or_property (var
));
11634 else if (up_to_date
< 0
11635 || !NILP (Fget (var
, Qlast_arrow_position
)))
11637 Fput (var
, Qlast_arrow_position
, Qt
);
11638 Fput (var
, Qlast_arrow_string
, Qt
);
11644 /* Return overlay arrow string to display at row.
11645 Return integer (bitmap number) for arrow bitmap in left fringe.
11646 Return nil if no overlay arrow. */
11649 overlay_arrow_at_row (it
, row
)
11651 struct glyph_row
*row
;
11655 for (vlist
= Voverlay_arrow_variable_list
;
11657 vlist
= XCDR (vlist
))
11659 Lisp_Object var
= XCAR (vlist
);
11662 if (!SYMBOLP (var
))
11665 val
= find_symbol_value (var
);
11668 && current_buffer
== XMARKER (val
)->buffer
11669 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11671 if (FRAME_WINDOW_P (it
->f
)
11672 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11674 #ifdef HAVE_WINDOW_SYSTEM
11675 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11678 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11679 return make_number (fringe_bitmap
);
11682 return make_number (-1); /* Use default arrow bitmap */
11684 return overlay_arrow_string_or_property (var
);
11691 /* Return 1 if point moved out of or into a composition. Otherwise
11692 return 0. PREV_BUF and PREV_PT are the last point buffer and
11693 position. BUF and PT are the current point buffer and position. */
11696 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11697 struct buffer
*prev_buf
, *buf
;
11700 EMACS_INT start
, end
;
11702 Lisp_Object buffer
;
11704 XSETBUFFER (buffer
, buf
);
11705 /* Check a composition at the last point if point moved within the
11707 if (prev_buf
== buf
)
11710 /* Point didn't move. */
11713 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11714 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11715 && COMPOSITION_VALID_P (start
, end
, prop
)
11716 && start
< prev_pt
&& end
> prev_pt
)
11717 /* The last point was within the composition. Return 1 iff
11718 point moved out of the composition. */
11719 return (pt
<= start
|| pt
>= end
);
11722 /* Check a composition at the current point. */
11723 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11724 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11725 && COMPOSITION_VALID_P (start
, end
, prop
)
11726 && start
< pt
&& end
> pt
);
11730 /* Reconsider the setting of B->clip_changed which is displayed
11734 reconsider_clip_changes (w
, b
)
11738 if (b
->clip_changed
11739 && !NILP (w
->window_end_valid
)
11740 && w
->current_matrix
->buffer
== b
11741 && w
->current_matrix
->zv
== BUF_ZV (b
)
11742 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11743 b
->clip_changed
= 0;
11745 /* If display wasn't paused, and W is not a tool bar window, see if
11746 point has been moved into or out of a composition. In that case,
11747 we set b->clip_changed to 1 to force updating the screen. If
11748 b->clip_changed has already been set to 1, we can skip this
11750 if (!b
->clip_changed
11751 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11755 if (w
== XWINDOW (selected_window
))
11756 pt
= BUF_PT (current_buffer
);
11758 pt
= marker_position (w
->pointm
);
11760 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11761 || pt
!= XINT (w
->last_point
))
11762 && check_point_in_composition (w
->current_matrix
->buffer
,
11763 XINT (w
->last_point
),
11764 XBUFFER (w
->buffer
), pt
))
11765 b
->clip_changed
= 1;
11770 /* Select FRAME to forward the values of frame-local variables into C
11771 variables so that the redisplay routines can access those values
11775 select_frame_for_redisplay (frame
)
11778 Lisp_Object tail
, tem
;
11779 Lisp_Object old
= selected_frame
;
11780 struct Lisp_Symbol
*sym
;
11782 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11784 selected_frame
= frame
;
11787 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11788 if (CONSP (XCAR (tail
))
11789 && (tem
= XCAR (XCAR (tail
)),
11791 && (sym
= indirect_variable (XSYMBOL (tem
)),
11792 sym
->redirect
== SYMBOL_LOCALIZED
)
11793 && sym
->val
.blv
->frame_local
)
11794 /* Use find_symbol_value rather than Fsymbol_value
11795 to avoid an error if it is void. */
11796 find_symbol_value (tem
);
11797 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11801 #define STOP_POLLING \
11802 do { if (! polling_stopped_here) stop_polling (); \
11803 polling_stopped_here = 1; } while (0)
11805 #define RESUME_POLLING \
11806 do { if (polling_stopped_here) start_polling (); \
11807 polling_stopped_here = 0; } while (0)
11810 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11811 response to any user action; therefore, we should preserve the echo
11812 area. (Actually, our caller does that job.) Perhaps in the future
11813 avoid recentering windows if it is not necessary; currently that
11814 causes some problems. */
11817 redisplay_internal (preserve_echo_area
)
11818 int preserve_echo_area
;
11820 struct window
*w
= XWINDOW (selected_window
);
11823 int must_finish
= 0;
11824 struct text_pos tlbufpos
, tlendpos
;
11825 int number_of_visible_frames
;
11828 int polling_stopped_here
= 0;
11829 Lisp_Object old_frame
= selected_frame
;
11831 /* Non-zero means redisplay has to consider all windows on all
11832 frames. Zero means, only selected_window is considered. */
11833 int consider_all_windows_p
;
11835 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11837 /* No redisplay if running in batch mode or frame is not yet fully
11838 initialized, or redisplay is explicitly turned off by setting
11839 Vinhibit_redisplay. */
11840 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11841 || !NILP (Vinhibit_redisplay
))
11844 /* Don't examine these until after testing Vinhibit_redisplay.
11845 When Emacs is shutting down, perhaps because its connection to
11846 X has dropped, we should not look at them at all. */
11847 f
= XFRAME (w
->frame
);
11848 sf
= SELECTED_FRAME ();
11850 if (!f
->glyphs_initialized_p
)
11853 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11854 if (popup_activated ())
11858 /* I don't think this happens but let's be paranoid. */
11859 if (redisplaying_p
)
11862 /* Record a function that resets redisplaying_p to its old value
11863 when we leave this function. */
11864 count
= SPECPDL_INDEX ();
11865 record_unwind_protect (unwind_redisplay
,
11866 Fcons (make_number (redisplaying_p
), selected_frame
));
11868 specbind (Qinhibit_free_realized_faces
, Qnil
);
11871 Lisp_Object tail
, frame
;
11873 FOR_EACH_FRAME (tail
, frame
)
11875 struct frame
*f
= XFRAME (frame
);
11876 f
->already_hscrolled_p
= 0;
11881 if (!EQ (old_frame
, selected_frame
)
11882 && FRAME_LIVE_P (XFRAME (old_frame
)))
11883 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11884 selected_frame and selected_window to be temporarily out-of-sync so
11885 when we come back here via `goto retry', we need to resync because we
11886 may need to run Elisp code (via prepare_menu_bars). */
11887 select_frame_for_redisplay (old_frame
);
11890 reconsider_clip_changes (w
, current_buffer
);
11891 last_escape_glyph_frame
= NULL
;
11892 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11894 /* If new fonts have been loaded that make a glyph matrix adjustment
11895 necessary, do it. */
11896 if (fonts_changed_p
)
11898 adjust_glyphs (NULL
);
11899 ++windows_or_buffers_changed
;
11900 fonts_changed_p
= 0;
11903 /* If face_change_count is non-zero, init_iterator will free all
11904 realized faces, which includes the faces referenced from current
11905 matrices. So, we can't reuse current matrices in this case. */
11906 if (face_change_count
)
11907 ++windows_or_buffers_changed
;
11909 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11910 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11912 /* Since frames on a single ASCII terminal share the same
11913 display area, displaying a different frame means redisplay
11914 the whole thing. */
11915 windows_or_buffers_changed
++;
11916 SET_FRAME_GARBAGED (sf
);
11918 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11920 FRAME_TTY (sf
)->previous_frame
= sf
;
11923 /* Set the visible flags for all frames. Do this before checking
11924 for resized or garbaged frames; they want to know if their frames
11925 are visible. See the comment in frame.h for
11926 FRAME_SAMPLE_VISIBILITY. */
11928 Lisp_Object tail
, frame
;
11930 number_of_visible_frames
= 0;
11932 FOR_EACH_FRAME (tail
, frame
)
11934 struct frame
*f
= XFRAME (frame
);
11936 FRAME_SAMPLE_VISIBILITY (f
);
11937 if (FRAME_VISIBLE_P (f
))
11938 ++number_of_visible_frames
;
11939 clear_desired_matrices (f
);
11943 /* Notice any pending interrupt request to change frame size. */
11944 do_pending_window_change (1);
11946 /* Clear frames marked as garbaged. */
11947 if (frame_garbaged
)
11948 clear_garbaged_frames ();
11950 /* Build menubar and tool-bar items. */
11951 if (NILP (Vmemory_full
))
11952 prepare_menu_bars ();
11954 if (windows_or_buffers_changed
)
11955 update_mode_lines
++;
11957 /* Detect case that we need to write or remove a star in the mode line. */
11958 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11960 w
->update_mode_line
= Qt
;
11961 if (buffer_shared
> 1)
11962 update_mode_lines
++;
11965 /* Avoid invocation of point motion hooks by `current_column' below. */
11966 count1
= SPECPDL_INDEX ();
11967 specbind (Qinhibit_point_motion_hooks
, Qt
);
11969 /* If %c is in the mode line, update it if needed. */
11970 if (!NILP (w
->column_number_displayed
)
11971 /* This alternative quickly identifies a common case
11972 where no change is needed. */
11973 && !(PT
== XFASTINT (w
->last_point
)
11974 && XFASTINT (w
->last_modified
) >= MODIFF
11975 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11976 && (XFASTINT (w
->column_number_displayed
)
11977 != (int) current_column ())) /* iftc */
11978 w
->update_mode_line
= Qt
;
11980 unbind_to (count1
, Qnil
);
11982 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11984 /* The variable buffer_shared is set in redisplay_window and
11985 indicates that we redisplay a buffer in different windows. See
11987 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11988 || cursor_type_changed
);
11990 /* If specs for an arrow have changed, do thorough redisplay
11991 to ensure we remove any arrow that should no longer exist. */
11992 if (overlay_arrows_changed_p ())
11993 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11995 /* Normally the message* functions will have already displayed and
11996 updated the echo area, but the frame may have been trashed, or
11997 the update may have been preempted, so display the echo area
11998 again here. Checking message_cleared_p captures the case that
11999 the echo area should be cleared. */
12000 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12001 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12002 || (message_cleared_p
12003 && minibuf_level
== 0
12004 /* If the mini-window is currently selected, this means the
12005 echo-area doesn't show through. */
12006 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12008 int window_height_changed_p
= echo_area_display (0);
12011 /* If we don't display the current message, don't clear the
12012 message_cleared_p flag, because, if we did, we wouldn't clear
12013 the echo area in the next redisplay which doesn't preserve
12015 if (!display_last_displayed_message_p
)
12016 message_cleared_p
= 0;
12018 if (fonts_changed_p
)
12020 else if (window_height_changed_p
)
12022 consider_all_windows_p
= 1;
12023 ++update_mode_lines
;
12024 ++windows_or_buffers_changed
;
12026 /* If window configuration was changed, frames may have been
12027 marked garbaged. Clear them or we will experience
12028 surprises wrt scrolling. */
12029 if (frame_garbaged
)
12030 clear_garbaged_frames ();
12033 else if (EQ (selected_window
, minibuf_window
)
12034 && (current_buffer
->clip_changed
12035 || XFASTINT (w
->last_modified
) < MODIFF
12036 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12037 && resize_mini_window (w
, 0))
12039 /* Resized active mini-window to fit the size of what it is
12040 showing if its contents might have changed. */
12042 /* FIXME: this causes all frames to be updated, which seems unnecessary
12043 since only the current frame needs to be considered. This function needs
12044 to be rewritten with two variables, consider_all_windows and
12045 consider_all_frames. */
12046 consider_all_windows_p
= 1;
12047 ++windows_or_buffers_changed
;
12048 ++update_mode_lines
;
12050 /* If window configuration was changed, frames may have been
12051 marked garbaged. Clear them or we will experience
12052 surprises wrt scrolling. */
12053 if (frame_garbaged
)
12054 clear_garbaged_frames ();
12058 /* If showing the region, and mark has changed, we must redisplay
12059 the whole window. The assignment to this_line_start_pos prevents
12060 the optimization directly below this if-statement. */
12061 if (((!NILP (Vtransient_mark_mode
)
12062 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
12063 != !NILP (w
->region_showing
))
12064 || (!NILP (w
->region_showing
)
12065 && !EQ (w
->region_showing
,
12066 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
12067 CHARPOS (this_line_start_pos
) = 0;
12069 /* Optimize the case that only the line containing the cursor in the
12070 selected window has changed. Variables starting with this_ are
12071 set in display_line and record information about the line
12072 containing the cursor. */
12073 tlbufpos
= this_line_start_pos
;
12074 tlendpos
= this_line_end_pos
;
12075 if (!consider_all_windows_p
12076 && CHARPOS (tlbufpos
) > 0
12077 && NILP (w
->update_mode_line
)
12078 && !current_buffer
->clip_changed
12079 && !current_buffer
->prevent_redisplay_optimizations_p
12080 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12081 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12082 /* Make sure recorded data applies to current buffer, etc. */
12083 && this_line_buffer
== current_buffer
12084 && current_buffer
== XBUFFER (w
->buffer
)
12085 && NILP (w
->force_start
)
12086 && NILP (w
->optional_new_start
)
12087 /* Point must be on the line that we have info recorded about. */
12088 && PT
>= CHARPOS (tlbufpos
)
12089 && PT
<= Z
- CHARPOS (tlendpos
)
12090 /* All text outside that line, including its final newline,
12091 must be unchanged. */
12092 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12093 CHARPOS (tlendpos
)))
12095 if (CHARPOS (tlbufpos
) > BEGV
12096 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12097 && (CHARPOS (tlbufpos
) == ZV
12098 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12099 /* Former continuation line has disappeared by becoming empty. */
12101 else if (XFASTINT (w
->last_modified
) < MODIFF
12102 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12103 || MINI_WINDOW_P (w
))
12105 /* We have to handle the case of continuation around a
12106 wide-column character (see the comment in indent.c around
12109 For instance, in the following case:
12111 -------- Insert --------
12112 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12113 J_I_ ==> J_I_ `^^' are cursors.
12117 As we have to redraw the line above, we cannot use this
12121 int line_height_before
= this_line_pixel_height
;
12123 /* Note that start_display will handle the case that the
12124 line starting at tlbufpos is a continuation line. */
12125 start_display (&it
, w
, tlbufpos
);
12127 /* Implementation note: It this still necessary? */
12128 if (it
.current_x
!= this_line_start_x
)
12131 TRACE ((stderr
, "trying display optimization 1\n"));
12132 w
->cursor
.vpos
= -1;
12133 overlay_arrow_seen
= 0;
12134 it
.vpos
= this_line_vpos
;
12135 it
.current_y
= this_line_y
;
12136 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12137 display_line (&it
);
12139 /* If line contains point, is not continued,
12140 and ends at same distance from eob as before, we win. */
12141 if (w
->cursor
.vpos
>= 0
12142 /* Line is not continued, otherwise this_line_start_pos
12143 would have been set to 0 in display_line. */
12144 && CHARPOS (this_line_start_pos
)
12145 /* Line ends as before. */
12146 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12147 /* Line has same height as before. Otherwise other lines
12148 would have to be shifted up or down. */
12149 && this_line_pixel_height
== line_height_before
)
12151 /* If this is not the window's last line, we must adjust
12152 the charstarts of the lines below. */
12153 if (it
.current_y
< it
.last_visible_y
)
12155 struct glyph_row
*row
12156 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12157 int delta
, delta_bytes
;
12159 /* We used to distinguish between two cases here,
12160 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12161 when the line ends in a newline or the end of the
12162 buffer's accessible portion. But both cases did
12163 the same, so they were collapsed. */
12165 - CHARPOS (tlendpos
)
12166 - MATRIX_ROW_START_CHARPOS (row
));
12167 delta_bytes
= (Z_BYTE
12168 - BYTEPOS (tlendpos
)
12169 - MATRIX_ROW_START_BYTEPOS (row
));
12171 increment_matrix_positions (w
->current_matrix
,
12172 this_line_vpos
+ 1,
12173 w
->current_matrix
->nrows
,
12174 delta
, delta_bytes
);
12177 /* If this row displays text now but previously didn't,
12178 or vice versa, w->window_end_vpos may have to be
12180 if ((it
.glyph_row
- 1)->displays_text_p
)
12182 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12183 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12185 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12186 && this_line_vpos
> 0)
12187 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12188 w
->window_end_valid
= Qnil
;
12190 /* Update hint: No need to try to scroll in update_window. */
12191 w
->desired_matrix
->no_scrolling_p
= 1;
12194 *w
->desired_matrix
->method
= 0;
12195 debug_method_add (w
, "optimization 1");
12197 #ifdef HAVE_WINDOW_SYSTEM
12198 update_window_fringes (w
, 0);
12205 else if (/* Cursor position hasn't changed. */
12206 PT
== XFASTINT (w
->last_point
)
12207 /* Make sure the cursor was last displayed
12208 in this window. Otherwise we have to reposition it. */
12209 && 0 <= w
->cursor
.vpos
12210 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12214 do_pending_window_change (1);
12216 /* We used to always goto end_of_redisplay here, but this
12217 isn't enough if we have a blinking cursor. */
12218 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12219 goto end_of_redisplay
;
12223 /* If highlighting the region, or if the cursor is in the echo area,
12224 then we can't just move the cursor. */
12225 else if (! (!NILP (Vtransient_mark_mode
)
12226 && !NILP (current_buffer
->mark_active
))
12227 && (EQ (selected_window
, current_buffer
->last_selected_window
)
12228 || highlight_nonselected_windows
)
12229 && NILP (w
->region_showing
)
12230 && NILP (Vshow_trailing_whitespace
)
12231 && !cursor_in_echo_area
)
12234 struct glyph_row
*row
;
12236 /* Skip from tlbufpos to PT and see where it is. Note that
12237 PT may be in invisible text. If so, we will end at the
12238 next visible position. */
12239 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12240 NULL
, DEFAULT_FACE_ID
);
12241 it
.current_x
= this_line_start_x
;
12242 it
.current_y
= this_line_y
;
12243 it
.vpos
= this_line_vpos
;
12245 /* The call to move_it_to stops in front of PT, but
12246 moves over before-strings. */
12247 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12249 if (it
.vpos
== this_line_vpos
12250 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12253 xassert (this_line_vpos
== it
.vpos
);
12254 xassert (this_line_y
== it
.current_y
);
12255 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12257 *w
->desired_matrix
->method
= 0;
12258 debug_method_add (w
, "optimization 3");
12267 /* Text changed drastically or point moved off of line. */
12268 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12271 CHARPOS (this_line_start_pos
) = 0;
12272 consider_all_windows_p
|= buffer_shared
> 1;
12273 ++clear_face_cache_count
;
12274 #ifdef HAVE_WINDOW_SYSTEM
12275 ++clear_image_cache_count
;
12278 /* Build desired matrices, and update the display. If
12279 consider_all_windows_p is non-zero, do it for all windows on all
12280 frames. Otherwise do it for selected_window, only. */
12282 if (consider_all_windows_p
)
12284 Lisp_Object tail
, frame
;
12286 FOR_EACH_FRAME (tail
, frame
)
12287 XFRAME (frame
)->updated_p
= 0;
12289 /* Recompute # windows showing selected buffer. This will be
12290 incremented each time such a window is displayed. */
12293 FOR_EACH_FRAME (tail
, frame
)
12295 struct frame
*f
= XFRAME (frame
);
12297 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12299 if (! EQ (frame
, selected_frame
))
12300 /* Select the frame, for the sake of frame-local
12302 select_frame_for_redisplay (frame
);
12304 /* Mark all the scroll bars to be removed; we'll redeem
12305 the ones we want when we redisplay their windows. */
12306 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12307 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12309 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12310 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12312 /* The X error handler may have deleted that frame. */
12313 if (!FRAME_LIVE_P (f
))
12316 /* Any scroll bars which redisplay_windows should have
12317 nuked should now go away. */
12318 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12319 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12321 /* If fonts changed, display again. */
12322 /* ??? rms: I suspect it is a mistake to jump all the way
12323 back to retry here. It should just retry this frame. */
12324 if (fonts_changed_p
)
12327 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12329 /* See if we have to hscroll. */
12330 if (!f
->already_hscrolled_p
)
12332 f
->already_hscrolled_p
= 1;
12333 if (hscroll_windows (f
->root_window
))
12337 /* Prevent various kinds of signals during display
12338 update. stdio is not robust about handling
12339 signals, which can cause an apparent I/O
12341 if (interrupt_input
)
12342 unrequest_sigio ();
12345 /* Update the display. */
12346 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12347 pause
|= update_frame (f
, 0, 0);
12353 if (!EQ (old_frame
, selected_frame
)
12354 && FRAME_LIVE_P (XFRAME (old_frame
)))
12355 /* We played a bit fast-and-loose above and allowed selected_frame
12356 and selected_window to be temporarily out-of-sync but let's make
12357 sure this stays contained. */
12358 select_frame_for_redisplay (old_frame
);
12359 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12363 /* Do the mark_window_display_accurate after all windows have
12364 been redisplayed because this call resets flags in buffers
12365 which are needed for proper redisplay. */
12366 FOR_EACH_FRAME (tail
, frame
)
12368 struct frame
*f
= XFRAME (frame
);
12371 mark_window_display_accurate (f
->root_window
, 1);
12372 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12373 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12378 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12380 Lisp_Object mini_window
;
12381 struct frame
*mini_frame
;
12383 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12384 /* Use list_of_error, not Qerror, so that
12385 we catch only errors and don't run the debugger. */
12386 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12388 redisplay_window_error
);
12390 /* Compare desired and current matrices, perform output. */
12393 /* If fonts changed, display again. */
12394 if (fonts_changed_p
)
12397 /* Prevent various kinds of signals during display update.
12398 stdio is not robust about handling signals,
12399 which can cause an apparent I/O error. */
12400 if (interrupt_input
)
12401 unrequest_sigio ();
12404 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12406 if (hscroll_windows (selected_window
))
12409 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12410 pause
= update_frame (sf
, 0, 0);
12413 /* We may have called echo_area_display at the top of this
12414 function. If the echo area is on another frame, that may
12415 have put text on a frame other than the selected one, so the
12416 above call to update_frame would not have caught it. Catch
12418 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12419 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12421 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12423 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12424 pause
|= update_frame (mini_frame
, 0, 0);
12425 if (!pause
&& hscroll_windows (mini_window
))
12430 /* If display was paused because of pending input, make sure we do a
12431 thorough update the next time. */
12434 /* Prevent the optimization at the beginning of
12435 redisplay_internal that tries a single-line update of the
12436 line containing the cursor in the selected window. */
12437 CHARPOS (this_line_start_pos
) = 0;
12439 /* Let the overlay arrow be updated the next time. */
12440 update_overlay_arrows (0);
12442 /* If we pause after scrolling, some rows in the current
12443 matrices of some windows are not valid. */
12444 if (!WINDOW_FULL_WIDTH_P (w
)
12445 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12446 update_mode_lines
= 1;
12450 if (!consider_all_windows_p
)
12452 /* This has already been done above if
12453 consider_all_windows_p is set. */
12454 mark_window_display_accurate_1 (w
, 1);
12456 /* Say overlay arrows are up to date. */
12457 update_overlay_arrows (1);
12459 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12460 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12463 update_mode_lines
= 0;
12464 windows_or_buffers_changed
= 0;
12465 cursor_type_changed
= 0;
12468 /* Start SIGIO interrupts coming again. Having them off during the
12469 code above makes it less likely one will discard output, but not
12470 impossible, since there might be stuff in the system buffer here.
12471 But it is much hairier to try to do anything about that. */
12472 if (interrupt_input
)
12476 /* If a frame has become visible which was not before, redisplay
12477 again, so that we display it. Expose events for such a frame
12478 (which it gets when becoming visible) don't call the parts of
12479 redisplay constructing glyphs, so simply exposing a frame won't
12480 display anything in this case. So, we have to display these
12481 frames here explicitly. */
12484 Lisp_Object tail
, frame
;
12487 FOR_EACH_FRAME (tail
, frame
)
12489 int this_is_visible
= 0;
12491 if (XFRAME (frame
)->visible
)
12492 this_is_visible
= 1;
12493 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12494 if (XFRAME (frame
)->visible
)
12495 this_is_visible
= 1;
12497 if (this_is_visible
)
12501 if (new_count
!= number_of_visible_frames
)
12502 windows_or_buffers_changed
++;
12505 /* Change frame size now if a change is pending. */
12506 do_pending_window_change (1);
12508 /* If we just did a pending size change, or have additional
12509 visible frames, redisplay again. */
12510 if (windows_or_buffers_changed
&& !pause
)
12513 /* Clear the face cache eventually. */
12514 if (consider_all_windows_p
)
12516 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12518 clear_face_cache (0);
12519 clear_face_cache_count
= 0;
12521 #ifdef HAVE_WINDOW_SYSTEM
12522 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12524 clear_image_caches (Qnil
);
12525 clear_image_cache_count
= 0;
12527 #endif /* HAVE_WINDOW_SYSTEM */
12531 unbind_to (count
, Qnil
);
12536 /* Redisplay, but leave alone any recent echo area message unless
12537 another message has been requested in its place.
12539 This is useful in situations where you need to redisplay but no
12540 user action has occurred, making it inappropriate for the message
12541 area to be cleared. See tracking_off and
12542 wait_reading_process_output for examples of these situations.
12544 FROM_WHERE is an integer saying from where this function was
12545 called. This is useful for debugging. */
12548 redisplay_preserve_echo_area (from_where
)
12551 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12553 if (!NILP (echo_area_buffer
[1]))
12555 /* We have a previously displayed message, but no current
12556 message. Redisplay the previous message. */
12557 display_last_displayed_message_p
= 1;
12558 redisplay_internal (1);
12559 display_last_displayed_message_p
= 0;
12562 redisplay_internal (1);
12564 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12565 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12566 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12570 /* Function registered with record_unwind_protect in
12571 redisplay_internal. Reset redisplaying_p to the value it had
12572 before redisplay_internal was called, and clear
12573 prevent_freeing_realized_faces_p. It also selects the previously
12574 selected frame, unless it has been deleted (by an X connection
12575 failure during redisplay, for example). */
12578 unwind_redisplay (val
)
12581 Lisp_Object old_redisplaying_p
, old_frame
;
12583 old_redisplaying_p
= XCAR (val
);
12584 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12585 old_frame
= XCDR (val
);
12586 if (! EQ (old_frame
, selected_frame
)
12587 && FRAME_LIVE_P (XFRAME (old_frame
)))
12588 select_frame_for_redisplay (old_frame
);
12593 /* Mark the display of window W as accurate or inaccurate. If
12594 ACCURATE_P is non-zero mark display of W as accurate. If
12595 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12596 redisplay_internal is called. */
12599 mark_window_display_accurate_1 (w
, accurate_p
)
12603 if (BUFFERP (w
->buffer
))
12605 struct buffer
*b
= XBUFFER (w
->buffer
);
12608 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12609 w
->last_overlay_modified
12610 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12612 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12616 b
->clip_changed
= 0;
12617 b
->prevent_redisplay_optimizations_p
= 0;
12619 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12620 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12621 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12622 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12624 w
->current_matrix
->buffer
= b
;
12625 w
->current_matrix
->begv
= BUF_BEGV (b
);
12626 w
->current_matrix
->zv
= BUF_ZV (b
);
12628 w
->last_cursor
= w
->cursor
;
12629 w
->last_cursor_off_p
= w
->cursor_off_p
;
12631 if (w
== XWINDOW (selected_window
))
12632 w
->last_point
= make_number (BUF_PT (b
));
12634 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12640 w
->window_end_valid
= w
->buffer
;
12641 w
->update_mode_line
= Qnil
;
12646 /* Mark the display of windows in the window tree rooted at WINDOW as
12647 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12648 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12649 be redisplayed the next time redisplay_internal is called. */
12652 mark_window_display_accurate (window
, accurate_p
)
12653 Lisp_Object window
;
12658 for (; !NILP (window
); window
= w
->next
)
12660 w
= XWINDOW (window
);
12661 mark_window_display_accurate_1 (w
, accurate_p
);
12663 if (!NILP (w
->vchild
))
12664 mark_window_display_accurate (w
->vchild
, accurate_p
);
12665 if (!NILP (w
->hchild
))
12666 mark_window_display_accurate (w
->hchild
, accurate_p
);
12671 update_overlay_arrows (1);
12675 /* Force a thorough redisplay the next time by setting
12676 last_arrow_position and last_arrow_string to t, which is
12677 unequal to any useful value of Voverlay_arrow_... */
12678 update_overlay_arrows (-1);
12683 /* Return value in display table DP (Lisp_Char_Table *) for character
12684 C. Since a display table doesn't have any parent, we don't have to
12685 follow parent. Do not call this function directly but use the
12686 macro DISP_CHAR_VECTOR. */
12689 disp_char_vector (dp
, c
)
12690 struct Lisp_Char_Table
*dp
;
12695 if (ASCII_CHAR_P (c
))
12698 if (SUB_CHAR_TABLE_P (val
))
12699 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12705 XSETCHAR_TABLE (table
, dp
);
12706 val
= char_table_ref (table
, c
);
12715 /***********************************************************************
12717 ***********************************************************************/
12719 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12722 redisplay_windows (window
)
12723 Lisp_Object window
;
12725 while (!NILP (window
))
12727 struct window
*w
= XWINDOW (window
);
12729 if (!NILP (w
->hchild
))
12730 redisplay_windows (w
->hchild
);
12731 else if (!NILP (w
->vchild
))
12732 redisplay_windows (w
->vchild
);
12733 else if (!NILP (w
->buffer
))
12735 displayed_buffer
= XBUFFER (w
->buffer
);
12736 /* Use list_of_error, not Qerror, so that
12737 we catch only errors and don't run the debugger. */
12738 internal_condition_case_1 (redisplay_window_0
, window
,
12740 redisplay_window_error
);
12748 redisplay_window_error ()
12750 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12755 redisplay_window_0 (window
)
12756 Lisp_Object window
;
12758 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12759 redisplay_window (window
, 0);
12764 redisplay_window_1 (window
)
12765 Lisp_Object window
;
12767 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12768 redisplay_window (window
, 1);
12773 /* Increment GLYPH until it reaches END or CONDITION fails while
12774 adding (GLYPH)->pixel_width to X. */
12776 #define SKIP_GLYPHS(glyph, end, x, condition) \
12779 (x) += (glyph)->pixel_width; \
12782 while ((glyph) < (end) && (condition))
12785 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12786 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12787 which positions recorded in ROW differ from current buffer
12790 Return 0 if cursor is not on this row, 1 otherwise. */
12793 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12795 struct glyph_row
*row
;
12796 struct glyph_matrix
*matrix
;
12797 int delta
, delta_bytes
, dy
, dvpos
;
12799 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12800 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12801 struct glyph
*cursor
= NULL
;
12802 /* The last known character position in row. */
12803 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12805 EMACS_INT pt_old
= PT
- delta
;
12806 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12807 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12808 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12809 /* A glyph beyond the edge of TEXT_AREA which we should never
12811 struct glyph
*glyphs_end
= end
;
12812 /* Non-zero means we've found a match for cursor position, but that
12813 glyph has the avoid_cursor_p flag set. */
12814 int match_with_avoid_cursor
= 0;
12815 /* Non-zero means we've seen at least one glyph that came from a
12817 int string_seen
= 0;
12818 /* Largest buffer position seen so far during scan of glyph row. */
12819 EMACS_INT bpos_max
= last_pos
;
12820 /* Last buffer position covered by an overlay string with an integer
12821 `cursor' property. */
12822 EMACS_INT bpos_covered
= 0;
12824 /* Skip over glyphs not having an object at the start and the end of
12825 the row. These are special glyphs like truncation marks on
12826 terminal frames. */
12827 if (row
->displays_text_p
)
12829 if (!row
->reversed_p
)
12832 && INTEGERP (glyph
->object
)
12833 && glyph
->charpos
< 0)
12835 x
+= glyph
->pixel_width
;
12839 && INTEGERP ((end
- 1)->object
)
12840 /* CHARPOS is zero for blanks and stretch glyphs
12841 inserted by extend_face_to_end_of_line. */
12842 && (end
- 1)->charpos
<= 0)
12844 glyph_before
= glyph
- 1;
12851 /* If the glyph row is reversed, we need to process it from back
12852 to front, so swap the edge pointers. */
12853 glyphs_end
= end
= glyph
- 1;
12854 glyph
+= row
->used
[TEXT_AREA
] - 1;
12856 while (glyph
> end
+ 1
12857 && INTEGERP (glyph
->object
)
12858 && glyph
->charpos
< 0)
12861 x
-= glyph
->pixel_width
;
12863 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12865 /* By default, in reversed rows we put the cursor on the
12866 rightmost (first in the reading order) glyph. */
12867 for (g
= end
+ 1; g
< glyph
; g
++)
12868 x
+= g
->pixel_width
;
12870 && INTEGERP ((end
+ 1)->object
)
12871 && (end
+ 1)->charpos
<= 0)
12873 glyph_before
= glyph
+ 1;
12877 else if (row
->reversed_p
)
12879 /* In R2L rows that don't display text, put the cursor on the
12880 rightmost glyph. Case in point: an empty last line that is
12881 part of an R2L paragraph. */
12883 /* Avoid placing the cursor on the last glyph of the row, where
12884 on terminal frames we hold the vertical border between
12885 adjacent windows. */
12886 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12887 && !WINDOW_RIGHTMOST_P (w
)
12888 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12890 x
= -1; /* will be computed below, at label compute_x */
12893 /* Step 1: Try to find the glyph whose character position
12894 corresponds to point. If that's not possible, find 2 glyphs
12895 whose character positions are the closest to point, one before
12896 point, the other after it. */
12897 if (!row
->reversed_p
)
12898 while (/* not marched to end of glyph row */
12900 /* glyph was not inserted by redisplay for internal purposes */
12901 && !INTEGERP (glyph
->object
))
12903 if (BUFFERP (glyph
->object
))
12905 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12907 if (glyph
->charpos
> bpos_max
)
12908 bpos_max
= glyph
->charpos
;
12909 if (!glyph
->avoid_cursor_p
)
12911 /* If we hit point, we've found the glyph on which to
12912 display the cursor. */
12915 match_with_avoid_cursor
= 0;
12918 /* See if we've found a better approximation to
12919 POS_BEFORE or to POS_AFTER. Note that we want the
12920 first (leftmost) glyph of all those that are the
12921 closest from below, and the last (rightmost) of all
12922 those from above. */
12923 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12925 pos_before
= glyph
->charpos
;
12926 glyph_before
= glyph
;
12928 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12930 pos_after
= glyph
->charpos
;
12931 glyph_after
= glyph
;
12934 else if (dpos
== 0)
12935 match_with_avoid_cursor
= 1;
12937 else if (STRINGP (glyph
->object
))
12939 Lisp_Object chprop
;
12940 int glyph_pos
= glyph
->charpos
;
12942 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12944 if (INTEGERP (chprop
))
12946 bpos_covered
= bpos_max
+ XINT (chprop
);
12947 /* If the `cursor' property covers buffer positions up
12948 to and including point, we should display cursor on
12949 this glyph. Note that overlays and text properties
12950 with string values stop bidi reordering, so every
12951 buffer position to the left of the string is always
12952 smaller than any position to the right of the
12953 string. Therefore, if a `cursor' property on one
12954 of the string's characters has an integer value, we
12955 will break out of the loop below _before_ we get to
12956 the position match above. IOW, integer values of
12957 the `cursor' property override the "exact match for
12958 point" strategy of positioning the cursor. */
12959 /* Implementation note: bpos_max == pt_old when, e.g.,
12960 we are in an empty line, where bpos_max is set to
12961 MATRIX_ROW_START_CHARPOS, see above. */
12962 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12971 x
+= glyph
->pixel_width
;
12974 else if (glyph
> end
) /* row is reversed */
12975 while (!INTEGERP (glyph
->object
))
12977 if (BUFFERP (glyph
->object
))
12979 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12981 if (glyph
->charpos
> bpos_max
)
12982 bpos_max
= glyph
->charpos
;
12983 if (!glyph
->avoid_cursor_p
)
12987 match_with_avoid_cursor
= 0;
12990 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12992 pos_before
= glyph
->charpos
;
12993 glyph_before
= glyph
;
12995 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12997 pos_after
= glyph
->charpos
;
12998 glyph_after
= glyph
;
13001 else if (dpos
== 0)
13002 match_with_avoid_cursor
= 1;
13004 else if (STRINGP (glyph
->object
))
13006 Lisp_Object chprop
;
13007 int glyph_pos
= glyph
->charpos
;
13009 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13011 if (INTEGERP (chprop
))
13013 bpos_covered
= bpos_max
+ XINT (chprop
);
13014 /* If the `cursor' property covers buffer positions up
13015 to and including point, we should display cursor on
13017 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13026 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13028 x
--; /* can't use any pixel_width */
13031 x
-= glyph
->pixel_width
;
13034 /* Step 2: If we didn't find an exact match for point, we need to
13035 look for a proper place to put the cursor among glyphs between
13036 GLYPH_BEFORE and GLYPH_AFTER. */
13037 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13038 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13039 && bpos_covered
< pt_old
)
13041 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13043 EMACS_INT ellipsis_pos
;
13045 /* Scan back over the ellipsis glyphs. */
13046 if (!row
->reversed_p
)
13048 ellipsis_pos
= (glyph
- 1)->charpos
;
13049 while (glyph
> row
->glyphs
[TEXT_AREA
]
13050 && (glyph
- 1)->charpos
== ellipsis_pos
)
13051 glyph
--, x
-= glyph
->pixel_width
;
13052 /* That loop always goes one position too far, including
13053 the glyph before the ellipsis. So scan forward over
13055 x
+= glyph
->pixel_width
;
13058 else /* row is reversed */
13060 ellipsis_pos
= (glyph
+ 1)->charpos
;
13061 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13062 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13063 glyph
++, x
+= glyph
->pixel_width
;
13064 x
-= glyph
->pixel_width
;
13068 else if (match_with_avoid_cursor
13069 /* zero-width characters produce no glyphs */
13070 || ((row
->reversed_p
13071 ? glyph_after
> glyphs_end
13072 : glyph_after
< glyphs_end
)
13073 && eabs (glyph_after
- glyph_before
) == 1))
13075 cursor
= glyph_after
;
13078 else if (string_seen
)
13080 int incr
= row
->reversed_p
? -1 : +1;
13082 /* Need to find the glyph that came out of a string which is
13083 present at point. That glyph is somewhere between
13084 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13085 positioned between POS_BEFORE and POS_AFTER in the
13087 struct glyph
*stop
= glyph_after
;
13088 EMACS_INT pos
= pos_before
;
13091 for (glyph
= glyph_before
+ incr
;
13092 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13095 /* Any glyphs that come from the buffer are here because
13096 of bidi reordering. Skip them, and only pay
13097 attention to glyphs that came from some string. */
13098 if (STRINGP (glyph
->object
))
13103 str
= glyph
->object
;
13104 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
13105 if (tem
== 0 /* from overlay */
13108 /* If the string from which this glyph came is
13109 found in the buffer at point, then we've
13110 found the glyph we've been looking for. If
13111 it comes from an overlay (tem == 0), and it
13112 has the `cursor' property on one of its
13113 glyphs, record that glyph as a candidate for
13114 displaying the cursor. (As in the
13115 unidirectional version, we will display the
13116 cursor on the last candidate we find.) */
13117 if (tem
== 0 || tem
== pt_old
)
13119 /* The glyphs from this string could have
13120 been reordered. Find the one with the
13121 smallest string position. Or there could
13122 be a character in the string with the
13123 `cursor' property, which means display
13124 cursor on that character's glyph. */
13125 int strpos
= glyph
->charpos
;
13128 for (glyph
+= incr
;
13129 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13130 && EQ (glyph
->object
, str
);
13134 int gpos
= glyph
->charpos
;
13136 cprop
= Fget_char_property (make_number (gpos
),
13144 if (glyph
->charpos
< strpos
)
13146 strpos
= glyph
->charpos
;
13155 pos
= tem
+ 1; /* don't find previous instances */
13157 /* This string is not what we want; skip all of the
13158 glyphs that came from it. */
13161 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13162 && EQ (glyph
->object
, str
));
13168 /* If we reached the end of the line, and END was from a string,
13169 the cursor is not on this line. */
13171 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13172 && STRINGP (end
->object
)
13173 && row
->continued_p
)
13179 if (cursor
!= NULL
)
13185 /* Need to compute x that corresponds to GLYPH. */
13186 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13188 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13190 x
+= g
->pixel_width
;
13194 /* ROW could be part of a continued line, which, under bidi
13195 reordering, might have other rows whose start and end charpos
13196 occlude point. Only set w->cursor if we found a better
13197 approximation to the cursor position than we have from previously
13198 examined candidate rows belonging to the same continued line. */
13199 if (/* we already have a candidate row */
13200 w
->cursor
.vpos
>= 0
13201 /* that candidate is not the row we are processing */
13202 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13203 /* the row we are processing is part of a continued line */
13204 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13205 /* Make sure cursor.vpos specifies a row whose start and end
13206 charpos occlude point. This is because some callers of this
13207 function leave cursor.vpos at the row where the cursor was
13208 displayed during the last redisplay cycle. */
13209 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13210 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13213 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13215 /* Don't consider glyphs that are outside TEXT_AREA. */
13216 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13218 /* Keep the candidate whose buffer position is the closest to
13220 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13221 w
->cursor
.hpos
>= 0
13222 && w
->cursor
.hpos
< MATRIX_ROW_USED(matrix
, w
->cursor
.vpos
)
13223 && BUFFERP (g1
->object
)
13224 && (g1
->charpos
== pt_old
/* an exact match always wins */
13225 || (BUFFERP (glyph
->object
)
13226 && eabs (g1
->charpos
- pt_old
)
13227 < eabs (glyph
->charpos
- pt_old
))))
13229 /* If this candidate gives an exact match, use that. */
13230 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13231 /* Otherwise, keep the candidate that comes from a row
13232 spanning less buffer positions. This may win when one or
13233 both candidate positions are on glyphs that came from
13234 display strings, for which we cannot compare buffer
13236 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13237 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13238 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13241 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13243 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13244 w
->cursor
.y
= row
->y
+ dy
;
13246 if (w
== XWINDOW (selected_window
))
13248 if (!row
->continued_p
13249 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13252 this_line_buffer
= XBUFFER (w
->buffer
);
13254 CHARPOS (this_line_start_pos
)
13255 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13256 BYTEPOS (this_line_start_pos
)
13257 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13259 CHARPOS (this_line_end_pos
)
13260 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13261 BYTEPOS (this_line_end_pos
)
13262 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13264 this_line_y
= w
->cursor
.y
;
13265 this_line_pixel_height
= row
->height
;
13266 this_line_vpos
= w
->cursor
.vpos
;
13267 this_line_start_x
= row
->x
;
13270 CHARPOS (this_line_start_pos
) = 0;
13277 /* Run window scroll functions, if any, for WINDOW with new window
13278 start STARTP. Sets the window start of WINDOW to that position.
13280 We assume that the window's buffer is really current. */
13282 static INLINE
struct text_pos
13283 run_window_scroll_functions (window
, startp
)
13284 Lisp_Object window
;
13285 struct text_pos startp
;
13287 struct window
*w
= XWINDOW (window
);
13288 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13290 if (current_buffer
!= XBUFFER (w
->buffer
))
13293 if (!NILP (Vwindow_scroll_functions
))
13295 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13296 make_number (CHARPOS (startp
)));
13297 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13298 /* In case the hook functions switch buffers. */
13299 if (current_buffer
!= XBUFFER (w
->buffer
))
13300 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13307 /* Make sure the line containing the cursor is fully visible.
13308 A value of 1 means there is nothing to be done.
13309 (Either the line is fully visible, or it cannot be made so,
13310 or we cannot tell.)
13312 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13313 is higher than window.
13315 A value of 0 means the caller should do scrolling
13316 as if point had gone off the screen. */
13319 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13322 int current_matrix_p
;
13324 struct glyph_matrix
*matrix
;
13325 struct glyph_row
*row
;
13328 if (!make_cursor_line_fully_visible_p
)
13331 /* It's not always possible to find the cursor, e.g, when a window
13332 is full of overlay strings. Don't do anything in that case. */
13333 if (w
->cursor
.vpos
< 0)
13336 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13337 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13339 /* If the cursor row is not partially visible, there's nothing to do. */
13340 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13343 /* If the row the cursor is in is taller than the window's height,
13344 it's not clear what to do, so do nothing. */
13345 window_height
= window_box_height (w
);
13346 if (row
->height
>= window_height
)
13348 if (!force_p
|| MINI_WINDOW_P (w
)
13349 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13356 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13357 non-zero means only WINDOW is redisplayed in redisplay_internal.
13358 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13359 in redisplay_window to bring a partially visible line into view in
13360 the case that only the cursor has moved.
13362 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13363 last screen line's vertical height extends past the end of the screen.
13367 1 if scrolling succeeded
13369 0 if scrolling didn't find point.
13371 -1 if new fonts have been loaded so that we must interrupt
13372 redisplay, adjust glyph matrices, and try again. */
13378 SCROLLING_NEED_LARGER_MATRICES
13382 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13383 scroll_step
, temp_scroll_step
, last_line_misfit
)
13384 Lisp_Object window
;
13385 int just_this_one_p
;
13386 EMACS_INT scroll_conservatively
, scroll_step
;
13387 int temp_scroll_step
;
13388 int last_line_misfit
;
13390 struct window
*w
= XWINDOW (window
);
13391 struct frame
*f
= XFRAME (w
->frame
);
13392 struct text_pos pos
, startp
;
13394 int this_scroll_margin
, scroll_max
, rc
, height
;
13395 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13396 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13397 Lisp_Object aggressive
;
13398 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13401 debug_method_add (w
, "try_scrolling");
13404 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13406 /* Compute scroll margin height in pixels. We scroll when point is
13407 within this distance from the top or bottom of the window. */
13408 if (scroll_margin
> 0)
13409 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13410 * FRAME_LINE_HEIGHT (f
);
13412 this_scroll_margin
= 0;
13414 /* Force scroll_conservatively to have a reasonable value, to avoid
13415 overflow while computing how much to scroll. Note that the user
13416 can supply scroll-conservatively equal to `most-positive-fixnum',
13417 which can be larger than INT_MAX. */
13418 if (scroll_conservatively
> scroll_limit
)
13420 scroll_conservatively
= scroll_limit
;
13421 scroll_max
= INT_MAX
;
13423 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13424 /* Compute how much we should try to scroll maximally to bring
13425 point into view. */
13426 scroll_max
= (max (scroll_step
,
13427 max (scroll_conservatively
, temp_scroll_step
))
13428 * FRAME_LINE_HEIGHT (f
));
13429 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13430 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13431 /* We're trying to scroll because of aggressive scrolling but no
13432 scroll_step is set. Choose an arbitrary one. */
13433 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13439 /* Decide whether to scroll down. */
13440 if (PT
> CHARPOS (startp
))
13442 int scroll_margin_y
;
13444 /* Compute the pixel ypos of the scroll margin, then move it to
13445 either that ypos or PT, whichever comes first. */
13446 start_display (&it
, w
, startp
);
13447 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13448 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13449 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13450 (MOVE_TO_POS
| MOVE_TO_Y
));
13452 if (PT
> CHARPOS (it
.current
.pos
))
13454 int y0
= line_bottom_y (&it
);
13456 /* Compute the distance from the scroll margin to PT
13457 (including the height of the cursor line). Moving the
13458 iterator unconditionally to PT can be slow if PT is far
13459 away, so stop 10 lines past the window bottom (is there a
13460 way to do the right thing quickly?). */
13461 move_it_to (&it
, PT
, -1,
13462 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13463 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13464 dy
= line_bottom_y (&it
) - y0
;
13466 if (dy
> scroll_max
)
13467 return SCROLLING_FAILED
;
13475 /* Point is in or below the bottom scroll margin, so move the
13476 window start down. If scrolling conservatively, move it just
13477 enough down to make point visible. If scroll_step is set,
13478 move it down by scroll_step. */
13479 if (scroll_conservatively
)
13481 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13482 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13483 else if (scroll_step
|| temp_scroll_step
)
13484 amount_to_scroll
= scroll_max
;
13487 aggressive
= current_buffer
->scroll_up_aggressively
;
13488 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13489 if (NUMBERP (aggressive
))
13491 double float_amount
= XFLOATINT (aggressive
) * height
;
13492 amount_to_scroll
= float_amount
;
13493 if (amount_to_scroll
== 0 && float_amount
> 0)
13494 amount_to_scroll
= 1;
13498 if (amount_to_scroll
<= 0)
13499 return SCROLLING_FAILED
;
13501 start_display (&it
, w
, startp
);
13502 move_it_vertically (&it
, amount_to_scroll
);
13504 /* If STARTP is unchanged, move it down another screen line. */
13505 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13506 move_it_by_lines (&it
, 1, 1);
13507 startp
= it
.current
.pos
;
13511 struct text_pos scroll_margin_pos
= startp
;
13513 /* See if point is inside the scroll margin at the top of the
13515 if (this_scroll_margin
)
13517 start_display (&it
, w
, startp
);
13518 move_it_vertically (&it
, this_scroll_margin
);
13519 scroll_margin_pos
= it
.current
.pos
;
13522 if (PT
< CHARPOS (scroll_margin_pos
))
13524 /* Point is in the scroll margin at the top of the window or
13525 above what is displayed in the window. */
13528 /* Compute the vertical distance from PT to the scroll
13529 margin position. Give up if distance is greater than
13531 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13532 start_display (&it
, w
, pos
);
13534 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13535 it
.last_visible_y
, -1,
13536 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13537 dy
= it
.current_y
- y0
;
13538 if (dy
> scroll_max
)
13539 return SCROLLING_FAILED
;
13541 /* Compute new window start. */
13542 start_display (&it
, w
, startp
);
13544 if (scroll_conservatively
)
13546 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13547 else if (scroll_step
|| temp_scroll_step
)
13548 amount_to_scroll
= scroll_max
;
13551 aggressive
= current_buffer
->scroll_down_aggressively
;
13552 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13553 if (NUMBERP (aggressive
))
13555 double float_amount
= XFLOATINT (aggressive
) * height
;
13556 amount_to_scroll
= float_amount
;
13557 if (amount_to_scroll
== 0 && float_amount
> 0)
13558 amount_to_scroll
= 1;
13562 if (amount_to_scroll
<= 0)
13563 return SCROLLING_FAILED
;
13565 move_it_vertically_backward (&it
, amount_to_scroll
);
13566 startp
= it
.current
.pos
;
13570 /* Run window scroll functions. */
13571 startp
= run_window_scroll_functions (window
, startp
);
13573 /* Display the window. Give up if new fonts are loaded, or if point
13575 if (!try_window (window
, startp
, 0))
13576 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13577 else if (w
->cursor
.vpos
< 0)
13579 clear_glyph_matrix (w
->desired_matrix
);
13580 rc
= SCROLLING_FAILED
;
13584 /* Maybe forget recorded base line for line number display. */
13585 if (!just_this_one_p
13586 || current_buffer
->clip_changed
13587 || BEG_UNCHANGED
< CHARPOS (startp
))
13588 w
->base_line_number
= Qnil
;
13590 /* If cursor ends up on a partially visible line,
13591 treat that as being off the bottom of the screen. */
13592 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13594 clear_glyph_matrix (w
->desired_matrix
);
13595 ++extra_scroll_margin_lines
;
13598 rc
= SCROLLING_SUCCESS
;
13605 /* Compute a suitable window start for window W if display of W starts
13606 on a continuation line. Value is non-zero if a new window start
13609 The new window start will be computed, based on W's width, starting
13610 from the start of the continued line. It is the start of the
13611 screen line with the minimum distance from the old start W->start. */
13614 compute_window_start_on_continuation_line (w
)
13617 struct text_pos pos
, start_pos
;
13618 int window_start_changed_p
= 0;
13620 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13622 /* If window start is on a continuation line... Window start may be
13623 < BEGV in case there's invisible text at the start of the
13624 buffer (M-x rmail, for example). */
13625 if (CHARPOS (start_pos
) > BEGV
13626 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13629 struct glyph_row
*row
;
13631 /* Handle the case that the window start is out of range. */
13632 if (CHARPOS (start_pos
) < BEGV
)
13633 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13634 else if (CHARPOS (start_pos
) > ZV
)
13635 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13637 /* Find the start of the continued line. This should be fast
13638 because scan_buffer is fast (newline cache). */
13639 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13640 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13641 row
, DEFAULT_FACE_ID
);
13642 reseat_at_previous_visible_line_start (&it
);
13644 /* If the line start is "too far" away from the window start,
13645 say it takes too much time to compute a new window start. */
13646 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13647 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13649 int min_distance
, distance
;
13651 /* Move forward by display lines to find the new window
13652 start. If window width was enlarged, the new start can
13653 be expected to be > the old start. If window width was
13654 decreased, the new window start will be < the old start.
13655 So, we're looking for the display line start with the
13656 minimum distance from the old window start. */
13657 pos
= it
.current
.pos
;
13658 min_distance
= INFINITY
;
13659 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13660 distance
< min_distance
)
13662 min_distance
= distance
;
13663 pos
= it
.current
.pos
;
13664 move_it_by_lines (&it
, 1, 0);
13667 /* Set the window start there. */
13668 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13669 window_start_changed_p
= 1;
13673 return window_start_changed_p
;
13677 /* Try cursor movement in case text has not changed in window WINDOW,
13678 with window start STARTP. Value is
13680 CURSOR_MOVEMENT_SUCCESS if successful
13682 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13684 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13685 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13686 we want to scroll as if scroll-step were set to 1. See the code.
13688 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13689 which case we have to abort this redisplay, and adjust matrices
13694 CURSOR_MOVEMENT_SUCCESS
,
13695 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13696 CURSOR_MOVEMENT_MUST_SCROLL
,
13697 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13701 try_cursor_movement (window
, startp
, scroll_step
)
13702 Lisp_Object window
;
13703 struct text_pos startp
;
13706 struct window
*w
= XWINDOW (window
);
13707 struct frame
*f
= XFRAME (w
->frame
);
13708 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13711 if (inhibit_try_cursor_movement
)
13715 /* Handle case where text has not changed, only point, and it has
13716 not moved off the frame. */
13717 if (/* Point may be in this window. */
13718 PT
>= CHARPOS (startp
)
13719 /* Selective display hasn't changed. */
13720 && !current_buffer
->clip_changed
13721 /* Function force-mode-line-update is used to force a thorough
13722 redisplay. It sets either windows_or_buffers_changed or
13723 update_mode_lines. So don't take a shortcut here for these
13725 && !update_mode_lines
13726 && !windows_or_buffers_changed
13727 && !cursor_type_changed
13728 /* Can't use this case if highlighting a region. When a
13729 region exists, cursor movement has to do more than just
13731 && !(!NILP (Vtransient_mark_mode
)
13732 && !NILP (current_buffer
->mark_active
))
13733 && NILP (w
->region_showing
)
13734 && NILP (Vshow_trailing_whitespace
)
13735 /* Right after splitting windows, last_point may be nil. */
13736 && INTEGERP (w
->last_point
)
13737 /* This code is not used for mini-buffer for the sake of the case
13738 of redisplaying to replace an echo area message; since in
13739 that case the mini-buffer contents per se are usually
13740 unchanged. This code is of no real use in the mini-buffer
13741 since the handling of this_line_start_pos, etc., in redisplay
13742 handles the same cases. */
13743 && !EQ (window
, minibuf_window
)
13744 /* When splitting windows or for new windows, it happens that
13745 redisplay is called with a nil window_end_vpos or one being
13746 larger than the window. This should really be fixed in
13747 window.c. I don't have this on my list, now, so we do
13748 approximately the same as the old redisplay code. --gerd. */
13749 && INTEGERP (w
->window_end_vpos
)
13750 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13751 && (FRAME_WINDOW_P (f
)
13752 || !overlay_arrow_in_current_buffer_p ()))
13754 int this_scroll_margin
, top_scroll_margin
;
13755 struct glyph_row
*row
= NULL
;
13758 debug_method_add (w
, "cursor movement");
13761 /* Scroll if point within this distance from the top or bottom
13762 of the window. This is a pixel value. */
13763 if (scroll_margin
> 0)
13765 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13766 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13769 this_scroll_margin
= 0;
13771 top_scroll_margin
= this_scroll_margin
;
13772 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13773 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13775 /* Start with the row the cursor was displayed during the last
13776 not paused redisplay. Give up if that row is not valid. */
13777 if (w
->last_cursor
.vpos
< 0
13778 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13779 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13782 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13783 if (row
->mode_line_p
)
13785 if (!row
->enabled_p
)
13786 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13787 /* If rows are bidi-reordered, back up until we find a row
13788 that does not belong to a continuation line. This is
13789 because we must consider all rows of a continued line as
13790 candidates for cursor positioning, since row start and
13791 end positions change non-linearly with vertical position
13793 /* FIXME: Revisit this when glyph ``spilling'' in
13794 continuation lines' rows is implemented for
13795 bidi-reordered rows. */
13796 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13798 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13800 xassert (row
->enabled_p
);
13802 /* If we hit the beginning of the displayed portion
13803 without finding the first row of a continued
13805 if (row
<= w
->current_matrix
->rows
)
13807 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13815 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13818 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13820 if (PT
> XFASTINT (w
->last_point
))
13822 /* Point has moved forward. */
13823 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13824 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13826 xassert (row
->enabled_p
);
13830 /* If the end position of a row equals the start
13831 position of the next row, and PT is at that position,
13832 we would rather display cursor in the next line. */
13833 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13834 && MATRIX_ROW_END_CHARPOS (row
) == PT
13835 && row
< w
->current_matrix
->rows
13836 + w
->current_matrix
->nrows
- 1
13837 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13838 && !cursor_row_p (w
, row
))
13841 /* If within the scroll margin, scroll. Note that
13842 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13843 the next line would be drawn, and that
13844 this_scroll_margin can be zero. */
13845 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13846 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13847 /* Line is completely visible last line in window
13848 and PT is to be set in the next line. */
13849 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13850 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13851 && !row
->ends_at_zv_p
13852 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13855 else if (PT
< XFASTINT (w
->last_point
))
13857 /* Cursor has to be moved backward. Note that PT >=
13858 CHARPOS (startp) because of the outer if-statement. */
13859 while (!row
->mode_line_p
13860 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13861 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13862 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13863 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13864 row
> w
->current_matrix
->rows
13865 && (row
-1)->ends_in_newline_from_string_p
))))
13866 && (row
->y
> top_scroll_margin
13867 || CHARPOS (startp
) == BEGV
))
13869 xassert (row
->enabled_p
);
13873 /* Consider the following case: Window starts at BEGV,
13874 there is invisible, intangible text at BEGV, so that
13875 display starts at some point START > BEGV. It can
13876 happen that we are called with PT somewhere between
13877 BEGV and START. Try to handle that case. */
13878 if (row
< w
->current_matrix
->rows
13879 || row
->mode_line_p
)
13881 row
= w
->current_matrix
->rows
;
13882 if (row
->mode_line_p
)
13886 /* Due to newlines in overlay strings, we may have to
13887 skip forward over overlay strings. */
13888 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13889 && MATRIX_ROW_END_CHARPOS (row
) == PT
13890 && !cursor_row_p (w
, row
))
13893 /* If within the scroll margin, scroll. */
13894 if (row
->y
< top_scroll_margin
13895 && CHARPOS (startp
) != BEGV
)
13900 /* Cursor did not move. So don't scroll even if cursor line
13901 is partially visible, as it was so before. */
13902 rc
= CURSOR_MOVEMENT_SUCCESS
;
13905 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13906 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13908 /* if PT is not in the glyph row, give up. */
13909 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13911 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13912 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13913 && make_cursor_line_fully_visible_p
)
13915 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13916 && !row
->ends_at_zv_p
13917 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13918 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13919 else if (row
->height
> window_box_height (w
))
13921 /* If we end up in a partially visible line, let's
13922 make it fully visible, except when it's taller
13923 than the window, in which case we can't do much
13926 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13930 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13931 if (!cursor_row_fully_visible_p (w
, 0, 1))
13932 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13934 rc
= CURSOR_MOVEMENT_SUCCESS
;
13938 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13939 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13941 /* With bidi-reordered rows, there could be more than
13942 one candidate row whose start and end positions
13943 occlude point. We need to let set_cursor_from_row
13944 find the best candidate. */
13945 /* FIXME: Revisit this when glyph ``spilling'' in
13946 continuation lines' rows is implemented for
13947 bidi-reordered rows. */
13952 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13954 /* As soon as we've found the first suitable row
13955 whose ends_at_zv_p flag is set, we are done. */
13957 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13959 rc
= CURSOR_MOVEMENT_SUCCESS
;
13964 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13965 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13966 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13967 && cursor_row_p (w
, row
));
13968 /* If we didn't find any candidate rows, or exited the
13969 loop before all the candidates were examined, signal
13970 to the caller that this method failed. */
13971 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13973 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13974 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13975 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13977 rc
= CURSOR_MOVEMENT_SUCCESS
;
13983 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13985 rc
= CURSOR_MOVEMENT_SUCCESS
;
13990 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13991 && MATRIX_ROW_START_CHARPOS (row
) == PT
13992 && cursor_row_p (w
, row
));
14001 set_vertical_scroll_bar (w
)
14004 int start
, end
, whole
;
14006 /* Calculate the start and end positions for the current window.
14007 At some point, it would be nice to choose between scrollbars
14008 which reflect the whole buffer size, with special markers
14009 indicating narrowing, and scrollbars which reflect only the
14012 Note that mini-buffers sometimes aren't displaying any text. */
14013 if (!MINI_WINDOW_P (w
)
14014 || (w
== XWINDOW (minibuf_window
)
14015 && NILP (echo_area_buffer
[0])))
14017 struct buffer
*buf
= XBUFFER (w
->buffer
);
14018 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14019 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14020 /* I don't think this is guaranteed to be right. For the
14021 moment, we'll pretend it is. */
14022 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14026 if (whole
< (end
- start
))
14027 whole
= end
- start
;
14030 start
= end
= whole
= 0;
14032 /* Indicate what this scroll bar ought to be displaying now. */
14033 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14034 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14035 (w
, end
- start
, whole
, start
);
14039 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14040 selected_window is redisplayed.
14042 We can return without actually redisplaying the window if
14043 fonts_changed_p is nonzero. In that case, redisplay_internal will
14047 redisplay_window (window
, just_this_one_p
)
14048 Lisp_Object window
;
14049 int just_this_one_p
;
14051 struct window
*w
= XWINDOW (window
);
14052 struct frame
*f
= XFRAME (w
->frame
);
14053 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14054 struct buffer
*old
= current_buffer
;
14055 struct text_pos lpoint
, opoint
, startp
;
14056 int update_mode_line
;
14059 /* Record it now because it's overwritten. */
14060 int current_matrix_up_to_date_p
= 0;
14061 int used_current_matrix_p
= 0;
14062 /* This is less strict than current_matrix_up_to_date_p.
14063 It indictes that the buffer contents and narrowing are unchanged. */
14064 int buffer_unchanged_p
= 0;
14065 int temp_scroll_step
= 0;
14066 int count
= SPECPDL_INDEX ();
14068 int centering_position
= -1;
14069 int last_line_misfit
= 0;
14070 int beg_unchanged
, end_unchanged
;
14072 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14075 /* W must be a leaf window here. */
14076 xassert (!NILP (w
->buffer
));
14078 *w
->desired_matrix
->method
= 0;
14082 reconsider_clip_changes (w
, buffer
);
14084 /* Has the mode line to be updated? */
14085 update_mode_line
= (!NILP (w
->update_mode_line
)
14086 || update_mode_lines
14087 || buffer
->clip_changed
14088 || buffer
->prevent_redisplay_optimizations_p
);
14090 if (MINI_WINDOW_P (w
))
14092 if (w
== XWINDOW (echo_area_window
)
14093 && !NILP (echo_area_buffer
[0]))
14095 if (update_mode_line
)
14096 /* We may have to update a tty frame's menu bar or a
14097 tool-bar. Example `M-x C-h C-h C-g'. */
14098 goto finish_menu_bars
;
14100 /* We've already displayed the echo area glyphs in this window. */
14101 goto finish_scroll_bars
;
14103 else if ((w
!= XWINDOW (minibuf_window
)
14104 || minibuf_level
== 0)
14105 /* When buffer is nonempty, redisplay window normally. */
14106 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14107 /* Quail displays non-mini buffers in minibuffer window.
14108 In that case, redisplay the window normally. */
14109 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14111 /* W is a mini-buffer window, but it's not active, so clear
14113 int yb
= window_text_bottom_y (w
);
14114 struct glyph_row
*row
;
14117 for (y
= 0, row
= w
->desired_matrix
->rows
;
14119 y
+= row
->height
, ++row
)
14120 blank_row (w
, row
, y
);
14121 goto finish_scroll_bars
;
14124 clear_glyph_matrix (w
->desired_matrix
);
14127 /* Otherwise set up data on this window; select its buffer and point
14129 /* Really select the buffer, for the sake of buffer-local
14131 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14133 current_matrix_up_to_date_p
14134 = (!NILP (w
->window_end_valid
)
14135 && !current_buffer
->clip_changed
14136 && !current_buffer
->prevent_redisplay_optimizations_p
14137 && XFASTINT (w
->last_modified
) >= MODIFF
14138 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14140 /* Run the window-bottom-change-functions
14141 if it is possible that the text on the screen has changed
14142 (either due to modification of the text, or any other reason). */
14143 if (!current_matrix_up_to_date_p
14144 && !NILP (Vwindow_text_change_functions
))
14146 safe_run_hooks (Qwindow_text_change_functions
);
14150 beg_unchanged
= BEG_UNCHANGED
;
14151 end_unchanged
= END_UNCHANGED
;
14153 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14155 specbind (Qinhibit_point_motion_hooks
, Qt
);
14158 = (!NILP (w
->window_end_valid
)
14159 && !current_buffer
->clip_changed
14160 && XFASTINT (w
->last_modified
) >= MODIFF
14161 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14163 /* When windows_or_buffers_changed is non-zero, we can't rely on
14164 the window end being valid, so set it to nil there. */
14165 if (windows_or_buffers_changed
)
14167 /* If window starts on a continuation line, maybe adjust the
14168 window start in case the window's width changed. */
14169 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14170 compute_window_start_on_continuation_line (w
);
14172 w
->window_end_valid
= Qnil
;
14175 /* Some sanity checks. */
14176 CHECK_WINDOW_END (w
);
14177 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14179 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14182 /* If %c is in mode line, update it if needed. */
14183 if (!NILP (w
->column_number_displayed
)
14184 /* This alternative quickly identifies a common case
14185 where no change is needed. */
14186 && !(PT
== XFASTINT (w
->last_point
)
14187 && XFASTINT (w
->last_modified
) >= MODIFF
14188 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14189 && (XFASTINT (w
->column_number_displayed
)
14190 != (int) current_column ())) /* iftc */
14191 update_mode_line
= 1;
14193 /* Count number of windows showing the selected buffer. An indirect
14194 buffer counts as its base buffer. */
14195 if (!just_this_one_p
)
14197 struct buffer
*current_base
, *window_base
;
14198 current_base
= current_buffer
;
14199 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14200 if (current_base
->base_buffer
)
14201 current_base
= current_base
->base_buffer
;
14202 if (window_base
->base_buffer
)
14203 window_base
= window_base
->base_buffer
;
14204 if (current_base
== window_base
)
14208 /* Point refers normally to the selected window. For any other
14209 window, set up appropriate value. */
14210 if (!EQ (window
, selected_window
))
14212 int new_pt
= XMARKER (w
->pointm
)->charpos
;
14213 int new_pt_byte
= marker_byte_position (w
->pointm
);
14217 new_pt_byte
= BEGV_BYTE
;
14218 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14220 else if (new_pt
> (ZV
- 1))
14223 new_pt_byte
= ZV_BYTE
;
14224 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14227 /* We don't use SET_PT so that the point-motion hooks don't run. */
14228 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14231 /* If any of the character widths specified in the display table
14232 have changed, invalidate the width run cache. It's true that
14233 this may be a bit late to catch such changes, but the rest of
14234 redisplay goes (non-fatally) haywire when the display table is
14235 changed, so why should we worry about doing any better? */
14236 if (current_buffer
->width_run_cache
)
14238 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14240 if (! disptab_matches_widthtab (disptab
,
14241 XVECTOR (current_buffer
->width_table
)))
14243 invalidate_region_cache (current_buffer
,
14244 current_buffer
->width_run_cache
,
14246 recompute_width_table (current_buffer
, disptab
);
14250 /* If window-start is screwed up, choose a new one. */
14251 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14254 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14256 /* If someone specified a new starting point but did not insist,
14257 check whether it can be used. */
14258 if (!NILP (w
->optional_new_start
)
14259 && CHARPOS (startp
) >= BEGV
14260 && CHARPOS (startp
) <= ZV
)
14262 w
->optional_new_start
= Qnil
;
14263 start_display (&it
, w
, startp
);
14264 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14265 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14266 if (IT_CHARPOS (it
) == PT
)
14267 w
->force_start
= Qt
;
14268 /* IT may overshoot PT if text at PT is invisible. */
14269 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14270 w
->force_start
= Qt
;
14275 /* Handle case where place to start displaying has been specified,
14276 unless the specified location is outside the accessible range. */
14277 if (!NILP (w
->force_start
)
14278 || w
->frozen_window_start_p
)
14280 /* We set this later on if we have to adjust point. */
14283 w
->force_start
= Qnil
;
14285 w
->window_end_valid
= Qnil
;
14287 /* Forget any recorded base line for line number display. */
14288 if (!buffer_unchanged_p
)
14289 w
->base_line_number
= Qnil
;
14291 /* Redisplay the mode line. Select the buffer properly for that.
14292 Also, run the hook window-scroll-functions
14293 because we have scrolled. */
14294 /* Note, we do this after clearing force_start because
14295 if there's an error, it is better to forget about force_start
14296 than to get into an infinite loop calling the hook functions
14297 and having them get more errors. */
14298 if (!update_mode_line
14299 || ! NILP (Vwindow_scroll_functions
))
14301 update_mode_line
= 1;
14302 w
->update_mode_line
= Qt
;
14303 startp
= run_window_scroll_functions (window
, startp
);
14306 w
->last_modified
= make_number (0);
14307 w
->last_overlay_modified
= make_number (0);
14308 if (CHARPOS (startp
) < BEGV
)
14309 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14310 else if (CHARPOS (startp
) > ZV
)
14311 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14313 /* Redisplay, then check if cursor has been set during the
14314 redisplay. Give up if new fonts were loaded. */
14315 /* We used to issue a CHECK_MARGINS argument to try_window here,
14316 but this causes scrolling to fail when point begins inside
14317 the scroll margin (bug#148) -- cyd */
14318 if (!try_window (window
, startp
, 0))
14320 w
->force_start
= Qt
;
14321 clear_glyph_matrix (w
->desired_matrix
);
14322 goto need_larger_matrices
;
14325 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14327 /* If point does not appear, try to move point so it does
14328 appear. The desired matrix has been built above, so we
14329 can use it here. */
14330 new_vpos
= window_box_height (w
) / 2;
14333 if (!cursor_row_fully_visible_p (w
, 0, 0))
14335 /* Point does appear, but on a line partly visible at end of window.
14336 Move it back to a fully-visible line. */
14337 new_vpos
= window_box_height (w
);
14340 /* If we need to move point for either of the above reasons,
14341 now actually do it. */
14344 struct glyph_row
*row
;
14346 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14347 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14350 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14351 MATRIX_ROW_START_BYTEPOS (row
));
14353 if (w
!= XWINDOW (selected_window
))
14354 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14355 else if (current_buffer
== old
)
14356 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14358 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14360 /* If we are highlighting the region, then we just changed
14361 the region, so redisplay to show it. */
14362 if (!NILP (Vtransient_mark_mode
)
14363 && !NILP (current_buffer
->mark_active
))
14365 clear_glyph_matrix (w
->desired_matrix
);
14366 if (!try_window (window
, startp
, 0))
14367 goto need_larger_matrices
;
14372 debug_method_add (w
, "forced window start");
14377 /* Handle case where text has not changed, only point, and it has
14378 not moved off the frame, and we are not retrying after hscroll.
14379 (current_matrix_up_to_date_p is nonzero when retrying.) */
14380 if (current_matrix_up_to_date_p
14381 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14382 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14386 case CURSOR_MOVEMENT_SUCCESS
:
14387 used_current_matrix_p
= 1;
14390 case CURSOR_MOVEMENT_MUST_SCROLL
:
14391 goto try_to_scroll
;
14397 /* If current starting point was originally the beginning of a line
14398 but no longer is, find a new starting point. */
14399 else if (!NILP (w
->start_at_line_beg
)
14400 && !(CHARPOS (startp
) <= BEGV
14401 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14404 debug_method_add (w
, "recenter 1");
14409 /* Try scrolling with try_window_id. Value is > 0 if update has
14410 been done, it is -1 if we know that the same window start will
14411 not work. It is 0 if unsuccessful for some other reason. */
14412 else if ((tem
= try_window_id (w
)) != 0)
14415 debug_method_add (w
, "try_window_id %d", tem
);
14418 if (fonts_changed_p
)
14419 goto need_larger_matrices
;
14423 /* Otherwise try_window_id has returned -1 which means that we
14424 don't want the alternative below this comment to execute. */
14426 else if (CHARPOS (startp
) >= BEGV
14427 && CHARPOS (startp
) <= ZV
14428 && PT
>= CHARPOS (startp
)
14429 && (CHARPOS (startp
) < ZV
14430 /* Avoid starting at end of buffer. */
14431 || CHARPOS (startp
) == BEGV
14432 || (XFASTINT (w
->last_modified
) >= MODIFF
14433 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14436 /* If first window line is a continuation line, and window start
14437 is inside the modified region, but the first change is before
14438 current window start, we must select a new window start.
14440 However, if this is the result of a down-mouse event (e.g. by
14441 extending the mouse-drag-overlay), we don't want to select a
14442 new window start, since that would change the position under
14443 the mouse, resulting in an unwanted mouse-movement rather
14444 than a simple mouse-click. */
14445 if (NILP (w
->start_at_line_beg
)
14446 && NILP (do_mouse_tracking
)
14447 && CHARPOS (startp
) > BEGV
14448 && CHARPOS (startp
) > BEG
+ beg_unchanged
14449 && CHARPOS (startp
) <= Z
- end_unchanged
14450 /* Even if w->start_at_line_beg is nil, a new window may
14451 start at a line_beg, since that's how set_buffer_window
14452 sets it. So, we need to check the return value of
14453 compute_window_start_on_continuation_line. (See also
14455 && XMARKER (w
->start
)->buffer
== current_buffer
14456 && compute_window_start_on_continuation_line (w
))
14458 w
->force_start
= Qt
;
14459 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14464 debug_method_add (w
, "same window start");
14467 /* Try to redisplay starting at same place as before.
14468 If point has not moved off frame, accept the results. */
14469 if (!current_matrix_up_to_date_p
14470 /* Don't use try_window_reusing_current_matrix in this case
14471 because a window scroll function can have changed the
14473 || !NILP (Vwindow_scroll_functions
)
14474 || MINI_WINDOW_P (w
)
14475 || !(used_current_matrix_p
14476 = try_window_reusing_current_matrix (w
)))
14478 IF_DEBUG (debug_method_add (w
, "1"));
14479 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14480 /* -1 means we need to scroll.
14481 0 means we need new matrices, but fonts_changed_p
14482 is set in that case, so we will detect it below. */
14483 goto try_to_scroll
;
14486 if (fonts_changed_p
)
14487 goto need_larger_matrices
;
14489 if (w
->cursor
.vpos
>= 0)
14491 if (!just_this_one_p
14492 || current_buffer
->clip_changed
14493 || BEG_UNCHANGED
< CHARPOS (startp
))
14494 /* Forget any recorded base line for line number display. */
14495 w
->base_line_number
= Qnil
;
14497 if (!cursor_row_fully_visible_p (w
, 1, 0))
14499 clear_glyph_matrix (w
->desired_matrix
);
14500 last_line_misfit
= 1;
14502 /* Drop through and scroll. */
14507 clear_glyph_matrix (w
->desired_matrix
);
14512 w
->last_modified
= make_number (0);
14513 w
->last_overlay_modified
= make_number (0);
14515 /* Redisplay the mode line. Select the buffer properly for that. */
14516 if (!update_mode_line
)
14518 update_mode_line
= 1;
14519 w
->update_mode_line
= Qt
;
14522 /* Try to scroll by specified few lines. */
14523 if ((scroll_conservatively
14525 || temp_scroll_step
14526 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14527 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14528 && !current_buffer
->clip_changed
14529 && CHARPOS (startp
) >= BEGV
14530 && CHARPOS (startp
) <= ZV
)
14532 /* The function returns -1 if new fonts were loaded, 1 if
14533 successful, 0 if not successful. */
14534 int rc
= try_scrolling (window
, just_this_one_p
,
14535 scroll_conservatively
,
14537 temp_scroll_step
, last_line_misfit
);
14540 case SCROLLING_SUCCESS
:
14543 case SCROLLING_NEED_LARGER_MATRICES
:
14544 goto need_larger_matrices
;
14546 case SCROLLING_FAILED
:
14554 /* Finally, just choose place to start which centers point */
14557 if (centering_position
< 0)
14558 centering_position
= window_box_height (w
) / 2;
14561 debug_method_add (w
, "recenter");
14564 /* w->vscroll = 0; */
14566 /* Forget any previously recorded base line for line number display. */
14567 if (!buffer_unchanged_p
)
14568 w
->base_line_number
= Qnil
;
14570 /* Move backward half the height of the window. */
14571 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14572 it
.current_y
= it
.last_visible_y
;
14573 move_it_vertically_backward (&it
, centering_position
);
14574 xassert (IT_CHARPOS (it
) >= BEGV
);
14576 /* The function move_it_vertically_backward may move over more
14577 than the specified y-distance. If it->w is small, e.g. a
14578 mini-buffer window, we may end up in front of the window's
14579 display area. Start displaying at the start of the line
14580 containing PT in this case. */
14581 if (it
.current_y
<= 0)
14583 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14584 move_it_vertically_backward (&it
, 0);
14588 it
.current_x
= it
.hpos
= 0;
14590 /* Set startp here explicitly in case that helps avoid an infinite loop
14591 in case the window-scroll-functions functions get errors. */
14592 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14594 /* Run scroll hooks. */
14595 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14597 /* Redisplay the window. */
14598 if (!current_matrix_up_to_date_p
14599 || windows_or_buffers_changed
14600 || cursor_type_changed
14601 /* Don't use try_window_reusing_current_matrix in this case
14602 because it can have changed the buffer. */
14603 || !NILP (Vwindow_scroll_functions
)
14604 || !just_this_one_p
14605 || MINI_WINDOW_P (w
)
14606 || !(used_current_matrix_p
14607 = try_window_reusing_current_matrix (w
)))
14608 try_window (window
, startp
, 0);
14610 /* If new fonts have been loaded (due to fontsets), give up. We
14611 have to start a new redisplay since we need to re-adjust glyph
14613 if (fonts_changed_p
)
14614 goto need_larger_matrices
;
14616 /* If cursor did not appear assume that the middle of the window is
14617 in the first line of the window. Do it again with the next line.
14618 (Imagine a window of height 100, displaying two lines of height
14619 60. Moving back 50 from it->last_visible_y will end in the first
14621 if (w
->cursor
.vpos
< 0)
14623 if (!NILP (w
->window_end_valid
)
14624 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14626 clear_glyph_matrix (w
->desired_matrix
);
14627 move_it_by_lines (&it
, 1, 0);
14628 try_window (window
, it
.current
.pos
, 0);
14630 else if (PT
< IT_CHARPOS (it
))
14632 clear_glyph_matrix (w
->desired_matrix
);
14633 move_it_by_lines (&it
, -1, 0);
14634 try_window (window
, it
.current
.pos
, 0);
14638 /* Not much we can do about it. */
14642 /* Consider the following case: Window starts at BEGV, there is
14643 invisible, intangible text at BEGV, so that display starts at
14644 some point START > BEGV. It can happen that we are called with
14645 PT somewhere between BEGV and START. Try to handle that case. */
14646 if (w
->cursor
.vpos
< 0)
14648 struct glyph_row
*row
= w
->current_matrix
->rows
;
14649 if (row
->mode_line_p
)
14651 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14654 if (!cursor_row_fully_visible_p (w
, 0, 0))
14656 /* If vscroll is enabled, disable it and try again. */
14660 clear_glyph_matrix (w
->desired_matrix
);
14664 /* If centering point failed to make the whole line visible,
14665 put point at the top instead. That has to make the whole line
14666 visible, if it can be done. */
14667 if (centering_position
== 0)
14670 clear_glyph_matrix (w
->desired_matrix
);
14671 centering_position
= 0;
14677 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14678 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14679 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14682 /* Display the mode line, if we must. */
14683 if ((update_mode_line
14684 /* If window not full width, must redo its mode line
14685 if (a) the window to its side is being redone and
14686 (b) we do a frame-based redisplay. This is a consequence
14687 of how inverted lines are drawn in frame-based redisplay. */
14688 || (!just_this_one_p
14689 && !FRAME_WINDOW_P (f
)
14690 && !WINDOW_FULL_WIDTH_P (w
))
14691 /* Line number to display. */
14692 || INTEGERP (w
->base_line_pos
)
14693 /* Column number is displayed and different from the one displayed. */
14694 || (!NILP (w
->column_number_displayed
)
14695 && (XFASTINT (w
->column_number_displayed
)
14696 != (int) current_column ()))) /* iftc */
14697 /* This means that the window has a mode line. */
14698 && (WINDOW_WANTS_MODELINE_P (w
)
14699 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14701 display_mode_lines (w
);
14703 /* If mode line height has changed, arrange for a thorough
14704 immediate redisplay using the correct mode line height. */
14705 if (WINDOW_WANTS_MODELINE_P (w
)
14706 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14708 fonts_changed_p
= 1;
14709 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14710 = DESIRED_MODE_LINE_HEIGHT (w
);
14713 /* If header line height has changed, arrange for a thorough
14714 immediate redisplay using the correct header line height. */
14715 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14716 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14718 fonts_changed_p
= 1;
14719 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14720 = DESIRED_HEADER_LINE_HEIGHT (w
);
14723 if (fonts_changed_p
)
14724 goto need_larger_matrices
;
14727 if (!line_number_displayed
14728 && !BUFFERP (w
->base_line_pos
))
14730 w
->base_line_pos
= Qnil
;
14731 w
->base_line_number
= Qnil
;
14736 /* When we reach a frame's selected window, redo the frame's menu bar. */
14737 if (update_mode_line
14738 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14740 int redisplay_menu_p
= 0;
14741 int redisplay_tool_bar_p
= 0;
14743 if (FRAME_WINDOW_P (f
))
14745 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14746 || defined (HAVE_NS) || defined (USE_GTK)
14747 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14749 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14753 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14755 if (redisplay_menu_p
)
14756 display_menu_bar (w
);
14758 #ifdef HAVE_WINDOW_SYSTEM
14759 if (FRAME_WINDOW_P (f
))
14761 #if defined (USE_GTK) || defined (HAVE_NS)
14762 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14764 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14765 && (FRAME_TOOL_BAR_LINES (f
) > 0
14766 || !NILP (Vauto_resize_tool_bars
));
14769 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14771 extern int ignore_mouse_drag_p
;
14772 ignore_mouse_drag_p
= 1;
14778 #ifdef HAVE_WINDOW_SYSTEM
14779 if (FRAME_WINDOW_P (f
)
14780 && update_window_fringes (w
, (just_this_one_p
14781 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14782 || w
->pseudo_window_p
)))
14786 if (draw_window_fringes (w
, 1))
14787 x_draw_vertical_border (w
);
14791 #endif /* HAVE_WINDOW_SYSTEM */
14793 /* We go to this label, with fonts_changed_p nonzero,
14794 if it is necessary to try again using larger glyph matrices.
14795 We have to redeem the scroll bar even in this case,
14796 because the loop in redisplay_internal expects that. */
14797 need_larger_matrices
:
14799 finish_scroll_bars
:
14801 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14803 /* Set the thumb's position and size. */
14804 set_vertical_scroll_bar (w
);
14806 /* Note that we actually used the scroll bar attached to this
14807 window, so it shouldn't be deleted at the end of redisplay. */
14808 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14809 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14812 /* Restore current_buffer and value of point in it. */
14813 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14814 set_buffer_internal_1 (old
);
14815 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14816 shorter. This can be caused by log truncation in *Messages*. */
14817 if (CHARPOS (lpoint
) <= ZV
)
14818 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14820 unbind_to (count
, Qnil
);
14824 /* Build the complete desired matrix of WINDOW with a window start
14825 buffer position POS.
14827 Value is 1 if successful. It is zero if fonts were loaded during
14828 redisplay which makes re-adjusting glyph matrices necessary, and -1
14829 if point would appear in the scroll margins.
14830 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14831 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14835 try_window (window
, pos
, flags
)
14836 Lisp_Object window
;
14837 struct text_pos pos
;
14840 struct window
*w
= XWINDOW (window
);
14842 struct glyph_row
*last_text_row
= NULL
;
14843 struct frame
*f
= XFRAME (w
->frame
);
14845 /* Make POS the new window start. */
14846 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14848 /* Mark cursor position as unknown. No overlay arrow seen. */
14849 w
->cursor
.vpos
= -1;
14850 overlay_arrow_seen
= 0;
14852 /* Initialize iterator and info to start at POS. */
14853 start_display (&it
, w
, pos
);
14855 /* Display all lines of W. */
14856 while (it
.current_y
< it
.last_visible_y
)
14858 if (display_line (&it
))
14859 last_text_row
= it
.glyph_row
- 1;
14860 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14864 /* Don't let the cursor end in the scroll margins. */
14865 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14866 && !MINI_WINDOW_P (w
))
14868 int this_scroll_margin
;
14870 if (scroll_margin
> 0)
14872 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14873 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14876 this_scroll_margin
= 0;
14878 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14879 && w
->cursor
.y
< this_scroll_margin
14880 && CHARPOS (pos
) > BEGV
14881 && IT_CHARPOS (it
) < ZV
)
14882 /* rms: considering make_cursor_line_fully_visible_p here
14883 seems to give wrong results. We don't want to recenter
14884 when the last line is partly visible, we want to allow
14885 that case to be handled in the usual way. */
14886 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14888 w
->cursor
.vpos
= -1;
14889 clear_glyph_matrix (w
->desired_matrix
);
14894 /* If bottom moved off end of frame, change mode line percentage. */
14895 if (XFASTINT (w
->window_end_pos
) <= 0
14896 && Z
!= IT_CHARPOS (it
))
14897 w
->update_mode_line
= Qt
;
14899 /* Set window_end_pos to the offset of the last character displayed
14900 on the window from the end of current_buffer. Set
14901 window_end_vpos to its row number. */
14904 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14905 w
->window_end_bytepos
14906 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14908 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14910 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14911 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14912 ->displays_text_p
);
14916 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14917 w
->window_end_pos
= make_number (Z
- ZV
);
14918 w
->window_end_vpos
= make_number (0);
14921 /* But that is not valid info until redisplay finishes. */
14922 w
->window_end_valid
= Qnil
;
14928 /************************************************************************
14929 Window redisplay reusing current matrix when buffer has not changed
14930 ************************************************************************/
14932 /* Try redisplay of window W showing an unchanged buffer with a
14933 different window start than the last time it was displayed by
14934 reusing its current matrix. Value is non-zero if successful.
14935 W->start is the new window start. */
14938 try_window_reusing_current_matrix (w
)
14941 struct frame
*f
= XFRAME (w
->frame
);
14942 struct glyph_row
*row
, *bottom_row
;
14945 struct text_pos start
, new_start
;
14946 int nrows_scrolled
, i
;
14947 struct glyph_row
*last_text_row
;
14948 struct glyph_row
*last_reused_text_row
;
14949 struct glyph_row
*start_row
;
14950 int start_vpos
, min_y
, max_y
;
14953 if (inhibit_try_window_reusing
)
14957 if (/* This function doesn't handle terminal frames. */
14958 !FRAME_WINDOW_P (f
)
14959 /* Don't try to reuse the display if windows have been split
14961 || windows_or_buffers_changed
14962 || cursor_type_changed
)
14965 /* Can't do this if region may have changed. */
14966 if ((!NILP (Vtransient_mark_mode
)
14967 && !NILP (current_buffer
->mark_active
))
14968 || !NILP (w
->region_showing
)
14969 || !NILP (Vshow_trailing_whitespace
))
14972 /* If top-line visibility has changed, give up. */
14973 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14974 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14977 /* Give up if old or new display is scrolled vertically. We could
14978 make this function handle this, but right now it doesn't. */
14979 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14980 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14983 /* The variable new_start now holds the new window start. The old
14984 start `start' can be determined from the current matrix. */
14985 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14986 start
= start_row
->start
.pos
;
14987 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14989 /* Clear the desired matrix for the display below. */
14990 clear_glyph_matrix (w
->desired_matrix
);
14992 if (CHARPOS (new_start
) <= CHARPOS (start
))
14996 /* Don't use this method if the display starts with an ellipsis
14997 displayed for invisible text. It's not easy to handle that case
14998 below, and it's certainly not worth the effort since this is
14999 not a frequent case. */
15000 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15003 IF_DEBUG (debug_method_add (w
, "twu1"));
15005 /* Display up to a row that can be reused. The variable
15006 last_text_row is set to the last row displayed that displays
15007 text. Note that it.vpos == 0 if or if not there is a
15008 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15009 start_display (&it
, w
, new_start
);
15010 first_row_y
= it
.current_y
;
15011 w
->cursor
.vpos
= -1;
15012 last_text_row
= last_reused_text_row
= NULL
;
15014 while (it
.current_y
< it
.last_visible_y
15015 && !fonts_changed_p
)
15017 /* If we have reached into the characters in the START row,
15018 that means the line boundaries have changed. So we
15019 can't start copying with the row START. Maybe it will
15020 work to start copying with the following row. */
15021 while (IT_CHARPOS (it
) > CHARPOS (start
))
15023 /* Advance to the next row as the "start". */
15025 start
= start_row
->start
.pos
;
15026 /* If there are no more rows to try, or just one, give up. */
15027 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15028 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15029 || CHARPOS (start
) == ZV
)
15031 clear_glyph_matrix (w
->desired_matrix
);
15035 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15037 /* If we have reached alignment,
15038 we can copy the rest of the rows. */
15039 if (IT_CHARPOS (it
) == CHARPOS (start
))
15042 if (display_line (&it
))
15043 last_text_row
= it
.glyph_row
- 1;
15046 /* A value of current_y < last_visible_y means that we stopped
15047 at the previous window start, which in turn means that we
15048 have at least one reusable row. */
15049 if (it
.current_y
< it
.last_visible_y
)
15051 /* IT.vpos always starts from 0; it counts text lines. */
15052 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15054 /* Find PT if not already found in the lines displayed. */
15055 if (w
->cursor
.vpos
< 0)
15057 int dy
= it
.current_y
- start_row
->y
;
15059 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15060 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15062 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15063 dy
, nrows_scrolled
);
15066 clear_glyph_matrix (w
->desired_matrix
);
15071 /* Scroll the display. Do it before the current matrix is
15072 changed. The problem here is that update has not yet
15073 run, i.e. part of the current matrix is not up to date.
15074 scroll_run_hook will clear the cursor, and use the
15075 current matrix to get the height of the row the cursor is
15077 run
.current_y
= start_row
->y
;
15078 run
.desired_y
= it
.current_y
;
15079 run
.height
= it
.last_visible_y
- it
.current_y
;
15081 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15084 FRAME_RIF (f
)->update_window_begin_hook (w
);
15085 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15086 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15087 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15091 /* Shift current matrix down by nrows_scrolled lines. */
15092 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15093 rotate_matrix (w
->current_matrix
,
15095 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15098 /* Disable lines that must be updated. */
15099 for (i
= 0; i
< nrows_scrolled
; ++i
)
15100 (start_row
+ i
)->enabled_p
= 0;
15102 /* Re-compute Y positions. */
15103 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15104 max_y
= it
.last_visible_y
;
15105 for (row
= start_row
+ nrows_scrolled
;
15109 row
->y
= it
.current_y
;
15110 row
->visible_height
= row
->height
;
15112 if (row
->y
< min_y
)
15113 row
->visible_height
-= min_y
- row
->y
;
15114 if (row
->y
+ row
->height
> max_y
)
15115 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15116 row
->redraw_fringe_bitmaps_p
= 1;
15118 it
.current_y
+= row
->height
;
15120 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15121 last_reused_text_row
= row
;
15122 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15126 /* Disable lines in the current matrix which are now
15127 below the window. */
15128 for (++row
; row
< bottom_row
; ++row
)
15129 row
->enabled_p
= row
->mode_line_p
= 0;
15132 /* Update window_end_pos etc.; last_reused_text_row is the last
15133 reused row from the current matrix containing text, if any.
15134 The value of last_text_row is the last displayed line
15135 containing text. */
15136 if (last_reused_text_row
)
15138 w
->window_end_bytepos
15139 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15141 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15143 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15144 w
->current_matrix
));
15146 else if (last_text_row
)
15148 w
->window_end_bytepos
15149 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15151 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15153 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15157 /* This window must be completely empty. */
15158 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15159 w
->window_end_pos
= make_number (Z
- ZV
);
15160 w
->window_end_vpos
= make_number (0);
15162 w
->window_end_valid
= Qnil
;
15164 /* Update hint: don't try scrolling again in update_window. */
15165 w
->desired_matrix
->no_scrolling_p
= 1;
15168 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15172 else if (CHARPOS (new_start
) > CHARPOS (start
))
15174 struct glyph_row
*pt_row
, *row
;
15175 struct glyph_row
*first_reusable_row
;
15176 struct glyph_row
*first_row_to_display
;
15178 int yb
= window_text_bottom_y (w
);
15180 /* Find the row starting at new_start, if there is one. Don't
15181 reuse a partially visible line at the end. */
15182 first_reusable_row
= start_row
;
15183 while (first_reusable_row
->enabled_p
15184 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15185 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15186 < CHARPOS (new_start
)))
15187 ++first_reusable_row
;
15189 /* Give up if there is no row to reuse. */
15190 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15191 || !first_reusable_row
->enabled_p
15192 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15193 != CHARPOS (new_start
)))
15196 /* We can reuse fully visible rows beginning with
15197 first_reusable_row to the end of the window. Set
15198 first_row_to_display to the first row that cannot be reused.
15199 Set pt_row to the row containing point, if there is any. */
15201 for (first_row_to_display
= first_reusable_row
;
15202 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15203 ++first_row_to_display
)
15205 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15206 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15207 pt_row
= first_row_to_display
;
15210 /* Start displaying at the start of first_row_to_display. */
15211 xassert (first_row_to_display
->y
< yb
);
15212 init_to_row_start (&it
, w
, first_row_to_display
);
15214 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15216 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15218 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15219 + WINDOW_HEADER_LINE_HEIGHT (w
));
15221 /* Display lines beginning with first_row_to_display in the
15222 desired matrix. Set last_text_row to the last row displayed
15223 that displays text. */
15224 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15225 if (pt_row
== NULL
)
15226 w
->cursor
.vpos
= -1;
15227 last_text_row
= NULL
;
15228 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15229 if (display_line (&it
))
15230 last_text_row
= it
.glyph_row
- 1;
15232 /* If point is in a reused row, adjust y and vpos of the cursor
15236 w
->cursor
.vpos
-= nrows_scrolled
;
15237 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15240 /* Give up if point isn't in a row displayed or reused. (This
15241 also handles the case where w->cursor.vpos < nrows_scrolled
15242 after the calls to display_line, which can happen with scroll
15243 margins. See bug#1295.) */
15244 if (w
->cursor
.vpos
< 0)
15246 clear_glyph_matrix (w
->desired_matrix
);
15250 /* Scroll the display. */
15251 run
.current_y
= first_reusable_row
->y
;
15252 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15253 run
.height
= it
.last_visible_y
- run
.current_y
;
15254 dy
= run
.current_y
- run
.desired_y
;
15259 FRAME_RIF (f
)->update_window_begin_hook (w
);
15260 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15261 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15262 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15266 /* Adjust Y positions of reused rows. */
15267 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15268 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15269 max_y
= it
.last_visible_y
;
15270 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15273 row
->visible_height
= row
->height
;
15274 if (row
->y
< min_y
)
15275 row
->visible_height
-= min_y
- row
->y
;
15276 if (row
->y
+ row
->height
> max_y
)
15277 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15278 row
->redraw_fringe_bitmaps_p
= 1;
15281 /* Scroll the current matrix. */
15282 xassert (nrows_scrolled
> 0);
15283 rotate_matrix (w
->current_matrix
,
15285 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15288 /* Disable rows not reused. */
15289 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15290 row
->enabled_p
= 0;
15292 /* Point may have moved to a different line, so we cannot assume that
15293 the previous cursor position is valid; locate the correct row. */
15296 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15297 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15301 w
->cursor
.y
= row
->y
;
15303 if (row
< bottom_row
)
15305 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15306 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15307 struct glyph
*orig_glyph
= glyph
;
15308 struct cursor_pos orig_cursor
= w
->cursor
;
15311 && (!BUFFERP (glyph
->object
)
15312 || glyph
->charpos
!= PT
);
15316 w
->cursor
.x
+= glyph
->pixel_width
;
15318 /* With bidi reordering, charpos changes non-linearly
15319 with hpos, so the right glyph could be to the
15321 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15322 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15324 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15326 glyph
= orig_glyph
- 1;
15327 orig_cursor
.hpos
--;
15328 orig_cursor
.x
-= glyph
->pixel_width
;
15329 for (; glyph
>= start_glyph
15330 && (!BUFFERP (glyph
->object
)
15331 || glyph
->charpos
!= PT
);
15335 w
->cursor
.x
-= glyph
->pixel_width
;
15337 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15338 w
->cursor
= orig_cursor
;
15343 /* Adjust window end. A null value of last_text_row means that
15344 the window end is in reused rows which in turn means that
15345 only its vpos can have changed. */
15348 w
->window_end_bytepos
15349 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15351 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15353 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15358 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15361 w
->window_end_valid
= Qnil
;
15362 w
->desired_matrix
->no_scrolling_p
= 1;
15365 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15375 /************************************************************************
15376 Window redisplay reusing current matrix when buffer has changed
15377 ************************************************************************/
15379 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15380 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15382 static struct glyph_row
*
15383 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15384 struct glyph_row
*));
15387 /* Return the last row in MATRIX displaying text. If row START is
15388 non-null, start searching with that row. IT gives the dimensions
15389 of the display. Value is null if matrix is empty; otherwise it is
15390 a pointer to the row found. */
15392 static struct glyph_row
*
15393 find_last_row_displaying_text (matrix
, it
, start
)
15394 struct glyph_matrix
*matrix
;
15396 struct glyph_row
*start
;
15398 struct glyph_row
*row
, *row_found
;
15400 /* Set row_found to the last row in IT->w's current matrix
15401 displaying text. The loop looks funny but think of partially
15404 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15405 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15407 xassert (row
->enabled_p
);
15409 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15418 /* Return the last row in the current matrix of W that is not affected
15419 by changes at the start of current_buffer that occurred since W's
15420 current matrix was built. Value is null if no such row exists.
15422 BEG_UNCHANGED us the number of characters unchanged at the start of
15423 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15424 first changed character in current_buffer. Characters at positions <
15425 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15426 when the current matrix was built. */
15428 static struct glyph_row
*
15429 find_last_unchanged_at_beg_row (w
)
15432 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15433 struct glyph_row
*row
;
15434 struct glyph_row
*row_found
= NULL
;
15435 int yb
= window_text_bottom_y (w
);
15437 /* Find the last row displaying unchanged text. */
15438 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15439 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15440 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15443 if (/* If row ends before first_changed_pos, it is unchanged,
15444 except in some case. */
15445 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15446 /* When row ends in ZV and we write at ZV it is not
15448 && !row
->ends_at_zv_p
15449 /* When first_changed_pos is the end of a continued line,
15450 row is not unchanged because it may be no longer
15452 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15453 && (row
->continued_p
15454 || row
->exact_window_width_line_p
)))
15457 /* Stop if last visible row. */
15458 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15466 /* Find the first glyph row in the current matrix of W that is not
15467 affected by changes at the end of current_buffer since the
15468 time W's current matrix was built.
15470 Return in *DELTA the number of chars by which buffer positions in
15471 unchanged text at the end of current_buffer must be adjusted.
15473 Return in *DELTA_BYTES the corresponding number of bytes.
15475 Value is null if no such row exists, i.e. all rows are affected by
15478 static struct glyph_row
*
15479 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15481 int *delta
, *delta_bytes
;
15483 struct glyph_row
*row
;
15484 struct glyph_row
*row_found
= NULL
;
15486 *delta
= *delta_bytes
= 0;
15488 /* Display must not have been paused, otherwise the current matrix
15489 is not up to date. */
15490 eassert (!NILP (w
->window_end_valid
));
15492 /* A value of window_end_pos >= END_UNCHANGED means that the window
15493 end is in the range of changed text. If so, there is no
15494 unchanged row at the end of W's current matrix. */
15495 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15498 /* Set row to the last row in W's current matrix displaying text. */
15499 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15501 /* If matrix is entirely empty, no unchanged row exists. */
15502 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15504 /* The value of row is the last glyph row in the matrix having a
15505 meaningful buffer position in it. The end position of row
15506 corresponds to window_end_pos. This allows us to translate
15507 buffer positions in the current matrix to current buffer
15508 positions for characters not in changed text. */
15509 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15510 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15511 int last_unchanged_pos
, last_unchanged_pos_old
;
15512 struct glyph_row
*first_text_row
15513 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15515 *delta
= Z
- Z_old
;
15516 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15518 /* Set last_unchanged_pos to the buffer position of the last
15519 character in the buffer that has not been changed. Z is the
15520 index + 1 of the last character in current_buffer, i.e. by
15521 subtracting END_UNCHANGED we get the index of the last
15522 unchanged character, and we have to add BEG to get its buffer
15524 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15525 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15527 /* Search backward from ROW for a row displaying a line that
15528 starts at a minimum position >= last_unchanged_pos_old. */
15529 for (; row
> first_text_row
; --row
)
15531 /* This used to abort, but it can happen.
15532 It is ok to just stop the search instead here. KFS. */
15533 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15536 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15541 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15547 /* Make sure that glyph rows in the current matrix of window W
15548 reference the same glyph memory as corresponding rows in the
15549 frame's frame matrix. This function is called after scrolling W's
15550 current matrix on a terminal frame in try_window_id and
15551 try_window_reusing_current_matrix. */
15554 sync_frame_with_window_matrix_rows (w
)
15557 struct frame
*f
= XFRAME (w
->frame
);
15558 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15560 /* Preconditions: W must be a leaf window and full-width. Its frame
15561 must have a frame matrix. */
15562 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15563 xassert (WINDOW_FULL_WIDTH_P (w
));
15564 xassert (!FRAME_WINDOW_P (f
));
15566 /* If W is a full-width window, glyph pointers in W's current matrix
15567 have, by definition, to be the same as glyph pointers in the
15568 corresponding frame matrix. Note that frame matrices have no
15569 marginal areas (see build_frame_matrix). */
15570 window_row
= w
->current_matrix
->rows
;
15571 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15572 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15573 while (window_row
< window_row_end
)
15575 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15576 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15578 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15579 frame_row
->glyphs
[TEXT_AREA
] = start
;
15580 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15581 frame_row
->glyphs
[LAST_AREA
] = end
;
15583 /* Disable frame rows whose corresponding window rows have
15584 been disabled in try_window_id. */
15585 if (!window_row
->enabled_p
)
15586 frame_row
->enabled_p
= 0;
15588 ++window_row
, ++frame_row
;
15593 /* Find the glyph row in window W containing CHARPOS. Consider all
15594 rows between START and END (not inclusive). END null means search
15595 all rows to the end of the display area of W. Value is the row
15596 containing CHARPOS or null. */
15599 row_containing_pos (w
, charpos
, start
, end
, dy
)
15602 struct glyph_row
*start
, *end
;
15605 struct glyph_row
*row
= start
;
15606 struct glyph_row
*best_row
= NULL
;
15607 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15610 /* If we happen to start on a header-line, skip that. */
15611 if (row
->mode_line_p
)
15614 if ((end
&& row
>= end
) || !row
->enabled_p
)
15617 last_y
= window_text_bottom_y (w
) - dy
;
15621 /* Give up if we have gone too far. */
15622 if (end
&& row
>= end
)
15624 /* This formerly returned if they were equal.
15625 I think that both quantities are of a "last plus one" type;
15626 if so, when they are equal, the row is within the screen. -- rms. */
15627 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15630 /* If it is in this row, return this row. */
15631 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15632 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15633 /* The end position of a row equals the start
15634 position of the next row. If CHARPOS is there, we
15635 would rather display it in the next line, except
15636 when this line ends in ZV. */
15637 && !row
->ends_at_zv_p
15638 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15639 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15643 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15645 /* In bidi-reordered rows, there could be several rows
15646 occluding point. We need to find the one which fits
15647 CHARPOS the best. */
15648 for (g
= row
->glyphs
[TEXT_AREA
];
15649 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15652 if (!STRINGP (g
->object
))
15654 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15656 mindif
= eabs (g
->charpos
- charpos
);
15669 /* Try to redisplay window W by reusing its existing display. W's
15670 current matrix must be up to date when this function is called,
15671 i.e. window_end_valid must not be nil.
15675 1 if display has been updated
15676 0 if otherwise unsuccessful
15677 -1 if redisplay with same window start is known not to succeed
15679 The following steps are performed:
15681 1. Find the last row in the current matrix of W that is not
15682 affected by changes at the start of current_buffer. If no such row
15685 2. Find the first row in W's current matrix that is not affected by
15686 changes at the end of current_buffer. Maybe there is no such row.
15688 3. Display lines beginning with the row + 1 found in step 1 to the
15689 row found in step 2 or, if step 2 didn't find a row, to the end of
15692 4. If cursor is not known to appear on the window, give up.
15694 5. If display stopped at the row found in step 2, scroll the
15695 display and current matrix as needed.
15697 6. Maybe display some lines at the end of W, if we must. This can
15698 happen under various circumstances, like a partially visible line
15699 becoming fully visible, or because newly displayed lines are displayed
15700 in smaller font sizes.
15702 7. Update W's window end information. */
15708 struct frame
*f
= XFRAME (w
->frame
);
15709 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15710 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15711 struct glyph_row
*last_unchanged_at_beg_row
;
15712 struct glyph_row
*first_unchanged_at_end_row
;
15713 struct glyph_row
*row
;
15714 struct glyph_row
*bottom_row
;
15717 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15718 struct text_pos start_pos
;
15720 int first_unchanged_at_end_vpos
= 0;
15721 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15722 struct text_pos start
;
15723 int first_changed_charpos
, last_changed_charpos
;
15726 if (inhibit_try_window_id
)
15730 /* This is handy for debugging. */
15732 #define GIVE_UP(X) \
15734 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15738 #define GIVE_UP(X) return 0
15741 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15743 /* Don't use this for mini-windows because these can show
15744 messages and mini-buffers, and we don't handle that here. */
15745 if (MINI_WINDOW_P (w
))
15748 /* This flag is used to prevent redisplay optimizations. */
15749 if (windows_or_buffers_changed
|| cursor_type_changed
)
15752 /* Verify that narrowing has not changed.
15753 Also verify that we were not told to prevent redisplay optimizations.
15754 It would be nice to further
15755 reduce the number of cases where this prevents try_window_id. */
15756 if (current_buffer
->clip_changed
15757 || current_buffer
->prevent_redisplay_optimizations_p
)
15760 /* Window must either use window-based redisplay or be full width. */
15761 if (!FRAME_WINDOW_P (f
)
15762 && (!FRAME_LINE_INS_DEL_OK (f
)
15763 || !WINDOW_FULL_WIDTH_P (w
)))
15766 /* Give up if point is known NOT to appear in W. */
15767 if (PT
< CHARPOS (start
))
15770 /* Another way to prevent redisplay optimizations. */
15771 if (XFASTINT (w
->last_modified
) == 0)
15774 /* Verify that window is not hscrolled. */
15775 if (XFASTINT (w
->hscroll
) != 0)
15778 /* Verify that display wasn't paused. */
15779 if (NILP (w
->window_end_valid
))
15782 /* Can't use this if highlighting a region because a cursor movement
15783 will do more than just set the cursor. */
15784 if (!NILP (Vtransient_mark_mode
)
15785 && !NILP (current_buffer
->mark_active
))
15788 /* Likewise if highlighting trailing whitespace. */
15789 if (!NILP (Vshow_trailing_whitespace
))
15792 /* Likewise if showing a region. */
15793 if (!NILP (w
->region_showing
))
15796 /* Can't use this if overlay arrow position and/or string have
15798 if (overlay_arrows_changed_p ())
15801 /* When word-wrap is on, adding a space to the first word of a
15802 wrapped line can change the wrap position, altering the line
15803 above it. It might be worthwhile to handle this more
15804 intelligently, but for now just redisplay from scratch. */
15805 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15808 /* Under bidi reordering, adding or deleting a character in the
15809 beginning of a paragraph, before the first strong directional
15810 character, can change the base direction of the paragraph (unless
15811 the buffer specifies a fixed paragraph direction), which will
15812 require to redisplay the whole paragraph. It might be worthwhile
15813 to find the paragraph limits and widen the range of redisplayed
15814 lines to that, but for now just give up this optimization and
15815 redisplay from scratch. */
15816 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15817 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15820 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15821 only if buffer has really changed. The reason is that the gap is
15822 initially at Z for freshly visited files. The code below would
15823 set end_unchanged to 0 in that case. */
15824 if (MODIFF
> SAVE_MODIFF
15825 /* This seems to happen sometimes after saving a buffer. */
15826 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15828 if (GPT
- BEG
< BEG_UNCHANGED
)
15829 BEG_UNCHANGED
= GPT
- BEG
;
15830 if (Z
- GPT
< END_UNCHANGED
)
15831 END_UNCHANGED
= Z
- GPT
;
15834 /* The position of the first and last character that has been changed. */
15835 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15836 last_changed_charpos
= Z
- END_UNCHANGED
;
15838 /* If window starts after a line end, and the last change is in
15839 front of that newline, then changes don't affect the display.
15840 This case happens with stealth-fontification. Note that although
15841 the display is unchanged, glyph positions in the matrix have to
15842 be adjusted, of course. */
15843 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15844 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15845 && ((last_changed_charpos
< CHARPOS (start
)
15846 && CHARPOS (start
) == BEGV
)
15847 || (last_changed_charpos
< CHARPOS (start
) - 1
15848 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15850 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15851 struct glyph_row
*r0
;
15853 /* Compute how many chars/bytes have been added to or removed
15854 from the buffer. */
15855 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15856 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15858 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15860 /* Give up if PT is not in the window. Note that it already has
15861 been checked at the start of try_window_id that PT is not in
15862 front of the window start. */
15863 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15866 /* If window start is unchanged, we can reuse the whole matrix
15867 as is, after adjusting glyph positions. No need to compute
15868 the window end again, since its offset from Z hasn't changed. */
15869 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15870 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15871 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15872 /* PT must not be in a partially visible line. */
15873 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15874 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15876 /* Adjust positions in the glyph matrix. */
15877 if (delta
|| delta_bytes
)
15879 struct glyph_row
*r1
15880 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15881 increment_matrix_positions (w
->current_matrix
,
15882 MATRIX_ROW_VPOS (r0
, current_matrix
),
15883 MATRIX_ROW_VPOS (r1
, current_matrix
),
15884 delta
, delta_bytes
);
15887 /* Set the cursor. */
15888 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15890 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15897 /* Handle the case that changes are all below what is displayed in
15898 the window, and that PT is in the window. This shortcut cannot
15899 be taken if ZV is visible in the window, and text has been added
15900 there that is visible in the window. */
15901 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15902 /* ZV is not visible in the window, or there are no
15903 changes at ZV, actually. */
15904 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15905 || first_changed_charpos
== last_changed_charpos
))
15907 struct glyph_row
*r0
;
15909 /* Give up if PT is not in the window. Note that it already has
15910 been checked at the start of try_window_id that PT is not in
15911 front of the window start. */
15912 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15915 /* If window start is unchanged, we can reuse the whole matrix
15916 as is, without changing glyph positions since no text has
15917 been added/removed in front of the window end. */
15918 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15919 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15920 /* PT must not be in a partially visible line. */
15921 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15922 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15924 /* We have to compute the window end anew since text
15925 can have been added/removed after it. */
15927 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15928 w
->window_end_bytepos
15929 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15931 /* Set the cursor. */
15932 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15934 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15941 /* Give up if window start is in the changed area.
15943 The condition used to read
15945 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15947 but why that was tested escapes me at the moment. */
15948 if (CHARPOS (start
) >= first_changed_charpos
15949 && CHARPOS (start
) <= last_changed_charpos
)
15952 /* Check that window start agrees with the start of the first glyph
15953 row in its current matrix. Check this after we know the window
15954 start is not in changed text, otherwise positions would not be
15956 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15957 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15960 /* Give up if the window ends in strings. Overlay strings
15961 at the end are difficult to handle, so don't try. */
15962 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15963 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15966 /* Compute the position at which we have to start displaying new
15967 lines. Some of the lines at the top of the window might be
15968 reusable because they are not displaying changed text. Find the
15969 last row in W's current matrix not affected by changes at the
15970 start of current_buffer. Value is null if changes start in the
15971 first line of window. */
15972 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15973 if (last_unchanged_at_beg_row
)
15975 /* Avoid starting to display in the moddle of a character, a TAB
15976 for instance. This is easier than to set up the iterator
15977 exactly, and it's not a frequent case, so the additional
15978 effort wouldn't really pay off. */
15979 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15980 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15981 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15982 --last_unchanged_at_beg_row
;
15984 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15987 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15989 start_pos
= it
.current
.pos
;
15991 /* Start displaying new lines in the desired matrix at the same
15992 vpos we would use in the current matrix, i.e. below
15993 last_unchanged_at_beg_row. */
15994 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15996 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15997 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15999 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16003 /* There are no reusable lines at the start of the window.
16004 Start displaying in the first text line. */
16005 start_display (&it
, w
, start
);
16006 it
.vpos
= it
.first_vpos
;
16007 start_pos
= it
.current
.pos
;
16010 /* Find the first row that is not affected by changes at the end of
16011 the buffer. Value will be null if there is no unchanged row, in
16012 which case we must redisplay to the end of the window. delta
16013 will be set to the value by which buffer positions beginning with
16014 first_unchanged_at_end_row have to be adjusted due to text
16016 first_unchanged_at_end_row
16017 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16018 IF_DEBUG (debug_delta
= delta
);
16019 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16021 /* Set stop_pos to the buffer position up to which we will have to
16022 display new lines. If first_unchanged_at_end_row != NULL, this
16023 is the buffer position of the start of the line displayed in that
16024 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16025 that we don't stop at a buffer position. */
16027 if (first_unchanged_at_end_row
)
16029 xassert (last_unchanged_at_beg_row
== NULL
16030 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16032 /* If this is a continuation line, move forward to the next one
16033 that isn't. Changes in lines above affect this line.
16034 Caution: this may move first_unchanged_at_end_row to a row
16035 not displaying text. */
16036 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16037 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16038 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16039 < it
.last_visible_y
))
16040 ++first_unchanged_at_end_row
;
16042 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16043 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16044 >= it
.last_visible_y
))
16045 first_unchanged_at_end_row
= NULL
;
16048 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16050 first_unchanged_at_end_vpos
16051 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16052 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16055 else if (last_unchanged_at_beg_row
== NULL
)
16061 /* Either there is no unchanged row at the end, or the one we have
16062 now displays text. This is a necessary condition for the window
16063 end pos calculation at the end of this function. */
16064 xassert (first_unchanged_at_end_row
== NULL
16065 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16067 debug_last_unchanged_at_beg_vpos
16068 = (last_unchanged_at_beg_row
16069 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16071 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16073 #endif /* GLYPH_DEBUG != 0 */
16076 /* Display new lines. Set last_text_row to the last new line
16077 displayed which has text on it, i.e. might end up as being the
16078 line where the window_end_vpos is. */
16079 w
->cursor
.vpos
= -1;
16080 last_text_row
= NULL
;
16081 overlay_arrow_seen
= 0;
16082 while (it
.current_y
< it
.last_visible_y
16083 && !fonts_changed_p
16084 && (first_unchanged_at_end_row
== NULL
16085 || IT_CHARPOS (it
) < stop_pos
))
16087 if (display_line (&it
))
16088 last_text_row
= it
.glyph_row
- 1;
16091 if (fonts_changed_p
)
16095 /* Compute differences in buffer positions, y-positions etc. for
16096 lines reused at the bottom of the window. Compute what we can
16098 if (first_unchanged_at_end_row
16099 /* No lines reused because we displayed everything up to the
16100 bottom of the window. */
16101 && it
.current_y
< it
.last_visible_y
)
16104 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16106 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16107 run
.current_y
= first_unchanged_at_end_row
->y
;
16108 run
.desired_y
= run
.current_y
+ dy
;
16109 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16113 delta
= delta_bytes
= dvpos
= dy
16114 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16115 first_unchanged_at_end_row
= NULL
;
16117 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16120 /* Find the cursor if not already found. We have to decide whether
16121 PT will appear on this window (it sometimes doesn't, but this is
16122 not a very frequent case.) This decision has to be made before
16123 the current matrix is altered. A value of cursor.vpos < 0 means
16124 that PT is either in one of the lines beginning at
16125 first_unchanged_at_end_row or below the window. Don't care for
16126 lines that might be displayed later at the window end; as
16127 mentioned, this is not a frequent case. */
16128 if (w
->cursor
.vpos
< 0)
16130 /* Cursor in unchanged rows at the top? */
16131 if (PT
< CHARPOS (start_pos
)
16132 && last_unchanged_at_beg_row
)
16134 row
= row_containing_pos (w
, PT
,
16135 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16136 last_unchanged_at_beg_row
+ 1, 0);
16138 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16141 /* Start from first_unchanged_at_end_row looking for PT. */
16142 else if (first_unchanged_at_end_row
)
16144 row
= row_containing_pos (w
, PT
- delta
,
16145 first_unchanged_at_end_row
, NULL
, 0);
16147 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16148 delta_bytes
, dy
, dvpos
);
16151 /* Give up if cursor was not found. */
16152 if (w
->cursor
.vpos
< 0)
16154 clear_glyph_matrix (w
->desired_matrix
);
16159 /* Don't let the cursor end in the scroll margins. */
16161 int this_scroll_margin
, cursor_height
;
16163 this_scroll_margin
= max (0, scroll_margin
);
16164 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16165 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16166 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16168 if ((w
->cursor
.y
< this_scroll_margin
16169 && CHARPOS (start
) > BEGV
)
16170 /* Old redisplay didn't take scroll margin into account at the bottom,
16171 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16172 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16173 ? cursor_height
+ this_scroll_margin
16174 : 1)) > it
.last_visible_y
)
16176 w
->cursor
.vpos
= -1;
16177 clear_glyph_matrix (w
->desired_matrix
);
16182 /* Scroll the display. Do it before changing the current matrix so
16183 that xterm.c doesn't get confused about where the cursor glyph is
16185 if (dy
&& run
.height
)
16189 if (FRAME_WINDOW_P (f
))
16191 FRAME_RIF (f
)->update_window_begin_hook (w
);
16192 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16193 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16194 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16198 /* Terminal frame. In this case, dvpos gives the number of
16199 lines to scroll by; dvpos < 0 means scroll up. */
16200 int first_unchanged_at_end_vpos
16201 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16202 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
16203 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16204 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16205 + window_internal_height (w
));
16207 /* Perform the operation on the screen. */
16210 /* Scroll last_unchanged_at_beg_row to the end of the
16211 window down dvpos lines. */
16212 set_terminal_window (f
, end
);
16214 /* On dumb terminals delete dvpos lines at the end
16215 before inserting dvpos empty lines. */
16216 if (!FRAME_SCROLL_REGION_OK (f
))
16217 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16219 /* Insert dvpos empty lines in front of
16220 last_unchanged_at_beg_row. */
16221 ins_del_lines (f
, from
, dvpos
);
16223 else if (dvpos
< 0)
16225 /* Scroll up last_unchanged_at_beg_vpos to the end of
16226 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16227 set_terminal_window (f
, end
);
16229 /* Delete dvpos lines in front of
16230 last_unchanged_at_beg_vpos. ins_del_lines will set
16231 the cursor to the given vpos and emit |dvpos| delete
16233 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16235 /* On a dumb terminal insert dvpos empty lines at the
16237 if (!FRAME_SCROLL_REGION_OK (f
))
16238 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16241 set_terminal_window (f
, 0);
16247 /* Shift reused rows of the current matrix to the right position.
16248 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16250 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16251 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16254 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16255 bottom_vpos
, dvpos
);
16256 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16259 else if (dvpos
> 0)
16261 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16262 bottom_vpos
, dvpos
);
16263 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16264 first_unchanged_at_end_vpos
+ dvpos
, 0);
16267 /* For frame-based redisplay, make sure that current frame and window
16268 matrix are in sync with respect to glyph memory. */
16269 if (!FRAME_WINDOW_P (f
))
16270 sync_frame_with_window_matrix_rows (w
);
16272 /* Adjust buffer positions in reused rows. */
16273 if (delta
|| delta_bytes
)
16274 increment_matrix_positions (current_matrix
,
16275 first_unchanged_at_end_vpos
+ dvpos
,
16276 bottom_vpos
, delta
, delta_bytes
);
16278 /* Adjust Y positions. */
16280 shift_glyph_matrix (w
, current_matrix
,
16281 first_unchanged_at_end_vpos
+ dvpos
,
16284 if (first_unchanged_at_end_row
)
16286 first_unchanged_at_end_row
+= dvpos
;
16287 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16288 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16289 first_unchanged_at_end_row
= NULL
;
16292 /* If scrolling up, there may be some lines to display at the end of
16294 last_text_row_at_end
= NULL
;
16297 /* Scrolling up can leave for example a partially visible line
16298 at the end of the window to be redisplayed. */
16299 /* Set last_row to the glyph row in the current matrix where the
16300 window end line is found. It has been moved up or down in
16301 the matrix by dvpos. */
16302 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16303 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16305 /* If last_row is the window end line, it should display text. */
16306 xassert (last_row
->displays_text_p
);
16308 /* If window end line was partially visible before, begin
16309 displaying at that line. Otherwise begin displaying with the
16310 line following it. */
16311 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16313 init_to_row_start (&it
, w
, last_row
);
16314 it
.vpos
= last_vpos
;
16315 it
.current_y
= last_row
->y
;
16319 init_to_row_end (&it
, w
, last_row
);
16320 it
.vpos
= 1 + last_vpos
;
16321 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16325 /* We may start in a continuation line. If so, we have to
16326 get the right continuation_lines_width and current_x. */
16327 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16328 it
.hpos
= it
.current_x
= 0;
16330 /* Display the rest of the lines at the window end. */
16331 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16332 while (it
.current_y
< it
.last_visible_y
16333 && !fonts_changed_p
)
16335 /* Is it always sure that the display agrees with lines in
16336 the current matrix? I don't think so, so we mark rows
16337 displayed invalid in the current matrix by setting their
16338 enabled_p flag to zero. */
16339 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16340 if (display_line (&it
))
16341 last_text_row_at_end
= it
.glyph_row
- 1;
16345 /* Update window_end_pos and window_end_vpos. */
16346 if (first_unchanged_at_end_row
16347 && !last_text_row_at_end
)
16349 /* Window end line if one of the preserved rows from the current
16350 matrix. Set row to the last row displaying text in current
16351 matrix starting at first_unchanged_at_end_row, after
16353 xassert (first_unchanged_at_end_row
->displays_text_p
);
16354 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16355 first_unchanged_at_end_row
);
16356 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16358 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16359 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16361 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16362 xassert (w
->window_end_bytepos
>= 0);
16363 IF_DEBUG (debug_method_add (w
, "A"));
16365 else if (last_text_row_at_end
)
16368 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16369 w
->window_end_bytepos
16370 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16372 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16373 xassert (w
->window_end_bytepos
>= 0);
16374 IF_DEBUG (debug_method_add (w
, "B"));
16376 else if (last_text_row
)
16378 /* We have displayed either to the end of the window or at the
16379 end of the window, i.e. the last row with text is to be found
16380 in the desired matrix. */
16382 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16383 w
->window_end_bytepos
16384 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16386 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16387 xassert (w
->window_end_bytepos
>= 0);
16389 else if (first_unchanged_at_end_row
== NULL
16390 && last_text_row
== NULL
16391 && last_text_row_at_end
== NULL
)
16393 /* Displayed to end of window, but no line containing text was
16394 displayed. Lines were deleted at the end of the window. */
16395 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16396 int vpos
= XFASTINT (w
->window_end_vpos
);
16397 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16398 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16401 row
== NULL
&& vpos
>= first_vpos
;
16402 --vpos
, --current_row
, --desired_row
)
16404 if (desired_row
->enabled_p
)
16406 if (desired_row
->displays_text_p
)
16409 else if (current_row
->displays_text_p
)
16413 xassert (row
!= NULL
);
16414 w
->window_end_vpos
= make_number (vpos
+ 1);
16415 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16416 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16417 xassert (w
->window_end_bytepos
>= 0);
16418 IF_DEBUG (debug_method_add (w
, "C"));
16423 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16424 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16426 /* Record that display has not been completed. */
16427 w
->window_end_valid
= Qnil
;
16428 w
->desired_matrix
->no_scrolling_p
= 1;
16436 /***********************************************************************
16437 More debugging support
16438 ***********************************************************************/
16442 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16443 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16444 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16447 /* Dump the contents of glyph matrix MATRIX on stderr.
16449 GLYPHS 0 means don't show glyph contents.
16450 GLYPHS 1 means show glyphs in short form
16451 GLYPHS > 1 means show glyphs in long form. */
16454 dump_glyph_matrix (matrix
, glyphs
)
16455 struct glyph_matrix
*matrix
;
16459 for (i
= 0; i
< matrix
->nrows
; ++i
)
16460 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16464 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16465 the glyph row and area where the glyph comes from. */
16468 dump_glyph (row
, glyph
, area
)
16469 struct glyph_row
*row
;
16470 struct glyph
*glyph
;
16473 if (glyph
->type
== CHAR_GLYPH
)
16476 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16477 glyph
- row
->glyphs
[TEXT_AREA
],
16480 (BUFFERP (glyph
->object
)
16482 : (STRINGP (glyph
->object
)
16485 glyph
->pixel_width
,
16487 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16491 glyph
->left_box_line_p
,
16492 glyph
->right_box_line_p
);
16494 else if (glyph
->type
== STRETCH_GLYPH
)
16497 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16498 glyph
- row
->glyphs
[TEXT_AREA
],
16501 (BUFFERP (glyph
->object
)
16503 : (STRINGP (glyph
->object
)
16506 glyph
->pixel_width
,
16510 glyph
->left_box_line_p
,
16511 glyph
->right_box_line_p
);
16513 else if (glyph
->type
== IMAGE_GLYPH
)
16516 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16517 glyph
- row
->glyphs
[TEXT_AREA
],
16520 (BUFFERP (glyph
->object
)
16522 : (STRINGP (glyph
->object
)
16525 glyph
->pixel_width
,
16529 glyph
->left_box_line_p
,
16530 glyph
->right_box_line_p
);
16532 else if (glyph
->type
== COMPOSITE_GLYPH
)
16535 " %5d %4c %6d %c %3d 0x%05x",
16536 glyph
- row
->glyphs
[TEXT_AREA
],
16539 (BUFFERP (glyph
->object
)
16541 : (STRINGP (glyph
->object
)
16544 glyph
->pixel_width
,
16546 if (glyph
->u
.cmp
.automatic
)
16549 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16550 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16552 glyph
->left_box_line_p
,
16553 glyph
->right_box_line_p
);
16558 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16559 GLYPHS 0 means don't show glyph contents.
16560 GLYPHS 1 means show glyphs in short form
16561 GLYPHS > 1 means show glyphs in long form. */
16564 dump_glyph_row (row
, vpos
, glyphs
)
16565 struct glyph_row
*row
;
16570 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16571 fprintf (stderr
, "======================================================================\n");
16573 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16574 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16576 MATRIX_ROW_START_CHARPOS (row
),
16577 MATRIX_ROW_END_CHARPOS (row
),
16578 row
->used
[TEXT_AREA
],
16579 row
->contains_overlapping_glyphs_p
,
16581 row
->truncated_on_left_p
,
16582 row
->truncated_on_right_p
,
16584 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16585 row
->displays_text_p
,
16588 row
->ends_in_middle_of_char_p
,
16589 row
->starts_in_middle_of_char_p
,
16595 row
->visible_height
,
16598 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16599 row
->end
.overlay_string_index
,
16600 row
->continuation_lines_width
);
16601 fprintf (stderr
, "%9d %5d\n",
16602 CHARPOS (row
->start
.string_pos
),
16603 CHARPOS (row
->end
.string_pos
));
16604 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16605 row
->end
.dpvec_index
);
16612 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16614 struct glyph
*glyph
= row
->glyphs
[area
];
16615 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16617 /* Glyph for a line end in text. */
16618 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16621 if (glyph
< glyph_end
)
16622 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16624 for (; glyph
< glyph_end
; ++glyph
)
16625 dump_glyph (row
, glyph
, area
);
16628 else if (glyphs
== 1)
16632 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16634 char *s
= (char *) alloca (row
->used
[area
] + 1);
16637 for (i
= 0; i
< row
->used
[area
]; ++i
)
16639 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16640 if (glyph
->type
== CHAR_GLYPH
16641 && glyph
->u
.ch
< 0x80
16642 && glyph
->u
.ch
>= ' ')
16643 s
[i
] = glyph
->u
.ch
;
16649 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16655 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16656 Sdump_glyph_matrix
, 0, 1, "p",
16657 doc
: /* Dump the current matrix of the selected window to stderr.
16658 Shows contents of glyph row structures. With non-nil
16659 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16660 glyphs in short form, otherwise show glyphs in long form. */)
16662 Lisp_Object glyphs
;
16664 struct window
*w
= XWINDOW (selected_window
);
16665 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16667 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16668 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16669 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16670 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16671 fprintf (stderr
, "=============================================\n");
16672 dump_glyph_matrix (w
->current_matrix
,
16673 NILP (glyphs
) ? 0 : XINT (glyphs
));
16678 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16679 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16682 struct frame
*f
= XFRAME (selected_frame
);
16683 dump_glyph_matrix (f
->current_matrix
, 1);
16688 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16689 doc
: /* Dump glyph row ROW to stderr.
16690 GLYPH 0 means don't dump glyphs.
16691 GLYPH 1 means dump glyphs in short form.
16692 GLYPH > 1 or omitted means dump glyphs in long form. */)
16694 Lisp_Object row
, glyphs
;
16696 struct glyph_matrix
*matrix
;
16699 CHECK_NUMBER (row
);
16700 matrix
= XWINDOW (selected_window
)->current_matrix
;
16702 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16703 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16705 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16710 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16711 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16712 GLYPH 0 means don't dump glyphs.
16713 GLYPH 1 means dump glyphs in short form.
16714 GLYPH > 1 or omitted means dump glyphs in long form. */)
16716 Lisp_Object row
, glyphs
;
16718 struct frame
*sf
= SELECTED_FRAME ();
16719 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16722 CHECK_NUMBER (row
);
16724 if (vpos
>= 0 && vpos
< m
->nrows
)
16725 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16726 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16731 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16732 doc
: /* Toggle tracing of redisplay.
16733 With ARG, turn tracing on if and only if ARG is positive. */)
16738 trace_redisplay_p
= !trace_redisplay_p
;
16741 arg
= Fprefix_numeric_value (arg
);
16742 trace_redisplay_p
= XINT (arg
) > 0;
16749 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16750 doc
: /* Like `format', but print result to stderr.
16751 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16756 Lisp_Object s
= Fformat (nargs
, args
);
16757 fprintf (stderr
, "%s", SDATA (s
));
16761 #endif /* GLYPH_DEBUG */
16765 /***********************************************************************
16766 Building Desired Matrix Rows
16767 ***********************************************************************/
16769 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16770 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16772 static struct glyph_row
*
16773 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16775 Lisp_Object overlay_arrow_string
;
16777 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16778 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16779 struct buffer
*old
= current_buffer
;
16780 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16781 int arrow_len
= SCHARS (overlay_arrow_string
);
16782 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16783 const unsigned char *p
;
16786 int n_glyphs_before
;
16788 set_buffer_temp (buffer
);
16789 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16790 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16791 SET_TEXT_POS (it
.position
, 0, 0);
16793 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16795 while (p
< arrow_end
)
16797 Lisp_Object face
, ilisp
;
16799 /* Get the next character. */
16801 it
.c
= string_char_and_length (p
, &it
.len
);
16803 it
.c
= *p
, it
.len
= 1;
16806 /* Get its face. */
16807 ilisp
= make_number (p
- arrow_string
);
16808 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16809 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16811 /* Compute its width, get its glyphs. */
16812 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16813 SET_TEXT_POS (it
.position
, -1, -1);
16814 PRODUCE_GLYPHS (&it
);
16816 /* If this character doesn't fit any more in the line, we have
16817 to remove some glyphs. */
16818 if (it
.current_x
> it
.last_visible_x
)
16820 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16825 set_buffer_temp (old
);
16826 return it
.glyph_row
;
16830 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16831 glyphs are only inserted for terminal frames since we can't really
16832 win with truncation glyphs when partially visible glyphs are
16833 involved. Which glyphs to insert is determined by
16834 produce_special_glyphs. */
16837 insert_left_trunc_glyphs (it
)
16840 struct it truncate_it
;
16841 struct glyph
*from
, *end
, *to
, *toend
;
16843 xassert (!FRAME_WINDOW_P (it
->f
));
16845 /* Get the truncation glyphs. */
16847 truncate_it
.current_x
= 0;
16848 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16849 truncate_it
.glyph_row
= &scratch_glyph_row
;
16850 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16851 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16852 truncate_it
.object
= make_number (0);
16853 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16855 /* Overwrite glyphs from IT with truncation glyphs. */
16856 if (!it
->glyph_row
->reversed_p
)
16858 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16859 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16860 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16861 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16866 /* There may be padding glyphs left over. Overwrite them too. */
16867 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16869 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16875 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16879 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16880 that back to front. */
16881 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16882 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16883 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16884 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16886 while (from
>= end
&& to
>= toend
)
16888 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16891 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16892 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16893 while (from
>= end
&& to
>= toend
)
16898 /* Need to free some room before prepending additional
16900 int move_by
= from
- end
+ 1;
16901 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16902 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16904 for ( ; g
>= g0
; g
--)
16906 while (from
>= end
)
16908 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16914 /* Compute the pixel height and width of IT->glyph_row.
16916 Most of the time, ascent and height of a display line will be equal
16917 to the max_ascent and max_height values of the display iterator
16918 structure. This is not the case if
16920 1. We hit ZV without displaying anything. In this case, max_ascent
16921 and max_height will be zero.
16923 2. We have some glyphs that don't contribute to the line height.
16924 (The glyph row flag contributes_to_line_height_p is for future
16925 pixmap extensions).
16927 The first case is easily covered by using default values because in
16928 these cases, the line height does not really matter, except that it
16929 must not be zero. */
16932 compute_line_metrics (it
)
16935 struct glyph_row
*row
= it
->glyph_row
;
16938 if (FRAME_WINDOW_P (it
->f
))
16940 int i
, min_y
, max_y
;
16942 /* The line may consist of one space only, that was added to
16943 place the cursor on it. If so, the row's height hasn't been
16945 if (row
->height
== 0)
16947 if (it
->max_ascent
+ it
->max_descent
== 0)
16948 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16949 row
->ascent
= it
->max_ascent
;
16950 row
->height
= it
->max_ascent
+ it
->max_descent
;
16951 row
->phys_ascent
= it
->max_phys_ascent
;
16952 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16953 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16956 /* Compute the width of this line. */
16957 row
->pixel_width
= row
->x
;
16958 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16959 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16961 xassert (row
->pixel_width
>= 0);
16962 xassert (row
->ascent
>= 0 && row
->height
> 0);
16964 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16965 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16967 /* If first line's physical ascent is larger than its logical
16968 ascent, use the physical ascent, and make the row taller.
16969 This makes accented characters fully visible. */
16970 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16971 && row
->phys_ascent
> row
->ascent
)
16973 row
->height
+= row
->phys_ascent
- row
->ascent
;
16974 row
->ascent
= row
->phys_ascent
;
16977 /* Compute how much of the line is visible. */
16978 row
->visible_height
= row
->height
;
16980 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16981 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16983 if (row
->y
< min_y
)
16984 row
->visible_height
-= min_y
- row
->y
;
16985 if (row
->y
+ row
->height
> max_y
)
16986 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16990 row
->pixel_width
= row
->used
[TEXT_AREA
];
16991 if (row
->continued_p
)
16992 row
->pixel_width
-= it
->continuation_pixel_width
;
16993 else if (row
->truncated_on_right_p
)
16994 row
->pixel_width
-= it
->truncation_pixel_width
;
16995 row
->ascent
= row
->phys_ascent
= 0;
16996 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16997 row
->extra_line_spacing
= 0;
17000 /* Compute a hash code for this row. */
17002 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17003 for (i
= 0; i
< row
->used
[area
]; ++i
)
17004 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17005 + row
->glyphs
[area
][i
].u
.val
17006 + row
->glyphs
[area
][i
].face_id
17007 + row
->glyphs
[area
][i
].padding_p
17008 + (row
->glyphs
[area
][i
].type
<< 2));
17010 it
->max_ascent
= it
->max_descent
= 0;
17011 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17015 /* Append one space to the glyph row of iterator IT if doing a
17016 window-based redisplay. The space has the same face as
17017 IT->face_id. Value is non-zero if a space was added.
17019 This function is called to make sure that there is always one glyph
17020 at the end of a glyph row that the cursor can be set on under
17021 window-systems. (If there weren't such a glyph we would not know
17022 how wide and tall a box cursor should be displayed).
17024 At the same time this space let's a nicely handle clearing to the
17025 end of the line if the row ends in italic text. */
17028 append_space_for_newline (it
, default_face_p
)
17030 int default_face_p
;
17032 if (FRAME_WINDOW_P (it
->f
))
17034 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17036 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17037 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17039 /* Save some values that must not be changed.
17040 Must save IT->c and IT->len because otherwise
17041 ITERATOR_AT_END_P wouldn't work anymore after
17042 append_space_for_newline has been called. */
17043 enum display_element_type saved_what
= it
->what
;
17044 int saved_c
= it
->c
, saved_len
= it
->len
;
17045 int saved_x
= it
->current_x
;
17046 int saved_face_id
= it
->face_id
;
17047 struct text_pos saved_pos
;
17048 Lisp_Object saved_object
;
17051 saved_object
= it
->object
;
17052 saved_pos
= it
->position
;
17054 it
->what
= IT_CHARACTER
;
17055 bzero (&it
->position
, sizeof it
->position
);
17056 it
->object
= make_number (0);
17060 if (default_face_p
)
17061 it
->face_id
= DEFAULT_FACE_ID
;
17062 else if (it
->face_before_selective_p
)
17063 it
->face_id
= it
->saved_face_id
;
17064 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17065 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17067 PRODUCE_GLYPHS (it
);
17069 it
->override_ascent
= -1;
17070 it
->constrain_row_ascent_descent_p
= 0;
17071 it
->current_x
= saved_x
;
17072 it
->object
= saved_object
;
17073 it
->position
= saved_pos
;
17074 it
->what
= saved_what
;
17075 it
->face_id
= saved_face_id
;
17076 it
->len
= saved_len
;
17086 /* Extend the face of the last glyph in the text area of IT->glyph_row
17087 to the end of the display line. Called from display_line. If the
17088 glyph row is empty, add a space glyph to it so that we know the
17089 face to draw. Set the glyph row flag fill_line_p. If the glyph
17090 row is R2L, prepend a stretch glyph to cover the empty space to the
17091 left of the leftmost glyph. */
17094 extend_face_to_end_of_line (it
)
17098 struct frame
*f
= it
->f
;
17100 /* If line is already filled, do nothing. Non window-system frames
17101 get a grace of one more ``pixel'' because their characters are
17102 1-``pixel'' wide, so they hit the equality too early. This grace
17103 is needed only for R2L rows that are not continued, to produce
17104 one extra blank where we could display the cursor. */
17105 if (it
->current_x
>= it
->last_visible_x
17106 + (!FRAME_WINDOW_P (f
)
17107 && it
->glyph_row
->reversed_p
17108 && !it
->glyph_row
->continued_p
))
17111 /* Face extension extends the background and box of IT->face_id
17112 to the end of the line. If the background equals the background
17113 of the frame, we don't have to do anything. */
17114 if (it
->face_before_selective_p
)
17115 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17117 face
= FACE_FROM_ID (f
, it
->face_id
);
17119 if (FRAME_WINDOW_P (f
)
17120 && it
->glyph_row
->displays_text_p
17121 && face
->box
== FACE_NO_BOX
17122 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17124 && !it
->glyph_row
->reversed_p
)
17127 /* Set the glyph row flag indicating that the face of the last glyph
17128 in the text area has to be drawn to the end of the text area. */
17129 it
->glyph_row
->fill_line_p
= 1;
17131 /* If current character of IT is not ASCII, make sure we have the
17132 ASCII face. This will be automatically undone the next time
17133 get_next_display_element returns a multibyte character. Note
17134 that the character will always be single byte in unibyte
17136 if (!ASCII_CHAR_P (it
->c
))
17138 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17141 if (FRAME_WINDOW_P (f
))
17143 /* If the row is empty, add a space with the current face of IT,
17144 so that we know which face to draw. */
17145 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17147 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17148 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17149 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17151 #ifdef HAVE_WINDOW_SYSTEM
17152 if (it
->glyph_row
->reversed_p
)
17154 /* Prepend a stretch glyph to the row, such that the
17155 rightmost glyph will be drawn flushed all the way to the
17156 right margin of the window. The stretch glyph that will
17157 occupy the empty space, if any, to the left of the
17159 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17160 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17161 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17163 int row_width
, stretch_ascent
, stretch_width
;
17164 struct text_pos saved_pos
;
17165 int saved_face_id
, saved_avoid_cursor
;
17167 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17168 row_width
+= g
->pixel_width
;
17169 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17170 if (stretch_width
> 0)
17173 (((it
->ascent
+ it
->descent
)
17174 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17175 saved_pos
= it
->position
;
17176 bzero (&it
->position
, sizeof it
->position
);
17177 saved_avoid_cursor
= it
->avoid_cursor_p
;
17178 it
->avoid_cursor_p
= 1;
17179 saved_face_id
= it
->face_id
;
17180 /* The last row's stretch glyph should get the default
17181 face, to avoid painting the rest of the window with
17182 the region face, if the region ends at ZV. */
17183 if (it
->glyph_row
->ends_at_zv_p
)
17184 it
->face_id
= DEFAULT_FACE_ID
;
17186 it
->face_id
= face
->id
;
17187 append_stretch_glyph (it
, make_number (0), stretch_width
,
17188 it
->ascent
+ it
->descent
, stretch_ascent
);
17189 it
->position
= saved_pos
;
17190 it
->avoid_cursor_p
= saved_avoid_cursor
;
17191 it
->face_id
= saved_face_id
;
17194 #endif /* HAVE_WINDOW_SYSTEM */
17198 /* Save some values that must not be changed. */
17199 int saved_x
= it
->current_x
;
17200 struct text_pos saved_pos
;
17201 Lisp_Object saved_object
;
17202 enum display_element_type saved_what
= it
->what
;
17203 int saved_face_id
= it
->face_id
;
17205 saved_object
= it
->object
;
17206 saved_pos
= it
->position
;
17208 it
->what
= IT_CHARACTER
;
17209 bzero (&it
->position
, sizeof it
->position
);
17210 it
->object
= make_number (0);
17213 /* The last row's blank glyphs should get the default face, to
17214 avoid painting the rest of the window with the region face,
17215 if the region ends at ZV. */
17216 if (it
->glyph_row
->ends_at_zv_p
)
17217 it
->face_id
= DEFAULT_FACE_ID
;
17219 it
->face_id
= face
->id
;
17221 PRODUCE_GLYPHS (it
);
17223 while (it
->current_x
<= it
->last_visible_x
)
17224 PRODUCE_GLYPHS (it
);
17226 /* Don't count these blanks really. It would let us insert a left
17227 truncation glyph below and make us set the cursor on them, maybe. */
17228 it
->current_x
= saved_x
;
17229 it
->object
= saved_object
;
17230 it
->position
= saved_pos
;
17231 it
->what
= saved_what
;
17232 it
->face_id
= saved_face_id
;
17237 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17238 trailing whitespace. */
17241 trailing_whitespace_p (charpos
)
17244 int bytepos
= CHAR_TO_BYTE (charpos
);
17247 while (bytepos
< ZV_BYTE
17248 && (c
= FETCH_CHAR (bytepos
),
17249 c
== ' ' || c
== '\t'))
17252 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17254 if (bytepos
!= PT_BYTE
)
17261 /* Highlight trailing whitespace, if any, in ROW. */
17264 highlight_trailing_whitespace (f
, row
)
17266 struct glyph_row
*row
;
17268 int used
= row
->used
[TEXT_AREA
];
17272 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17273 struct glyph
*glyph
= start
+ used
- 1;
17275 if (row
->reversed_p
)
17277 /* Right-to-left rows need to be processed in the opposite
17278 direction, so swap the edge pointers. */
17280 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17283 /* Skip over glyphs inserted to display the cursor at the
17284 end of a line, for extending the face of the last glyph
17285 to the end of the line on terminals, and for truncation
17286 and continuation glyphs. */
17287 if (!row
->reversed_p
)
17289 while (glyph
>= start
17290 && glyph
->type
== CHAR_GLYPH
17291 && INTEGERP (glyph
->object
))
17296 while (glyph
<= start
17297 && glyph
->type
== CHAR_GLYPH
17298 && INTEGERP (glyph
->object
))
17302 /* If last glyph is a space or stretch, and it's trailing
17303 whitespace, set the face of all trailing whitespace glyphs in
17304 IT->glyph_row to `trailing-whitespace'. */
17305 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17306 && BUFFERP (glyph
->object
)
17307 && (glyph
->type
== STRETCH_GLYPH
17308 || (glyph
->type
== CHAR_GLYPH
17309 && glyph
->u
.ch
== ' '))
17310 && trailing_whitespace_p (glyph
->charpos
))
17312 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17316 if (!row
->reversed_p
)
17318 while (glyph
>= start
17319 && BUFFERP (glyph
->object
)
17320 && (glyph
->type
== STRETCH_GLYPH
17321 || (glyph
->type
== CHAR_GLYPH
17322 && glyph
->u
.ch
== ' ')))
17323 (glyph
--)->face_id
= face_id
;
17327 while (glyph
<= start
17328 && BUFFERP (glyph
->object
)
17329 && (glyph
->type
== STRETCH_GLYPH
17330 || (glyph
->type
== CHAR_GLYPH
17331 && glyph
->u
.ch
== ' ')))
17332 (glyph
++)->face_id
= face_id
;
17339 /* Value is non-zero if glyph row ROW in window W should be
17340 used to hold the cursor. */
17343 cursor_row_p (w
, row
)
17345 struct glyph_row
*row
;
17347 int cursor_row_p
= 1;
17349 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
17351 /* Suppose the row ends on a string.
17352 Unless the row is continued, that means it ends on a newline
17353 in the string. If it's anything other than a display string
17354 (e.g. a before-string from an overlay), we don't want the
17355 cursor there. (This heuristic seems to give the optimal
17356 behavior for the various types of multi-line strings.) */
17357 if (CHARPOS (row
->end
.string_pos
) >= 0)
17359 if (row
->continued_p
)
17363 /* Check for `display' property. */
17364 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17365 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17366 struct glyph
*glyph
;
17369 for (glyph
= end
; glyph
>= beg
; --glyph
)
17370 if (STRINGP (glyph
->object
))
17373 = Fget_char_property (make_number (PT
),
17377 && display_prop_string_p (prop
, glyph
->object
));
17382 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17384 /* If the row ends in middle of a real character,
17385 and the line is continued, we want the cursor here.
17386 That's because MATRIX_ROW_END_CHARPOS would equal
17387 PT if PT is before the character. */
17388 if (!row
->ends_in_ellipsis_p
)
17389 cursor_row_p
= row
->continued_p
;
17391 /* If the row ends in an ellipsis, then
17392 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17393 We want that position to be displayed after the ellipsis. */
17396 /* If the row ends at ZV, display the cursor at the end of that
17397 row instead of at the start of the row below. */
17398 else if (row
->ends_at_zv_p
)
17404 return cursor_row_p
;
17409 /* Push the display property PROP so that it will be rendered at the
17410 current position in IT. Return 1 if PROP was successfully pushed,
17414 push_display_prop (struct it
*it
, Lisp_Object prop
)
17418 if (STRINGP (prop
))
17420 if (SCHARS (prop
) == 0)
17427 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17428 it
->current
.overlay_string_index
= -1;
17429 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17430 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17431 it
->method
= GET_FROM_STRING
;
17432 it
->stop_charpos
= 0;
17434 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17436 it
->method
= GET_FROM_STRETCH
;
17439 #ifdef HAVE_WINDOW_SYSTEM
17440 else if (IMAGEP (prop
))
17442 it
->what
= IT_IMAGE
;
17443 it
->image_id
= lookup_image (it
->f
, prop
);
17444 it
->method
= GET_FROM_IMAGE
;
17446 #endif /* HAVE_WINDOW_SYSTEM */
17449 pop_it (it
); /* bogus display property, give up */
17456 /* Return the character-property PROP at the current position in IT. */
17459 get_it_property (it
, prop
)
17463 Lisp_Object position
;
17465 if (STRINGP (it
->object
))
17466 position
= make_number (IT_STRING_CHARPOS (*it
));
17467 else if (BUFFERP (it
->object
))
17468 position
= make_number (IT_CHARPOS (*it
));
17472 return Fget_char_property (position
, prop
, it
->object
);
17475 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17478 handle_line_prefix (struct it
*it
)
17480 Lisp_Object prefix
;
17481 if (it
->continuation_lines_width
> 0)
17483 prefix
= get_it_property (it
, Qwrap_prefix
);
17485 prefix
= Vwrap_prefix
;
17489 prefix
= get_it_property (it
, Qline_prefix
);
17491 prefix
= Vline_prefix
;
17493 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17495 /* If the prefix is wider than the window, and we try to wrap
17496 it, it would acquire its own wrap prefix, and so on till the
17497 iterator stack overflows. So, don't wrap the prefix. */
17498 it
->line_wrap
= TRUNCATE
;
17499 it
->avoid_cursor_p
= 1;
17505 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17506 only for R2L lines from display_line, when it decides that too many
17507 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17510 unproduce_glyphs (it
, n
)
17514 struct glyph
*glyph
, *end
;
17516 xassert (it
->glyph_row
);
17517 xassert (it
->glyph_row
->reversed_p
);
17518 xassert (it
->area
== TEXT_AREA
);
17519 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17521 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17522 n
= it
->glyph_row
->used
[TEXT_AREA
];
17523 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17524 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17525 for ( ; glyph
< end
; glyph
++)
17526 glyph
[-n
] = *glyph
;
17529 /* Find the positions in a bidi-reordered ROW to serve as ROW->start
17531 static struct display_pos
17532 find_row_end (it
, row
)
17534 struct glyph_row
*row
;
17536 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17537 lines' rows is implemented for bidi-reordered rows. */
17538 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17541 struct text_pos tpos
;
17542 struct display_pos row_end
= it
->current
;
17544 for (g
= row
->glyphs
[TEXT_AREA
];
17545 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17548 if (BUFFERP (g
->object
))
17550 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17551 min_pos
= g
->charpos
;
17552 if (g
->charpos
> max_pos
)
17553 max_pos
= g
->charpos
;
17556 /* Empty lines have a valid buffer position at their first
17557 glyph, but that glyph's OBJECT is zero, as if it didn't come
17558 from a buffer. If we didn't find any valid buffer positions
17559 in this row, maybe we have such an empty line. */
17560 if (max_pos
== 0 && row
->used
[TEXT_AREA
])
17562 for (g
= row
->glyphs
[TEXT_AREA
];
17563 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17566 if (INTEGERP (g
->object
))
17568 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17569 min_pos
= g
->charpos
;
17570 if (g
->charpos
> max_pos
)
17571 max_pos
= g
->charpos
;
17576 /* ROW->start is the value of min_pos, the minimal buffer position
17580 /* Avoid calling the costly CHAR_TO_BYTE if possible. */
17581 if (min_pos
!= row
->start
.pos
.charpos
)
17582 SET_TEXT_POS (row
->start
.pos
, min_pos
, CHAR_TO_BYTE (min_pos
));
17587 /* For ROW->end, we need the position that is _after_ max_pos, in
17588 the logical order, unless we are at ZV. */
17589 if (row
->ends_at_zv_p
)
17591 if (!row
->used
[TEXT_AREA
])
17592 row
->start
.pos
= row_end
.pos
;
17594 else if (row
->used
[TEXT_AREA
] && max_pos
)
17598 SET_TEXT_POS (tpos
, max_pos
, CHAR_TO_BYTE (max_pos
));
17601 reseat (it
, tpos
, 0);
17602 if (!get_next_display_element (it
))
17603 abort (); /* this row cannot be at ZV, see above */
17604 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (it
);
17605 set_iterator_to_next (it
, 1);
17606 row_end
= it
->current
;
17607 /* If the character at max_pos is not a newline and the
17608 characters at max_pos+1 is a newline, skip that newline as
17609 well. Note that this may skip some invisible text. */
17611 && get_next_display_element (it
)
17612 && ITERATOR_AT_END_OF_LINE_P (it
))
17614 set_iterator_to_next (it
, 1);
17615 /* Record the position after the newline of a continued row.
17616 We will need that to set ROW->end of the last row
17617 produced for a continued line. */
17618 if (row
->continued_p
)
17619 save_it
.eol_pos
= it
->current
.pos
;
17622 row_end
= it
->current
;
17623 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17626 else if (!row
->continued_p
17627 && MATRIX_ROW_CONTINUATION_LINE_P (row
)
17628 && it
->eol_pos
.charpos
> 0)
17630 /* Last row of a continued line. Use the position recorded
17631 in IT->eol_pos, to the effect that the newline belongs to
17632 this row, not to the row which displays the character
17633 with the largest buffer position before the newline. */
17634 row_end
.pos
= it
->eol_pos
;
17635 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17638 /* The members of ROW->end that are not taken from buffer
17639 positions are copied from IT->current. */
17640 row_end
.string_pos
= it
->current
.string_pos
;
17641 row_end
.overlay_string_index
= it
->current
.overlay_string_index
;
17642 row_end
.dpvec_index
= it
->current
.dpvec_index
;
17647 /* Construct the glyph row IT->glyph_row in the desired matrix of
17648 IT->w from text at the current position of IT. See dispextern.h
17649 for an overview of struct it. Value is non-zero if
17650 IT->glyph_row displays text, as opposed to a line displaying ZV
17657 struct glyph_row
*row
= it
->glyph_row
;
17658 Lisp_Object overlay_arrow_string
;
17660 int may_wrap
= 0, wrap_x
;
17661 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17662 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17663 int wrap_row_extra_line_spacing
;
17666 /* We always start displaying at hpos zero even if hscrolled. */
17667 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17669 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17670 >= it
->w
->desired_matrix
->nrows
)
17672 it
->w
->nrows_scale_factor
++;
17673 fonts_changed_p
= 1;
17677 /* Is IT->w showing the region? */
17678 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17680 /* Clear the result glyph row and enable it. */
17681 prepare_desired_row (row
);
17683 row
->y
= it
->current_y
;
17684 row
->start
= it
->start
;
17685 row
->continuation_lines_width
= it
->continuation_lines_width
;
17686 row
->displays_text_p
= 1;
17687 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17688 it
->starts_in_middle_of_char_p
= 0;
17690 /* Arrange the overlays nicely for our purposes. Usually, we call
17691 display_line on only one line at a time, in which case this
17692 can't really hurt too much, or we call it on lines which appear
17693 one after another in the buffer, in which case all calls to
17694 recenter_overlay_lists but the first will be pretty cheap. */
17695 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17697 /* Move over display elements that are not visible because we are
17698 hscrolled. This may stop at an x-position < IT->first_visible_x
17699 if the first glyph is partially visible or if we hit a line end. */
17700 if (it
->current_x
< it
->first_visible_x
)
17702 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17703 MOVE_TO_POS
| MOVE_TO_X
);
17707 /* We only do this when not calling `move_it_in_display_line_to'
17708 above, because move_it_in_display_line_to calls
17709 handle_line_prefix itself. */
17710 handle_line_prefix (it
);
17713 /* Get the initial row height. This is either the height of the
17714 text hscrolled, if there is any, or zero. */
17715 row
->ascent
= it
->max_ascent
;
17716 row
->height
= it
->max_ascent
+ it
->max_descent
;
17717 row
->phys_ascent
= it
->max_phys_ascent
;
17718 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17719 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17721 /* Loop generating characters. The loop is left with IT on the next
17722 character to display. */
17725 int n_glyphs_before
, hpos_before
, x_before
;
17727 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17729 /* Retrieve the next thing to display. Value is zero if end of
17731 if (!get_next_display_element (it
))
17733 /* Maybe add a space at the end of this line that is used to
17734 display the cursor there under X. Set the charpos of the
17735 first glyph of blank lines not corresponding to any text
17737 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17738 row
->exact_window_width_line_p
= 1;
17739 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17740 || row
->used
[TEXT_AREA
] == 0)
17742 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17743 row
->displays_text_p
= 0;
17745 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17746 && (!MINI_WINDOW_P (it
->w
)
17747 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17748 row
->indicate_empty_line_p
= 1;
17751 it
->continuation_lines_width
= 0;
17752 row
->ends_at_zv_p
= 1;
17753 /* A row that displays right-to-left text must always have
17754 its last face extended all the way to the end of line,
17755 even if this row ends in ZV. */
17756 if (row
->reversed_p
)
17757 extend_face_to_end_of_line (it
);
17761 /* Now, get the metrics of what we want to display. This also
17762 generates glyphs in `row' (which is IT->glyph_row). */
17763 n_glyphs_before
= row
->used
[TEXT_AREA
];
17766 /* Remember the line height so far in case the next element doesn't
17767 fit on the line. */
17768 if (it
->line_wrap
!= TRUNCATE
)
17770 ascent
= it
->max_ascent
;
17771 descent
= it
->max_descent
;
17772 phys_ascent
= it
->max_phys_ascent
;
17773 phys_descent
= it
->max_phys_descent
;
17775 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17777 if (IT_DISPLAYING_WHITESPACE (it
))
17783 wrap_row_used
= row
->used
[TEXT_AREA
];
17784 wrap_row_ascent
= row
->ascent
;
17785 wrap_row_height
= row
->height
;
17786 wrap_row_phys_ascent
= row
->phys_ascent
;
17787 wrap_row_phys_height
= row
->phys_height
;
17788 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17794 PRODUCE_GLYPHS (it
);
17796 /* If this display element was in marginal areas, continue with
17798 if (it
->area
!= TEXT_AREA
)
17800 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17801 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17802 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17803 row
->phys_height
= max (row
->phys_height
,
17804 it
->max_phys_ascent
+ it
->max_phys_descent
);
17805 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17806 it
->max_extra_line_spacing
);
17807 set_iterator_to_next (it
, 1);
17811 /* Does the display element fit on the line? If we truncate
17812 lines, we should draw past the right edge of the window. If
17813 we don't truncate, we want to stop so that we can display the
17814 continuation glyph before the right margin. If lines are
17815 continued, there are two possible strategies for characters
17816 resulting in more than 1 glyph (e.g. tabs): Display as many
17817 glyphs as possible in this line and leave the rest for the
17818 continuation line, or display the whole element in the next
17819 line. Original redisplay did the former, so we do it also. */
17820 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17821 hpos_before
= it
->hpos
;
17824 if (/* Not a newline. */
17826 /* Glyphs produced fit entirely in the line. */
17827 && it
->current_x
< it
->last_visible_x
)
17829 it
->hpos
+= nglyphs
;
17830 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17831 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17832 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17833 row
->phys_height
= max (row
->phys_height
,
17834 it
->max_phys_ascent
+ it
->max_phys_descent
);
17835 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17836 it
->max_extra_line_spacing
);
17837 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17838 row
->x
= x
- it
->first_visible_x
;
17843 struct glyph
*glyph
;
17845 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17847 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17848 new_x
= x
+ glyph
->pixel_width
;
17850 if (/* Lines are continued. */
17851 it
->line_wrap
!= TRUNCATE
17852 && (/* Glyph doesn't fit on the line. */
17853 new_x
> it
->last_visible_x
17854 /* Or it fits exactly on a window system frame. */
17855 || (new_x
== it
->last_visible_x
17856 && FRAME_WINDOW_P (it
->f
))))
17858 /* End of a continued line. */
17861 || (new_x
== it
->last_visible_x
17862 && FRAME_WINDOW_P (it
->f
)))
17864 /* Current glyph is the only one on the line or
17865 fits exactly on the line. We must continue
17866 the line because we can't draw the cursor
17867 after the glyph. */
17868 row
->continued_p
= 1;
17869 it
->current_x
= new_x
;
17870 it
->continuation_lines_width
+= new_x
;
17872 if (i
== nglyphs
- 1)
17874 /* If line-wrap is on, check if a previous
17875 wrap point was found. */
17876 if (wrap_row_used
> 0
17877 /* Even if there is a previous wrap
17878 point, continue the line here as
17879 usual, if (i) the previous character
17880 was a space or tab AND (ii) the
17881 current character is not. */
17883 || IT_DISPLAYING_WHITESPACE (it
)))
17886 set_iterator_to_next (it
, 1);
17887 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17889 if (!get_next_display_element (it
))
17891 row
->exact_window_width_line_p
= 1;
17892 it
->continuation_lines_width
= 0;
17893 row
->continued_p
= 0;
17894 row
->ends_at_zv_p
= 1;
17896 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17898 row
->continued_p
= 0;
17899 row
->exact_window_width_line_p
= 1;
17904 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17905 && !FRAME_WINDOW_P (it
->f
))
17907 /* A padding glyph that doesn't fit on this line.
17908 This means the whole character doesn't fit
17910 if (row
->reversed_p
)
17911 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17912 - n_glyphs_before
);
17913 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17915 /* Fill the rest of the row with continuation
17916 glyphs like in 20.x. */
17917 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17918 < row
->glyphs
[1 + TEXT_AREA
])
17919 produce_special_glyphs (it
, IT_CONTINUATION
);
17921 row
->continued_p
= 1;
17922 it
->current_x
= x_before
;
17923 it
->continuation_lines_width
+= x_before
;
17925 /* Restore the height to what it was before the
17926 element not fitting on the line. */
17927 it
->max_ascent
= ascent
;
17928 it
->max_descent
= descent
;
17929 it
->max_phys_ascent
= phys_ascent
;
17930 it
->max_phys_descent
= phys_descent
;
17932 else if (wrap_row_used
> 0)
17935 if (row
->reversed_p
)
17936 unproduce_glyphs (it
,
17937 row
->used
[TEXT_AREA
] - wrap_row_used
);
17939 it
->continuation_lines_width
+= wrap_x
;
17940 row
->used
[TEXT_AREA
] = wrap_row_used
;
17941 row
->ascent
= wrap_row_ascent
;
17942 row
->height
= wrap_row_height
;
17943 row
->phys_ascent
= wrap_row_phys_ascent
;
17944 row
->phys_height
= wrap_row_phys_height
;
17945 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17946 row
->continued_p
= 1;
17947 row
->ends_at_zv_p
= 0;
17948 row
->exact_window_width_line_p
= 0;
17949 it
->continuation_lines_width
+= x
;
17951 /* Make sure that a non-default face is extended
17952 up to the right margin of the window. */
17953 extend_face_to_end_of_line (it
);
17955 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17957 /* A TAB that extends past the right edge of the
17958 window. This produces a single glyph on
17959 window system frames. We leave the glyph in
17960 this row and let it fill the row, but don't
17961 consume the TAB. */
17962 it
->continuation_lines_width
+= it
->last_visible_x
;
17963 row
->ends_in_middle_of_char_p
= 1;
17964 row
->continued_p
= 1;
17965 glyph
->pixel_width
= it
->last_visible_x
- x
;
17966 it
->starts_in_middle_of_char_p
= 1;
17970 /* Something other than a TAB that draws past
17971 the right edge of the window. Restore
17972 positions to values before the element. */
17973 if (row
->reversed_p
)
17974 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17975 - (n_glyphs_before
+ i
));
17976 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17978 /* Display continuation glyphs. */
17979 if (!FRAME_WINDOW_P (it
->f
))
17980 produce_special_glyphs (it
, IT_CONTINUATION
);
17981 row
->continued_p
= 1;
17983 it
->current_x
= x_before
;
17984 it
->continuation_lines_width
+= x
;
17985 extend_face_to_end_of_line (it
);
17987 if (nglyphs
> 1 && i
> 0)
17989 row
->ends_in_middle_of_char_p
= 1;
17990 it
->starts_in_middle_of_char_p
= 1;
17993 /* Restore the height to what it was before the
17994 element not fitting on the line. */
17995 it
->max_ascent
= ascent
;
17996 it
->max_descent
= descent
;
17997 it
->max_phys_ascent
= phys_ascent
;
17998 it
->max_phys_descent
= phys_descent
;
18003 else if (new_x
> it
->first_visible_x
)
18005 /* Increment number of glyphs actually displayed. */
18008 if (x
< it
->first_visible_x
)
18009 /* Glyph is partially visible, i.e. row starts at
18010 negative X position. */
18011 row
->x
= x
- it
->first_visible_x
;
18015 /* Glyph is completely off the left margin of the
18016 window. This should not happen because of the
18017 move_it_in_display_line at the start of this
18018 function, unless the text display area of the
18019 window is empty. */
18020 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18024 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18025 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18026 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18027 row
->phys_height
= max (row
->phys_height
,
18028 it
->max_phys_ascent
+ it
->max_phys_descent
);
18029 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18030 it
->max_extra_line_spacing
);
18032 /* End of this display line if row is continued. */
18033 if (row
->continued_p
|| row
->ends_at_zv_p
)
18038 /* Is this a line end? If yes, we're also done, after making
18039 sure that a non-default face is extended up to the right
18040 margin of the window. */
18041 if (ITERATOR_AT_END_OF_LINE_P (it
))
18043 int used_before
= row
->used
[TEXT_AREA
];
18045 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18047 /* Add a space at the end of the line that is used to
18048 display the cursor there. */
18049 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18050 append_space_for_newline (it
, 0);
18052 /* Extend the face to the end of the line. */
18053 extend_face_to_end_of_line (it
);
18055 /* Make sure we have the position. */
18056 if (used_before
== 0)
18057 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18059 /* Consume the line end. This skips over invisible lines. */
18060 set_iterator_to_next (it
, 1);
18061 it
->continuation_lines_width
= 0;
18065 /* Proceed with next display element. Note that this skips
18066 over lines invisible because of selective display. */
18067 set_iterator_to_next (it
, 1);
18069 /* If we truncate lines, we are done when the last displayed
18070 glyphs reach past the right margin of the window. */
18071 if (it
->line_wrap
== TRUNCATE
18072 && (FRAME_WINDOW_P (it
->f
)
18073 ? (it
->current_x
>= it
->last_visible_x
)
18074 : (it
->current_x
> it
->last_visible_x
)))
18076 /* Maybe add truncation glyphs. */
18077 if (!FRAME_WINDOW_P (it
->f
))
18081 if (!row
->reversed_p
)
18083 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18084 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18089 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18090 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18092 /* Remove any padding glyphs at the front of ROW, to
18093 make room for the truncation glyphs we will be
18094 adding below. The loop below always inserts at
18095 least one truncation glyph, so also remove the
18096 last glyph added to ROW. */
18097 unproduce_glyphs (it
, i
+ 1);
18098 /* Adjust i for the loop below. */
18099 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18102 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18104 row
->used
[TEXT_AREA
] = i
;
18105 produce_special_glyphs (it
, IT_TRUNCATION
);
18108 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18110 /* Don't truncate if we can overflow newline into fringe. */
18111 if (!get_next_display_element (it
))
18113 it
->continuation_lines_width
= 0;
18114 row
->ends_at_zv_p
= 1;
18115 row
->exact_window_width_line_p
= 1;
18118 if (ITERATOR_AT_END_OF_LINE_P (it
))
18120 row
->exact_window_width_line_p
= 1;
18121 goto at_end_of_line
;
18125 row
->truncated_on_right_p
= 1;
18126 it
->continuation_lines_width
= 0;
18127 reseat_at_next_visible_line_start (it
, 0);
18128 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18129 it
->hpos
= hpos_before
;
18130 it
->current_x
= x_before
;
18135 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18136 at the left window margin. */
18137 if (it
->first_visible_x
18138 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
18140 if (!FRAME_WINDOW_P (it
->f
))
18141 insert_left_trunc_glyphs (it
);
18142 row
->truncated_on_left_p
= 1;
18145 /* If the start of this line is the overlay arrow-position, then
18146 mark this glyph row as the one containing the overlay arrow.
18147 This is clearly a mess with variable size fonts. It would be
18148 better to let it be displayed like cursors under X. */
18149 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18150 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18151 !NILP (overlay_arrow_string
)))
18153 /* Overlay arrow in window redisplay is a fringe bitmap. */
18154 if (STRINGP (overlay_arrow_string
))
18156 struct glyph_row
*arrow_row
18157 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18158 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18159 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18160 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18161 struct glyph
*p2
, *end
;
18163 /* Copy the arrow glyphs. */
18164 while (glyph
< arrow_end
)
18167 /* Throw away padding glyphs. */
18169 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18170 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18176 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18181 xassert (INTEGERP (overlay_arrow_string
));
18182 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18184 overlay_arrow_seen
= 1;
18187 /* Compute pixel dimensions of this line. */
18188 compute_line_metrics (it
);
18190 /* Remember the position at which this line ends. */
18191 row
->end
= it
->current
;
18192 /* ROW->start and ROW->end must be the smallest and the largest
18193 buffer positions in ROW. But if ROW was bidi-reordered, these
18194 two positions can be anywhere in the row, so we must rescan all
18195 of the ROW's glyphs to find them. */
18197 row
->end
= find_row_end (it
, row
);
18199 /* Record whether this row ends inside an ellipsis. */
18200 row
->ends_in_ellipsis_p
18201 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18202 && it
->ellipsis_p
);
18204 /* Save fringe bitmaps in this row. */
18205 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18206 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18207 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18208 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18210 it
->left_user_fringe_bitmap
= 0;
18211 it
->left_user_fringe_face_id
= 0;
18212 it
->right_user_fringe_bitmap
= 0;
18213 it
->right_user_fringe_face_id
= 0;
18215 /* Maybe set the cursor. */
18216 cvpos
= it
->w
->cursor
.vpos
;
18218 /* In bidi-reordered rows, keep checking for proper cursor
18219 position even if one has been found already, because buffer
18220 positions in such rows change non-linearly with ROW->VPOS,
18221 when a line is continued. One exception: when we are at ZV,
18222 display cursor on the first suitable glyph row, since all
18223 the empty rows after that also have their position set to ZV. */
18224 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18225 lines' rows is implemented for bidi-reordered rows. */
18227 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18228 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18229 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18230 && cursor_row_p (it
->w
, row
))
18231 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18233 /* Highlight trailing whitespace. */
18234 if (!NILP (Vshow_trailing_whitespace
))
18235 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18237 /* Prepare for the next line. This line starts horizontally at (X
18238 HPOS) = (0 0). Vertical positions are incremented. As a
18239 convenience for the caller, IT->glyph_row is set to the next
18241 it
->current_x
= it
->hpos
= 0;
18242 it
->current_y
+= row
->height
;
18245 /* The next row should by default use the same value of the
18246 reversed_p flag as this one. set_iterator_to_next decides when
18247 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18248 the flag accordingly. */
18249 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18250 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18251 it
->start
= row
->end
;
18252 return row
->displays_text_p
;
18257 /***********************************************************************
18259 ***********************************************************************/
18261 /* Redisplay the menu bar in the frame for window W.
18263 The menu bar of X frames that don't have X toolkit support is
18264 displayed in a special window W->frame->menu_bar_window.
18266 The menu bar of terminal frames is treated specially as far as
18267 glyph matrices are concerned. Menu bar lines are not part of
18268 windows, so the update is done directly on the frame matrix rows
18269 for the menu bar. */
18272 display_menu_bar (w
)
18275 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18280 /* Don't do all this for graphical frames. */
18282 if (FRAME_W32_P (f
))
18285 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18291 if (FRAME_NS_P (f
))
18293 #endif /* HAVE_NS */
18295 #ifdef USE_X_TOOLKIT
18296 xassert (!FRAME_WINDOW_P (f
));
18297 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18298 it
.first_visible_x
= 0;
18299 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18300 #else /* not USE_X_TOOLKIT */
18301 if (FRAME_WINDOW_P (f
))
18303 /* Menu bar lines are displayed in the desired matrix of the
18304 dummy window menu_bar_window. */
18305 struct window
*menu_w
;
18306 xassert (WINDOWP (f
->menu_bar_window
));
18307 menu_w
= XWINDOW (f
->menu_bar_window
);
18308 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18310 it
.first_visible_x
= 0;
18311 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18315 /* This is a TTY frame, i.e. character hpos/vpos are used as
18317 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18319 it
.first_visible_x
= 0;
18320 it
.last_visible_x
= FRAME_COLS (f
);
18322 #endif /* not USE_X_TOOLKIT */
18324 if (! mode_line_inverse_video
)
18325 /* Force the menu-bar to be displayed in the default face. */
18326 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18328 /* Clear all rows of the menu bar. */
18329 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18331 struct glyph_row
*row
= it
.glyph_row
+ i
;
18332 clear_glyph_row (row
);
18333 row
->enabled_p
= 1;
18334 row
->full_width_p
= 1;
18337 /* Display all items of the menu bar. */
18338 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18339 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18341 Lisp_Object string
;
18343 /* Stop at nil string. */
18344 string
= AREF (items
, i
+ 1);
18348 /* Remember where item was displayed. */
18349 ASET (items
, i
+ 3, make_number (it
.hpos
));
18351 /* Display the item, pad with one space. */
18352 if (it
.current_x
< it
.last_visible_x
)
18353 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18354 SCHARS (string
) + 1, 0, 0, -1);
18357 /* Fill out the line with spaces. */
18358 if (it
.current_x
< it
.last_visible_x
)
18359 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18361 /* Compute the total height of the lines. */
18362 compute_line_metrics (&it
);
18367 /***********************************************************************
18369 ***********************************************************************/
18371 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18372 FORCE is non-zero, redisplay mode lines unconditionally.
18373 Otherwise, redisplay only mode lines that are garbaged. Value is
18374 the number of windows whose mode lines were redisplayed. */
18377 redisplay_mode_lines (window
, force
)
18378 Lisp_Object window
;
18383 while (!NILP (window
))
18385 struct window
*w
= XWINDOW (window
);
18387 if (WINDOWP (w
->hchild
))
18388 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18389 else if (WINDOWP (w
->vchild
))
18390 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18392 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18393 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18395 struct text_pos lpoint
;
18396 struct buffer
*old
= current_buffer
;
18398 /* Set the window's buffer for the mode line display. */
18399 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18400 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18402 /* Point refers normally to the selected window. For any
18403 other window, set up appropriate value. */
18404 if (!EQ (window
, selected_window
))
18406 struct text_pos pt
;
18408 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18409 if (CHARPOS (pt
) < BEGV
)
18410 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18411 else if (CHARPOS (pt
) > (ZV
- 1))
18412 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18414 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18417 /* Display mode lines. */
18418 clear_glyph_matrix (w
->desired_matrix
);
18419 if (display_mode_lines (w
))
18422 w
->must_be_updated_p
= 1;
18425 /* Restore old settings. */
18426 set_buffer_internal_1 (old
);
18427 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18437 /* Display the mode and/or header line of window W. Value is the
18438 sum number of mode lines and header lines displayed. */
18441 display_mode_lines (w
)
18444 Lisp_Object old_selected_window
, old_selected_frame
;
18447 old_selected_frame
= selected_frame
;
18448 selected_frame
= w
->frame
;
18449 old_selected_window
= selected_window
;
18450 XSETWINDOW (selected_window
, w
);
18452 /* These will be set while the mode line specs are processed. */
18453 line_number_displayed
= 0;
18454 w
->column_number_displayed
= Qnil
;
18456 if (WINDOW_WANTS_MODELINE_P (w
))
18458 struct window
*sel_w
= XWINDOW (old_selected_window
);
18460 /* Select mode line face based on the real selected window. */
18461 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18462 current_buffer
->mode_line_format
);
18466 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18468 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18469 current_buffer
->header_line_format
);
18473 selected_frame
= old_selected_frame
;
18474 selected_window
= old_selected_window
;
18479 /* Display mode or header line of window W. FACE_ID specifies which
18480 line to display; it is either MODE_LINE_FACE_ID or
18481 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18482 display. Value is the pixel height of the mode/header line
18486 display_mode_line (w
, face_id
, format
)
18488 enum face_id face_id
;
18489 Lisp_Object format
;
18493 int count
= SPECPDL_INDEX ();
18495 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18496 /* Don't extend on a previously drawn mode-line.
18497 This may happen if called from pos_visible_p. */
18498 it
.glyph_row
->enabled_p
= 0;
18499 prepare_desired_row (it
.glyph_row
);
18501 it
.glyph_row
->mode_line_p
= 1;
18503 if (! mode_line_inverse_video
)
18504 /* Force the mode-line to be displayed in the default face. */
18505 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18507 record_unwind_protect (unwind_format_mode_line
,
18508 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18510 mode_line_target
= MODE_LINE_DISPLAY
;
18512 /* Temporarily make frame's keyboard the current kboard so that
18513 kboard-local variables in the mode_line_format will get the right
18515 push_kboard (FRAME_KBOARD (it
.f
));
18516 record_unwind_save_match_data ();
18517 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18520 unbind_to (count
, Qnil
);
18522 /* Fill up with spaces. */
18523 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18525 compute_line_metrics (&it
);
18526 it
.glyph_row
->full_width_p
= 1;
18527 it
.glyph_row
->continued_p
= 0;
18528 it
.glyph_row
->truncated_on_left_p
= 0;
18529 it
.glyph_row
->truncated_on_right_p
= 0;
18531 /* Make a 3D mode-line have a shadow at its right end. */
18532 face
= FACE_FROM_ID (it
.f
, face_id
);
18533 extend_face_to_end_of_line (&it
);
18534 if (face
->box
!= FACE_NO_BOX
)
18536 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18537 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18538 last
->right_box_line_p
= 1;
18541 return it
.glyph_row
->height
;
18544 /* Move element ELT in LIST to the front of LIST.
18545 Return the updated list. */
18548 move_elt_to_front (elt
, list
)
18549 Lisp_Object elt
, list
;
18551 register Lisp_Object tail
, prev
;
18552 register Lisp_Object tem
;
18556 while (CONSP (tail
))
18562 /* Splice out the link TAIL. */
18564 list
= XCDR (tail
);
18566 Fsetcdr (prev
, XCDR (tail
));
18568 /* Now make it the first. */
18569 Fsetcdr (tail
, list
);
18574 tail
= XCDR (tail
);
18578 /* Not found--return unchanged LIST. */
18582 /* Contribute ELT to the mode line for window IT->w. How it
18583 translates into text depends on its data type.
18585 IT describes the display environment in which we display, as usual.
18587 DEPTH is the depth in recursion. It is used to prevent
18588 infinite recursion here.
18590 FIELD_WIDTH is the number of characters the display of ELT should
18591 occupy in the mode line, and PRECISION is the maximum number of
18592 characters to display from ELT's representation. See
18593 display_string for details.
18595 Returns the hpos of the end of the text generated by ELT.
18597 PROPS is a property list to add to any string we encounter.
18599 If RISKY is nonzero, remove (disregard) any properties in any string
18600 we encounter, and ignore :eval and :propertize.
18602 The global variable `mode_line_target' determines whether the
18603 output is passed to `store_mode_line_noprop',
18604 `store_mode_line_string', or `display_string'. */
18607 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18610 int field_width
, precision
;
18611 Lisp_Object elt
, props
;
18614 int n
= 0, field
, prec
;
18619 elt
= build_string ("*too-deep*");
18623 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18627 /* A string: output it and check for %-constructs within it. */
18631 if (SCHARS (elt
) > 0
18632 && (!NILP (props
) || risky
))
18634 Lisp_Object oprops
, aelt
;
18635 oprops
= Ftext_properties_at (make_number (0), elt
);
18637 /* If the starting string's properties are not what
18638 we want, translate the string. Also, if the string
18639 is risky, do that anyway. */
18641 if (NILP (Fequal (props
, oprops
)) || risky
)
18643 /* If the starting string has properties,
18644 merge the specified ones onto the existing ones. */
18645 if (! NILP (oprops
) && !risky
)
18649 oprops
= Fcopy_sequence (oprops
);
18651 while (CONSP (tem
))
18653 oprops
= Fplist_put (oprops
, XCAR (tem
),
18654 XCAR (XCDR (tem
)));
18655 tem
= XCDR (XCDR (tem
));
18660 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18661 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18663 /* AELT is what we want. Move it to the front
18664 without consing. */
18666 mode_line_proptrans_alist
18667 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18673 /* If AELT has the wrong props, it is useless.
18674 so get rid of it. */
18676 mode_line_proptrans_alist
18677 = Fdelq (aelt
, mode_line_proptrans_alist
);
18679 elt
= Fcopy_sequence (elt
);
18680 Fset_text_properties (make_number (0), Flength (elt
),
18682 /* Add this item to mode_line_proptrans_alist. */
18683 mode_line_proptrans_alist
18684 = Fcons (Fcons (elt
, props
),
18685 mode_line_proptrans_alist
);
18686 /* Truncate mode_line_proptrans_alist
18687 to at most 50 elements. */
18688 tem
= Fnthcdr (make_number (50),
18689 mode_line_proptrans_alist
);
18691 XSETCDR (tem
, Qnil
);
18700 prec
= precision
- n
;
18701 switch (mode_line_target
)
18703 case MODE_LINE_NOPROP
:
18704 case MODE_LINE_TITLE
:
18705 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18707 case MODE_LINE_STRING
:
18708 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18710 case MODE_LINE_DISPLAY
:
18711 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18712 0, prec
, 0, STRING_MULTIBYTE (elt
));
18719 /* Handle the non-literal case. */
18721 while ((precision
<= 0 || n
< precision
)
18722 && SREF (elt
, offset
) != 0
18723 && (mode_line_target
!= MODE_LINE_DISPLAY
18724 || it
->current_x
< it
->last_visible_x
))
18726 int last_offset
= offset
;
18728 /* Advance to end of string or next format specifier. */
18729 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18732 if (offset
- 1 != last_offset
)
18734 int nchars
, nbytes
;
18736 /* Output to end of string or up to '%'. Field width
18737 is length of string. Don't output more than
18738 PRECISION allows us. */
18741 prec
= c_string_width (SDATA (elt
) + last_offset
,
18742 offset
- last_offset
, precision
- n
,
18745 switch (mode_line_target
)
18747 case MODE_LINE_NOPROP
:
18748 case MODE_LINE_TITLE
:
18749 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18751 case MODE_LINE_STRING
:
18753 int bytepos
= last_offset
;
18754 int charpos
= string_byte_to_char (elt
, bytepos
);
18755 int endpos
= (precision
<= 0
18756 ? string_byte_to_char (elt
, offset
)
18757 : charpos
+ nchars
);
18759 n
+= store_mode_line_string (NULL
,
18760 Fsubstring (elt
, make_number (charpos
),
18761 make_number (endpos
)),
18765 case MODE_LINE_DISPLAY
:
18767 int bytepos
= last_offset
;
18768 int charpos
= string_byte_to_char (elt
, bytepos
);
18770 if (precision
<= 0)
18771 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18772 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18774 STRING_MULTIBYTE (elt
));
18779 else /* c == '%' */
18781 int percent_position
= offset
;
18783 /* Get the specified minimum width. Zero means
18786 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18787 field
= field
* 10 + c
- '0';
18789 /* Don't pad beyond the total padding allowed. */
18790 if (field_width
- n
> 0 && field
> field_width
- n
)
18791 field
= field_width
- n
;
18793 /* Note that either PRECISION <= 0 or N < PRECISION. */
18794 prec
= precision
- n
;
18797 n
+= display_mode_element (it
, depth
, field
, prec
,
18798 Vglobal_mode_string
, props
,
18803 int bytepos
, charpos
;
18804 unsigned char *spec
;
18805 Lisp_Object string
;
18807 bytepos
= percent_position
;
18808 charpos
= (STRING_MULTIBYTE (elt
)
18809 ? string_byte_to_char (elt
, bytepos
)
18811 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18812 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18814 switch (mode_line_target
)
18816 case MODE_LINE_NOPROP
:
18817 case MODE_LINE_TITLE
:
18818 n
+= store_mode_line_noprop (spec
, field
, prec
);
18820 case MODE_LINE_STRING
:
18822 int len
= strlen (spec
);
18823 Lisp_Object tem
= make_string (spec
, len
);
18824 props
= Ftext_properties_at (make_number (charpos
), elt
);
18825 /* Should only keep face property in props */
18826 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18829 case MODE_LINE_DISPLAY
:
18831 int nglyphs_before
, nwritten
;
18833 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18834 nwritten
= display_string (spec
, string
, elt
,
18839 /* Assign to the glyphs written above the
18840 string where the `%x' came from, position
18844 struct glyph
*glyph
18845 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18849 for (i
= 0; i
< nwritten
; ++i
)
18851 glyph
[i
].object
= elt
;
18852 glyph
[i
].charpos
= charpos
;
18869 /* A symbol: process the value of the symbol recursively
18870 as if it appeared here directly. Avoid error if symbol void.
18871 Special case: if value of symbol is a string, output the string
18874 register Lisp_Object tem
;
18876 /* If the variable is not marked as risky to set
18877 then its contents are risky to use. */
18878 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18881 tem
= Fboundp (elt
);
18884 tem
= Fsymbol_value (elt
);
18885 /* If value is a string, output that string literally:
18886 don't check for % within it. */
18890 if (!EQ (tem
, elt
))
18892 /* Give up right away for nil or t. */
18902 register Lisp_Object car
, tem
;
18904 /* A cons cell: five distinct cases.
18905 If first element is :eval or :propertize, do something special.
18906 If first element is a string or a cons, process all the elements
18907 and effectively concatenate them.
18908 If first element is a negative number, truncate displaying cdr to
18909 at most that many characters. If positive, pad (with spaces)
18910 to at least that many characters.
18911 If first element is a symbol, process the cadr or caddr recursively
18912 according to whether the symbol's value is non-nil or nil. */
18914 if (EQ (car
, QCeval
))
18916 /* An element of the form (:eval FORM) means evaluate FORM
18917 and use the result as mode line elements. */
18922 if (CONSP (XCDR (elt
)))
18925 spec
= safe_eval (XCAR (XCDR (elt
)));
18926 n
+= display_mode_element (it
, depth
, field_width
- n
,
18927 precision
- n
, spec
, props
,
18931 else if (EQ (car
, QCpropertize
))
18933 /* An element of the form (:propertize ELT PROPS...)
18934 means display ELT but applying properties PROPS. */
18939 if (CONSP (XCDR (elt
)))
18940 n
+= display_mode_element (it
, depth
, field_width
- n
,
18941 precision
- n
, XCAR (XCDR (elt
)),
18942 XCDR (XCDR (elt
)), risky
);
18944 else if (SYMBOLP (car
))
18946 tem
= Fboundp (car
);
18950 /* elt is now the cdr, and we know it is a cons cell.
18951 Use its car if CAR has a non-nil value. */
18954 tem
= Fsymbol_value (car
);
18961 /* Symbol's value is nil (or symbol is unbound)
18962 Get the cddr of the original list
18963 and if possible find the caddr and use that. */
18967 else if (!CONSP (elt
))
18972 else if (INTEGERP (car
))
18974 register int lim
= XINT (car
);
18978 /* Negative int means reduce maximum width. */
18979 if (precision
<= 0)
18982 precision
= min (precision
, -lim
);
18986 /* Padding specified. Don't let it be more than
18987 current maximum. */
18989 lim
= min (precision
, lim
);
18991 /* If that's more padding than already wanted, queue it.
18992 But don't reduce padding already specified even if
18993 that is beyond the current truncation point. */
18994 field_width
= max (lim
, field_width
);
18998 else if (STRINGP (car
) || CONSP (car
))
19000 Lisp_Object halftail
= elt
;
19004 && (precision
<= 0 || n
< precision
))
19006 n
+= display_mode_element (it
, depth
,
19007 /* Do padding only after the last
19008 element in the list. */
19009 (! CONSP (XCDR (elt
))
19012 precision
- n
, XCAR (elt
),
19016 if ((len
& 1) == 0)
19017 halftail
= XCDR (halftail
);
19018 /* Check for cycle. */
19019 if (EQ (halftail
, elt
))
19028 elt
= build_string ("*invalid*");
19032 /* Pad to FIELD_WIDTH. */
19033 if (field_width
> 0 && n
< field_width
)
19035 switch (mode_line_target
)
19037 case MODE_LINE_NOPROP
:
19038 case MODE_LINE_TITLE
:
19039 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19041 case MODE_LINE_STRING
:
19042 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19044 case MODE_LINE_DISPLAY
:
19045 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19054 /* Store a mode-line string element in mode_line_string_list.
19056 If STRING is non-null, display that C string. Otherwise, the Lisp
19057 string LISP_STRING is displayed.
19059 FIELD_WIDTH is the minimum number of output glyphs to produce.
19060 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19061 with spaces. FIELD_WIDTH <= 0 means don't pad.
19063 PRECISION is the maximum number of characters to output from
19064 STRING. PRECISION <= 0 means don't truncate the string.
19066 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19067 properties to the string.
19069 PROPS are the properties to add to the string.
19070 The mode_line_string_face face property is always added to the string.
19074 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
19076 Lisp_Object lisp_string
;
19085 if (string
!= NULL
)
19087 len
= strlen (string
);
19088 if (precision
> 0 && len
> precision
)
19090 lisp_string
= make_string (string
, len
);
19092 props
= mode_line_string_face_prop
;
19093 else if (!NILP (mode_line_string_face
))
19095 Lisp_Object face
= Fplist_get (props
, Qface
);
19096 props
= Fcopy_sequence (props
);
19098 face
= mode_line_string_face
;
19100 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19101 props
= Fplist_put (props
, Qface
, face
);
19103 Fadd_text_properties (make_number (0), make_number (len
),
19104 props
, lisp_string
);
19108 len
= XFASTINT (Flength (lisp_string
));
19109 if (precision
> 0 && len
> precision
)
19112 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19115 if (!NILP (mode_line_string_face
))
19119 props
= Ftext_properties_at (make_number (0), lisp_string
);
19120 face
= Fplist_get (props
, Qface
);
19122 face
= mode_line_string_face
;
19124 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19125 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19127 lisp_string
= Fcopy_sequence (lisp_string
);
19130 Fadd_text_properties (make_number (0), make_number (len
),
19131 props
, lisp_string
);
19136 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19140 if (field_width
> len
)
19142 field_width
-= len
;
19143 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19145 Fadd_text_properties (make_number (0), make_number (field_width
),
19146 props
, lisp_string
);
19147 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19155 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19157 doc
: /* Format a string out of a mode line format specification.
19158 First arg FORMAT specifies the mode line format (see `mode-line-format'
19159 for details) to use.
19161 Optional second arg FACE specifies the face property to put
19162 on all characters for which no face is specified.
19163 The value t means whatever face the window's mode line currently uses
19164 \(either `mode-line' or `mode-line-inactive', depending).
19165 A value of nil means the default is no face property.
19166 If FACE is an integer, the value string has no text properties.
19168 Optional third and fourth args WINDOW and BUFFER specify the window
19169 and buffer to use as the context for the formatting (defaults
19170 are the selected window and the window's buffer). */)
19171 (format
, face
, window
, buffer
)
19172 Lisp_Object format
, face
, window
, buffer
;
19177 struct buffer
*old_buffer
= NULL
;
19179 int no_props
= INTEGERP (face
);
19180 int count
= SPECPDL_INDEX ();
19182 int string_start
= 0;
19185 window
= selected_window
;
19186 CHECK_WINDOW (window
);
19187 w
= XWINDOW (window
);
19190 buffer
= w
->buffer
;
19191 CHECK_BUFFER (buffer
);
19193 /* Make formatting the modeline a non-op when noninteractive, otherwise
19194 there will be problems later caused by a partially initialized frame. */
19195 if (NILP (format
) || noninteractive
)
19196 return empty_unibyte_string
;
19204 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
19205 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
19209 face_id
= DEFAULT_FACE_ID
;
19211 if (XBUFFER (buffer
) != current_buffer
)
19212 old_buffer
= current_buffer
;
19214 /* Save things including mode_line_proptrans_alist,
19215 and set that to nil so that we don't alter the outer value. */
19216 record_unwind_protect (unwind_format_mode_line
,
19217 format_mode_line_unwind_data
19218 (old_buffer
, selected_window
, 1));
19219 mode_line_proptrans_alist
= Qnil
;
19221 Fselect_window (window
, Qt
);
19223 set_buffer_internal_1 (XBUFFER (buffer
));
19225 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19229 mode_line_target
= MODE_LINE_NOPROP
;
19230 mode_line_string_face_prop
= Qnil
;
19231 mode_line_string_list
= Qnil
;
19232 string_start
= MODE_LINE_NOPROP_LEN (0);
19236 mode_line_target
= MODE_LINE_STRING
;
19237 mode_line_string_list
= Qnil
;
19238 mode_line_string_face
= face
;
19239 mode_line_string_face_prop
19240 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19243 push_kboard (FRAME_KBOARD (it
.f
));
19244 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19249 len
= MODE_LINE_NOPROP_LEN (string_start
);
19250 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19254 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19255 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19256 empty_unibyte_string
);
19259 unbind_to (count
, Qnil
);
19263 /* Write a null-terminated, right justified decimal representation of
19264 the positive integer D to BUF using a minimal field width WIDTH. */
19267 pint2str (buf
, width
, d
)
19268 register char *buf
;
19269 register int width
;
19272 register char *p
= buf
;
19280 *p
++ = d
% 10 + '0';
19285 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19296 /* Write a null-terminated, right justified decimal and "human
19297 readable" representation of the nonnegative integer D to BUF using
19298 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19300 static const char power_letter
[] =
19314 pint2hrstr (buf
, width
, d
)
19319 /* We aim to represent the nonnegative integer D as
19320 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19323 /* -1 means: do not use TENTHS. */
19327 /* Length of QUOTIENT.TENTHS as a string. */
19333 if (1000 <= quotient
)
19335 /* Scale to the appropriate EXPONENT. */
19338 remainder
= quotient
% 1000;
19342 while (1000 <= quotient
);
19344 /* Round to nearest and decide whether to use TENTHS or not. */
19347 tenths
= remainder
/ 100;
19348 if (50 <= remainder
% 100)
19355 if (quotient
== 10)
19363 if (500 <= remainder
)
19365 if (quotient
< 999)
19376 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19377 if (tenths
== -1 && quotient
<= 99)
19384 p
= psuffix
= buf
+ max (width
, length
);
19386 /* Print EXPONENT. */
19388 *psuffix
++ = power_letter
[exponent
];
19391 /* Print TENTHS. */
19394 *--p
= '0' + tenths
;
19398 /* Print QUOTIENT. */
19401 int digit
= quotient
% 10;
19402 *--p
= '0' + digit
;
19404 while ((quotient
/= 10) != 0);
19406 /* Print leading spaces. */
19411 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19412 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19413 type of CODING_SYSTEM. Return updated pointer into BUF. */
19415 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19418 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
19419 Lisp_Object coding_system
;
19420 register char *buf
;
19424 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19425 const unsigned char *eol_str
;
19427 /* The EOL conversion we are using. */
19428 Lisp_Object eoltype
;
19430 val
= CODING_SYSTEM_SPEC (coding_system
);
19433 if (!VECTORP (val
)) /* Not yet decided. */
19438 eoltype
= eol_mnemonic_undecided
;
19439 /* Don't mention EOL conversion if it isn't decided. */
19444 Lisp_Object eolvalue
;
19446 attrs
= AREF (val
, 0);
19447 eolvalue
= AREF (val
, 2);
19450 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19454 /* The EOL conversion that is normal on this system. */
19456 if (NILP (eolvalue
)) /* Not yet decided. */
19457 eoltype
= eol_mnemonic_undecided
;
19458 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19459 eoltype
= eol_mnemonic_undecided
;
19460 else /* eolvalue is Qunix, Qdos, or Qmac. */
19461 eoltype
= (EQ (eolvalue
, Qunix
)
19462 ? eol_mnemonic_unix
19463 : (EQ (eolvalue
, Qdos
) == 1
19464 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19470 /* Mention the EOL conversion if it is not the usual one. */
19471 if (STRINGP (eoltype
))
19473 eol_str
= SDATA (eoltype
);
19474 eol_str_len
= SBYTES (eoltype
);
19476 else if (CHARACTERP (eoltype
))
19478 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19479 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19484 eol_str
= invalid_eol_type
;
19485 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19487 bcopy (eol_str
, buf
, eol_str_len
);
19488 buf
+= eol_str_len
;
19494 /* Return a string for the output of a mode line %-spec for window W,
19495 generated by character C. PRECISION >= 0 means don't return a
19496 string longer than that value. FIELD_WIDTH > 0 means pad the
19497 string returned with spaces to that value. Return a Lisp string in
19498 *STRING if the resulting string is taken from that Lisp string.
19500 Note we operate on the current buffer for most purposes,
19501 the exception being w->base_line_pos. */
19503 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19506 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19509 int field_width
, precision
;
19510 Lisp_Object
*string
;
19513 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19514 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19515 struct buffer
*b
= current_buffer
;
19523 if (!NILP (b
->read_only
))
19525 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19530 /* This differs from %* only for a modified read-only buffer. */
19531 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19533 if (!NILP (b
->read_only
))
19538 /* This differs from %* in ignoring read-only-ness. */
19539 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19551 if (command_loop_level
> 5)
19553 p
= decode_mode_spec_buf
;
19554 for (i
= 0; i
< command_loop_level
; i
++)
19557 return decode_mode_spec_buf
;
19565 if (command_loop_level
> 5)
19567 p
= decode_mode_spec_buf
;
19568 for (i
= 0; i
< command_loop_level
; i
++)
19571 return decode_mode_spec_buf
;
19578 /* Let lots_of_dashes be a string of infinite length. */
19579 if (mode_line_target
== MODE_LINE_NOPROP
||
19580 mode_line_target
== MODE_LINE_STRING
)
19582 if (field_width
<= 0
19583 || field_width
> sizeof (lots_of_dashes
))
19585 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19586 decode_mode_spec_buf
[i
] = '-';
19587 decode_mode_spec_buf
[i
] = '\0';
19588 return decode_mode_spec_buf
;
19591 return lots_of_dashes
;
19599 /* %c and %l are ignored in `frame-title-format'.
19600 (In redisplay_internal, the frame title is drawn _before_ the
19601 windows are updated, so the stuff which depends on actual
19602 window contents (such as %l) may fail to render properly, or
19603 even crash emacs.) */
19604 if (mode_line_target
== MODE_LINE_TITLE
)
19608 int col
= (int) current_column (); /* iftc */
19609 w
->column_number_displayed
= make_number (col
);
19610 pint2str (decode_mode_spec_buf
, field_width
, col
);
19611 return decode_mode_spec_buf
;
19615 #ifndef SYSTEM_MALLOC
19617 if (NILP (Vmemory_full
))
19620 return "!MEM FULL! ";
19627 /* %F displays the frame name. */
19628 if (!NILP (f
->title
))
19629 return (char *) SDATA (f
->title
);
19630 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19631 return (char *) SDATA (f
->name
);
19640 int size
= ZV
- BEGV
;
19641 pint2str (decode_mode_spec_buf
, field_width
, size
);
19642 return decode_mode_spec_buf
;
19647 int size
= ZV
- BEGV
;
19648 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19649 return decode_mode_spec_buf
;
19654 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19655 int topline
, nlines
, junk
, height
;
19657 /* %c and %l are ignored in `frame-title-format'. */
19658 if (mode_line_target
== MODE_LINE_TITLE
)
19661 startpos
= XMARKER (w
->start
)->charpos
;
19662 startpos_byte
= marker_byte_position (w
->start
);
19663 height
= WINDOW_TOTAL_LINES (w
);
19665 /* If we decided that this buffer isn't suitable for line numbers,
19666 don't forget that too fast. */
19667 if (EQ (w
->base_line_pos
, w
->buffer
))
19669 /* But do forget it, if the window shows a different buffer now. */
19670 else if (BUFFERP (w
->base_line_pos
))
19671 w
->base_line_pos
= Qnil
;
19673 /* If the buffer is very big, don't waste time. */
19674 if (INTEGERP (Vline_number_display_limit
)
19675 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19677 w
->base_line_pos
= Qnil
;
19678 w
->base_line_number
= Qnil
;
19682 if (INTEGERP (w
->base_line_number
)
19683 && INTEGERP (w
->base_line_pos
)
19684 && XFASTINT (w
->base_line_pos
) <= startpos
)
19686 line
= XFASTINT (w
->base_line_number
);
19687 linepos
= XFASTINT (w
->base_line_pos
);
19688 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19693 linepos
= BUF_BEGV (b
);
19694 linepos_byte
= BUF_BEGV_BYTE (b
);
19697 /* Count lines from base line to window start position. */
19698 nlines
= display_count_lines (linepos
, linepos_byte
,
19702 topline
= nlines
+ line
;
19704 /* Determine a new base line, if the old one is too close
19705 or too far away, or if we did not have one.
19706 "Too close" means it's plausible a scroll-down would
19707 go back past it. */
19708 if (startpos
== BUF_BEGV (b
))
19710 w
->base_line_number
= make_number (topline
);
19711 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19713 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19714 || linepos
== BUF_BEGV (b
))
19716 int limit
= BUF_BEGV (b
);
19717 int limit_byte
= BUF_BEGV_BYTE (b
);
19719 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19721 if (startpos
- distance
> limit
)
19723 limit
= startpos
- distance
;
19724 limit_byte
= CHAR_TO_BYTE (limit
);
19727 nlines
= display_count_lines (startpos
, startpos_byte
,
19729 - (height
* 2 + 30),
19731 /* If we couldn't find the lines we wanted within
19732 line_number_display_limit_width chars per line,
19733 give up on line numbers for this window. */
19734 if (position
== limit_byte
&& limit
== startpos
- distance
)
19736 w
->base_line_pos
= w
->buffer
;
19737 w
->base_line_number
= Qnil
;
19741 w
->base_line_number
= make_number (topline
- nlines
);
19742 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19745 /* Now count lines from the start pos to point. */
19746 nlines
= display_count_lines (startpos
, startpos_byte
,
19747 PT_BYTE
, PT
, &junk
);
19749 /* Record that we did display the line number. */
19750 line_number_displayed
= 1;
19752 /* Make the string to show. */
19753 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19754 return decode_mode_spec_buf
;
19757 char* p
= decode_mode_spec_buf
;
19758 int pad
= field_width
- 2;
19764 return decode_mode_spec_buf
;
19770 obj
= b
->mode_name
;
19774 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19780 int pos
= marker_position (w
->start
);
19781 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19783 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19785 if (pos
<= BUF_BEGV (b
))
19790 else if (pos
<= BUF_BEGV (b
))
19794 if (total
> 1000000)
19795 /* Do it differently for a large value, to avoid overflow. */
19796 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19798 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19799 /* We can't normally display a 3-digit number,
19800 so get us a 2-digit number that is close. */
19803 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19804 return decode_mode_spec_buf
;
19808 /* Display percentage of size above the bottom of the screen. */
19811 int toppos
= marker_position (w
->start
);
19812 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19813 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19815 if (botpos
>= BUF_ZV (b
))
19817 if (toppos
<= BUF_BEGV (b
))
19824 if (total
> 1000000)
19825 /* Do it differently for a large value, to avoid overflow. */
19826 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19828 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19829 /* We can't normally display a 3-digit number,
19830 so get us a 2-digit number that is close. */
19833 if (toppos
<= BUF_BEGV (b
))
19834 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19836 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19837 return decode_mode_spec_buf
;
19842 /* status of process */
19843 obj
= Fget_buffer_process (Fcurrent_buffer ());
19845 return "no process";
19846 #ifdef subprocesses
19847 obj
= Fsymbol_name (Fprocess_status (obj
));
19853 int count
= inhibit_garbage_collection ();
19854 Lisp_Object val
= call1 (intern ("file-remote-p"),
19855 current_buffer
->directory
);
19856 unbind_to (count
, Qnil
);
19864 case 't': /* indicate TEXT or BINARY */
19865 #ifdef MODE_LINE_BINARY_TEXT
19866 return MODE_LINE_BINARY_TEXT (b
);
19872 /* coding-system (not including end-of-line format) */
19874 /* coding-system (including end-of-line type) */
19876 int eol_flag
= (c
== 'Z');
19877 char *p
= decode_mode_spec_buf
;
19879 if (! FRAME_WINDOW_P (f
))
19881 /* No need to mention EOL here--the terminal never needs
19882 to do EOL conversion. */
19883 p
= decode_mode_spec_coding (CODING_ID_NAME
19884 (FRAME_KEYBOARD_CODING (f
)->id
),
19886 p
= decode_mode_spec_coding (CODING_ID_NAME
19887 (FRAME_TERMINAL_CODING (f
)->id
),
19890 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19893 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19894 #ifdef subprocesses
19895 obj
= Fget_buffer_process (Fcurrent_buffer ());
19896 if (PROCESSP (obj
))
19898 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19900 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19903 #endif /* subprocesses */
19906 return decode_mode_spec_buf
;
19913 return (char *) SDATA (obj
);
19920 /* Count up to COUNT lines starting from START / START_BYTE.
19921 But don't go beyond LIMIT_BYTE.
19922 Return the number of lines thus found (always nonnegative).
19924 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19927 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19928 int start
, start_byte
, limit_byte
, count
;
19931 register unsigned char *cursor
;
19932 unsigned char *base
;
19934 register int ceiling
;
19935 register unsigned char *ceiling_addr
;
19936 int orig_count
= count
;
19938 /* If we are not in selective display mode,
19939 check only for newlines. */
19940 int selective_display
= (!NILP (current_buffer
->selective_display
)
19941 && !INTEGERP (current_buffer
->selective_display
));
19945 while (start_byte
< limit_byte
)
19947 ceiling
= BUFFER_CEILING_OF (start_byte
);
19948 ceiling
= min (limit_byte
- 1, ceiling
);
19949 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19950 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19953 if (selective_display
)
19954 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19957 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19960 if (cursor
!= ceiling_addr
)
19964 start_byte
+= cursor
- base
+ 1;
19965 *byte_pos_ptr
= start_byte
;
19969 if (++cursor
== ceiling_addr
)
19975 start_byte
+= cursor
- base
;
19980 while (start_byte
> limit_byte
)
19982 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19983 ceiling
= max (limit_byte
, ceiling
);
19984 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19985 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19988 if (selective_display
)
19989 while (--cursor
!= ceiling_addr
19990 && *cursor
!= '\n' && *cursor
!= 015)
19993 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19996 if (cursor
!= ceiling_addr
)
20000 start_byte
+= cursor
- base
+ 1;
20001 *byte_pos_ptr
= start_byte
;
20002 /* When scanning backwards, we should
20003 not count the newline posterior to which we stop. */
20004 return - orig_count
- 1;
20010 /* Here we add 1 to compensate for the last decrement
20011 of CURSOR, which took it past the valid range. */
20012 start_byte
+= cursor
- base
+ 1;
20016 *byte_pos_ptr
= limit_byte
;
20019 return - orig_count
+ count
;
20020 return orig_count
- count
;
20026 /***********************************************************************
20028 ***********************************************************************/
20030 /* Display a NUL-terminated string, starting with index START.
20032 If STRING is non-null, display that C string. Otherwise, the Lisp
20033 string LISP_STRING is displayed. There's a case that STRING is
20034 non-null and LISP_STRING is not nil. It means STRING is a string
20035 data of LISP_STRING. In that case, we display LISP_STRING while
20036 ignoring its text properties.
20038 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20039 FACE_STRING. Display STRING or LISP_STRING with the face at
20040 FACE_STRING_POS in FACE_STRING:
20042 Display the string in the environment given by IT, but use the
20043 standard display table, temporarily.
20045 FIELD_WIDTH is the minimum number of output glyphs to produce.
20046 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20047 with spaces. If STRING has more characters, more than FIELD_WIDTH
20048 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20050 PRECISION is the maximum number of characters to output from
20051 STRING. PRECISION < 0 means don't truncate the string.
20053 This is roughly equivalent to printf format specifiers:
20055 FIELD_WIDTH PRECISION PRINTF
20056 ----------------------------------------
20062 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20063 display them, and < 0 means obey the current buffer's value of
20064 enable_multibyte_characters.
20066 Value is the number of columns displayed. */
20069 display_string (string
, lisp_string
, face_string
, face_string_pos
,
20070 start
, it
, field_width
, precision
, max_x
, multibyte
)
20071 unsigned char *string
;
20072 Lisp_Object lisp_string
;
20073 Lisp_Object face_string
;
20074 EMACS_INT face_string_pos
;
20077 int field_width
, precision
, max_x
;
20080 int hpos_at_start
= it
->hpos
;
20081 int saved_face_id
= it
->face_id
;
20082 struct glyph_row
*row
= it
->glyph_row
;
20084 /* Initialize the iterator IT for iteration over STRING beginning
20085 with index START. */
20086 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20087 precision
, field_width
, multibyte
);
20088 if (string
&& STRINGP (lisp_string
))
20089 /* LISP_STRING is the one returned by decode_mode_spec. We should
20090 ignore its text properties. */
20091 it
->stop_charpos
= -1;
20093 /* If displaying STRING, set up the face of the iterator
20094 from LISP_STRING, if that's given. */
20095 if (STRINGP (face_string
))
20101 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20102 0, it
->region_beg_charpos
,
20103 it
->region_end_charpos
,
20104 &endptr
, it
->base_face_id
, 0);
20105 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20106 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20109 /* Set max_x to the maximum allowed X position. Don't let it go
20110 beyond the right edge of the window. */
20112 max_x
= it
->last_visible_x
;
20114 max_x
= min (max_x
, it
->last_visible_x
);
20116 /* Skip over display elements that are not visible. because IT->w is
20118 if (it
->current_x
< it
->first_visible_x
)
20119 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20120 MOVE_TO_POS
| MOVE_TO_X
);
20122 row
->ascent
= it
->max_ascent
;
20123 row
->height
= it
->max_ascent
+ it
->max_descent
;
20124 row
->phys_ascent
= it
->max_phys_ascent
;
20125 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20126 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20128 /* This condition is for the case that we are called with current_x
20129 past last_visible_x. */
20130 while (it
->current_x
< max_x
)
20132 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20134 /* Get the next display element. */
20135 if (!get_next_display_element (it
))
20138 /* Produce glyphs. */
20139 x_before
= it
->current_x
;
20140 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20141 PRODUCE_GLYPHS (it
);
20143 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20146 while (i
< nglyphs
)
20148 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20150 if (it
->line_wrap
!= TRUNCATE
20151 && x
+ glyph
->pixel_width
> max_x
)
20153 /* End of continued line or max_x reached. */
20154 if (CHAR_GLYPH_PADDING_P (*glyph
))
20156 /* A wide character is unbreakable. */
20157 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20158 it
->current_x
= x_before
;
20162 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20167 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20169 /* Glyph is at least partially visible. */
20171 if (x
< it
->first_visible_x
)
20172 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20176 /* Glyph is off the left margin of the display area.
20177 Should not happen. */
20181 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20182 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20183 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20184 row
->phys_height
= max (row
->phys_height
,
20185 it
->max_phys_ascent
+ it
->max_phys_descent
);
20186 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20187 it
->max_extra_line_spacing
);
20188 x
+= glyph
->pixel_width
;
20192 /* Stop if max_x reached. */
20196 /* Stop at line ends. */
20197 if (ITERATOR_AT_END_OF_LINE_P (it
))
20199 it
->continuation_lines_width
= 0;
20203 set_iterator_to_next (it
, 1);
20205 /* Stop if truncating at the right edge. */
20206 if (it
->line_wrap
== TRUNCATE
20207 && it
->current_x
>= it
->last_visible_x
)
20209 /* Add truncation mark, but don't do it if the line is
20210 truncated at a padding space. */
20211 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20213 if (!FRAME_WINDOW_P (it
->f
))
20217 if (it
->current_x
> it
->last_visible_x
)
20219 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20220 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20222 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20224 row
->used
[TEXT_AREA
] = i
;
20225 produce_special_glyphs (it
, IT_TRUNCATION
);
20228 produce_special_glyphs (it
, IT_TRUNCATION
);
20230 it
->glyph_row
->truncated_on_right_p
= 1;
20236 /* Maybe insert a truncation at the left. */
20237 if (it
->first_visible_x
20238 && IT_CHARPOS (*it
) > 0)
20240 if (!FRAME_WINDOW_P (it
->f
))
20241 insert_left_trunc_glyphs (it
);
20242 it
->glyph_row
->truncated_on_left_p
= 1;
20245 it
->face_id
= saved_face_id
;
20247 /* Value is number of columns displayed. */
20248 return it
->hpos
- hpos_at_start
;
20253 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20254 appears as an element of LIST or as the car of an element of LIST.
20255 If PROPVAL is a list, compare each element against LIST in that
20256 way, and return 1/2 if any element of PROPVAL is found in LIST.
20257 Otherwise return 0. This function cannot quit.
20258 The return value is 2 if the text is invisible but with an ellipsis
20259 and 1 if it's invisible and without an ellipsis. */
20262 invisible_p (propval
, list
)
20263 register Lisp_Object propval
;
20266 register Lisp_Object tail
, proptail
;
20268 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20270 register Lisp_Object tem
;
20272 if (EQ (propval
, tem
))
20274 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20275 return NILP (XCDR (tem
)) ? 1 : 2;
20278 if (CONSP (propval
))
20280 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20282 Lisp_Object propelt
;
20283 propelt
= XCAR (proptail
);
20284 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20286 register Lisp_Object tem
;
20288 if (EQ (propelt
, tem
))
20290 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20291 return NILP (XCDR (tem
)) ? 1 : 2;
20299 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20300 doc
: /* Non-nil if the property makes the text invisible.
20301 POS-OR-PROP can be a marker or number, in which case it is taken to be
20302 a position in the current buffer and the value of the `invisible' property
20303 is checked; or it can be some other value, which is then presumed to be the
20304 value of the `invisible' property of the text of interest.
20305 The non-nil value returned can be t for truly invisible text or something
20306 else if the text is replaced by an ellipsis. */)
20308 Lisp_Object pos_or_prop
;
20311 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20312 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20314 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20315 return (invis
== 0 ? Qnil
20317 : make_number (invis
));
20320 /* Calculate a width or height in pixels from a specification using
20321 the following elements:
20324 NUM - a (fractional) multiple of the default font width/height
20325 (NUM) - specifies exactly NUM pixels
20326 UNIT - a fixed number of pixels, see below.
20327 ELEMENT - size of a display element in pixels, see below.
20328 (NUM . SPEC) - equals NUM * SPEC
20329 (+ SPEC SPEC ...) - add pixel values
20330 (- SPEC SPEC ...) - subtract pixel values
20331 (- SPEC) - negate pixel value
20334 INT or FLOAT - a number constant
20335 SYMBOL - use symbol's (buffer local) variable binding.
20338 in - pixels per inch *)
20339 mm - pixels per 1/1000 meter *)
20340 cm - pixels per 1/100 meter *)
20341 width - width of current font in pixels.
20342 height - height of current font in pixels.
20344 *) using the ratio(s) defined in display-pixels-per-inch.
20348 left-fringe - left fringe width in pixels
20349 right-fringe - right fringe width in pixels
20351 left-margin - left margin width in pixels
20352 right-margin - right margin width in pixels
20354 scroll-bar - scroll-bar area width in pixels
20358 Pixels corresponding to 5 inches:
20361 Total width of non-text areas on left side of window (if scroll-bar is on left):
20362 '(space :width (+ left-fringe left-margin scroll-bar))
20364 Align to first text column (in header line):
20365 '(space :align-to 0)
20367 Align to middle of text area minus half the width of variable `my-image'
20368 containing a loaded image:
20369 '(space :align-to (0.5 . (- text my-image)))
20371 Width of left margin minus width of 1 character in the default font:
20372 '(space :width (- left-margin 1))
20374 Width of left margin minus width of 2 characters in the current font:
20375 '(space :width (- left-margin (2 . width)))
20377 Center 1 character over left-margin (in header line):
20378 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20380 Different ways to express width of left fringe plus left margin minus one pixel:
20381 '(space :width (- (+ left-fringe left-margin) (1)))
20382 '(space :width (+ left-fringe left-margin (- (1))))
20383 '(space :width (+ left-fringe left-margin (-1)))
20387 #define NUMVAL(X) \
20388 ((INTEGERP (X) || FLOATP (X)) \
20393 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
20398 int width_p
, *align_to
;
20402 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20403 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20406 return OK_PIXELS (0);
20408 xassert (FRAME_LIVE_P (it
->f
));
20410 if (SYMBOLP (prop
))
20412 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20414 char *unit
= SDATA (SYMBOL_NAME (prop
));
20416 if (unit
[0] == 'i' && unit
[1] == 'n')
20418 else if (unit
[0] == 'm' && unit
[1] == 'm')
20420 else if (unit
[0] == 'c' && unit
[1] == 'm')
20427 #ifdef HAVE_WINDOW_SYSTEM
20428 if (FRAME_WINDOW_P (it
->f
)
20430 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20431 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20433 return OK_PIXELS (ppi
/ pixels
);
20436 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20437 || (CONSP (Vdisplay_pixels_per_inch
)
20439 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20440 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20442 return OK_PIXELS (ppi
/ pixels
);
20448 #ifdef HAVE_WINDOW_SYSTEM
20449 if (EQ (prop
, Qheight
))
20450 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20451 if (EQ (prop
, Qwidth
))
20452 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20454 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20455 return OK_PIXELS (1);
20458 if (EQ (prop
, Qtext
))
20459 return OK_PIXELS (width_p
20460 ? window_box_width (it
->w
, TEXT_AREA
)
20461 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20463 if (align_to
&& *align_to
< 0)
20466 if (EQ (prop
, Qleft
))
20467 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20468 if (EQ (prop
, Qright
))
20469 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20470 if (EQ (prop
, Qcenter
))
20471 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20472 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20473 if (EQ (prop
, Qleft_fringe
))
20474 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20475 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20476 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20477 if (EQ (prop
, Qright_fringe
))
20478 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20479 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20480 : window_box_right_offset (it
->w
, TEXT_AREA
));
20481 if (EQ (prop
, Qleft_margin
))
20482 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20483 if (EQ (prop
, Qright_margin
))
20484 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20485 if (EQ (prop
, Qscroll_bar
))
20486 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20488 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20489 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20490 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20495 if (EQ (prop
, Qleft_fringe
))
20496 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20497 if (EQ (prop
, Qright_fringe
))
20498 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20499 if (EQ (prop
, Qleft_margin
))
20500 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20501 if (EQ (prop
, Qright_margin
))
20502 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20503 if (EQ (prop
, Qscroll_bar
))
20504 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20507 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20510 if (INTEGERP (prop
) || FLOATP (prop
))
20512 int base_unit
= (width_p
20513 ? FRAME_COLUMN_WIDTH (it
->f
)
20514 : FRAME_LINE_HEIGHT (it
->f
));
20515 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20520 Lisp_Object car
= XCAR (prop
);
20521 Lisp_Object cdr
= XCDR (prop
);
20525 #ifdef HAVE_WINDOW_SYSTEM
20526 if (FRAME_WINDOW_P (it
->f
)
20527 && valid_image_p (prop
))
20529 int id
= lookup_image (it
->f
, prop
);
20530 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20532 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20535 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20541 while (CONSP (cdr
))
20543 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20544 font
, width_p
, align_to
))
20547 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20552 if (EQ (car
, Qminus
))
20554 return OK_PIXELS (pixels
);
20557 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20560 if (INTEGERP (car
) || FLOATP (car
))
20563 pixels
= XFLOATINT (car
);
20565 return OK_PIXELS (pixels
);
20566 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20567 font
, width_p
, align_to
))
20568 return OK_PIXELS (pixels
* fact
);
20579 /***********************************************************************
20581 ***********************************************************************/
20583 #ifdef HAVE_WINDOW_SYSTEM
20588 dump_glyph_string (s
)
20589 struct glyph_string
*s
;
20591 fprintf (stderr
, "glyph string\n");
20592 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20593 s
->x
, s
->y
, s
->width
, s
->height
);
20594 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20595 fprintf (stderr
, " hl = %d\n", s
->hl
);
20596 fprintf (stderr
, " left overhang = %d, right = %d\n",
20597 s
->left_overhang
, s
->right_overhang
);
20598 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20599 fprintf (stderr
, " extends to end of line = %d\n",
20600 s
->extends_to_end_of_line_p
);
20601 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20602 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20605 #endif /* GLYPH_DEBUG */
20607 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20608 of XChar2b structures for S; it can't be allocated in
20609 init_glyph_string because it must be allocated via `alloca'. W
20610 is the window on which S is drawn. ROW and AREA are the glyph row
20611 and area within the row from which S is constructed. START is the
20612 index of the first glyph structure covered by S. HL is a
20613 face-override for drawing S. */
20616 #define OPTIONAL_HDC(hdc) hdc,
20617 #define DECLARE_HDC(hdc) HDC hdc;
20618 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20619 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20622 #ifndef OPTIONAL_HDC
20623 #define OPTIONAL_HDC(hdc)
20624 #define DECLARE_HDC(hdc)
20625 #define ALLOCATE_HDC(hdc, f)
20626 #define RELEASE_HDC(hdc, f)
20630 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20631 struct glyph_string
*s
;
20635 struct glyph_row
*row
;
20636 enum glyph_row_area area
;
20638 enum draw_glyphs_face hl
;
20640 bzero (s
, sizeof *s
);
20642 s
->f
= XFRAME (w
->frame
);
20646 s
->display
= FRAME_X_DISPLAY (s
->f
);
20647 s
->window
= FRAME_X_WINDOW (s
->f
);
20648 s
->char2b
= char2b
;
20652 s
->first_glyph
= row
->glyphs
[area
] + start
;
20653 s
->height
= row
->height
;
20654 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20655 s
->ybase
= s
->y
+ row
->ascent
;
20659 /* Append the list of glyph strings with head H and tail T to the list
20660 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20663 append_glyph_string_lists (head
, tail
, h
, t
)
20664 struct glyph_string
**head
, **tail
;
20665 struct glyph_string
*h
, *t
;
20679 /* Prepend the list of glyph strings with head H and tail T to the
20680 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20684 prepend_glyph_string_lists (head
, tail
, h
, t
)
20685 struct glyph_string
**head
, **tail
;
20686 struct glyph_string
*h
, *t
;
20700 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20701 Set *HEAD and *TAIL to the resulting list. */
20704 append_glyph_string (head
, tail
, s
)
20705 struct glyph_string
**head
, **tail
;
20706 struct glyph_string
*s
;
20708 s
->next
= s
->prev
= NULL
;
20709 append_glyph_string_lists (head
, tail
, s
, s
);
20713 /* Get face and two-byte form of character C in face FACE_ID on frame
20714 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20715 means we want to display multibyte text. DISPLAY_P non-zero means
20716 make sure that X resources for the face returned are allocated.
20717 Value is a pointer to a realized face that is ready for display if
20718 DISPLAY_P is non-zero. */
20720 static INLINE
struct face
*
20721 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20725 int multibyte_p
, display_p
;
20727 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20731 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20733 if (code
!= FONT_INVALID_CODE
)
20734 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20736 STORE_XCHAR2B (char2b
, 0, 0);
20739 /* Make sure X resources of the face are allocated. */
20740 #ifdef HAVE_X_WINDOWS
20744 xassert (face
!= NULL
);
20745 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20752 /* Get face and two-byte form of character glyph GLYPH on frame F.
20753 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20754 a pointer to a realized face that is ready for display. */
20756 static INLINE
struct face
*
20757 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20759 struct glyph
*glyph
;
20765 xassert (glyph
->type
== CHAR_GLYPH
);
20766 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20773 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20775 if (code
!= FONT_INVALID_CODE
)
20776 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20778 STORE_XCHAR2B (char2b
, 0, 0);
20781 /* Make sure X resources of the face are allocated. */
20782 xassert (face
!= NULL
);
20783 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20788 /* Fill glyph string S with composition components specified by S->cmp.
20790 BASE_FACE is the base face of the composition.
20791 S->cmp_from is the index of the first component for S.
20793 OVERLAPS non-zero means S should draw the foreground only, and use
20794 its physical height for clipping. See also draw_glyphs.
20796 Value is the index of a component not in S. */
20799 fill_composite_glyph_string (s
, base_face
, overlaps
)
20800 struct glyph_string
*s
;
20801 struct face
*base_face
;
20805 /* For all glyphs of this composition, starting at the offset
20806 S->cmp_from, until we reach the end of the definition or encounter a
20807 glyph that requires the different face, add it to S. */
20812 s
->for_overlaps
= overlaps
;
20815 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20817 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20821 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20824 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20825 s
->char2b
+ i
, 1, 1);
20831 s
->font
= s
->face
->font
;
20833 else if (s
->face
!= face
)
20841 /* All glyph strings for the same composition has the same width,
20842 i.e. the width set for the first component of the composition. */
20843 s
->width
= s
->first_glyph
->pixel_width
;
20845 /* If the specified font could not be loaded, use the frame's
20846 default font, but record the fact that we couldn't load it in
20847 the glyph string so that we can draw rectangles for the
20848 characters of the glyph string. */
20849 if (s
->font
== NULL
)
20851 s
->font_not_found_p
= 1;
20852 s
->font
= FRAME_FONT (s
->f
);
20855 /* Adjust base line for subscript/superscript text. */
20856 s
->ybase
+= s
->first_glyph
->voffset
;
20858 /* This glyph string must always be drawn with 16-bit functions. */
20865 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20866 struct glyph_string
*s
;
20868 int start
, end
, overlaps
;
20870 struct glyph
*glyph
, *last
;
20871 Lisp_Object lgstring
;
20874 s
->for_overlaps
= overlaps
;
20875 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20876 last
= s
->row
->glyphs
[s
->area
] + end
;
20877 s
->cmp_id
= glyph
->u
.cmp
.id
;
20878 s
->cmp_from
= glyph
->u
.cmp
.from
;
20879 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20880 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20881 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20882 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20884 while (glyph
< last
20885 && glyph
->u
.cmp
.automatic
20886 && glyph
->u
.cmp
.id
== s
->cmp_id
20887 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20888 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20890 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20892 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20893 unsigned code
= LGLYPH_CODE (lglyph
);
20895 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20897 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20898 return glyph
- s
->row
->glyphs
[s
->area
];
20902 /* Fill glyph string S from a sequence of character glyphs.
20904 FACE_ID is the face id of the string. START is the index of the
20905 first glyph to consider, END is the index of the last + 1.
20906 OVERLAPS non-zero means S should draw the foreground only, and use
20907 its physical height for clipping. See also draw_glyphs.
20909 Value is the index of the first glyph not in S. */
20912 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20913 struct glyph_string
*s
;
20915 int start
, end
, overlaps
;
20917 struct glyph
*glyph
, *last
;
20919 int glyph_not_available_p
;
20921 xassert (s
->f
== XFRAME (s
->w
->frame
));
20922 xassert (s
->nchars
== 0);
20923 xassert (start
>= 0 && end
> start
);
20925 s
->for_overlaps
= overlaps
;
20926 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20927 last
= s
->row
->glyphs
[s
->area
] + end
;
20928 voffset
= glyph
->voffset
;
20929 s
->padding_p
= glyph
->padding_p
;
20930 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20932 while (glyph
< last
20933 && glyph
->type
== CHAR_GLYPH
20934 && glyph
->voffset
== voffset
20935 /* Same face id implies same font, nowadays. */
20936 && glyph
->face_id
== face_id
20937 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20941 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20942 s
->char2b
+ s
->nchars
,
20944 s
->two_byte_p
= two_byte_p
;
20946 xassert (s
->nchars
<= end
- start
);
20947 s
->width
+= glyph
->pixel_width
;
20948 if (glyph
++->padding_p
!= s
->padding_p
)
20952 s
->font
= s
->face
->font
;
20954 /* If the specified font could not be loaded, use the frame's font,
20955 but record the fact that we couldn't load it in
20956 S->font_not_found_p so that we can draw rectangles for the
20957 characters of the glyph string. */
20958 if (s
->font
== NULL
|| glyph_not_available_p
)
20960 s
->font_not_found_p
= 1;
20961 s
->font
= FRAME_FONT (s
->f
);
20964 /* Adjust base line for subscript/superscript text. */
20965 s
->ybase
+= voffset
;
20967 xassert (s
->face
&& s
->face
->gc
);
20968 return glyph
- s
->row
->glyphs
[s
->area
];
20972 /* Fill glyph string S from image glyph S->first_glyph. */
20975 fill_image_glyph_string (s
)
20976 struct glyph_string
*s
;
20978 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20979 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20981 s
->slice
= s
->first_glyph
->slice
;
20982 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20983 s
->font
= s
->face
->font
;
20984 s
->width
= s
->first_glyph
->pixel_width
;
20986 /* Adjust base line for subscript/superscript text. */
20987 s
->ybase
+= s
->first_glyph
->voffset
;
20991 /* Fill glyph string S from a sequence of stretch glyphs.
20993 ROW is the glyph row in which the glyphs are found, AREA is the
20994 area within the row. START is the index of the first glyph to
20995 consider, END is the index of the last + 1.
20997 Value is the index of the first glyph not in S. */
21000 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
21001 struct glyph_string
*s
;
21002 struct glyph_row
*row
;
21003 enum glyph_row_area area
;
21006 struct glyph
*glyph
, *last
;
21007 int voffset
, face_id
;
21009 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21011 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21012 last
= s
->row
->glyphs
[s
->area
] + end
;
21013 face_id
= glyph
->face_id
;
21014 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21015 s
->font
= s
->face
->font
;
21016 s
->width
= glyph
->pixel_width
;
21018 voffset
= glyph
->voffset
;
21022 && glyph
->type
== STRETCH_GLYPH
21023 && glyph
->voffset
== voffset
21024 && glyph
->face_id
== face_id
);
21026 s
->width
+= glyph
->pixel_width
;
21028 /* Adjust base line for subscript/superscript text. */
21029 s
->ybase
+= voffset
;
21031 /* The case that face->gc == 0 is handled when drawing the glyph
21032 string by calling PREPARE_FACE_FOR_DISPLAY. */
21034 return glyph
- s
->row
->glyphs
[s
->area
];
21037 static struct font_metrics
*
21038 get_per_char_metric (f
, font
, char2b
)
21043 static struct font_metrics metrics
;
21044 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21046 if (! font
|| code
== FONT_INVALID_CODE
)
21048 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21053 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21054 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21055 assumed to be zero. */
21058 x_get_glyph_overhangs (glyph
, f
, left
, right
)
21059 struct glyph
*glyph
;
21063 *left
= *right
= 0;
21065 if (glyph
->type
== CHAR_GLYPH
)
21069 struct font_metrics
*pcm
;
21071 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21072 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
21074 if (pcm
->rbearing
> pcm
->width
)
21075 *right
= pcm
->rbearing
- pcm
->width
;
21076 if (pcm
->lbearing
< 0)
21077 *left
= -pcm
->lbearing
;
21080 else if (glyph
->type
== COMPOSITE_GLYPH
)
21082 if (! glyph
->u
.cmp
.automatic
)
21084 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21086 if (cmp
->rbearing
> cmp
->pixel_width
)
21087 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21088 if (cmp
->lbearing
< 0)
21089 *left
= - cmp
->lbearing
;
21093 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21094 struct font_metrics metrics
;
21096 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
21097 glyph
->u
.cmp
.to
+ 1, &metrics
);
21098 if (metrics
.rbearing
> metrics
.width
)
21099 *right
= metrics
.rbearing
- metrics
.width
;
21100 if (metrics
.lbearing
< 0)
21101 *left
= - metrics
.lbearing
;
21107 /* Return the index of the first glyph preceding glyph string S that
21108 is overwritten by S because of S's left overhang. Value is -1
21109 if no glyphs are overwritten. */
21112 left_overwritten (s
)
21113 struct glyph_string
*s
;
21117 if (s
->left_overhang
)
21120 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21121 int first
= s
->first_glyph
- glyphs
;
21123 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21124 x
-= glyphs
[i
].pixel_width
;
21135 /* Return the index of the first glyph preceding glyph string S that
21136 is overwriting S because of its right overhang. Value is -1 if no
21137 glyph in front of S overwrites S. */
21140 left_overwriting (s
)
21141 struct glyph_string
*s
;
21144 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21145 int first
= s
->first_glyph
- glyphs
;
21149 for (i
= first
- 1; i
>= 0; --i
)
21152 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21155 x
-= glyphs
[i
].pixel_width
;
21162 /* Return the index of the last glyph following glyph string S that is
21163 overwritten by S because of S's right overhang. Value is -1 if
21164 no such glyph is found. */
21167 right_overwritten (s
)
21168 struct glyph_string
*s
;
21172 if (s
->right_overhang
)
21175 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21176 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21177 int end
= s
->row
->used
[s
->area
];
21179 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21180 x
+= glyphs
[i
].pixel_width
;
21189 /* Return the index of the last glyph following glyph string S that
21190 overwrites S because of its left overhang. Value is negative
21191 if no such glyph is found. */
21194 right_overwriting (s
)
21195 struct glyph_string
*s
;
21198 int end
= s
->row
->used
[s
->area
];
21199 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21200 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21204 for (i
= first
; i
< end
; ++i
)
21207 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21210 x
+= glyphs
[i
].pixel_width
;
21217 /* Set background width of glyph string S. START is the index of the
21218 first glyph following S. LAST_X is the right-most x-position + 1
21219 in the drawing area. */
21222 set_glyph_string_background_width (s
, start
, last_x
)
21223 struct glyph_string
*s
;
21227 /* If the face of this glyph string has to be drawn to the end of
21228 the drawing area, set S->extends_to_end_of_line_p. */
21230 if (start
== s
->row
->used
[s
->area
]
21231 && s
->area
== TEXT_AREA
21232 && ((s
->row
->fill_line_p
21233 && (s
->hl
== DRAW_NORMAL_TEXT
21234 || s
->hl
== DRAW_IMAGE_RAISED
21235 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21236 || s
->hl
== DRAW_MOUSE_FACE
))
21237 s
->extends_to_end_of_line_p
= 1;
21239 /* If S extends its face to the end of the line, set its
21240 background_width to the distance to the right edge of the drawing
21242 if (s
->extends_to_end_of_line_p
)
21243 s
->background_width
= last_x
- s
->x
+ 1;
21245 s
->background_width
= s
->width
;
21249 /* Compute overhangs and x-positions for glyph string S and its
21250 predecessors, or successors. X is the starting x-position for S.
21251 BACKWARD_P non-zero means process predecessors. */
21254 compute_overhangs_and_x (s
, x
, backward_p
)
21255 struct glyph_string
*s
;
21263 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21264 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21274 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21275 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21285 /* The following macros are only called from draw_glyphs below.
21286 They reference the following parameters of that function directly:
21287 `w', `row', `area', and `overlap_p'
21288 as well as the following local variables:
21289 `s', `f', and `hdc' (in W32) */
21292 /* On W32, silently add local `hdc' variable to argument list of
21293 init_glyph_string. */
21294 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21295 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21297 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21298 init_glyph_string (s, char2b, w, row, area, start, hl)
21301 /* Add a glyph string for a stretch glyph to the list of strings
21302 between HEAD and TAIL. START is the index of the stretch glyph in
21303 row area AREA of glyph row ROW. END is the index of the last glyph
21304 in that glyph row area. X is the current output position assigned
21305 to the new glyph string constructed. HL overrides that face of the
21306 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21307 is the right-most x-position of the drawing area. */
21309 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21310 and below -- keep them on one line. */
21311 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21314 s = (struct glyph_string *) alloca (sizeof *s); \
21315 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21316 START = fill_stretch_glyph_string (s, row, area, START, END); \
21317 append_glyph_string (&HEAD, &TAIL, s); \
21323 /* Add a glyph string for an image glyph to the list of strings
21324 between HEAD and TAIL. START is the index of the image glyph in
21325 row area AREA of glyph row ROW. END is the index of the last glyph
21326 in that glyph row area. X is the current output position assigned
21327 to the new glyph string constructed. HL overrides that face of the
21328 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21329 is the right-most x-position of the drawing area. */
21331 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21334 s = (struct glyph_string *) alloca (sizeof *s); \
21335 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21336 fill_image_glyph_string (s); \
21337 append_glyph_string (&HEAD, &TAIL, s); \
21344 /* Add a glyph string for a sequence of character glyphs to the list
21345 of strings between HEAD and TAIL. START is the index of the first
21346 glyph in row area AREA of glyph row ROW that is part of the new
21347 glyph string. END is the index of the last glyph in that glyph row
21348 area. X is the current output position assigned to the new glyph
21349 string constructed. HL overrides that face of the glyph; e.g. it
21350 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21351 right-most x-position of the drawing area. */
21353 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21359 face_id = (row)->glyphs[area][START].face_id; \
21361 s = (struct glyph_string *) alloca (sizeof *s); \
21362 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21363 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21364 append_glyph_string (&HEAD, &TAIL, s); \
21366 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21371 /* Add a glyph string for a composite sequence to the list of strings
21372 between HEAD and TAIL. START is the index of the first glyph in
21373 row area AREA of glyph row ROW that is part of the new glyph
21374 string. END is the index of the last glyph in that glyph row area.
21375 X is the current output position assigned to the new glyph string
21376 constructed. HL overrides that face of the glyph; e.g. it is
21377 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21378 x-position of the drawing area. */
21380 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21382 int face_id = (row)->glyphs[area][START].face_id; \
21383 struct face *base_face = FACE_FROM_ID (f, face_id); \
21384 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21385 struct composition *cmp = composition_table[cmp_id]; \
21387 struct glyph_string *first_s; \
21390 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21392 /* Make glyph_strings for each glyph sequence that is drawable by \
21393 the same face, and append them to HEAD/TAIL. */ \
21394 for (n = 0; n < cmp->glyph_len;) \
21396 s = (struct glyph_string *) alloca (sizeof *s); \
21397 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21398 append_glyph_string (&(HEAD), &(TAIL), s); \
21404 n = fill_composite_glyph_string (s, base_face, overlaps); \
21412 /* Add a glyph string for a glyph-string sequence to the list of strings
21413 between HEAD and TAIL. */
21415 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21419 Lisp_Object gstring; \
21421 face_id = (row)->glyphs[area][START].face_id; \
21422 gstring = (composition_gstring_from_id \
21423 ((row)->glyphs[area][START].u.cmp.id)); \
21424 s = (struct glyph_string *) alloca (sizeof *s); \
21425 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21426 * LGSTRING_GLYPH_LEN (gstring)); \
21427 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21428 append_glyph_string (&(HEAD), &(TAIL), s); \
21430 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21434 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21435 of AREA of glyph row ROW on window W between indices START and END.
21436 HL overrides the face for drawing glyph strings, e.g. it is
21437 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21438 x-positions of the drawing area.
21440 This is an ugly monster macro construct because we must use alloca
21441 to allocate glyph strings (because draw_glyphs can be called
21442 asynchronously). */
21444 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21447 HEAD = TAIL = NULL; \
21448 while (START < END) \
21450 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21451 switch (first_glyph->type) \
21454 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21458 case COMPOSITE_GLYPH: \
21459 if (first_glyph->u.cmp.automatic) \
21460 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21463 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21467 case STRETCH_GLYPH: \
21468 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21472 case IMAGE_GLYPH: \
21473 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21483 set_glyph_string_background_width (s, START, LAST_X); \
21490 /* Draw glyphs between START and END in AREA of ROW on window W,
21491 starting at x-position X. X is relative to AREA in W. HL is a
21492 face-override with the following meaning:
21494 DRAW_NORMAL_TEXT draw normally
21495 DRAW_CURSOR draw in cursor face
21496 DRAW_MOUSE_FACE draw in mouse face.
21497 DRAW_INVERSE_VIDEO draw in mode line face
21498 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21499 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21501 If OVERLAPS is non-zero, draw only the foreground of characters and
21502 clip to the physical height of ROW. Non-zero value also defines
21503 the overlapping part to be drawn:
21505 OVERLAPS_PRED overlap with preceding rows
21506 OVERLAPS_SUCC overlap with succeeding rows
21507 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21508 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21510 Value is the x-position reached, relative to AREA of W. */
21513 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21516 struct glyph_row
*row
;
21517 enum glyph_row_area area
;
21518 EMACS_INT start
, end
;
21519 enum draw_glyphs_face hl
;
21522 struct glyph_string
*head
, *tail
;
21523 struct glyph_string
*s
;
21524 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21525 int i
, j
, x_reached
, last_x
, area_left
= 0;
21526 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21529 ALLOCATE_HDC (hdc
, f
);
21531 /* Let's rather be paranoid than getting a SEGV. */
21532 end
= min (end
, row
->used
[area
]);
21533 start
= max (0, start
);
21534 start
= min (end
, start
);
21536 /* Translate X to frame coordinates. Set last_x to the right
21537 end of the drawing area. */
21538 if (row
->full_width_p
)
21540 /* X is relative to the left edge of W, without scroll bars
21542 area_left
= WINDOW_LEFT_EDGE_X (w
);
21543 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21547 area_left
= window_box_left (w
, area
);
21548 last_x
= area_left
+ window_box_width (w
, area
);
21552 /* Build a doubly-linked list of glyph_string structures between
21553 head and tail from what we have to draw. Note that the macro
21554 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21555 the reason we use a separate variable `i'. */
21557 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21559 x_reached
= tail
->x
+ tail
->background_width
;
21563 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21564 the row, redraw some glyphs in front or following the glyph
21565 strings built above. */
21566 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21568 struct glyph_string
*h
, *t
;
21569 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21570 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21573 /* If mouse highlighting is on, we may need to draw adjacent
21574 glyphs using mouse-face highlighting. */
21575 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21577 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21579 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21580 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21582 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21584 check_mouse_face
= 1;
21585 mouse_beg_col
= (row
== mouse_beg_row
)
21586 ? dpyinfo
->mouse_face_beg_col
: 0;
21587 mouse_end_col
= (row
== mouse_end_row
)
21588 ? dpyinfo
->mouse_face_end_col
21589 : row
->used
[TEXT_AREA
];
21593 /* Compute overhangs for all glyph strings. */
21594 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21595 for (s
= head
; s
; s
= s
->next
)
21596 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21598 /* Prepend glyph strings for glyphs in front of the first glyph
21599 string that are overwritten because of the first glyph
21600 string's left overhang. The background of all strings
21601 prepended must be drawn because the first glyph string
21603 i
= left_overwritten (head
);
21606 enum draw_glyphs_face overlap_hl
;
21608 /* If this row contains mouse highlighting, attempt to draw
21609 the overlapped glyphs with the correct highlight. This
21610 code fails if the overlap encompasses more than one glyph
21611 and mouse-highlight spans only some of these glyphs.
21612 However, making it work perfectly involves a lot more
21613 code, and I don't know if the pathological case occurs in
21614 practice, so we'll stick to this for now. --- cyd */
21615 if (check_mouse_face
21616 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21617 overlap_hl
= DRAW_MOUSE_FACE
;
21619 overlap_hl
= DRAW_NORMAL_TEXT
;
21622 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21623 overlap_hl
, dummy_x
, last_x
);
21625 compute_overhangs_and_x (t
, head
->x
, 1);
21626 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21630 /* Prepend glyph strings for glyphs in front of the first glyph
21631 string that overwrite that glyph string because of their
21632 right overhang. For these strings, only the foreground must
21633 be drawn, because it draws over the glyph string at `head'.
21634 The background must not be drawn because this would overwrite
21635 right overhangs of preceding glyphs for which no glyph
21637 i
= left_overwriting (head
);
21640 enum draw_glyphs_face overlap_hl
;
21642 if (check_mouse_face
21643 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21644 overlap_hl
= DRAW_MOUSE_FACE
;
21646 overlap_hl
= DRAW_NORMAL_TEXT
;
21649 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21650 overlap_hl
, dummy_x
, last_x
);
21651 for (s
= h
; s
; s
= s
->next
)
21652 s
->background_filled_p
= 1;
21653 compute_overhangs_and_x (t
, head
->x
, 1);
21654 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21657 /* Append glyphs strings for glyphs following the last glyph
21658 string tail that are overwritten by tail. The background of
21659 these strings has to be drawn because tail's foreground draws
21661 i
= right_overwritten (tail
);
21664 enum draw_glyphs_face overlap_hl
;
21666 if (check_mouse_face
21667 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21668 overlap_hl
= DRAW_MOUSE_FACE
;
21670 overlap_hl
= DRAW_NORMAL_TEXT
;
21672 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21673 overlap_hl
, x
, last_x
);
21674 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21675 we don't have `end = i;' here. */
21676 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21677 append_glyph_string_lists (&head
, &tail
, h
, t
);
21681 /* Append glyph strings for glyphs following the last glyph
21682 string tail that overwrite tail. The foreground of such
21683 glyphs has to be drawn because it writes into the background
21684 of tail. The background must not be drawn because it could
21685 paint over the foreground of following glyphs. */
21686 i
= right_overwriting (tail
);
21689 enum draw_glyphs_face overlap_hl
;
21690 if (check_mouse_face
21691 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21692 overlap_hl
= DRAW_MOUSE_FACE
;
21694 overlap_hl
= DRAW_NORMAL_TEXT
;
21697 i
++; /* We must include the Ith glyph. */
21698 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21699 overlap_hl
, x
, last_x
);
21700 for (s
= h
; s
; s
= s
->next
)
21701 s
->background_filled_p
= 1;
21702 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21703 append_glyph_string_lists (&head
, &tail
, h
, t
);
21705 if (clip_head
|| clip_tail
)
21706 for (s
= head
; s
; s
= s
->next
)
21708 s
->clip_head
= clip_head
;
21709 s
->clip_tail
= clip_tail
;
21713 /* Draw all strings. */
21714 for (s
= head
; s
; s
= s
->next
)
21715 FRAME_RIF (f
)->draw_glyph_string (s
);
21718 /* When focus a sole frame and move horizontally, this sets on_p to 0
21719 causing a failure to erase prev cursor position. */
21720 if (area
== TEXT_AREA
21721 && !row
->full_width_p
21722 /* When drawing overlapping rows, only the glyph strings'
21723 foreground is drawn, which doesn't erase a cursor
21727 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21728 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21729 : (tail
? tail
->x
+ tail
->background_width
: x
));
21733 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21734 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21738 /* Value is the x-position up to which drawn, relative to AREA of W.
21739 This doesn't include parts drawn because of overhangs. */
21740 if (row
->full_width_p
)
21741 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21743 x_reached
-= area_left
;
21745 RELEASE_HDC (hdc
, f
);
21750 /* Expand row matrix if too narrow. Don't expand if area
21753 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21755 if (!fonts_changed_p \
21756 && (it->glyph_row->glyphs[area] \
21757 < it->glyph_row->glyphs[area + 1])) \
21759 it->w->ncols_scale_factor++; \
21760 fonts_changed_p = 1; \
21764 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21765 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21771 struct glyph
*glyph
;
21772 enum glyph_row_area area
= it
->area
;
21774 xassert (it
->glyph_row
);
21775 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21777 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21778 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21780 /* If the glyph row is reversed, we need to prepend the glyph
21781 rather than append it. */
21782 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21786 /* Make room for the additional glyph. */
21787 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21789 glyph
= it
->glyph_row
->glyphs
[area
];
21791 glyph
->charpos
= CHARPOS (it
->position
);
21792 glyph
->object
= it
->object
;
21793 if (it
->pixel_width
> 0)
21795 glyph
->pixel_width
= it
->pixel_width
;
21796 glyph
->padding_p
= 0;
21800 /* Assure at least 1-pixel width. Otherwise, cursor can't
21801 be displayed correctly. */
21802 glyph
->pixel_width
= 1;
21803 glyph
->padding_p
= 1;
21805 glyph
->ascent
= it
->ascent
;
21806 glyph
->descent
= it
->descent
;
21807 glyph
->voffset
= it
->voffset
;
21808 glyph
->type
= CHAR_GLYPH
;
21809 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21810 glyph
->multibyte_p
= it
->multibyte_p
;
21811 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21812 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21813 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21814 || it
->phys_descent
> it
->descent
);
21815 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21816 glyph
->face_id
= it
->face_id
;
21817 glyph
->u
.ch
= it
->char_to_display
;
21818 glyph
->slice
= null_glyph_slice
;
21819 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21822 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21823 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21825 glyph
->bidi_type
= it
->bidi_it
.type
;
21829 glyph
->resolved_level
= 0;
21830 glyph
->bidi_type
= UNKNOWN_BT
;
21832 ++it
->glyph_row
->used
[area
];
21835 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21838 /* Store one glyph for the composition IT->cmp_it.id in
21839 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21843 append_composite_glyph (it
)
21846 struct glyph
*glyph
;
21847 enum glyph_row_area area
= it
->area
;
21849 xassert (it
->glyph_row
);
21851 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21852 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21854 /* If the glyph row is reversed, we need to prepend the glyph
21855 rather than append it. */
21856 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21860 /* Make room for the new glyph. */
21861 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21863 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21865 glyph
->charpos
= CHARPOS (it
->position
);
21866 glyph
->object
= it
->object
;
21867 glyph
->pixel_width
= it
->pixel_width
;
21868 glyph
->ascent
= it
->ascent
;
21869 glyph
->descent
= it
->descent
;
21870 glyph
->voffset
= it
->voffset
;
21871 glyph
->type
= COMPOSITE_GLYPH
;
21872 if (it
->cmp_it
.ch
< 0)
21874 glyph
->u
.cmp
.automatic
= 0;
21875 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21879 glyph
->u
.cmp
.automatic
= 1;
21880 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21881 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21882 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21884 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21885 glyph
->multibyte_p
= it
->multibyte_p
;
21886 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21887 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21888 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21889 || it
->phys_descent
> it
->descent
);
21890 glyph
->padding_p
= 0;
21891 glyph
->glyph_not_available_p
= 0;
21892 glyph
->face_id
= it
->face_id
;
21893 glyph
->slice
= null_glyph_slice
;
21894 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21897 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21898 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21900 glyph
->bidi_type
= it
->bidi_it
.type
;
21902 ++it
->glyph_row
->used
[area
];
21905 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21909 /* Change IT->ascent and IT->height according to the setting of
21913 take_vertical_position_into_account (it
)
21918 if (it
->voffset
< 0)
21919 /* Increase the ascent so that we can display the text higher
21921 it
->ascent
-= it
->voffset
;
21923 /* Increase the descent so that we can display the text lower
21925 it
->descent
+= it
->voffset
;
21930 /* Produce glyphs/get display metrics for the image IT is loaded with.
21931 See the description of struct display_iterator in dispextern.h for
21932 an overview of struct display_iterator. */
21935 produce_image_glyph (it
)
21940 int glyph_ascent
, crop
;
21941 struct glyph_slice slice
;
21943 xassert (it
->what
== IT_IMAGE
);
21945 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21947 /* Make sure X resources of the face is loaded. */
21948 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21950 if (it
->image_id
< 0)
21952 /* Fringe bitmap. */
21953 it
->ascent
= it
->phys_ascent
= 0;
21954 it
->descent
= it
->phys_descent
= 0;
21955 it
->pixel_width
= 0;
21960 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21962 /* Make sure X resources of the image is loaded. */
21963 prepare_image_for_display (it
->f
, img
);
21965 slice
.x
= slice
.y
= 0;
21966 slice
.width
= img
->width
;
21967 slice
.height
= img
->height
;
21969 if (INTEGERP (it
->slice
.x
))
21970 slice
.x
= XINT (it
->slice
.x
);
21971 else if (FLOATP (it
->slice
.x
))
21972 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21974 if (INTEGERP (it
->slice
.y
))
21975 slice
.y
= XINT (it
->slice
.y
);
21976 else if (FLOATP (it
->slice
.y
))
21977 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21979 if (INTEGERP (it
->slice
.width
))
21980 slice
.width
= XINT (it
->slice
.width
);
21981 else if (FLOATP (it
->slice
.width
))
21982 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21984 if (INTEGERP (it
->slice
.height
))
21985 slice
.height
= XINT (it
->slice
.height
);
21986 else if (FLOATP (it
->slice
.height
))
21987 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21989 if (slice
.x
>= img
->width
)
21990 slice
.x
= img
->width
;
21991 if (slice
.y
>= img
->height
)
21992 slice
.y
= img
->height
;
21993 if (slice
.x
+ slice
.width
>= img
->width
)
21994 slice
.width
= img
->width
- slice
.x
;
21995 if (slice
.y
+ slice
.height
> img
->height
)
21996 slice
.height
= img
->height
- slice
.y
;
21998 if (slice
.width
== 0 || slice
.height
== 0)
22001 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22003 it
->descent
= slice
.height
- glyph_ascent
;
22005 it
->descent
+= img
->vmargin
;
22006 if (slice
.y
+ slice
.height
== img
->height
)
22007 it
->descent
+= img
->vmargin
;
22008 it
->phys_descent
= it
->descent
;
22010 it
->pixel_width
= slice
.width
;
22012 it
->pixel_width
+= img
->hmargin
;
22013 if (slice
.x
+ slice
.width
== img
->width
)
22014 it
->pixel_width
+= img
->hmargin
;
22016 /* It's quite possible for images to have an ascent greater than
22017 their height, so don't get confused in that case. */
22018 if (it
->descent
< 0)
22023 if (face
->box
!= FACE_NO_BOX
)
22025 if (face
->box_line_width
> 0)
22028 it
->ascent
+= face
->box_line_width
;
22029 if (slice
.y
+ slice
.height
== img
->height
)
22030 it
->descent
+= face
->box_line_width
;
22033 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22034 it
->pixel_width
+= eabs (face
->box_line_width
);
22035 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22036 it
->pixel_width
+= eabs (face
->box_line_width
);
22039 take_vertical_position_into_account (it
);
22041 /* Automatically crop wide image glyphs at right edge so we can
22042 draw the cursor on same display row. */
22043 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22044 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22046 it
->pixel_width
-= crop
;
22047 slice
.width
-= crop
;
22052 struct glyph
*glyph
;
22053 enum glyph_row_area area
= it
->area
;
22055 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22056 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22058 glyph
->charpos
= CHARPOS (it
->position
);
22059 glyph
->object
= it
->object
;
22060 glyph
->pixel_width
= it
->pixel_width
;
22061 glyph
->ascent
= glyph_ascent
;
22062 glyph
->descent
= it
->descent
;
22063 glyph
->voffset
= it
->voffset
;
22064 glyph
->type
= IMAGE_GLYPH
;
22065 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22066 glyph
->multibyte_p
= it
->multibyte_p
;
22067 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22068 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22069 glyph
->overlaps_vertically_p
= 0;
22070 glyph
->padding_p
= 0;
22071 glyph
->glyph_not_available_p
= 0;
22072 glyph
->face_id
= it
->face_id
;
22073 glyph
->u
.img_id
= img
->id
;
22074 glyph
->slice
= slice
;
22075 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22078 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22079 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22081 glyph
->bidi_type
= it
->bidi_it
.type
;
22083 ++it
->glyph_row
->used
[area
];
22086 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22091 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22092 of the glyph, WIDTH and HEIGHT are the width and height of the
22093 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22096 append_stretch_glyph (it
, object
, width
, height
, ascent
)
22098 Lisp_Object object
;
22102 struct glyph
*glyph
;
22103 enum glyph_row_area area
= it
->area
;
22105 xassert (ascent
>= 0 && ascent
<= height
);
22107 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22108 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22110 /* If the glyph row is reversed, we need to prepend the glyph
22111 rather than append it. */
22112 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22116 /* Make room for the additional glyph. */
22117 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22119 glyph
= it
->glyph_row
->glyphs
[area
];
22121 glyph
->charpos
= CHARPOS (it
->position
);
22122 glyph
->object
= object
;
22123 glyph
->pixel_width
= width
;
22124 glyph
->ascent
= ascent
;
22125 glyph
->descent
= height
- ascent
;
22126 glyph
->voffset
= it
->voffset
;
22127 glyph
->type
= STRETCH_GLYPH
;
22128 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22129 glyph
->multibyte_p
= it
->multibyte_p
;
22130 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22131 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22132 glyph
->overlaps_vertically_p
= 0;
22133 glyph
->padding_p
= 0;
22134 glyph
->glyph_not_available_p
= 0;
22135 glyph
->face_id
= it
->face_id
;
22136 glyph
->u
.stretch
.ascent
= ascent
;
22137 glyph
->u
.stretch
.height
= height
;
22138 glyph
->slice
= null_glyph_slice
;
22139 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22142 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22143 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22145 glyph
->bidi_type
= it
->bidi_it
.type
;
22149 glyph
->resolved_level
= 0;
22150 glyph
->bidi_type
= UNKNOWN_BT
;
22152 ++it
->glyph_row
->used
[area
];
22155 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22159 /* Produce a stretch glyph for iterator IT. IT->object is the value
22160 of the glyph property displayed. The value must be a list
22161 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22164 1. `:width WIDTH' specifies that the space should be WIDTH *
22165 canonical char width wide. WIDTH may be an integer or floating
22168 2. `:relative-width FACTOR' specifies that the width of the stretch
22169 should be computed from the width of the first character having the
22170 `glyph' property, and should be FACTOR times that width.
22172 3. `:align-to HPOS' specifies that the space should be wide enough
22173 to reach HPOS, a value in canonical character units.
22175 Exactly one of the above pairs must be present.
22177 4. `:height HEIGHT' specifies that the height of the stretch produced
22178 should be HEIGHT, measured in canonical character units.
22180 5. `:relative-height FACTOR' specifies that the height of the
22181 stretch should be FACTOR times the height of the characters having
22182 the glyph property.
22184 Either none or exactly one of 4 or 5 must be present.
22186 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22187 of the stretch should be used for the ascent of the stretch.
22188 ASCENT must be in the range 0 <= ASCENT <= 100. */
22191 produce_stretch_glyph (it
)
22194 /* (space :width WIDTH :height HEIGHT ...) */
22195 Lisp_Object prop
, plist
;
22196 int width
= 0, height
= 0, align_to
= -1;
22197 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22200 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22201 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22203 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22205 /* List should start with `space'. */
22206 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22207 plist
= XCDR (it
->object
);
22209 /* Compute the width of the stretch. */
22210 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22211 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22213 /* Absolute width `:width WIDTH' specified and valid. */
22214 zero_width_ok_p
= 1;
22217 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22220 /* Relative width `:relative-width FACTOR' specified and valid.
22221 Compute the width of the characters having the `glyph'
22224 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22227 if (it
->multibyte_p
)
22229 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
22230 - IT_BYTEPOS (*it
));
22231 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22234 it2
.c
= *p
, it2
.len
= 1;
22236 it2
.glyph_row
= NULL
;
22237 it2
.what
= IT_CHARACTER
;
22238 x_produce_glyphs (&it2
);
22239 width
= NUMVAL (prop
) * it2
.pixel_width
;
22241 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22242 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22244 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22245 align_to
= (align_to
< 0
22247 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22248 else if (align_to
< 0)
22249 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22250 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22251 zero_width_ok_p
= 1;
22254 /* Nothing specified -> width defaults to canonical char width. */
22255 width
= FRAME_COLUMN_WIDTH (it
->f
);
22257 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22260 /* Compute height. */
22261 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22262 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22265 zero_height_ok_p
= 1;
22267 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22269 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22271 height
= FONT_HEIGHT (font
);
22273 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22276 /* Compute percentage of height used for ascent. If
22277 `:ascent ASCENT' is present and valid, use that. Otherwise,
22278 derive the ascent from the font in use. */
22279 if (prop
= Fplist_get (plist
, QCascent
),
22280 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22281 ascent
= height
* NUMVAL (prop
) / 100.0;
22282 else if (!NILP (prop
)
22283 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22284 ascent
= min (max (0, (int)tem
), height
);
22286 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22288 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22289 && it
->current_x
+ width
> it
->last_visible_x
)
22290 width
= it
->last_visible_x
- it
->current_x
- 1;
22292 if (width
> 0 && height
> 0 && it
->glyph_row
)
22294 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22295 if (!STRINGP (object
))
22296 object
= it
->w
->buffer
;
22297 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22300 it
->pixel_width
= width
;
22301 it
->ascent
= it
->phys_ascent
= ascent
;
22302 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22303 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22305 take_vertical_position_into_account (it
);
22308 /* Calculate line-height and line-spacing properties.
22309 An integer value specifies explicit pixel value.
22310 A float value specifies relative value to current face height.
22311 A cons (float . face-name) specifies relative value to
22312 height of specified face font.
22314 Returns height in pixels, or nil. */
22318 calc_line_height_property (it
, val
, font
, boff
, override
)
22322 int boff
, override
;
22324 Lisp_Object face_name
= Qnil
;
22325 int ascent
, descent
, height
;
22327 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22332 face_name
= XCAR (val
);
22334 if (!NUMBERP (val
))
22335 val
= make_number (1);
22336 if (NILP (face_name
))
22338 height
= it
->ascent
+ it
->descent
;
22343 if (NILP (face_name
))
22345 font
= FRAME_FONT (it
->f
);
22346 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22348 else if (EQ (face_name
, Qt
))
22357 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22359 return make_number (-1);
22361 face
= FACE_FROM_ID (it
->f
, face_id
);
22364 return make_number (-1);
22365 boff
= font
->baseline_offset
;
22366 if (font
->vertical_centering
)
22367 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22370 ascent
= FONT_BASE (font
) + boff
;
22371 descent
= FONT_DESCENT (font
) - boff
;
22375 it
->override_ascent
= ascent
;
22376 it
->override_descent
= descent
;
22377 it
->override_boff
= boff
;
22380 height
= ascent
+ descent
;
22384 height
= (int)(XFLOAT_DATA (val
) * height
);
22385 else if (INTEGERP (val
))
22386 height
*= XINT (val
);
22388 return make_number (height
);
22393 Produce glyphs/get display metrics for the display element IT is
22394 loaded with. See the description of struct it in dispextern.h
22395 for an overview of struct it. */
22398 x_produce_glyphs (it
)
22401 int extra_line_spacing
= it
->extra_line_spacing
;
22403 it
->glyph_not_available_p
= 0;
22405 if (it
->what
== IT_CHARACTER
)
22409 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22410 struct font_metrics
*pcm
;
22411 int font_not_found_p
;
22412 int boff
; /* baseline offset */
22413 /* We may change it->multibyte_p upon unibyte<->multibyte
22414 conversion. So, save the current value now and restore it
22417 Note: It seems that we don't have to record multibyte_p in
22418 struct glyph because the character code itself tells whether
22419 or not the character is multibyte. Thus, in the future, we
22420 must consider eliminating the field `multibyte_p' in the
22422 int saved_multibyte_p
= it
->multibyte_p
;
22424 /* Maybe translate single-byte characters to multibyte, or the
22426 it
->char_to_display
= it
->c
;
22427 if (!ASCII_BYTE_P (it
->c
)
22428 && ! it
->multibyte_p
)
22430 if (SINGLE_BYTE_CHAR_P (it
->c
)
22431 && unibyte_display_via_language_environment
)
22433 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22435 /* get_next_display_element assures that this decoding
22437 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22438 it
->multibyte_p
= 1;
22439 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22441 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22445 /* Get font to use. Encode IT->char_to_display. */
22446 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22447 &char2b
, it
->multibyte_p
, 0);
22450 font_not_found_p
= font
== NULL
;
22451 if (font_not_found_p
)
22453 /* When no suitable font found, display an empty box based
22454 on the metrics of the font of the default face (or what
22456 struct face
*no_font_face
22457 = FACE_FROM_ID (it
->f
,
22458 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22459 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22460 font
= no_font_face
->font
;
22461 boff
= font
->baseline_offset
;
22465 boff
= font
->baseline_offset
;
22466 if (font
->vertical_centering
)
22467 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22470 if (it
->char_to_display
>= ' '
22471 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22473 /* Either unibyte or ASCII. */
22478 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22480 if (it
->override_ascent
>= 0)
22482 it
->ascent
= it
->override_ascent
;
22483 it
->descent
= it
->override_descent
;
22484 boff
= it
->override_boff
;
22488 it
->ascent
= FONT_BASE (font
) + boff
;
22489 it
->descent
= FONT_DESCENT (font
) - boff
;
22494 it
->phys_ascent
= pcm
->ascent
+ boff
;
22495 it
->phys_descent
= pcm
->descent
- boff
;
22496 it
->pixel_width
= pcm
->width
;
22500 it
->glyph_not_available_p
= 1;
22501 it
->phys_ascent
= it
->ascent
;
22502 it
->phys_descent
= it
->descent
;
22503 it
->pixel_width
= FONT_WIDTH (font
);
22506 if (it
->constrain_row_ascent_descent_p
)
22508 if (it
->descent
> it
->max_descent
)
22510 it
->ascent
+= it
->descent
- it
->max_descent
;
22511 it
->descent
= it
->max_descent
;
22513 if (it
->ascent
> it
->max_ascent
)
22515 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22516 it
->ascent
= it
->max_ascent
;
22518 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22519 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22520 extra_line_spacing
= 0;
22523 /* If this is a space inside a region of text with
22524 `space-width' property, change its width. */
22525 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22527 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22529 /* If face has a box, add the box thickness to the character
22530 height. If character has a box line to the left and/or
22531 right, add the box line width to the character's width. */
22532 if (face
->box
!= FACE_NO_BOX
)
22534 int thick
= face
->box_line_width
;
22538 it
->ascent
+= thick
;
22539 it
->descent
+= thick
;
22544 if (it
->start_of_box_run_p
)
22545 it
->pixel_width
+= thick
;
22546 if (it
->end_of_box_run_p
)
22547 it
->pixel_width
+= thick
;
22550 /* If face has an overline, add the height of the overline
22551 (1 pixel) and a 1 pixel margin to the character height. */
22552 if (face
->overline_p
)
22553 it
->ascent
+= overline_margin
;
22555 if (it
->constrain_row_ascent_descent_p
)
22557 if (it
->ascent
> it
->max_ascent
)
22558 it
->ascent
= it
->max_ascent
;
22559 if (it
->descent
> it
->max_descent
)
22560 it
->descent
= it
->max_descent
;
22563 take_vertical_position_into_account (it
);
22565 /* If we have to actually produce glyphs, do it. */
22570 /* Translate a space with a `space-width' property
22571 into a stretch glyph. */
22572 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22573 / FONT_HEIGHT (font
));
22574 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22575 it
->ascent
+ it
->descent
, ascent
);
22580 /* If characters with lbearing or rbearing are displayed
22581 in this line, record that fact in a flag of the
22582 glyph row. This is used to optimize X output code. */
22583 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22584 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22586 if (! stretched_p
&& it
->pixel_width
== 0)
22587 /* We assure that all visible glyphs have at least 1-pixel
22589 it
->pixel_width
= 1;
22591 else if (it
->char_to_display
== '\n')
22593 /* A newline has no width, but we need the height of the
22594 line. But if previous part of the line sets a height,
22595 don't increase that height */
22597 Lisp_Object height
;
22598 Lisp_Object total_height
= Qnil
;
22600 it
->override_ascent
= -1;
22601 it
->pixel_width
= 0;
22604 height
= get_it_property(it
, Qline_height
);
22605 /* Split (line-height total-height) list */
22607 && CONSP (XCDR (height
))
22608 && NILP (XCDR (XCDR (height
))))
22610 total_height
= XCAR (XCDR (height
));
22611 height
= XCAR (height
);
22613 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22615 if (it
->override_ascent
>= 0)
22617 it
->ascent
= it
->override_ascent
;
22618 it
->descent
= it
->override_descent
;
22619 boff
= it
->override_boff
;
22623 it
->ascent
= FONT_BASE (font
) + boff
;
22624 it
->descent
= FONT_DESCENT (font
) - boff
;
22627 if (EQ (height
, Qt
))
22629 if (it
->descent
> it
->max_descent
)
22631 it
->ascent
+= it
->descent
- it
->max_descent
;
22632 it
->descent
= it
->max_descent
;
22634 if (it
->ascent
> it
->max_ascent
)
22636 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22637 it
->ascent
= it
->max_ascent
;
22639 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22640 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22641 it
->constrain_row_ascent_descent_p
= 1;
22642 extra_line_spacing
= 0;
22646 Lisp_Object spacing
;
22648 it
->phys_ascent
= it
->ascent
;
22649 it
->phys_descent
= it
->descent
;
22651 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22652 && face
->box
!= FACE_NO_BOX
22653 && face
->box_line_width
> 0)
22655 it
->ascent
+= face
->box_line_width
;
22656 it
->descent
+= face
->box_line_width
;
22659 && XINT (height
) > it
->ascent
+ it
->descent
)
22660 it
->ascent
= XINT (height
) - it
->descent
;
22662 if (!NILP (total_height
))
22663 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22666 spacing
= get_it_property(it
, Qline_spacing
);
22667 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22669 if (INTEGERP (spacing
))
22671 extra_line_spacing
= XINT (spacing
);
22672 if (!NILP (total_height
))
22673 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22677 else if (it
->char_to_display
== '\t')
22679 if (font
->space_width
> 0)
22681 int tab_width
= it
->tab_width
* font
->space_width
;
22682 int x
= it
->current_x
+ it
->continuation_lines_width
;
22683 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22685 /* If the distance from the current position to the next tab
22686 stop is less than a space character width, use the
22687 tab stop after that. */
22688 if (next_tab_x
- x
< font
->space_width
)
22689 next_tab_x
+= tab_width
;
22691 it
->pixel_width
= next_tab_x
- x
;
22693 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22694 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22698 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22699 it
->ascent
+ it
->descent
, it
->ascent
);
22704 it
->pixel_width
= 0;
22710 /* A multi-byte character. Assume that the display width of the
22711 character is the width of the character multiplied by the
22712 width of the font. */
22714 /* If we found a font, this font should give us the right
22715 metrics. If we didn't find a font, use the frame's
22716 default font and calculate the width of the character by
22717 multiplying the width of font by the width of the
22720 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22722 if (font_not_found_p
|| !pcm
)
22724 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22726 if (char_width
== 0)
22727 /* This is a non spacing character. But, as we are
22728 going to display an empty box, the box must occupy
22729 at least one column. */
22731 it
->glyph_not_available_p
= 1;
22732 it
->pixel_width
= font
->space_width
* char_width
;
22733 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22734 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22738 it
->pixel_width
= pcm
->width
;
22739 it
->phys_ascent
= pcm
->ascent
+ boff
;
22740 it
->phys_descent
= pcm
->descent
- boff
;
22742 && (pcm
->lbearing
< 0
22743 || pcm
->rbearing
> pcm
->width
))
22744 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22747 it
->ascent
= FONT_BASE (font
) + boff
;
22748 it
->descent
= FONT_DESCENT (font
) - boff
;
22749 if (face
->box
!= FACE_NO_BOX
)
22751 int thick
= face
->box_line_width
;
22755 it
->ascent
+= thick
;
22756 it
->descent
+= thick
;
22761 if (it
->start_of_box_run_p
)
22762 it
->pixel_width
+= thick
;
22763 if (it
->end_of_box_run_p
)
22764 it
->pixel_width
+= thick
;
22767 /* If face has an overline, add the height of the overline
22768 (1 pixel) and a 1 pixel margin to the character height. */
22769 if (face
->overline_p
)
22770 it
->ascent
+= overline_margin
;
22772 take_vertical_position_into_account (it
);
22774 if (it
->ascent
< 0)
22776 if (it
->descent
< 0)
22781 if (it
->pixel_width
== 0)
22782 /* We assure that all visible glyphs have at least 1-pixel
22784 it
->pixel_width
= 1;
22786 it
->multibyte_p
= saved_multibyte_p
;
22788 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22790 /* A static composition.
22792 Note: A composition is represented as one glyph in the
22793 glyph matrix. There are no padding glyphs.
22795 Important note: pixel_width, ascent, and descent are the
22796 values of what is drawn by draw_glyphs (i.e. the values of
22797 the overall glyphs composed). */
22798 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22799 int boff
; /* baseline offset */
22800 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22801 int glyph_len
= cmp
->glyph_len
;
22802 struct font
*font
= face
->font
;
22806 /* If we have not yet calculated pixel size data of glyphs of
22807 the composition for the current face font, calculate them
22808 now. Theoretically, we have to check all fonts for the
22809 glyphs, but that requires much time and memory space. So,
22810 here we check only the font of the first glyph. This may
22811 lead to incorrect display, but it's very rare, and C-l
22812 (recenter-top-bottom) can correct the display anyway. */
22813 if (! cmp
->font
|| cmp
->font
!= font
)
22815 /* Ascent and descent of the font of the first character
22816 of this composition (adjusted by baseline offset).
22817 Ascent and descent of overall glyphs should not be less
22818 than these, respectively. */
22819 int font_ascent
, font_descent
, font_height
;
22820 /* Bounding box of the overall glyphs. */
22821 int leftmost
, rightmost
, lowest
, highest
;
22822 int lbearing
, rbearing
;
22823 int i
, width
, ascent
, descent
;
22824 int left_padded
= 0, right_padded
= 0;
22827 struct font_metrics
*pcm
;
22828 int font_not_found_p
;
22831 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22832 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22834 if (glyph_len
< cmp
->glyph_len
)
22836 for (i
= 0; i
< glyph_len
; i
++)
22838 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22840 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22845 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22846 : IT_CHARPOS (*it
));
22847 /* If no suitable font is found, use the default font. */
22848 font_not_found_p
= font
== NULL
;
22849 if (font_not_found_p
)
22851 face
= face
->ascii_face
;
22854 boff
= font
->baseline_offset
;
22855 if (font
->vertical_centering
)
22856 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22857 font_ascent
= FONT_BASE (font
) + boff
;
22858 font_descent
= FONT_DESCENT (font
) - boff
;
22859 font_height
= FONT_HEIGHT (font
);
22861 cmp
->font
= (void *) font
;
22864 if (! font_not_found_p
)
22866 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22867 &char2b
, it
->multibyte_p
, 0);
22868 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22871 /* Initialize the bounding box. */
22874 width
= pcm
->width
;
22875 ascent
= pcm
->ascent
;
22876 descent
= pcm
->descent
;
22877 lbearing
= pcm
->lbearing
;
22878 rbearing
= pcm
->rbearing
;
22882 width
= FONT_WIDTH (font
);
22883 ascent
= FONT_BASE (font
);
22884 descent
= FONT_DESCENT (font
);
22891 lowest
= - descent
+ boff
;
22892 highest
= ascent
+ boff
;
22894 if (! font_not_found_p
22895 && font
->default_ascent
22896 && CHAR_TABLE_P (Vuse_default_ascent
)
22897 && !NILP (Faref (Vuse_default_ascent
,
22898 make_number (it
->char_to_display
))))
22899 highest
= font
->default_ascent
+ boff
;
22901 /* Draw the first glyph at the normal position. It may be
22902 shifted to right later if some other glyphs are drawn
22904 cmp
->offsets
[i
* 2] = 0;
22905 cmp
->offsets
[i
* 2 + 1] = boff
;
22906 cmp
->lbearing
= lbearing
;
22907 cmp
->rbearing
= rbearing
;
22909 /* Set cmp->offsets for the remaining glyphs. */
22910 for (i
++; i
< glyph_len
; i
++)
22912 int left
, right
, btm
, top
;
22913 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22915 struct face
*this_face
;
22920 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22921 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22922 font
= this_face
->font
;
22928 this_boff
= font
->baseline_offset
;
22929 if (font
->vertical_centering
)
22930 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22931 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22932 &char2b
, it
->multibyte_p
, 0);
22933 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22936 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22939 width
= pcm
->width
;
22940 ascent
= pcm
->ascent
;
22941 descent
= pcm
->descent
;
22942 lbearing
= pcm
->lbearing
;
22943 rbearing
= pcm
->rbearing
;
22944 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22946 /* Relative composition with or without
22947 alternate chars. */
22948 left
= (leftmost
+ rightmost
- width
) / 2;
22949 btm
= - descent
+ boff
;
22950 if (font
->relative_compose
22951 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22952 || NILP (Faref (Vignore_relative_composition
,
22953 make_number (ch
)))))
22956 if (- descent
>= font
->relative_compose
)
22957 /* One extra pixel between two glyphs. */
22959 else if (ascent
<= 0)
22960 /* One extra pixel between two glyphs. */
22961 btm
= lowest
- 1 - ascent
- descent
;
22966 /* A composition rule is specified by an integer
22967 value that encodes global and new reference
22968 points (GREF and NREF). GREF and NREF are
22969 specified by numbers as below:
22971 0---1---2 -- ascent
22975 9--10--11 -- center
22977 ---3---4---5--- baseline
22979 6---7---8 -- descent
22981 int rule
= COMPOSITION_RULE (cmp
, i
);
22982 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22984 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22985 grefx
= gref
% 3, nrefx
= nref
% 3;
22986 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22988 xoff
= font_height
* (xoff
- 128) / 256;
22990 yoff
= font_height
* (yoff
- 128) / 256;
22993 + grefx
* (rightmost
- leftmost
) / 2
22994 - nrefx
* width
/ 2
22997 btm
= ((grefy
== 0 ? highest
22999 : grefy
== 2 ? lowest
23000 : (highest
+ lowest
) / 2)
23001 - (nrefy
== 0 ? ascent
+ descent
23002 : nrefy
== 1 ? descent
- boff
23004 : (ascent
+ descent
) / 2)
23008 cmp
->offsets
[i
* 2] = left
;
23009 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23011 /* Update the bounding box of the overall glyphs. */
23014 right
= left
+ width
;
23015 if (left
< leftmost
)
23017 if (right
> rightmost
)
23020 top
= btm
+ descent
+ ascent
;
23026 if (cmp
->lbearing
> left
+ lbearing
)
23027 cmp
->lbearing
= left
+ lbearing
;
23028 if (cmp
->rbearing
< left
+ rbearing
)
23029 cmp
->rbearing
= left
+ rbearing
;
23033 /* If there are glyphs whose x-offsets are negative,
23034 shift all glyphs to the right and make all x-offsets
23038 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23039 cmp
->offsets
[i
* 2] -= leftmost
;
23040 rightmost
-= leftmost
;
23041 cmp
->lbearing
-= leftmost
;
23042 cmp
->rbearing
-= leftmost
;
23045 if (left_padded
&& cmp
->lbearing
< 0)
23047 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23048 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23049 rightmost
-= cmp
->lbearing
;
23050 cmp
->rbearing
-= cmp
->lbearing
;
23053 if (right_padded
&& rightmost
< cmp
->rbearing
)
23055 rightmost
= cmp
->rbearing
;
23058 cmp
->pixel_width
= rightmost
;
23059 cmp
->ascent
= highest
;
23060 cmp
->descent
= - lowest
;
23061 if (cmp
->ascent
< font_ascent
)
23062 cmp
->ascent
= font_ascent
;
23063 if (cmp
->descent
< font_descent
)
23064 cmp
->descent
= font_descent
;
23068 && (cmp
->lbearing
< 0
23069 || cmp
->rbearing
> cmp
->pixel_width
))
23070 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23072 it
->pixel_width
= cmp
->pixel_width
;
23073 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23074 it
->descent
= it
->phys_descent
= cmp
->descent
;
23075 if (face
->box
!= FACE_NO_BOX
)
23077 int thick
= face
->box_line_width
;
23081 it
->ascent
+= thick
;
23082 it
->descent
+= thick
;
23087 if (it
->start_of_box_run_p
)
23088 it
->pixel_width
+= thick
;
23089 if (it
->end_of_box_run_p
)
23090 it
->pixel_width
+= thick
;
23093 /* If face has an overline, add the height of the overline
23094 (1 pixel) and a 1 pixel margin to the character height. */
23095 if (face
->overline_p
)
23096 it
->ascent
+= overline_margin
;
23098 take_vertical_position_into_account (it
);
23099 if (it
->ascent
< 0)
23101 if (it
->descent
< 0)
23105 append_composite_glyph (it
);
23107 else if (it
->what
== IT_COMPOSITION
)
23109 /* A dynamic (automatic) composition. */
23110 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23111 Lisp_Object gstring
;
23112 struct font_metrics metrics
;
23114 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23116 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23119 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23120 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23121 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23122 it
->descent
= it
->phys_descent
= metrics
.descent
;
23123 if (face
->box
!= FACE_NO_BOX
)
23125 int thick
= face
->box_line_width
;
23129 it
->ascent
+= thick
;
23130 it
->descent
+= thick
;
23135 if (it
->start_of_box_run_p
)
23136 it
->pixel_width
+= thick
;
23137 if (it
->end_of_box_run_p
)
23138 it
->pixel_width
+= thick
;
23140 /* If face has an overline, add the height of the overline
23141 (1 pixel) and a 1 pixel margin to the character height. */
23142 if (face
->overline_p
)
23143 it
->ascent
+= overline_margin
;
23144 take_vertical_position_into_account (it
);
23145 if (it
->ascent
< 0)
23147 if (it
->descent
< 0)
23151 append_composite_glyph (it
);
23153 else if (it
->what
== IT_IMAGE
)
23154 produce_image_glyph (it
);
23155 else if (it
->what
== IT_STRETCH
)
23156 produce_stretch_glyph (it
);
23158 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23159 because this isn't true for images with `:ascent 100'. */
23160 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23161 if (it
->area
== TEXT_AREA
)
23162 it
->current_x
+= it
->pixel_width
;
23164 if (extra_line_spacing
> 0)
23166 it
->descent
+= extra_line_spacing
;
23167 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23168 it
->max_extra_line_spacing
= extra_line_spacing
;
23171 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23172 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23173 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23174 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23178 Output LEN glyphs starting at START at the nominal cursor position.
23179 Advance the nominal cursor over the text. The global variable
23180 updated_window contains the window being updated, updated_row is
23181 the glyph row being updated, and updated_area is the area of that
23182 row being updated. */
23185 x_write_glyphs (start
, len
)
23186 struct glyph
*start
;
23191 xassert (updated_window
&& updated_row
);
23194 /* Write glyphs. */
23196 hpos
= start
- updated_row
->glyphs
[updated_area
];
23197 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23198 updated_row
, updated_area
,
23200 DRAW_NORMAL_TEXT
, 0);
23202 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23203 if (updated_area
== TEXT_AREA
23204 && updated_window
->phys_cursor_on_p
23205 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23206 && updated_window
->phys_cursor
.hpos
>= hpos
23207 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23208 updated_window
->phys_cursor_on_p
= 0;
23212 /* Advance the output cursor. */
23213 output_cursor
.hpos
+= len
;
23214 output_cursor
.x
= x
;
23219 Insert LEN glyphs from START at the nominal cursor position. */
23222 x_insert_glyphs (start
, len
)
23223 struct glyph
*start
;
23228 int line_height
, shift_by_width
, shifted_region_width
;
23229 struct glyph_row
*row
;
23230 struct glyph
*glyph
;
23231 int frame_x
, frame_y
;
23234 xassert (updated_window
&& updated_row
);
23236 w
= updated_window
;
23237 f
= XFRAME (WINDOW_FRAME (w
));
23239 /* Get the height of the line we are in. */
23241 line_height
= row
->height
;
23243 /* Get the width of the glyphs to insert. */
23244 shift_by_width
= 0;
23245 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23246 shift_by_width
+= glyph
->pixel_width
;
23248 /* Get the width of the region to shift right. */
23249 shifted_region_width
= (window_box_width (w
, updated_area
)
23254 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23255 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23257 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23258 line_height
, shift_by_width
);
23260 /* Write the glyphs. */
23261 hpos
= start
- row
->glyphs
[updated_area
];
23262 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23264 DRAW_NORMAL_TEXT
, 0);
23266 /* Advance the output cursor. */
23267 output_cursor
.hpos
+= len
;
23268 output_cursor
.x
+= shift_by_width
;
23274 Erase the current text line from the nominal cursor position
23275 (inclusive) to pixel column TO_X (exclusive). The idea is that
23276 everything from TO_X onward is already erased.
23278 TO_X is a pixel position relative to updated_area of
23279 updated_window. TO_X == -1 means clear to the end of this area. */
23282 x_clear_end_of_line (to_x
)
23286 struct window
*w
= updated_window
;
23287 int max_x
, min_y
, max_y
;
23288 int from_x
, from_y
, to_y
;
23290 xassert (updated_window
&& updated_row
);
23291 f
= XFRAME (w
->frame
);
23293 if (updated_row
->full_width_p
)
23294 max_x
= WINDOW_TOTAL_WIDTH (w
);
23296 max_x
= window_box_width (w
, updated_area
);
23297 max_y
= window_text_bottom_y (w
);
23299 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23300 of window. For TO_X > 0, truncate to end of drawing area. */
23306 to_x
= min (to_x
, max_x
);
23308 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23310 /* Notice if the cursor will be cleared by this operation. */
23311 if (!updated_row
->full_width_p
)
23312 notice_overwritten_cursor (w
, updated_area
,
23313 output_cursor
.x
, -1,
23315 MATRIX_ROW_BOTTOM_Y (updated_row
));
23317 from_x
= output_cursor
.x
;
23319 /* Translate to frame coordinates. */
23320 if (updated_row
->full_width_p
)
23322 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23323 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23327 int area_left
= window_box_left (w
, updated_area
);
23328 from_x
+= area_left
;
23332 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23333 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23334 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23336 /* Prevent inadvertently clearing to end of the X window. */
23337 if (to_x
> from_x
&& to_y
> from_y
)
23340 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23341 to_x
- from_x
, to_y
- from_y
);
23346 #endif /* HAVE_WINDOW_SYSTEM */
23350 /***********************************************************************
23352 ***********************************************************************/
23354 /* Value is the internal representation of the specified cursor type
23355 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23356 of the bar cursor. */
23358 static enum text_cursor_kinds
23359 get_specified_cursor_type (arg
, width
)
23363 enum text_cursor_kinds type
;
23368 if (EQ (arg
, Qbox
))
23369 return FILLED_BOX_CURSOR
;
23371 if (EQ (arg
, Qhollow
))
23372 return HOLLOW_BOX_CURSOR
;
23374 if (EQ (arg
, Qbar
))
23381 && EQ (XCAR (arg
), Qbar
)
23382 && INTEGERP (XCDR (arg
))
23383 && XINT (XCDR (arg
)) >= 0)
23385 *width
= XINT (XCDR (arg
));
23389 if (EQ (arg
, Qhbar
))
23392 return HBAR_CURSOR
;
23396 && EQ (XCAR (arg
), Qhbar
)
23397 && INTEGERP (XCDR (arg
))
23398 && XINT (XCDR (arg
)) >= 0)
23400 *width
= XINT (XCDR (arg
));
23401 return HBAR_CURSOR
;
23404 /* Treat anything unknown as "hollow box cursor".
23405 It was bad to signal an error; people have trouble fixing
23406 .Xdefaults with Emacs, when it has something bad in it. */
23407 type
= HOLLOW_BOX_CURSOR
;
23412 /* Set the default cursor types for specified frame. */
23414 set_frame_cursor_types (f
, arg
)
23421 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23422 FRAME_CURSOR_WIDTH (f
) = width
;
23424 /* By default, set up the blink-off state depending on the on-state. */
23426 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23429 FRAME_BLINK_OFF_CURSOR (f
)
23430 = get_specified_cursor_type (XCDR (tem
), &width
);
23431 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23434 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23438 /* Return the cursor we want to be displayed in window W. Return
23439 width of bar/hbar cursor through WIDTH arg. Return with
23440 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23441 (i.e. if the `system caret' should track this cursor).
23443 In a mini-buffer window, we want the cursor only to appear if we
23444 are reading input from this window. For the selected window, we
23445 want the cursor type given by the frame parameter or buffer local
23446 setting of cursor-type. If explicitly marked off, draw no cursor.
23447 In all other cases, we want a hollow box cursor. */
23449 static enum text_cursor_kinds
23450 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
23452 struct glyph
*glyph
;
23454 int *active_cursor
;
23456 struct frame
*f
= XFRAME (w
->frame
);
23457 struct buffer
*b
= XBUFFER (w
->buffer
);
23458 int cursor_type
= DEFAULT_CURSOR
;
23459 Lisp_Object alt_cursor
;
23460 int non_selected
= 0;
23462 *active_cursor
= 1;
23465 if (cursor_in_echo_area
23466 && FRAME_HAS_MINIBUF_P (f
)
23467 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23469 if (w
== XWINDOW (echo_area_window
))
23471 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23473 *width
= FRAME_CURSOR_WIDTH (f
);
23474 return FRAME_DESIRED_CURSOR (f
);
23477 return get_specified_cursor_type (b
->cursor_type
, width
);
23480 *active_cursor
= 0;
23484 /* Detect a nonselected window or nonselected frame. */
23485 else if (w
!= XWINDOW (f
->selected_window
)
23486 #ifdef HAVE_WINDOW_SYSTEM
23487 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23491 *active_cursor
= 0;
23493 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23499 /* Never display a cursor in a window in which cursor-type is nil. */
23500 if (NILP (b
->cursor_type
))
23503 /* Get the normal cursor type for this window. */
23504 if (EQ (b
->cursor_type
, Qt
))
23506 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23507 *width
= FRAME_CURSOR_WIDTH (f
);
23510 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23512 /* Use cursor-in-non-selected-windows instead
23513 for non-selected window or frame. */
23516 alt_cursor
= b
->cursor_in_non_selected_windows
;
23517 if (!EQ (Qt
, alt_cursor
))
23518 return get_specified_cursor_type (alt_cursor
, width
);
23519 /* t means modify the normal cursor type. */
23520 if (cursor_type
== FILLED_BOX_CURSOR
)
23521 cursor_type
= HOLLOW_BOX_CURSOR
;
23522 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23524 return cursor_type
;
23527 /* Use normal cursor if not blinked off. */
23528 if (!w
->cursor_off_p
)
23530 #ifdef HAVE_WINDOW_SYSTEM
23531 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23533 if (cursor_type
== FILLED_BOX_CURSOR
)
23535 /* Using a block cursor on large images can be very annoying.
23536 So use a hollow cursor for "large" images.
23537 If image is not transparent (no mask), also use hollow cursor. */
23538 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23539 if (img
!= NULL
&& IMAGEP (img
->spec
))
23541 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23542 where N = size of default frame font size.
23543 This should cover most of the "tiny" icons people may use. */
23545 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23546 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23547 cursor_type
= HOLLOW_BOX_CURSOR
;
23550 else if (cursor_type
!= NO_CURSOR
)
23552 /* Display current only supports BOX and HOLLOW cursors for images.
23553 So for now, unconditionally use a HOLLOW cursor when cursor is
23554 not a solid box cursor. */
23555 cursor_type
= HOLLOW_BOX_CURSOR
;
23559 return cursor_type
;
23562 /* Cursor is blinked off, so determine how to "toggle" it. */
23564 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23565 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23566 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23568 /* Then see if frame has specified a specific blink off cursor type. */
23569 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23571 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23572 return FRAME_BLINK_OFF_CURSOR (f
);
23576 /* Some people liked having a permanently visible blinking cursor,
23577 while others had very strong opinions against it. So it was
23578 decided to remove it. KFS 2003-09-03 */
23580 /* Finally perform built-in cursor blinking:
23581 filled box <-> hollow box
23582 wide [h]bar <-> narrow [h]bar
23583 narrow [h]bar <-> no cursor
23584 other type <-> no cursor */
23586 if (cursor_type
== FILLED_BOX_CURSOR
)
23587 return HOLLOW_BOX_CURSOR
;
23589 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23592 return cursor_type
;
23600 #ifdef HAVE_WINDOW_SYSTEM
23602 /* Notice when the text cursor of window W has been completely
23603 overwritten by a drawing operation that outputs glyphs in AREA
23604 starting at X0 and ending at X1 in the line starting at Y0 and
23605 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23606 the rest of the line after X0 has been written. Y coordinates
23607 are window-relative. */
23610 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23612 enum glyph_row_area area
;
23613 int x0
, y0
, x1
, y1
;
23615 int cx0
, cx1
, cy0
, cy1
;
23616 struct glyph_row
*row
;
23618 if (!w
->phys_cursor_on_p
)
23620 if (area
!= TEXT_AREA
)
23623 if (w
->phys_cursor
.vpos
< 0
23624 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23625 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23626 !(row
->enabled_p
&& row
->displays_text_p
)))
23629 if (row
->cursor_in_fringe_p
)
23631 row
->cursor_in_fringe_p
= 0;
23632 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23633 w
->phys_cursor_on_p
= 0;
23637 cx0
= w
->phys_cursor
.x
;
23638 cx1
= cx0
+ w
->phys_cursor_width
;
23639 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23642 /* The cursor image will be completely removed from the
23643 screen if the output area intersects the cursor area in
23644 y-direction. When we draw in [y0 y1[, and some part of
23645 the cursor is at y < y0, that part must have been drawn
23646 before. When scrolling, the cursor is erased before
23647 actually scrolling, so we don't come here. When not
23648 scrolling, the rows above the old cursor row must have
23649 changed, and in this case these rows must have written
23650 over the cursor image.
23652 Likewise if part of the cursor is below y1, with the
23653 exception of the cursor being in the first blank row at
23654 the buffer and window end because update_text_area
23655 doesn't draw that row. (Except when it does, but
23656 that's handled in update_text_area.) */
23658 cy0
= w
->phys_cursor
.y
;
23659 cy1
= cy0
+ w
->phys_cursor_height
;
23660 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23663 w
->phys_cursor_on_p
= 0;
23666 #endif /* HAVE_WINDOW_SYSTEM */
23669 /************************************************************************
23671 ************************************************************************/
23673 #ifdef HAVE_WINDOW_SYSTEM
23676 Fix the display of area AREA of overlapping row ROW in window W
23677 with respect to the overlapping part OVERLAPS. */
23680 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23682 struct glyph_row
*row
;
23683 enum glyph_row_area area
;
23691 for (i
= 0; i
< row
->used
[area
];)
23693 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23695 int start
= i
, start_x
= x
;
23699 x
+= row
->glyphs
[area
][i
].pixel_width
;
23702 while (i
< row
->used
[area
]
23703 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23705 draw_glyphs (w
, start_x
, row
, area
,
23707 DRAW_NORMAL_TEXT
, overlaps
);
23711 x
+= row
->glyphs
[area
][i
].pixel_width
;
23721 Draw the cursor glyph of window W in glyph row ROW. See the
23722 comment of draw_glyphs for the meaning of HL. */
23725 draw_phys_cursor_glyph (w
, row
, hl
)
23727 struct glyph_row
*row
;
23728 enum draw_glyphs_face hl
;
23730 /* If cursor hpos is out of bounds, don't draw garbage. This can
23731 happen in mini-buffer windows when switching between echo area
23732 glyphs and mini-buffer. */
23733 if ((row
->reversed_p
23734 ? (w
->phys_cursor
.hpos
>= 0)
23735 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23737 int on_p
= w
->phys_cursor_on_p
;
23739 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23740 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23742 w
->phys_cursor_on_p
= on_p
;
23744 if (hl
== DRAW_CURSOR
)
23745 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23746 /* When we erase the cursor, and ROW is overlapped by other
23747 rows, make sure that these overlapping parts of other rows
23749 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23751 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23753 if (row
> w
->current_matrix
->rows
23754 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23755 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23756 OVERLAPS_ERASED_CURSOR
);
23758 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23759 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23760 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23761 OVERLAPS_ERASED_CURSOR
);
23768 Erase the image of a cursor of window W from the screen. */
23771 erase_phys_cursor (w
)
23774 struct frame
*f
= XFRAME (w
->frame
);
23775 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23776 int hpos
= w
->phys_cursor
.hpos
;
23777 int vpos
= w
->phys_cursor
.vpos
;
23778 int mouse_face_here_p
= 0;
23779 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23780 struct glyph_row
*cursor_row
;
23781 struct glyph
*cursor_glyph
;
23782 enum draw_glyphs_face hl
;
23784 /* No cursor displayed or row invalidated => nothing to do on the
23786 if (w
->phys_cursor_type
== NO_CURSOR
)
23787 goto mark_cursor_off
;
23789 /* VPOS >= active_glyphs->nrows means that window has been resized.
23790 Don't bother to erase the cursor. */
23791 if (vpos
>= active_glyphs
->nrows
)
23792 goto mark_cursor_off
;
23794 /* If row containing cursor is marked invalid, there is nothing we
23796 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23797 if (!cursor_row
->enabled_p
)
23798 goto mark_cursor_off
;
23800 /* If line spacing is > 0, old cursor may only be partially visible in
23801 window after split-window. So adjust visible height. */
23802 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23803 window_text_bottom_y (w
) - cursor_row
->y
);
23805 /* If row is completely invisible, don't attempt to delete a cursor which
23806 isn't there. This can happen if cursor is at top of a window, and
23807 we switch to a buffer with a header line in that window. */
23808 if (cursor_row
->visible_height
<= 0)
23809 goto mark_cursor_off
;
23811 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23812 if (cursor_row
->cursor_in_fringe_p
)
23814 cursor_row
->cursor_in_fringe_p
= 0;
23815 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23816 goto mark_cursor_off
;
23819 /* This can happen when the new row is shorter than the old one.
23820 In this case, either draw_glyphs or clear_end_of_line
23821 should have cleared the cursor. Note that we wouldn't be
23822 able to erase the cursor in this case because we don't have a
23823 cursor glyph at hand. */
23824 if ((cursor_row
->reversed_p
23825 ? (w
->phys_cursor
.hpos
< 0)
23826 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23827 goto mark_cursor_off
;
23829 /* If the cursor is in the mouse face area, redisplay that when
23830 we clear the cursor. */
23831 if (! NILP (dpyinfo
->mouse_face_window
)
23832 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23833 && (vpos
> dpyinfo
->mouse_face_beg_row
23834 || (vpos
== dpyinfo
->mouse_face_beg_row
23835 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23836 && (vpos
< dpyinfo
->mouse_face_end_row
23837 || (vpos
== dpyinfo
->mouse_face_end_row
23838 && hpos
< dpyinfo
->mouse_face_end_col
))
23839 /* Don't redraw the cursor's spot in mouse face if it is at the
23840 end of a line (on a newline). The cursor appears there, but
23841 mouse highlighting does not. */
23842 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23843 mouse_face_here_p
= 1;
23845 /* Maybe clear the display under the cursor. */
23846 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23849 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23852 cursor_glyph
= get_phys_cursor_glyph (w
);
23853 if (cursor_glyph
== NULL
)
23854 goto mark_cursor_off
;
23856 width
= cursor_glyph
->pixel_width
;
23857 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23858 x
= w
->phys_cursor
.x
;
23860 width
-= left_x
- x
;
23861 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23862 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23863 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23866 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23869 /* Erase the cursor by redrawing the character underneath it. */
23870 if (mouse_face_here_p
)
23871 hl
= DRAW_MOUSE_FACE
;
23873 hl
= DRAW_NORMAL_TEXT
;
23874 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23877 w
->phys_cursor_on_p
= 0;
23878 w
->phys_cursor_type
= NO_CURSOR
;
23883 Display or clear cursor of window W. If ON is zero, clear the
23884 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23885 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23888 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23890 int on
, hpos
, vpos
, x
, y
;
23892 struct frame
*f
= XFRAME (w
->frame
);
23893 int new_cursor_type
;
23894 int new_cursor_width
;
23896 struct glyph_row
*glyph_row
;
23897 struct glyph
*glyph
;
23899 /* This is pointless on invisible frames, and dangerous on garbaged
23900 windows and frames; in the latter case, the frame or window may
23901 be in the midst of changing its size, and x and y may be off the
23903 if (! FRAME_VISIBLE_P (f
)
23904 || FRAME_GARBAGED_P (f
)
23905 || vpos
>= w
->current_matrix
->nrows
23906 || hpos
>= w
->current_matrix
->matrix_w
)
23909 /* If cursor is off and we want it off, return quickly. */
23910 if (!on
&& !w
->phys_cursor_on_p
)
23913 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23914 /* If cursor row is not enabled, we don't really know where to
23915 display the cursor. */
23916 if (!glyph_row
->enabled_p
)
23918 w
->phys_cursor_on_p
= 0;
23923 if (!glyph_row
->exact_window_width_line_p
23924 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23925 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23927 xassert (interrupt_input_blocked
);
23929 /* Set new_cursor_type to the cursor we want to be displayed. */
23930 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23931 &new_cursor_width
, &active_cursor
);
23933 /* If cursor is currently being shown and we don't want it to be or
23934 it is in the wrong place, or the cursor type is not what we want,
23936 if (w
->phys_cursor_on_p
23938 || w
->phys_cursor
.x
!= x
23939 || w
->phys_cursor
.y
!= y
23940 || new_cursor_type
!= w
->phys_cursor_type
23941 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23942 && new_cursor_width
!= w
->phys_cursor_width
)))
23943 erase_phys_cursor (w
);
23945 /* Don't check phys_cursor_on_p here because that flag is only set
23946 to zero in some cases where we know that the cursor has been
23947 completely erased, to avoid the extra work of erasing the cursor
23948 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23949 still not be visible, or it has only been partly erased. */
23952 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23953 w
->phys_cursor_height
= glyph_row
->height
;
23955 /* Set phys_cursor_.* before x_draw_.* is called because some
23956 of them may need the information. */
23957 w
->phys_cursor
.x
= x
;
23958 w
->phys_cursor
.y
= glyph_row
->y
;
23959 w
->phys_cursor
.hpos
= hpos
;
23960 w
->phys_cursor
.vpos
= vpos
;
23963 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23964 new_cursor_type
, new_cursor_width
,
23965 on
, active_cursor
);
23969 /* Switch the display of W's cursor on or off, according to the value
23973 update_window_cursor (w
, on
)
23977 /* Don't update cursor in windows whose frame is in the process
23978 of being deleted. */
23979 if (w
->current_matrix
)
23982 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23983 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23989 /* Call update_window_cursor with parameter ON_P on all leaf windows
23990 in the window tree rooted at W. */
23993 update_cursor_in_window_tree (w
, on_p
)
23999 if (!NILP (w
->hchild
))
24000 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24001 else if (!NILP (w
->vchild
))
24002 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24004 update_window_cursor (w
, on_p
);
24006 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24012 Display the cursor on window W, or clear it, according to ON_P.
24013 Don't change the cursor's position. */
24016 x_update_cursor (f
, on_p
)
24020 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24025 Clear the cursor of window W to background color, and mark the
24026 cursor as not shown. This is used when the text where the cursor
24027 is about to be rewritten. */
24033 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24034 update_window_cursor (w
, 0);
24039 Display the active region described by mouse_face_* according to DRAW. */
24042 show_mouse_face (dpyinfo
, draw
)
24043 Display_Info
*dpyinfo
;
24044 enum draw_glyphs_face draw
;
24046 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
24047 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24049 if (/* If window is in the process of being destroyed, don't bother
24051 w
->current_matrix
!= NULL
24052 /* Don't update mouse highlight if hidden */
24053 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
24054 /* Recognize when we are called to operate on rows that don't exist
24055 anymore. This can happen when a window is split. */
24056 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24058 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24059 struct glyph_row
*row
, *first
, *last
;
24061 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
24062 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
24064 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24066 int start_hpos
, end_hpos
, start_x
;
24068 /* For all but the first row, the highlight starts at column 0. */
24071 start_hpos
= dpyinfo
->mouse_face_beg_col
;
24072 start_x
= dpyinfo
->mouse_face_beg_x
;
24081 end_hpos
= dpyinfo
->mouse_face_end_col
;
24084 end_hpos
= row
->used
[TEXT_AREA
];
24085 if (draw
== DRAW_NORMAL_TEXT
)
24086 row
->fill_line_p
= 1; /* Clear to end of line */
24089 if (end_hpos
> start_hpos
)
24091 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
24092 start_hpos
, end_hpos
,
24096 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24100 /* When we've written over the cursor, arrange for it to
24101 be displayed again. */
24102 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24105 display_and_set_cursor (w
, 1,
24106 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24107 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24112 /* Change the mouse cursor. */
24113 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
24114 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24115 else if (draw
== DRAW_MOUSE_FACE
)
24116 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24118 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24122 Clear out the mouse-highlighted active region.
24123 Redraw it un-highlighted first. Value is non-zero if mouse
24124 face was actually drawn unhighlighted. */
24127 clear_mouse_face (dpyinfo
)
24128 Display_Info
*dpyinfo
;
24132 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
24134 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
24138 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24139 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24140 dpyinfo
->mouse_face_window
= Qnil
;
24141 dpyinfo
->mouse_face_overlay
= Qnil
;
24147 Non-zero if physical cursor of window W is within mouse face. */
24150 cursor_in_mouse_face_p (w
)
24153 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24154 int in_mouse_face
= 0;
24156 if (WINDOWP (dpyinfo
->mouse_face_window
)
24157 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
24159 int hpos
= w
->phys_cursor
.hpos
;
24160 int vpos
= w
->phys_cursor
.vpos
;
24162 if (vpos
>= dpyinfo
->mouse_face_beg_row
24163 && vpos
<= dpyinfo
->mouse_face_end_row
24164 && (vpos
> dpyinfo
->mouse_face_beg_row
24165 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24166 && (vpos
< dpyinfo
->mouse_face_end_row
24167 || hpos
< dpyinfo
->mouse_face_end_col
24168 || dpyinfo
->mouse_face_past_end
))
24172 return in_mouse_face
;
24178 /* This function sets the mouse_face_* elements of DPYINFO, assuming
24179 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24180 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24181 for the overlay or run of text properties specifying the mouse
24182 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24183 before-string and after-string that must also be highlighted.
24184 DISPLAY_STRING, if non-nil, is a display string that may cover some
24185 or all of the highlighted text. */
24188 mouse_face_from_buffer_pos (Lisp_Object window
,
24189 Display_Info
*dpyinfo
,
24190 EMACS_INT mouse_charpos
,
24191 EMACS_INT start_charpos
,
24192 EMACS_INT end_charpos
,
24193 Lisp_Object before_string
,
24194 Lisp_Object after_string
,
24195 Lisp_Object display_string
)
24197 struct window
*w
= XWINDOW (window
);
24198 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24199 struct glyph_row
*row
;
24200 struct glyph
*glyph
, *end
;
24204 xassert (NILP (display_string
) || STRINGP (display_string
));
24205 xassert (NILP (before_string
) || STRINGP (before_string
));
24206 xassert (NILP (after_string
) || STRINGP (after_string
));
24208 /* Find the first highlighted glyph. */
24209 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
24211 dpyinfo
->mouse_face_beg_col
= 0;
24212 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
24213 dpyinfo
->mouse_face_beg_x
= first
->x
;
24214 dpyinfo
->mouse_face_beg_y
= first
->y
;
24218 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
24220 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24222 /* If the before-string or display-string contains newlines,
24223 row_containing_pos skips to its last row. Move back. */
24224 if (!NILP (before_string
) || !NILP (display_string
))
24226 struct glyph_row
*prev
;
24227 while ((prev
= row
- 1, prev
>= first
)
24228 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24229 && prev
->used
[TEXT_AREA
] > 0)
24231 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24232 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24233 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24235 || !(EQ (glyph
->object
, before_string
)
24236 || EQ (glyph
->object
, display_string
)))
24242 glyph
= row
->glyphs
[TEXT_AREA
];
24243 end
= glyph
+ row
->used
[TEXT_AREA
];
24245 dpyinfo
->mouse_face_beg_y
= row
->y
;
24246 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24248 /* Skip truncation glyphs at the start of the glyph row. */
24249 if (row
->displays_text_p
)
24251 && INTEGERP (glyph
->object
)
24252 && glyph
->charpos
< 0;
24254 x
+= glyph
->pixel_width
;
24256 /* Scan the glyph row, stopping before BEFORE_STRING or
24257 DISPLAY_STRING or START_CHARPOS. */
24259 && !INTEGERP (glyph
->object
)
24260 && !EQ (glyph
->object
, before_string
)
24261 && !EQ (glyph
->object
, display_string
)
24262 && !(BUFFERP (glyph
->object
)
24263 && glyph
->charpos
>= start_charpos
);
24265 x
+= glyph
->pixel_width
;
24267 dpyinfo
->mouse_face_beg_x
= x
;
24268 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24271 /* Find the last highlighted glyph. */
24272 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
24275 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24276 dpyinfo
->mouse_face_past_end
= 1;
24278 else if (!NILP (after_string
))
24280 /* If the after-string has newlines, advance to its last row. */
24281 struct glyph_row
*next
;
24282 struct glyph_row
*last
24283 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24285 for (next
= row
+ 1;
24287 && next
->used
[TEXT_AREA
] > 0
24288 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24293 glyph
= row
->glyphs
[TEXT_AREA
];
24294 end
= glyph
+ row
->used
[TEXT_AREA
];
24296 dpyinfo
->mouse_face_end_y
= row
->y
;
24297 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24299 /* Skip truncation glyphs at the start of the row. */
24300 if (row
->displays_text_p
)
24302 && INTEGERP (glyph
->object
)
24303 && glyph
->charpos
< 0;
24305 x
+= glyph
->pixel_width
;
24307 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
24310 && !INTEGERP (glyph
->object
)
24311 && !EQ (glyph
->object
, after_string
)
24312 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
24314 x
+= glyph
->pixel_width
;
24316 /* If we found AFTER_STRING, consume it and stop. */
24317 if (EQ (glyph
->object
, after_string
))
24319 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
24320 x
+= glyph
->pixel_width
;
24324 /* If there's no after-string, we must check if we overshot,
24325 which might be the case if we stopped after a string glyph.
24326 That glyph may belong to a before-string or display-string
24327 associated with the end position, which must not be
24329 Lisp_Object prev_object
;
24332 while (glyph
> row
->glyphs
[TEXT_AREA
])
24334 prev_object
= (glyph
- 1)->object
;
24335 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
24338 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
24339 if (pos
&& pos
< end_charpos
)
24342 for (; glyph
> row
->glyphs
[TEXT_AREA
]
24343 && EQ ((glyph
- 1)->object
, prev_object
);
24345 x
-= (glyph
- 1)->pixel_width
;
24349 dpyinfo
->mouse_face_end_x
= x
;
24350 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24351 dpyinfo
->mouse_face_window
= window
;
24352 dpyinfo
->mouse_face_face_id
24353 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24355 !dpyinfo
->mouse_face_hidden
, -1);
24356 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24360 /* Find the position of the glyph for position POS in OBJECT in
24361 window W's current matrix, and return in *X, *Y the pixel
24362 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24364 RIGHT_P non-zero means return the position of the right edge of the
24365 glyph, RIGHT_P zero means return the left edge position.
24367 If no glyph for POS exists in the matrix, return the position of
24368 the glyph with the next smaller position that is in the matrix, if
24369 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24370 exists in the matrix, return the position of the glyph with the
24371 next larger position in OBJECT.
24373 Value is non-zero if a glyph was found. */
24376 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
24379 Lisp_Object object
;
24380 int *hpos
, *vpos
, *x
, *y
;
24383 int yb
= window_text_bottom_y (w
);
24384 struct glyph_row
*r
;
24385 struct glyph
*best_glyph
= NULL
;
24386 struct glyph_row
*best_row
= NULL
;
24389 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24390 r
->enabled_p
&& r
->y
< yb
;
24393 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24394 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24397 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24398 if (EQ (g
->object
, object
))
24400 if (g
->charpos
== pos
)
24407 else if (best_glyph
== NULL
24408 || ((eabs (g
->charpos
- pos
)
24409 < eabs (best_glyph
->charpos
- pos
))
24412 : g
->charpos
> pos
)))
24426 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24430 *x
+= best_glyph
->pixel_width
;
24435 *vpos
= best_row
- w
->current_matrix
->rows
;
24438 return best_glyph
!= NULL
;
24442 /* See if position X, Y is within a hot-spot of an image. */
24445 on_hot_spot_p (hot_spot
, x
, y
)
24446 Lisp_Object hot_spot
;
24449 if (!CONSP (hot_spot
))
24452 if (EQ (XCAR (hot_spot
), Qrect
))
24454 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24455 Lisp_Object rect
= XCDR (hot_spot
);
24459 if (!CONSP (XCAR (rect
)))
24461 if (!CONSP (XCDR (rect
)))
24463 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24465 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24467 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24469 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24473 else if (EQ (XCAR (hot_spot
), Qcircle
))
24475 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24476 Lisp_Object circ
= XCDR (hot_spot
);
24477 Lisp_Object lr
, lx0
, ly0
;
24479 && CONSP (XCAR (circ
))
24480 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24481 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24482 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24484 double r
= XFLOATINT (lr
);
24485 double dx
= XINT (lx0
) - x
;
24486 double dy
= XINT (ly0
) - y
;
24487 return (dx
* dx
+ dy
* dy
<= r
* r
);
24490 else if (EQ (XCAR (hot_spot
), Qpoly
))
24492 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24493 if (VECTORP (XCDR (hot_spot
)))
24495 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24496 Lisp_Object
*poly
= v
->contents
;
24500 Lisp_Object lx
, ly
;
24503 /* Need an even number of coordinates, and at least 3 edges. */
24504 if (n
< 6 || n
& 1)
24507 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24508 If count is odd, we are inside polygon. Pixels on edges
24509 may or may not be included depending on actual geometry of the
24511 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24512 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24514 x0
= XINT (lx
), y0
= XINT (ly
);
24515 for (i
= 0; i
< n
; i
+= 2)
24517 int x1
= x0
, y1
= y0
;
24518 if ((lx
= poly
[i
], !INTEGERP (lx
))
24519 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24521 x0
= XINT (lx
), y0
= XINT (ly
);
24523 /* Does this segment cross the X line? */
24531 if (y
> y0
&& y
> y1
)
24533 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24543 find_hot_spot (map
, x
, y
)
24547 while (CONSP (map
))
24549 if (CONSP (XCAR (map
))
24550 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24558 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24560 doc
: /* Lookup in image map MAP coordinates X and Y.
24561 An image map is an alist where each element has the format (AREA ID PLIST).
24562 An AREA is specified as either a rectangle, a circle, or a polygon:
24563 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24564 pixel coordinates of the upper left and bottom right corners.
24565 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24566 and the radius of the circle; r may be a float or integer.
24567 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24568 vector describes one corner in the polygon.
24569 Returns the alist element for the first matching AREA in MAP. */)
24580 return find_hot_spot (map
, XINT (x
), XINT (y
));
24584 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24586 define_frame_cursor1 (f
, cursor
, pointer
)
24589 Lisp_Object pointer
;
24591 /* Do not change cursor shape while dragging mouse. */
24592 if (!NILP (do_mouse_tracking
))
24595 if (!NILP (pointer
))
24597 if (EQ (pointer
, Qarrow
))
24598 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24599 else if (EQ (pointer
, Qhand
))
24600 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24601 else if (EQ (pointer
, Qtext
))
24602 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24603 else if (EQ (pointer
, intern ("hdrag")))
24604 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24605 #ifdef HAVE_X_WINDOWS
24606 else if (EQ (pointer
, intern ("vdrag")))
24607 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24609 else if (EQ (pointer
, intern ("hourglass")))
24610 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24611 else if (EQ (pointer
, Qmodeline
))
24612 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24614 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24617 if (cursor
!= No_Cursor
)
24618 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24621 /* Take proper action when mouse has moved to the mode or header line
24622 or marginal area AREA of window W, x-position X and y-position Y.
24623 X is relative to the start of the text display area of W, so the
24624 width of bitmap areas and scroll bars must be subtracted to get a
24625 position relative to the start of the mode line. */
24628 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24629 Lisp_Object window
;
24631 enum window_part area
;
24633 struct window
*w
= XWINDOW (window
);
24634 struct frame
*f
= XFRAME (w
->frame
);
24635 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24636 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24637 Lisp_Object pointer
= Qnil
;
24638 int charpos
, dx
, dy
, width
, height
;
24639 Lisp_Object string
, object
= Qnil
;
24640 Lisp_Object pos
, help
;
24642 Lisp_Object mouse_face
;
24643 int original_x_pixel
= x
;
24644 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24645 struct glyph_row
*row
;
24647 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24652 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24653 &object
, &dx
, &dy
, &width
, &height
);
24655 row
= (area
== ON_MODE_LINE
24656 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24657 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24660 if (row
->mode_line_p
&& row
->enabled_p
)
24662 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24663 end
= glyph
+ row
->used
[TEXT_AREA
];
24665 for (x0
= original_x_pixel
;
24666 glyph
< end
&& x0
>= glyph
->pixel_width
;
24668 x0
-= glyph
->pixel_width
;
24676 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24677 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24678 &object
, &dx
, &dy
, &width
, &height
);
24683 if (IMAGEP (object
))
24685 Lisp_Object image_map
, hotspot
;
24686 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24688 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24690 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24692 Lisp_Object area_id
, plist
;
24694 area_id
= XCAR (hotspot
);
24695 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24696 If so, we could look for mouse-enter, mouse-leave
24697 properties in PLIST (and do something...). */
24698 hotspot
= XCDR (hotspot
);
24699 if (CONSP (hotspot
)
24700 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24702 pointer
= Fplist_get (plist
, Qpointer
);
24703 if (NILP (pointer
))
24705 help
= Fplist_get (plist
, Qhelp_echo
);
24708 help_echo_string
= help
;
24709 /* Is this correct? ++kfs */
24710 XSETWINDOW (help_echo_window
, w
);
24711 help_echo_object
= w
->buffer
;
24712 help_echo_pos
= charpos
;
24716 if (NILP (pointer
))
24717 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24720 if (STRINGP (string
))
24722 pos
= make_number (charpos
);
24723 /* If we're on a string with `help-echo' text property, arrange
24724 for the help to be displayed. This is done by setting the
24725 global variable help_echo_string to the help string. */
24728 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24731 help_echo_string
= help
;
24732 XSETWINDOW (help_echo_window
, w
);
24733 help_echo_object
= string
;
24734 help_echo_pos
= charpos
;
24738 if (NILP (pointer
))
24739 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24741 /* Change the mouse pointer according to what is under X/Y. */
24742 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24745 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24746 if (!KEYMAPP (map
))
24747 map
= Fget_text_property (pos
, Qkeymap
, string
);
24748 if (!KEYMAPP (map
))
24749 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24752 /* Change the mouse face according to what is under X/Y. */
24753 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24754 if (!NILP (mouse_face
)
24755 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24760 struct glyph
* tmp_glyph
;
24764 int total_pixel_width
;
24769 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24770 Qmouse_face
, string
, Qnil
);
24772 b
= make_number (0);
24774 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24776 e
= make_number (SCHARS (string
));
24778 /* Calculate the position(glyph position: GPOS) of GLYPH in
24779 displayed string. GPOS is different from CHARPOS.
24781 CHARPOS is the position of glyph in internal string
24782 object. A mode line string format has structures which
24783 is converted to a flatten by emacs lisp interpreter.
24784 The internal string is an element of the structures.
24785 The displayed string is the flatten string. */
24787 if (glyph
> row_start_glyph
)
24789 tmp_glyph
= glyph
- 1;
24790 while (tmp_glyph
>= row_start_glyph
24791 && tmp_glyph
->charpos
>= XINT (b
)
24792 && EQ (tmp_glyph
->object
, glyph
->object
))
24799 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24800 displayed string holding GLYPH.
24802 GSEQ_LENGTH is different from SCHARS (STRING).
24803 SCHARS (STRING) returns the length of the internal string. */
24804 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24805 tmp_glyph
->charpos
< XINT (e
);
24806 tmp_glyph
++, gseq_length
++)
24808 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24812 total_pixel_width
= 0;
24813 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24814 total_pixel_width
+= tmp_glyph
->pixel_width
;
24816 /* Pre calculation of re-rendering position */
24818 hpos
= (area
== ON_MODE_LINE
24819 ? (w
->current_matrix
)->nrows
- 1
24822 /* If the re-rendering position is included in the last
24823 re-rendering area, we should do nothing. */
24824 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24825 && dpyinfo
->mouse_face_beg_col
<= vpos
24826 && vpos
< dpyinfo
->mouse_face_end_col
24827 && dpyinfo
->mouse_face_beg_row
== hpos
)
24830 if (clear_mouse_face (dpyinfo
))
24831 cursor
= No_Cursor
;
24833 dpyinfo
->mouse_face_beg_col
= vpos
;
24834 dpyinfo
->mouse_face_beg_row
= hpos
;
24836 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24837 dpyinfo
->mouse_face_beg_y
= 0;
24839 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24840 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24842 dpyinfo
->mouse_face_end_x
= 0;
24843 dpyinfo
->mouse_face_end_y
= 0;
24845 dpyinfo
->mouse_face_past_end
= 0;
24846 dpyinfo
->mouse_face_window
= window
;
24848 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24851 glyph
->face_id
, 1);
24852 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24854 if (NILP (pointer
))
24857 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24858 clear_mouse_face (dpyinfo
);
24860 define_frame_cursor1 (f
, cursor
, pointer
);
24865 Take proper action when the mouse has moved to position X, Y on
24866 frame F as regards highlighting characters that have mouse-face
24867 properties. Also de-highlighting chars where the mouse was before.
24868 X and Y can be negative or out of range. */
24871 note_mouse_highlight (f
, x
, y
)
24875 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24876 enum window_part part
;
24877 Lisp_Object window
;
24879 Cursor cursor
= No_Cursor
;
24880 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24883 /* When a menu is active, don't highlight because this looks odd. */
24884 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24885 if (popup_activated ())
24889 if (NILP (Vmouse_highlight
)
24890 || !f
->glyphs_initialized_p
24891 || f
->pointer_invisible
)
24894 dpyinfo
->mouse_face_mouse_x
= x
;
24895 dpyinfo
->mouse_face_mouse_y
= y
;
24896 dpyinfo
->mouse_face_mouse_frame
= f
;
24898 if (dpyinfo
->mouse_face_defer
)
24901 if (gc_in_progress
)
24903 dpyinfo
->mouse_face_deferred_gc
= 1;
24907 /* Which window is that in? */
24908 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24910 /* If we were displaying active text in another window, clear that.
24911 Also clear if we move out of text area in same window. */
24912 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24913 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24914 && !NILP (dpyinfo
->mouse_face_window
)))
24915 clear_mouse_face (dpyinfo
);
24917 /* Not on a window -> return. */
24918 if (!WINDOWP (window
))
24921 /* Reset help_echo_string. It will get recomputed below. */
24922 help_echo_string
= Qnil
;
24924 /* Convert to window-relative pixel coordinates. */
24925 w
= XWINDOW (window
);
24926 frame_to_window_pixel_xy (w
, &x
, &y
);
24928 /* Handle tool-bar window differently since it doesn't display a
24930 if (EQ (window
, f
->tool_bar_window
))
24932 note_tool_bar_highlight (f
, x
, y
);
24936 /* Mouse is on the mode, header line or margin? */
24937 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24938 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24940 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24944 if (part
== ON_VERTICAL_BORDER
)
24946 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24947 help_echo_string
= build_string ("drag-mouse-1: resize");
24949 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24950 || part
== ON_SCROLL_BAR
)
24951 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24953 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24955 /* Are we in a window whose display is up to date?
24956 And verify the buffer's text has not changed. */
24957 b
= XBUFFER (w
->buffer
);
24958 if (part
== ON_TEXT
24959 && EQ (w
->window_end_valid
, w
->buffer
)
24960 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24961 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24963 int hpos
, vpos
, i
, dx
, dy
, area
;
24965 struct glyph
*glyph
;
24966 Lisp_Object object
;
24967 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24968 Lisp_Object
*overlay_vec
= NULL
;
24970 struct buffer
*obuf
;
24971 int obegv
, ozv
, same_region
;
24973 /* Find the glyph under X/Y. */
24974 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24976 /* Look for :pointer property on image. */
24977 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24979 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24980 if (img
!= NULL
&& IMAGEP (img
->spec
))
24982 Lisp_Object image_map
, hotspot
;
24983 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24985 && (hotspot
= find_hot_spot (image_map
,
24986 glyph
->slice
.x
+ dx
,
24987 glyph
->slice
.y
+ dy
),
24989 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24991 Lisp_Object area_id
, plist
;
24993 area_id
= XCAR (hotspot
);
24994 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24995 If so, we could look for mouse-enter, mouse-leave
24996 properties in PLIST (and do something...). */
24997 hotspot
= XCDR (hotspot
);
24998 if (CONSP (hotspot
)
24999 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25001 pointer
= Fplist_get (plist
, Qpointer
);
25002 if (NILP (pointer
))
25004 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25005 if (!NILP (help_echo_string
))
25007 help_echo_window
= window
;
25008 help_echo_object
= glyph
->object
;
25009 help_echo_pos
= glyph
->charpos
;
25013 if (NILP (pointer
))
25014 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25018 /* Clear mouse face if X/Y not over text. */
25020 || area
!= TEXT_AREA
25021 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
25023 if (clear_mouse_face (dpyinfo
))
25024 cursor
= No_Cursor
;
25025 if (NILP (pointer
))
25027 if (area
!= TEXT_AREA
)
25028 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25030 pointer
= Vvoid_text_area_pointer
;
25035 pos
= glyph
->charpos
;
25036 object
= glyph
->object
;
25037 if (!STRINGP (object
) && !BUFFERP (object
))
25040 /* If we get an out-of-range value, return now; avoid an error. */
25041 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25044 /* Make the window's buffer temporarily current for
25045 overlays_at and compute_char_face. */
25046 obuf
= current_buffer
;
25047 current_buffer
= b
;
25053 /* Is this char mouse-active or does it have help-echo? */
25054 position
= make_number (pos
);
25056 if (BUFFERP (object
))
25058 /* Put all the overlays we want in a vector in overlay_vec. */
25059 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25060 /* Sort overlays into increasing priority order. */
25061 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25066 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
25067 && vpos
>= dpyinfo
->mouse_face_beg_row
25068 && vpos
<= dpyinfo
->mouse_face_end_row
25069 && (vpos
> dpyinfo
->mouse_face_beg_row
25070 || hpos
>= dpyinfo
->mouse_face_beg_col
)
25071 && (vpos
< dpyinfo
->mouse_face_end_row
25072 || hpos
< dpyinfo
->mouse_face_end_col
25073 || dpyinfo
->mouse_face_past_end
));
25076 cursor
= No_Cursor
;
25078 /* Check mouse-face highlighting. */
25080 /* If there exists an overlay with mouse-face overlapping
25081 the one we are currently highlighting, we have to
25082 check if we enter the overlapping overlay, and then
25083 highlight only that. */
25084 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
25085 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
25087 /* Find the highest priority overlay with a mouse-face. */
25089 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25091 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25092 if (!NILP (mouse_face
))
25093 overlay
= overlay_vec
[i
];
25096 /* If we're highlighting the same overlay as before, there's
25097 no need to do that again. */
25098 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
25099 goto check_help_echo
;
25100 dpyinfo
->mouse_face_overlay
= overlay
;
25102 /* Clear the display of the old active region, if any. */
25103 if (clear_mouse_face (dpyinfo
))
25104 cursor
= No_Cursor
;
25106 /* If no overlay applies, get a text property. */
25107 if (NILP (overlay
))
25108 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25110 /* Next, compute the bounds of the mouse highlighting and
25112 if (!NILP (mouse_face
) && STRINGP (object
))
25114 /* The mouse-highlighting comes from a display string
25115 with a mouse-face. */
25119 b
= Fprevious_single_property_change
25120 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25121 e
= Fnext_single_property_change
25122 (position
, Qmouse_face
, object
, Qnil
);
25124 b
= make_number (0);
25126 e
= make_number (SCHARS (object
) - 1);
25128 fast_find_string_pos (w
, XINT (b
), object
,
25129 &dpyinfo
->mouse_face_beg_col
,
25130 &dpyinfo
->mouse_face_beg_row
,
25131 &dpyinfo
->mouse_face_beg_x
,
25132 &dpyinfo
->mouse_face_beg_y
, 0);
25133 fast_find_string_pos (w
, XINT (e
), object
,
25134 &dpyinfo
->mouse_face_end_col
,
25135 &dpyinfo
->mouse_face_end_row
,
25136 &dpyinfo
->mouse_face_end_x
,
25137 &dpyinfo
->mouse_face_end_y
, 1);
25138 dpyinfo
->mouse_face_past_end
= 0;
25139 dpyinfo
->mouse_face_window
= window
;
25140 dpyinfo
->mouse_face_face_id
25141 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25142 glyph
->face_id
, 1);
25143 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
25144 cursor
= No_Cursor
;
25148 /* The mouse-highlighting, if any, comes from an overlay
25149 or text property in the buffer. */
25150 Lisp_Object buffer
, display_string
;
25152 if (STRINGP (object
))
25154 /* If we are on a display string with no mouse-face,
25155 check if the text under it has one. */
25156 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25157 int start
= MATRIX_ROW_START_CHARPOS (r
);
25158 pos
= string_buffer_position (w
, object
, start
);
25161 mouse_face
= get_char_property_and_overlay
25162 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25163 buffer
= w
->buffer
;
25164 display_string
= object
;
25170 display_string
= Qnil
;
25173 if (!NILP (mouse_face
))
25175 Lisp_Object before
, after
;
25176 Lisp_Object before_string
, after_string
;
25178 if (NILP (overlay
))
25180 /* Handle the text property case. */
25181 before
= Fprevious_single_property_change
25182 (make_number (pos
+ 1), Qmouse_face
, buffer
,
25183 Fmarker_position (w
->start
));
25184 after
= Fnext_single_property_change
25185 (make_number (pos
), Qmouse_face
, buffer
,
25186 make_number (BUF_Z (XBUFFER (buffer
))
25187 - XFASTINT (w
->window_end_pos
)));
25188 before_string
= after_string
= Qnil
;
25192 /* Handle the overlay case. */
25193 before
= Foverlay_start (overlay
);
25194 after
= Foverlay_end (overlay
);
25195 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25196 after_string
= Foverlay_get (overlay
, Qafter_string
);
25198 if (!STRINGP (before_string
)) before_string
= Qnil
;
25199 if (!STRINGP (after_string
)) after_string
= Qnil
;
25202 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
25205 before_string
, after_string
,
25207 cursor
= No_Cursor
;
25214 /* Look for a `help-echo' property. */
25215 if (NILP (help_echo_string
)) {
25216 Lisp_Object help
, overlay
;
25218 /* Check overlays first. */
25219 help
= overlay
= Qnil
;
25220 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25222 overlay
= overlay_vec
[i
];
25223 help
= Foverlay_get (overlay
, Qhelp_echo
);
25228 help_echo_string
= help
;
25229 help_echo_window
= window
;
25230 help_echo_object
= overlay
;
25231 help_echo_pos
= pos
;
25235 Lisp_Object object
= glyph
->object
;
25236 int charpos
= glyph
->charpos
;
25238 /* Try text properties. */
25239 if (STRINGP (object
)
25241 && charpos
< SCHARS (object
))
25243 help
= Fget_text_property (make_number (charpos
),
25244 Qhelp_echo
, object
);
25247 /* If the string itself doesn't specify a help-echo,
25248 see if the buffer text ``under'' it does. */
25249 struct glyph_row
*r
25250 = MATRIX_ROW (w
->current_matrix
, vpos
);
25251 int start
= MATRIX_ROW_START_CHARPOS (r
);
25252 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
25255 help
= Fget_char_property (make_number (pos
),
25256 Qhelp_echo
, w
->buffer
);
25260 object
= w
->buffer
;
25265 else if (BUFFERP (object
)
25268 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25273 help_echo_string
= help
;
25274 help_echo_window
= window
;
25275 help_echo_object
= object
;
25276 help_echo_pos
= charpos
;
25281 /* Look for a `pointer' property. */
25282 if (NILP (pointer
))
25284 /* Check overlays first. */
25285 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25286 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25288 if (NILP (pointer
))
25290 Lisp_Object object
= glyph
->object
;
25291 int charpos
= glyph
->charpos
;
25293 /* Try text properties. */
25294 if (STRINGP (object
)
25296 && charpos
< SCHARS (object
))
25298 pointer
= Fget_text_property (make_number (charpos
),
25300 if (NILP (pointer
))
25302 /* If the string itself doesn't specify a pointer,
25303 see if the buffer text ``under'' it does. */
25304 struct glyph_row
*r
25305 = MATRIX_ROW (w
->current_matrix
, vpos
);
25306 int start
= MATRIX_ROW_START_CHARPOS (r
);
25307 EMACS_INT pos
= string_buffer_position (w
, object
,
25310 pointer
= Fget_char_property (make_number (pos
),
25311 Qpointer
, w
->buffer
);
25314 else if (BUFFERP (object
)
25317 pointer
= Fget_text_property (make_number (charpos
),
25324 current_buffer
= obuf
;
25329 define_frame_cursor1 (f
, cursor
, pointer
);
25334 Clear any mouse-face on window W. This function is part of the
25335 redisplay interface, and is called from try_window_id and similar
25336 functions to ensure the mouse-highlight is off. */
25339 x_clear_window_mouse_face (w
)
25342 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
25343 Lisp_Object window
;
25346 XSETWINDOW (window
, w
);
25347 if (EQ (window
, dpyinfo
->mouse_face_window
))
25348 clear_mouse_face (dpyinfo
);
25354 Just discard the mouse face information for frame F, if any.
25355 This is used when the size of F is changed. */
25358 cancel_mouse_face (f
)
25361 Lisp_Object window
;
25362 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25364 window
= dpyinfo
->mouse_face_window
;
25365 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25367 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25368 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25369 dpyinfo
->mouse_face_window
= Qnil
;
25374 #endif /* HAVE_WINDOW_SYSTEM */
25377 /***********************************************************************
25379 ***********************************************************************/
25381 #ifdef HAVE_WINDOW_SYSTEM
25383 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25384 which intersects rectangle R. R is in window-relative coordinates. */
25387 expose_area (w
, row
, r
, area
)
25389 struct glyph_row
*row
;
25391 enum glyph_row_area area
;
25393 struct glyph
*first
= row
->glyphs
[area
];
25394 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25395 struct glyph
*last
;
25396 int first_x
, start_x
, x
;
25398 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25399 /* If row extends face to end of line write the whole line. */
25400 draw_glyphs (w
, 0, row
, area
,
25401 0, row
->used
[area
],
25402 DRAW_NORMAL_TEXT
, 0);
25405 /* Set START_X to the window-relative start position for drawing glyphs of
25406 AREA. The first glyph of the text area can be partially visible.
25407 The first glyphs of other areas cannot. */
25408 start_x
= window_box_left_offset (w
, area
);
25410 if (area
== TEXT_AREA
)
25413 /* Find the first glyph that must be redrawn. */
25415 && x
+ first
->pixel_width
< r
->x
)
25417 x
+= first
->pixel_width
;
25421 /* Find the last one. */
25425 && x
< r
->x
+ r
->width
)
25427 x
+= last
->pixel_width
;
25433 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25434 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25435 DRAW_NORMAL_TEXT
, 0);
25440 /* Redraw the parts of the glyph row ROW on window W intersecting
25441 rectangle R. R is in window-relative coordinates. Value is
25442 non-zero if mouse-face was overwritten. */
25445 expose_line (w
, row
, r
)
25447 struct glyph_row
*row
;
25450 xassert (row
->enabled_p
);
25452 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25453 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25454 0, row
->used
[TEXT_AREA
],
25455 DRAW_NORMAL_TEXT
, 0);
25458 if (row
->used
[LEFT_MARGIN_AREA
])
25459 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25460 if (row
->used
[TEXT_AREA
])
25461 expose_area (w
, row
, r
, TEXT_AREA
);
25462 if (row
->used
[RIGHT_MARGIN_AREA
])
25463 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25464 draw_row_fringe_bitmaps (w
, row
);
25467 return row
->mouse_face_p
;
25471 /* Redraw those parts of glyphs rows during expose event handling that
25472 overlap other rows. Redrawing of an exposed line writes over parts
25473 of lines overlapping that exposed line; this function fixes that.
25475 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25476 row in W's current matrix that is exposed and overlaps other rows.
25477 LAST_OVERLAPPING_ROW is the last such row. */
25480 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25482 struct glyph_row
*first_overlapping_row
;
25483 struct glyph_row
*last_overlapping_row
;
25486 struct glyph_row
*row
;
25488 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25489 if (row
->overlapping_p
)
25491 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25494 if (row
->used
[LEFT_MARGIN_AREA
])
25495 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25497 if (row
->used
[TEXT_AREA
])
25498 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25500 if (row
->used
[RIGHT_MARGIN_AREA
])
25501 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25507 /* Return non-zero if W's cursor intersects rectangle R. */
25510 phys_cursor_in_rect_p (w
, r
)
25514 XRectangle cr
, result
;
25515 struct glyph
*cursor_glyph
;
25516 struct glyph_row
*row
;
25518 if (w
->phys_cursor
.vpos
>= 0
25519 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25520 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25522 && row
->cursor_in_fringe_p
)
25524 /* Cursor is in the fringe. */
25525 cr
.x
= window_box_right_offset (w
,
25526 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25527 ? RIGHT_MARGIN_AREA
25530 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25531 cr
.height
= row
->height
;
25532 return x_intersect_rectangles (&cr
, r
, &result
);
25535 cursor_glyph
= get_phys_cursor_glyph (w
);
25538 /* r is relative to W's box, but w->phys_cursor.x is relative
25539 to left edge of W's TEXT area. Adjust it. */
25540 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25541 cr
.y
= w
->phys_cursor
.y
;
25542 cr
.width
= cursor_glyph
->pixel_width
;
25543 cr
.height
= w
->phys_cursor_height
;
25544 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25545 I assume the effect is the same -- and this is portable. */
25546 return x_intersect_rectangles (&cr
, r
, &result
);
25548 /* If we don't understand the format, pretend we're not in the hot-spot. */
25554 Draw a vertical window border to the right of window W if W doesn't
25555 have vertical scroll bars. */
25558 x_draw_vertical_border (w
)
25561 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25563 /* We could do better, if we knew what type of scroll-bar the adjacent
25564 windows (on either side) have... But we don't :-(
25565 However, I think this works ok. ++KFS 2003-04-25 */
25567 /* Redraw borders between horizontally adjacent windows. Don't
25568 do it for frames with vertical scroll bars because either the
25569 right scroll bar of a window, or the left scroll bar of its
25570 neighbor will suffice as a border. */
25571 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25574 if (!WINDOW_RIGHTMOST_P (w
)
25575 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25577 int x0
, x1
, y0
, y1
;
25579 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25582 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25585 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25587 else if (!WINDOW_LEFTMOST_P (w
)
25588 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25590 int x0
, x1
, y0
, y1
;
25592 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25595 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25598 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25603 /* Redraw the part of window W intersection rectangle FR. Pixel
25604 coordinates in FR are frame-relative. Call this function with
25605 input blocked. Value is non-zero if the exposure overwrites
25609 expose_window (w
, fr
)
25613 struct frame
*f
= XFRAME (w
->frame
);
25615 int mouse_face_overwritten_p
= 0;
25617 /* If window is not yet fully initialized, do nothing. This can
25618 happen when toolkit scroll bars are used and a window is split.
25619 Reconfiguring the scroll bar will generate an expose for a newly
25621 if (w
->current_matrix
== NULL
)
25624 /* When we're currently updating the window, display and current
25625 matrix usually don't agree. Arrange for a thorough display
25627 if (w
== updated_window
)
25629 SET_FRAME_GARBAGED (f
);
25633 /* Frame-relative pixel rectangle of W. */
25634 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25635 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25636 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25637 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25639 if (x_intersect_rectangles (fr
, &wr
, &r
))
25641 int yb
= window_text_bottom_y (w
);
25642 struct glyph_row
*row
;
25643 int cursor_cleared_p
;
25644 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25646 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25647 r
.x
, r
.y
, r
.width
, r
.height
));
25649 /* Convert to window coordinates. */
25650 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25651 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25653 /* Turn off the cursor. */
25654 if (!w
->pseudo_window_p
25655 && phys_cursor_in_rect_p (w
, &r
))
25657 x_clear_cursor (w
);
25658 cursor_cleared_p
= 1;
25661 cursor_cleared_p
= 0;
25663 /* Update lines intersecting rectangle R. */
25664 first_overlapping_row
= last_overlapping_row
= NULL
;
25665 for (row
= w
->current_matrix
->rows
;
25670 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25672 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25673 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25674 || (r
.y
>= y0
&& r
.y
< y1
)
25675 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25677 /* A header line may be overlapping, but there is no need
25678 to fix overlapping areas for them. KFS 2005-02-12 */
25679 if (row
->overlapping_p
&& !row
->mode_line_p
)
25681 if (first_overlapping_row
== NULL
)
25682 first_overlapping_row
= row
;
25683 last_overlapping_row
= row
;
25687 if (expose_line (w
, row
, &r
))
25688 mouse_face_overwritten_p
= 1;
25691 else if (row
->overlapping_p
)
25693 /* We must redraw a row overlapping the exposed area. */
25695 ? y0
+ row
->phys_height
> r
.y
25696 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25698 if (first_overlapping_row
== NULL
)
25699 first_overlapping_row
= row
;
25700 last_overlapping_row
= row
;
25708 /* Display the mode line if there is one. */
25709 if (WINDOW_WANTS_MODELINE_P (w
)
25710 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25712 && row
->y
< r
.y
+ r
.height
)
25714 if (expose_line (w
, row
, &r
))
25715 mouse_face_overwritten_p
= 1;
25718 if (!w
->pseudo_window_p
)
25720 /* Fix the display of overlapping rows. */
25721 if (first_overlapping_row
)
25722 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25725 /* Draw border between windows. */
25726 x_draw_vertical_border (w
);
25728 /* Turn the cursor on again. */
25729 if (cursor_cleared_p
)
25730 update_window_cursor (w
, 1);
25734 return mouse_face_overwritten_p
;
25739 /* Redraw (parts) of all windows in the window tree rooted at W that
25740 intersect R. R contains frame pixel coordinates. Value is
25741 non-zero if the exposure overwrites mouse-face. */
25744 expose_window_tree (w
, r
)
25748 struct frame
*f
= XFRAME (w
->frame
);
25749 int mouse_face_overwritten_p
= 0;
25751 while (w
&& !FRAME_GARBAGED_P (f
))
25753 if (!NILP (w
->hchild
))
25754 mouse_face_overwritten_p
25755 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25756 else if (!NILP (w
->vchild
))
25757 mouse_face_overwritten_p
25758 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25760 mouse_face_overwritten_p
|= expose_window (w
, r
);
25762 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25765 return mouse_face_overwritten_p
;
25770 Redisplay an exposed area of frame F. X and Y are the upper-left
25771 corner of the exposed rectangle. W and H are width and height of
25772 the exposed area. All are pixel values. W or H zero means redraw
25773 the entire frame. */
25776 expose_frame (f
, x
, y
, w
, h
)
25781 int mouse_face_overwritten_p
= 0;
25783 TRACE ((stderr
, "expose_frame "));
25785 /* No need to redraw if frame will be redrawn soon. */
25786 if (FRAME_GARBAGED_P (f
))
25788 TRACE ((stderr
, " garbaged\n"));
25792 /* If basic faces haven't been realized yet, there is no point in
25793 trying to redraw anything. This can happen when we get an expose
25794 event while Emacs is starting, e.g. by moving another window. */
25795 if (FRAME_FACE_CACHE (f
) == NULL
25796 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25798 TRACE ((stderr
, " no faces\n"));
25802 if (w
== 0 || h
== 0)
25805 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25806 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25816 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25817 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25819 if (WINDOWP (f
->tool_bar_window
))
25820 mouse_face_overwritten_p
25821 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25823 #ifdef HAVE_X_WINDOWS
25825 #ifndef USE_X_TOOLKIT
25826 if (WINDOWP (f
->menu_bar_window
))
25827 mouse_face_overwritten_p
25828 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25829 #endif /* not USE_X_TOOLKIT */
25833 /* Some window managers support a focus-follows-mouse style with
25834 delayed raising of frames. Imagine a partially obscured frame,
25835 and moving the mouse into partially obscured mouse-face on that
25836 frame. The visible part of the mouse-face will be highlighted,
25837 then the WM raises the obscured frame. With at least one WM, KDE
25838 2.1, Emacs is not getting any event for the raising of the frame
25839 (even tried with SubstructureRedirectMask), only Expose events.
25840 These expose events will draw text normally, i.e. not
25841 highlighted. Which means we must redo the highlight here.
25842 Subsume it under ``we love X''. --gerd 2001-08-15 */
25843 /* Included in Windows version because Windows most likely does not
25844 do the right thing if any third party tool offers
25845 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25846 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25848 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25849 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25851 int x
= dpyinfo
->mouse_face_mouse_x
;
25852 int y
= dpyinfo
->mouse_face_mouse_y
;
25853 clear_mouse_face (dpyinfo
);
25854 note_mouse_highlight (f
, x
, y
);
25861 Determine the intersection of two rectangles R1 and R2. Return
25862 the intersection in *RESULT. Value is non-zero if RESULT is not
25866 x_intersect_rectangles (r1
, r2
, result
)
25867 XRectangle
*r1
, *r2
, *result
;
25869 XRectangle
*left
, *right
;
25870 XRectangle
*upper
, *lower
;
25871 int intersection_p
= 0;
25873 /* Rearrange so that R1 is the left-most rectangle. */
25875 left
= r1
, right
= r2
;
25877 left
= r2
, right
= r1
;
25879 /* X0 of the intersection is right.x0, if this is inside R1,
25880 otherwise there is no intersection. */
25881 if (right
->x
<= left
->x
+ left
->width
)
25883 result
->x
= right
->x
;
25885 /* The right end of the intersection is the minimum of the
25886 the right ends of left and right. */
25887 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25890 /* Same game for Y. */
25892 upper
= r1
, lower
= r2
;
25894 upper
= r2
, lower
= r1
;
25896 /* The upper end of the intersection is lower.y0, if this is inside
25897 of upper. Otherwise, there is no intersection. */
25898 if (lower
->y
<= upper
->y
+ upper
->height
)
25900 result
->y
= lower
->y
;
25902 /* The lower end of the intersection is the minimum of the lower
25903 ends of upper and lower. */
25904 result
->height
= (min (lower
->y
+ lower
->height
,
25905 upper
->y
+ upper
->height
)
25907 intersection_p
= 1;
25911 return intersection_p
;
25914 #endif /* HAVE_WINDOW_SYSTEM */
25917 /***********************************************************************
25919 ***********************************************************************/
25924 Vwith_echo_area_save_vector
= Qnil
;
25925 staticpro (&Vwith_echo_area_save_vector
);
25927 Vmessage_stack
= Qnil
;
25928 staticpro (&Vmessage_stack
);
25930 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25931 staticpro (&Qinhibit_redisplay
);
25933 message_dolog_marker1
= Fmake_marker ();
25934 staticpro (&message_dolog_marker1
);
25935 message_dolog_marker2
= Fmake_marker ();
25936 staticpro (&message_dolog_marker2
);
25937 message_dolog_marker3
= Fmake_marker ();
25938 staticpro (&message_dolog_marker3
);
25941 defsubr (&Sdump_frame_glyph_matrix
);
25942 defsubr (&Sdump_glyph_matrix
);
25943 defsubr (&Sdump_glyph_row
);
25944 defsubr (&Sdump_tool_bar_row
);
25945 defsubr (&Strace_redisplay
);
25946 defsubr (&Strace_to_stderr
);
25948 #ifdef HAVE_WINDOW_SYSTEM
25949 defsubr (&Stool_bar_lines_needed
);
25950 defsubr (&Slookup_image_map
);
25952 defsubr (&Sformat_mode_line
);
25953 defsubr (&Sinvisible_p
);
25955 staticpro (&Qmenu_bar_update_hook
);
25956 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25958 staticpro (&Qoverriding_terminal_local_map
);
25959 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25961 staticpro (&Qoverriding_local_map
);
25962 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25964 staticpro (&Qwindow_scroll_functions
);
25965 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25967 staticpro (&Qwindow_text_change_functions
);
25968 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25970 staticpro (&Qredisplay_end_trigger_functions
);
25971 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25973 staticpro (&Qinhibit_point_motion_hooks
);
25974 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25976 Qeval
= intern_c_string ("eval");
25977 staticpro (&Qeval
);
25979 QCdata
= intern_c_string (":data");
25980 staticpro (&QCdata
);
25981 Qdisplay
= intern_c_string ("display");
25982 staticpro (&Qdisplay
);
25983 Qspace_width
= intern_c_string ("space-width");
25984 staticpro (&Qspace_width
);
25985 Qraise
= intern_c_string ("raise");
25986 staticpro (&Qraise
);
25987 Qslice
= intern_c_string ("slice");
25988 staticpro (&Qslice
);
25989 Qspace
= intern_c_string ("space");
25990 staticpro (&Qspace
);
25991 Qmargin
= intern_c_string ("margin");
25992 staticpro (&Qmargin
);
25993 Qpointer
= intern_c_string ("pointer");
25994 staticpro (&Qpointer
);
25995 Qleft_margin
= intern_c_string ("left-margin");
25996 staticpro (&Qleft_margin
);
25997 Qright_margin
= intern_c_string ("right-margin");
25998 staticpro (&Qright_margin
);
25999 Qcenter
= intern_c_string ("center");
26000 staticpro (&Qcenter
);
26001 Qline_height
= intern_c_string ("line-height");
26002 staticpro (&Qline_height
);
26003 QCalign_to
= intern_c_string (":align-to");
26004 staticpro (&QCalign_to
);
26005 QCrelative_width
= intern_c_string (":relative-width");
26006 staticpro (&QCrelative_width
);
26007 QCrelative_height
= intern_c_string (":relative-height");
26008 staticpro (&QCrelative_height
);
26009 QCeval
= intern_c_string (":eval");
26010 staticpro (&QCeval
);
26011 QCpropertize
= intern_c_string (":propertize");
26012 staticpro (&QCpropertize
);
26013 QCfile
= intern_c_string (":file");
26014 staticpro (&QCfile
);
26015 Qfontified
= intern_c_string ("fontified");
26016 staticpro (&Qfontified
);
26017 Qfontification_functions
= intern_c_string ("fontification-functions");
26018 staticpro (&Qfontification_functions
);
26019 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26020 staticpro (&Qtrailing_whitespace
);
26021 Qescape_glyph
= intern_c_string ("escape-glyph");
26022 staticpro (&Qescape_glyph
);
26023 Qnobreak_space
= intern_c_string ("nobreak-space");
26024 staticpro (&Qnobreak_space
);
26025 Qimage
= intern_c_string ("image");
26026 staticpro (&Qimage
);
26027 Qtext
= intern_c_string ("text");
26028 staticpro (&Qtext
);
26029 Qboth
= intern_c_string ("both");
26030 staticpro (&Qboth
);
26031 Qboth_horiz
= intern_c_string ("both-horiz");
26032 staticpro (&Qboth_horiz
);
26033 QCmap
= intern_c_string (":map");
26034 staticpro (&QCmap
);
26035 QCpointer
= intern_c_string (":pointer");
26036 staticpro (&QCpointer
);
26037 Qrect
= intern_c_string ("rect");
26038 staticpro (&Qrect
);
26039 Qcircle
= intern_c_string ("circle");
26040 staticpro (&Qcircle
);
26041 Qpoly
= intern_c_string ("poly");
26042 staticpro (&Qpoly
);
26043 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26044 staticpro (&Qmessage_truncate_lines
);
26045 Qgrow_only
= intern_c_string ("grow-only");
26046 staticpro (&Qgrow_only
);
26047 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26048 staticpro (&Qinhibit_menubar_update
);
26049 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26050 staticpro (&Qinhibit_eval_during_redisplay
);
26051 Qposition
= intern_c_string ("position");
26052 staticpro (&Qposition
);
26053 Qbuffer_position
= intern_c_string ("buffer-position");
26054 staticpro (&Qbuffer_position
);
26055 Qobject
= intern_c_string ("object");
26056 staticpro (&Qobject
);
26057 Qbar
= intern_c_string ("bar");
26059 Qhbar
= intern_c_string ("hbar");
26060 staticpro (&Qhbar
);
26061 Qbox
= intern_c_string ("box");
26063 Qhollow
= intern_c_string ("hollow");
26064 staticpro (&Qhollow
);
26065 Qhand
= intern_c_string ("hand");
26066 staticpro (&Qhand
);
26067 Qarrow
= intern_c_string ("arrow");
26068 staticpro (&Qarrow
);
26069 Qtext
= intern_c_string ("text");
26070 staticpro (&Qtext
);
26071 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
26072 staticpro (&Qrisky_local_variable
);
26073 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26074 staticpro (&Qinhibit_free_realized_faces
);
26076 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26077 Fcons (intern_c_string ("void-variable"), Qnil
)),
26079 staticpro (&list_of_error
);
26081 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26082 staticpro (&Qlast_arrow_position
);
26083 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26084 staticpro (&Qlast_arrow_string
);
26086 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26087 staticpro (&Qoverlay_arrow_string
);
26088 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26089 staticpro (&Qoverlay_arrow_bitmap
);
26091 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26092 staticpro (&echo_buffer
[0]);
26093 staticpro (&echo_buffer
[1]);
26095 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26096 staticpro (&echo_area_buffer
[0]);
26097 staticpro (&echo_area_buffer
[1]);
26099 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26100 staticpro (&Vmessages_buffer_name
);
26102 mode_line_proptrans_alist
= Qnil
;
26103 staticpro (&mode_line_proptrans_alist
);
26104 mode_line_string_list
= Qnil
;
26105 staticpro (&mode_line_string_list
);
26106 mode_line_string_face
= Qnil
;
26107 staticpro (&mode_line_string_face
);
26108 mode_line_string_face_prop
= Qnil
;
26109 staticpro (&mode_line_string_face_prop
);
26110 Vmode_line_unwind_vector
= Qnil
;
26111 staticpro (&Vmode_line_unwind_vector
);
26113 help_echo_string
= Qnil
;
26114 staticpro (&help_echo_string
);
26115 help_echo_object
= Qnil
;
26116 staticpro (&help_echo_object
);
26117 help_echo_window
= Qnil
;
26118 staticpro (&help_echo_window
);
26119 previous_help_echo_string
= Qnil
;
26120 staticpro (&previous_help_echo_string
);
26121 help_echo_pos
= -1;
26123 Qright_to_left
= intern_c_string ("right-to-left");
26124 staticpro (&Qright_to_left
);
26125 Qleft_to_right
= intern_c_string ("left-to-right");
26126 staticpro (&Qleft_to_right
);
26128 #ifdef HAVE_WINDOW_SYSTEM
26129 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
26130 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26131 For example, if a block cursor is over a tab, it will be drawn as
26132 wide as that tab on the display. */);
26133 x_stretch_cursor_p
= 0;
26136 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
26137 doc
: /* *Non-nil means highlight trailing whitespace.
26138 The face used for trailing whitespace is `trailing-whitespace'. */);
26139 Vshow_trailing_whitespace
= Qnil
;
26141 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
26142 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26143 A value of t means highlight the character itself (for nobreak space,
26144 use face `nobreak-space').
26145 A value of nil means no highlighting.
26146 Other values mean display the escape glyph followed by an ordinary
26147 space or ordinary hyphen. */);
26148 Vnobreak_char_display
= Qt
;
26150 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
26151 doc
: /* *The pointer shape to show in void text areas.
26152 A value of nil means to show the text pointer. Other options are `arrow',
26153 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26154 Vvoid_text_area_pointer
= Qarrow
;
26156 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
26157 doc
: /* Non-nil means don't actually do any redisplay.
26158 This is used for internal purposes. */);
26159 Vinhibit_redisplay
= Qnil
;
26161 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
26162 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26163 Vglobal_mode_string
= Qnil
;
26165 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
26166 doc
: /* Marker for where to display an arrow on top of the buffer text.
26167 This must be the beginning of a line in order to work.
26168 See also `overlay-arrow-string'. */);
26169 Voverlay_arrow_position
= Qnil
;
26171 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
26172 doc
: /* String to display as an arrow in non-window frames.
26173 See also `overlay-arrow-position'. */);
26174 Voverlay_arrow_string
= make_pure_c_string ("=>");
26176 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
26177 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26178 The symbols on this list are examined during redisplay to determine
26179 where to display overlay arrows. */);
26180 Voverlay_arrow_variable_list
26181 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26183 DEFVAR_INT ("scroll-step", &scroll_step
,
26184 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26185 If that fails to bring point back on frame, point is centered instead.
26186 If this is zero, point is always centered after it moves off frame.
26187 If you want scrolling to always be a line at a time, you should set
26188 `scroll-conservatively' to a large value rather than set this to 1. */);
26190 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
26191 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26192 If point moves off-screen, redisplay will scroll by up to
26193 `scroll-conservatively' lines in order to bring point just barely
26194 onto the screen again. If that cannot be done, then redisplay
26195 recenters point as usual.
26197 A value of zero means always recenter point if it moves off screen. */);
26198 scroll_conservatively
= 0;
26200 DEFVAR_INT ("scroll-margin", &scroll_margin
,
26201 doc
: /* *Number of lines of margin at the top and bottom of a window.
26202 Recenter the window whenever point gets within this many lines
26203 of the top or bottom of the window. */);
26206 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
26207 doc
: /* Pixels per inch value for non-window system displays.
26208 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26209 Vdisplay_pixels_per_inch
= make_float (72.0);
26212 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
26215 DEFVAR_LISP ("truncate-partial-width-windows",
26216 &Vtruncate_partial_width_windows
,
26217 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26218 For an integer value, truncate lines in each window narrower than the
26219 full frame width, provided the window width is less than that integer;
26220 otherwise, respect the value of `truncate-lines'.
26222 For any other non-nil value, truncate lines in all windows that do
26223 not span the full frame width.
26225 A value of nil means to respect the value of `truncate-lines'.
26227 If `word-wrap' is enabled, you might want to reduce this. */);
26228 Vtruncate_partial_width_windows
= make_number (50);
26230 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
26231 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26232 Any other value means to use the appropriate face, `mode-line',
26233 `header-line', or `menu' respectively. */);
26234 mode_line_inverse_video
= 1;
26236 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
26237 doc
: /* *Maximum buffer size for which line number should be displayed.
26238 If the buffer is bigger than this, the line number does not appear
26239 in the mode line. A value of nil means no limit. */);
26240 Vline_number_display_limit
= Qnil
;
26242 DEFVAR_INT ("line-number-display-limit-width",
26243 &line_number_display_limit_width
,
26244 doc
: /* *Maximum line width (in characters) for line number display.
26245 If the average length of the lines near point is bigger than this, then the
26246 line number may be omitted from the mode line. */);
26247 line_number_display_limit_width
= 200;
26249 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
26250 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26251 highlight_nonselected_windows
= 0;
26253 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
26254 doc
: /* Non-nil if more than one frame is visible on this display.
26255 Minibuffer-only frames don't count, but iconified frames do.
26256 This variable is not guaranteed to be accurate except while processing
26257 `frame-title-format' and `icon-title-format'. */);
26259 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
26260 doc
: /* Template for displaying the title bar of visible frames.
26261 \(Assuming the window manager supports this feature.)
26263 This variable has the same structure as `mode-line-format', except that
26264 the %c and %l constructs are ignored. It is used only on frames for
26265 which no explicit name has been set \(see `modify-frame-parameters'). */);
26267 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
26268 doc
: /* Template for displaying the title bar of an iconified frame.
26269 \(Assuming the window manager supports this feature.)
26270 This variable has the same structure as `mode-line-format' (which see),
26271 and is used only on frames for which no explicit name has been set
26272 \(see `modify-frame-parameters'). */);
26274 = Vframe_title_format
26275 = pure_cons (intern_c_string ("multiple-frames"),
26276 pure_cons (make_pure_c_string ("%b"),
26277 pure_cons (pure_cons (empty_unibyte_string
,
26278 pure_cons (intern_c_string ("invocation-name"),
26279 pure_cons (make_pure_c_string ("@"),
26280 pure_cons (intern_c_string ("system-name"),
26284 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
26285 doc
: /* Maximum number of lines to keep in the message log buffer.
26286 If nil, disable message logging. If t, log messages but don't truncate
26287 the buffer when it becomes large. */);
26288 Vmessage_log_max
= make_number (100);
26290 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
26291 doc
: /* Functions called before redisplay, if window sizes have changed.
26292 The value should be a list of functions that take one argument.
26293 Just before redisplay, for each frame, if any of its windows have changed
26294 size since the last redisplay, or have been split or deleted,
26295 all the functions in the list are called, with the frame as argument. */);
26296 Vwindow_size_change_functions
= Qnil
;
26298 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
26299 doc
: /* List of functions to call before redisplaying a window with scrolling.
26300 Each function is called with two arguments, the window and its new
26301 display-start position. Note that these functions are also called by
26302 `set-window-buffer'. Also note that the value of `window-end' is not
26303 valid when these functions are called. */);
26304 Vwindow_scroll_functions
= Qnil
;
26306 DEFVAR_LISP ("window-text-change-functions",
26307 &Vwindow_text_change_functions
,
26308 doc
: /* Functions to call in redisplay when text in the window might change. */);
26309 Vwindow_text_change_functions
= Qnil
;
26311 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
26312 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26313 Each function is called with two arguments, the window and the end trigger value.
26314 See `set-window-redisplay-end-trigger'. */);
26315 Vredisplay_end_trigger_functions
= Qnil
;
26317 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
26318 doc
: /* *Non-nil means autoselect window with mouse pointer.
26319 If nil, do not autoselect windows.
26320 A positive number means delay autoselection by that many seconds: a
26321 window is autoselected only after the mouse has remained in that
26322 window for the duration of the delay.
26323 A negative number has a similar effect, but causes windows to be
26324 autoselected only after the mouse has stopped moving. \(Because of
26325 the way Emacs compares mouse events, you will occasionally wait twice
26326 that time before the window gets selected.\)
26327 Any other value means to autoselect window instantaneously when the
26328 mouse pointer enters it.
26330 Autoselection selects the minibuffer only if it is active, and never
26331 unselects the minibuffer if it is active.
26333 When customizing this variable make sure that the actual value of
26334 `focus-follows-mouse' matches the behavior of your window manager. */);
26335 Vmouse_autoselect_window
= Qnil
;
26337 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
26338 doc
: /* *Non-nil means automatically resize tool-bars.
26339 This dynamically changes the tool-bar's height to the minimum height
26340 that is needed to make all tool-bar items visible.
26341 If value is `grow-only', the tool-bar's height is only increased
26342 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26343 Vauto_resize_tool_bars
= Qt
;
26345 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
26346 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26347 auto_raise_tool_bar_buttons_p
= 1;
26349 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
26350 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26351 make_cursor_line_fully_visible_p
= 1;
26353 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
26354 doc
: /* *Border below tool-bar in pixels.
26355 If an integer, use it as the height of the border.
26356 If it is one of `internal-border-width' or `border-width', use the
26357 value of the corresponding frame parameter.
26358 Otherwise, no border is added below the tool-bar. */);
26359 Vtool_bar_border
= Qinternal_border_width
;
26361 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
26362 doc
: /* *Margin around tool-bar buttons in pixels.
26363 If an integer, use that for both horizontal and vertical margins.
26364 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26365 HORZ specifying the horizontal margin, and VERT specifying the
26366 vertical margin. */);
26367 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26369 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
26370 doc
: /* *Relief thickness of tool-bar buttons. */);
26371 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26373 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
26374 doc
: /* *Tool bar style to use.
26376 image - show images only
26377 text - show text only
26378 both - show both, text under image
26379 both-horiz - show text to the right of the image
26380 any other - use system default or image if no system default. */);
26381 Vtool_bar_style
= Qnil
;
26383 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26384 doc
: /* *Maximum number of characters a label can have to be shown.
26385 The tool bar style must also show labels for this to have any effect, see
26386 `tool-bar-style'. */);
26387 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26389 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26390 doc
: /* List of functions to call to fontify regions of text.
26391 Each function is called with one argument POS. Functions must
26392 fontify a region starting at POS in the current buffer, and give
26393 fontified regions the property `fontified'. */);
26394 Vfontification_functions
= Qnil
;
26395 Fmake_variable_buffer_local (Qfontification_functions
);
26397 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26398 &unibyte_display_via_language_environment
,
26399 doc
: /* *Non-nil means display unibyte text according to language environment.
26400 Specifically, this means that raw bytes in the range 160-255 decimal
26401 are displayed by converting them to the equivalent multibyte characters
26402 according to the current language environment. As a result, they are
26403 displayed according to the current fontset.
26405 Note that this variable affects only how these bytes are displayed,
26406 but does not change the fact they are interpreted as raw bytes. */);
26407 unibyte_display_via_language_environment
= 0;
26409 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26410 doc
: /* *Maximum height for resizing mini-windows.
26411 If a float, it specifies a fraction of the mini-window frame's height.
26412 If an integer, it specifies a number of lines. */);
26413 Vmax_mini_window_height
= make_float (0.25);
26415 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26416 doc
: /* *How to resize mini-windows.
26417 A value of nil means don't automatically resize mini-windows.
26418 A value of t means resize them to fit the text displayed in them.
26419 A value of `grow-only', the default, means let mini-windows grow
26420 only, until their display becomes empty, at which point the windows
26421 go back to their normal size. */);
26422 Vresize_mini_windows
= Qgrow_only
;
26424 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26425 doc
: /* Alist specifying how to blink the cursor off.
26426 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26427 `cursor-type' frame-parameter or variable equals ON-STATE,
26428 comparing using `equal', Emacs uses OFF-STATE to specify
26429 how to blink it off. ON-STATE and OFF-STATE are values for
26430 the `cursor-type' frame parameter.
26432 If a frame's ON-STATE has no entry in this list,
26433 the frame's other specifications determine how to blink the cursor off. */);
26434 Vblink_cursor_alist
= Qnil
;
26436 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26437 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26438 automatic_hscrolling_p
= 1;
26439 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26440 staticpro (&Qauto_hscroll_mode
);
26442 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26443 doc
: /* *How many columns away from the window edge point is allowed to get
26444 before automatic hscrolling will horizontally scroll the window. */);
26445 hscroll_margin
= 5;
26447 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26448 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26449 When point is less than `hscroll-margin' columns from the window
26450 edge, automatic hscrolling will scroll the window by the amount of columns
26451 determined by this variable. If its value is a positive integer, scroll that
26452 many columns. If it's a positive floating-point number, it specifies the
26453 fraction of the window's width to scroll. If it's nil or zero, point will be
26454 centered horizontally after the scroll. Any other value, including negative
26455 numbers, are treated as if the value were zero.
26457 Automatic hscrolling always moves point outside the scroll margin, so if
26458 point was more than scroll step columns inside the margin, the window will
26459 scroll more than the value given by the scroll step.
26461 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26462 and `scroll-right' overrides this variable's effect. */);
26463 Vhscroll_step
= make_number (0);
26465 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26466 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26467 Bind this around calls to `message' to let it take effect. */);
26468 message_truncate_lines
= 0;
26470 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26471 doc
: /* Normal hook run to update the menu bar definitions.
26472 Redisplay runs this hook before it redisplays the menu bar.
26473 This is used to update submenus such as Buffers,
26474 whose contents depend on various data. */);
26475 Vmenu_bar_update_hook
= Qnil
;
26477 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26478 doc
: /* Frame for which we are updating a menu.
26479 The enable predicate for a menu binding should check this variable. */);
26480 Vmenu_updating_frame
= Qnil
;
26482 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26483 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26484 inhibit_menubar_update
= 0;
26486 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26487 doc
: /* Prefix prepended to all continuation lines at display time.
26488 The value may be a string, an image, or a stretch-glyph; it is
26489 interpreted in the same way as the value of a `display' text property.
26491 This variable is overridden by any `wrap-prefix' text or overlay
26494 To add a prefix to non-continuation lines, use `line-prefix'. */);
26495 Vwrap_prefix
= Qnil
;
26496 staticpro (&Qwrap_prefix
);
26497 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26498 Fmake_variable_buffer_local (Qwrap_prefix
);
26500 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26501 doc
: /* Prefix prepended to all non-continuation lines at display time.
26502 The value may be a string, an image, or a stretch-glyph; it is
26503 interpreted in the same way as the value of a `display' text property.
26505 This variable is overridden by any `line-prefix' text or overlay
26508 To add a prefix to continuation lines, use `wrap-prefix'. */);
26509 Vline_prefix
= Qnil
;
26510 staticpro (&Qline_prefix
);
26511 Qline_prefix
= intern_c_string ("line-prefix");
26512 Fmake_variable_buffer_local (Qline_prefix
);
26514 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26515 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26516 inhibit_eval_during_redisplay
= 0;
26518 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26519 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26520 inhibit_free_realized_faces
= 0;
26523 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26524 doc
: /* Inhibit try_window_id display optimization. */);
26525 inhibit_try_window_id
= 0;
26527 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26528 doc
: /* Inhibit try_window_reusing display optimization. */);
26529 inhibit_try_window_reusing
= 0;
26531 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26532 doc
: /* Inhibit try_cursor_movement display optimization. */);
26533 inhibit_try_cursor_movement
= 0;
26534 #endif /* GLYPH_DEBUG */
26536 DEFVAR_INT ("overline-margin", &overline_margin
,
26537 doc
: /* *Space between overline and text, in pixels.
26538 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26539 margin to the caracter height. */);
26540 overline_margin
= 2;
26542 DEFVAR_INT ("underline-minimum-offset",
26543 &underline_minimum_offset
,
26544 doc
: /* Minimum distance between baseline and underline.
26545 This can improve legibility of underlined text at small font sizes,
26546 particularly when using variable `x-use-underline-position-properties'
26547 with fonts that specify an UNDERLINE_POSITION relatively close to the
26548 baseline. The default value is 1. */);
26549 underline_minimum_offset
= 1;
26551 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26552 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26553 display_hourglass_p
= 1;
26555 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26556 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26557 Value must be an integer or float. */);
26558 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26560 hourglass_atimer
= NULL
;
26561 hourglass_shown_p
= 0;
26565 /* Initialize this module when Emacs starts. */
26570 Lisp_Object root_window
;
26571 struct window
*mini_w
;
26573 current_header_line_height
= current_mode_line_height
= -1;
26575 CHARPOS (this_line_start_pos
) = 0;
26577 mini_w
= XWINDOW (minibuf_window
);
26578 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26580 if (!noninteractive
)
26582 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26585 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26586 set_window_height (root_window
,
26587 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26589 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26590 set_window_height (minibuf_window
, 1, 0);
26592 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26593 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26595 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26596 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26597 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26599 /* The default ellipsis glyphs `...'. */
26600 for (i
= 0; i
< 3; ++i
)
26601 default_invis_vector
[i
] = make_number ('.');
26605 /* Allocate the buffer for frame titles.
26606 Also used for `format-mode-line'. */
26608 mode_line_noprop_buf
= (char *) xmalloc (size
);
26609 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26610 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26611 mode_line_target
= MODE_LINE_DISPLAY
;
26614 help_echo_showing_p
= 0;
26617 /* Since w32 does not support atimers, it defines its own implementation of
26618 the following three functions in w32fns.c. */
26621 /* Platform-independent portion of hourglass implementation. */
26623 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26625 hourglass_started ()
26627 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26630 /* Cancel a currently active hourglass timer, and start a new one. */
26634 #if defined (HAVE_WINDOW_SYSTEM)
26636 int secs
, usecs
= 0;
26638 cancel_hourglass ();
26640 if (INTEGERP (Vhourglass_delay
)
26641 && XINT (Vhourglass_delay
) > 0)
26642 secs
= XFASTINT (Vhourglass_delay
);
26643 else if (FLOATP (Vhourglass_delay
)
26644 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26647 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26648 secs
= XFASTINT (tem
);
26649 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26652 secs
= DEFAULT_HOURGLASS_DELAY
;
26654 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26655 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26656 show_hourglass
, NULL
);
26661 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26664 cancel_hourglass ()
26666 #if defined (HAVE_WINDOW_SYSTEM)
26667 if (hourglass_atimer
)
26669 cancel_atimer (hourglass_atimer
);
26670 hourglass_atimer
= NULL
;
26673 if (hourglass_shown_p
)
26677 #endif /* ! WINDOWSNT */
26679 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26680 (do not change this comment) */