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. (Or,
36 let's say almost---see the description of direct update
39 The following diagram shows how redisplay code is invoked. As you
40 can see, Lisp calls redisplay and vice versa. Under window systems
41 like X, some portions of the redisplay code are also called
42 asynchronously during mouse movement or expose events. It is very
43 important that these code parts do NOT use the C library (malloc,
44 free) because many C libraries under Unix are not reentrant. They
45 may also NOT call functions of the Lisp interpreter which could
46 change the interpreter's state. If you don't follow these rules,
47 you will encounter bugs which are very hard to explain.
49 (Direct functions, see below)
50 direct_output_for_insert,
51 direct_forward_char (dispnew.c)
52 +---------------------------------+
55 +--------------+ redisplay +----------------+
56 | Lisp machine |---------------->| Redisplay code |<--+
57 +--------------+ (xdisp.c) +----------------+ |
59 +----------------------------------+ |
60 Don't use this path when called |
63 expose_window (asynchronous) |
65 X expose events -----+
67 What does redisplay do? Obviously, it has to figure out somehow what
68 has been changed since the last time the display has been updated,
69 and to make these changes visible. Preferably it would do that in
70 a moderately intelligent way, i.e. fast.
72 Changes in buffer text can be deduced from window and buffer
73 structures, and from some global variables like `beg_unchanged' and
74 `end_unchanged'. The contents of the display are additionally
75 recorded in a `glyph matrix', a two-dimensional matrix of glyph
76 structures. Each row in such a matrix corresponds to a line on the
77 display, and each glyph in a row corresponds to a column displaying
78 a character, an image, or what else. This matrix is called the
79 `current glyph matrix' or `current matrix' in redisplay
82 For buffer parts that have been changed since the last update, a
83 second glyph matrix is constructed, the so called `desired glyph
84 matrix' or short `desired matrix'. Current and desired matrix are
85 then compared to find a cheap way to update the display, e.g. by
86 reusing part of the display by scrolling lines.
91 You will find a lot of redisplay optimizations when you start
92 looking at the innards of redisplay. The overall goal of all these
93 optimizations is to make redisplay fast because it is done
96 Two optimizations are not found in xdisp.c. These are the direct
97 operations mentioned above. As the name suggests they follow a
98 different principle than the rest of redisplay. Instead of
99 building a desired matrix and then comparing it with the current
100 display, they perform their actions directly on the display and on
103 One direct operation updates the display after one character has
104 been entered. The other one moves the cursor by one position
105 forward or backward. You find these functions under the names
106 `direct_output_for_insert' and `direct_output_forward_char' in
112 Desired matrices are always built per Emacs window. The function
113 `display_line' is the central function to look at if you are
114 interested. It constructs one row in a desired matrix given an
115 iterator structure containing both a buffer position and a
116 description of the environment in which the text is to be
117 displayed. But this is too early, read on.
119 Characters and pixmaps displayed for a range of buffer text depend
120 on various settings of buffers and windows, on overlays and text
121 properties, on display tables, on selective display. The good news
122 is that all this hairy stuff is hidden behind a small set of
123 interface functions taking an iterator structure (struct it)
126 Iteration over things to be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator.
128 Calls to get_next_display_element fill the iterator structure with
129 relevant information about the next thing to display. Calls to
130 set_iterator_to_next move the iterator to the next thing.
132 Besides this, an iterator also contains information about the
133 display environment in which glyphs for display elements are to be
134 produced. It has fields for the width and height of the display,
135 the information whether long lines are truncated or continued, a
136 current X and Y position, and lots of other stuff you can better
139 Glyphs in a desired matrix are normally constructed in a loop
140 calling get_next_display_element and then produce_glyphs. The call
141 to produce_glyphs will fill the iterator structure with pixel
142 information about the element being displayed and at the same time
143 produce glyphs for it. If the display element fits on the line
144 being displayed, set_iterator_to_next is called next, otherwise the
145 glyphs produced are discarded.
150 That just couldn't be all, could it? What about terminal types not
151 supporting operations on sub-windows of the screen? To update the
152 display on such a terminal, window-based glyph matrices are not
153 well suited. To be able to reuse part of the display (scrolling
154 lines up and down), we must instead have a view of the whole
155 screen. This is what `frame matrices' are for. They are a trick.
157 Frames on terminals like above have a glyph pool. Windows on such
158 a frame sub-allocate their glyph memory from their frame's glyph
159 pool. The frame itself is given its own glyph matrices. By
160 coincidence---or maybe something else---rows in window glyph
161 matrices are slices of corresponding rows in frame matrices. Thus
162 writing to window matrices implicitly updates a frame matrix which
163 provides us with the view of the whole screen that we originally
164 wanted to have without having to move many bytes around. To be
165 honest, there is a little bit more done, but not much more. If you
166 plan to extend that code, take a look at dispnew.c. The function
167 build_frame_matrix is a good starting point. */
175 #include "keyboard.h"
178 #include "termchar.h"
179 #include "dispextern.h"
181 #include "character.h"
184 #include "commands.h"
188 #include "termhooks.h"
189 #include "intervals.h"
192 #include "region-cache.h"
195 #include "blockinput.h"
197 #ifdef HAVE_X_WINDOWS
212 #ifndef FRAME_X_OUTPUT
213 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
216 #define INFINITY 10000000
218 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
219 || defined(HAVE_NS) || defined (USE_GTK)
220 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
221 extern int pending_menu_activation
;
224 extern int interrupt_input
;
225 extern int command_loop_level
;
227 extern Lisp_Object do_mouse_tracking
;
229 extern int minibuffer_auto_raise
;
230 extern Lisp_Object Vminibuffer_list
;
232 extern Lisp_Object Qface
;
233 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
235 extern Lisp_Object Voverriding_local_map
;
236 extern Lisp_Object Voverriding_local_map_menu_flag
;
237 extern Lisp_Object Qmenu_item
;
238 extern Lisp_Object Qwhen
;
239 extern Lisp_Object Qhelp_echo
;
240 extern Lisp_Object Qbefore_string
, Qafter_string
;
242 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
243 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
244 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
245 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
246 Lisp_Object Qinhibit_point_motion_hooks
;
247 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
248 Lisp_Object Qfontified
;
249 Lisp_Object Qgrow_only
;
250 Lisp_Object Qinhibit_eval_during_redisplay
;
251 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
252 Lisp_Object Qright_to_left
, Qleft_to_right
;
255 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
258 Lisp_Object Qarrow
, Qhand
, Qtext
;
260 Lisp_Object Qrisky_local_variable
;
262 /* Holds the list (error). */
263 Lisp_Object list_of_error
;
265 /* Functions called to fontify regions of text. */
267 Lisp_Object Vfontification_functions
;
268 Lisp_Object Qfontification_functions
;
270 /* Non-nil means automatically select any window when the mouse
271 cursor moves into it. */
272 Lisp_Object Vmouse_autoselect_window
;
274 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
275 Lisp_Object Vline_prefix
, Qline_prefix
;
277 /* Non-zero means draw tool bar buttons raised when the mouse moves
280 int auto_raise_tool_bar_buttons_p
;
282 /* Non-zero means to reposition window if cursor line is only partially visible. */
284 int make_cursor_line_fully_visible_p
;
286 /* Margin below tool bar in pixels. 0 or nil means no margin.
287 If value is `internal-border-width' or `border-width',
288 the corresponding frame parameter is used. */
290 Lisp_Object Vtool_bar_border
;
292 /* Margin around tool bar buttons in pixels. */
294 Lisp_Object Vtool_bar_button_margin
;
296 /* Thickness of shadow to draw around tool bar buttons. */
298 EMACS_INT tool_bar_button_relief
;
300 /* Non-nil means automatically resize tool-bars so that all tool-bar
301 items are visible, and no blank lines remain.
303 If value is `grow-only', only make tool-bar bigger. */
305 Lisp_Object Vauto_resize_tool_bars
;
307 /* Non-zero means draw block and hollow cursor as wide as the glyph
308 under it. For example, if a block cursor is over a tab, it will be
309 drawn as wide as that tab on the display. */
311 int x_stretch_cursor_p
;
313 /* Non-nil means don't actually do any redisplay. */
315 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
317 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
319 int inhibit_eval_during_redisplay
;
321 /* Names of text properties relevant for redisplay. */
323 Lisp_Object Qdisplay
;
324 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
326 /* Symbols used in text property values. */
328 Lisp_Object Vdisplay_pixels_per_inch
;
329 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
330 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
333 Lisp_Object Qmargin
, Qpointer
;
334 Lisp_Object Qline_height
;
335 extern Lisp_Object Qheight
;
336 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
337 extern Lisp_Object Qscroll_bar
;
338 extern Lisp_Object Qcursor
;
340 /* Non-nil means highlight trailing whitespace. */
342 Lisp_Object Vshow_trailing_whitespace
;
344 /* Non-nil means escape non-break space and hyphens. */
346 Lisp_Object Vnobreak_char_display
;
348 #ifdef HAVE_WINDOW_SYSTEM
349 extern Lisp_Object Voverflow_newline_into_fringe
;
351 /* Test if overflow newline into fringe. Called with iterator IT
352 at or past right window margin, and with IT->current_x set. */
354 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
355 (!NILP (Voverflow_newline_into_fringe) \
356 && FRAME_WINDOW_P (it->f) \
357 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
358 && it->current_x == it->last_visible_x \
359 && it->line_wrap != WORD_WRAP)
361 #else /* !HAVE_WINDOW_SYSTEM */
362 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
363 #endif /* HAVE_WINDOW_SYSTEM */
365 /* Test if the display element loaded in IT is a space or tab
366 character. This is used to determine word wrapping. */
368 #define IT_DISPLAYING_WHITESPACE(it) \
369 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
371 /* Non-nil means show the text cursor in void text areas
372 i.e. in blank areas after eol and eob. This used to be
373 the default in 21.3. */
375 Lisp_Object Vvoid_text_area_pointer
;
377 /* Name of the face used to highlight trailing whitespace. */
379 Lisp_Object Qtrailing_whitespace
;
381 /* Name and number of the face used to highlight escape glyphs. */
383 Lisp_Object Qescape_glyph
;
385 /* Name and number of the face used to highlight non-breaking spaces. */
387 Lisp_Object Qnobreak_space
;
389 /* The symbol `image' which is the car of the lists used to represent
394 /* The image map types. */
395 Lisp_Object QCmap
, QCpointer
;
396 Lisp_Object Qrect
, Qcircle
, Qpoly
;
398 /* Non-zero means print newline to stdout before next mini-buffer
401 int noninteractive_need_newline
;
403 /* Non-zero means print newline to message log before next message. */
405 static int message_log_need_newline
;
407 /* Three markers that message_dolog uses.
408 It could allocate them itself, but that causes trouble
409 in handling memory-full errors. */
410 static Lisp_Object message_dolog_marker1
;
411 static Lisp_Object message_dolog_marker2
;
412 static Lisp_Object message_dolog_marker3
;
414 /* The buffer position of the first character appearing entirely or
415 partially on the line of the selected window which contains the
416 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
417 redisplay optimization in redisplay_internal. */
419 static struct text_pos this_line_start_pos
;
421 /* Number of characters past the end of the line above, including the
422 terminating newline. */
424 static struct text_pos this_line_end_pos
;
426 /* The vertical positions and the height of this line. */
428 static int this_line_vpos
;
429 static int this_line_y
;
430 static int this_line_pixel_height
;
432 /* X position at which this display line starts. Usually zero;
433 negative if first character is partially visible. */
435 static int this_line_start_x
;
437 /* Buffer that this_line_.* variables are referring to. */
439 static struct buffer
*this_line_buffer
;
441 /* Nonzero means truncate lines in all windows less wide than the
444 Lisp_Object Vtruncate_partial_width_windows
;
446 /* A flag to control how to display unibyte 8-bit character. */
448 int unibyte_display_via_language_environment
;
450 /* Nonzero means we have more than one non-mini-buffer-only frame.
451 Not guaranteed to be accurate except while parsing
452 frame-title-format. */
456 Lisp_Object Vglobal_mode_string
;
459 /* List of variables (symbols) which hold markers for overlay arrows.
460 The symbols on this list are examined during redisplay to determine
461 where to display overlay arrows. */
463 Lisp_Object Voverlay_arrow_variable_list
;
465 /* Marker for where to display an arrow on top of the buffer text. */
467 Lisp_Object Voverlay_arrow_position
;
469 /* String to display for the arrow. Only used on terminal frames. */
471 Lisp_Object Voverlay_arrow_string
;
473 /* Values of those variables at last redisplay are stored as
474 properties on `overlay-arrow-position' symbol. However, if
475 Voverlay_arrow_position is a marker, last-arrow-position is its
476 numerical position. */
478 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
480 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
481 properties on a symbol in overlay-arrow-variable-list. */
483 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
485 /* Like mode-line-format, but for the title bar on a visible frame. */
487 Lisp_Object Vframe_title_format
;
489 /* Like mode-line-format, but for the title bar on an iconified frame. */
491 Lisp_Object Vicon_title_format
;
493 /* List of functions to call when a window's size changes. These
494 functions get one arg, a frame on which one or more windows' sizes
497 static Lisp_Object Vwindow_size_change_functions
;
499 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
501 /* Nonzero if an overlay arrow has been displayed in this window. */
503 static int overlay_arrow_seen
;
505 /* Nonzero means highlight the region even in nonselected windows. */
507 int highlight_nonselected_windows
;
509 /* If cursor motion alone moves point off frame, try scrolling this
510 many lines up or down if that will bring it back. */
512 static EMACS_INT scroll_step
;
514 /* Nonzero means scroll just far enough to bring point back on the
515 screen, when appropriate. */
517 static EMACS_INT scroll_conservatively
;
519 /* Recenter the window whenever point gets within this many lines of
520 the top or bottom of the window. This value is translated into a
521 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
522 that there is really a fixed pixel height scroll margin. */
524 EMACS_INT scroll_margin
;
526 /* Number of windows showing the buffer of the selected window (or
527 another buffer with the same base buffer). keyboard.c refers to
532 /* Vector containing glyphs for an ellipsis `...'. */
534 static Lisp_Object default_invis_vector
[3];
536 /* Zero means display the mode-line/header-line/menu-bar in the default face
537 (this slightly odd definition is for compatibility with previous versions
538 of emacs), non-zero means display them using their respective faces.
540 This variable is deprecated. */
542 int mode_line_inverse_video
;
544 /* Prompt to display in front of the mini-buffer contents. */
546 Lisp_Object minibuf_prompt
;
548 /* Width of current mini-buffer prompt. Only set after display_line
549 of the line that contains the prompt. */
551 int minibuf_prompt_width
;
553 /* This is the window where the echo area message was displayed. It
554 is always a mini-buffer window, but it may not be the same window
555 currently active as a mini-buffer. */
557 Lisp_Object echo_area_window
;
559 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
560 pushes the current message and the value of
561 message_enable_multibyte on the stack, the function restore_message
562 pops the stack and displays MESSAGE again. */
564 Lisp_Object Vmessage_stack
;
566 /* Nonzero means multibyte characters were enabled when the echo area
567 message was specified. */
569 int message_enable_multibyte
;
571 /* Nonzero if we should redraw the mode lines on the next redisplay. */
573 int update_mode_lines
;
575 /* Nonzero if window sizes or contents have changed since last
576 redisplay that finished. */
578 int windows_or_buffers_changed
;
580 /* Nonzero means a frame's cursor type has been changed. */
582 int cursor_type_changed
;
584 /* Nonzero after display_mode_line if %l was used and it displayed a
587 int line_number_displayed
;
589 /* Maximum buffer size for which to display line numbers. */
591 Lisp_Object Vline_number_display_limit
;
593 /* Line width to consider when repositioning for line number display. */
595 static EMACS_INT line_number_display_limit_width
;
597 /* Number of lines to keep in the message log buffer. t means
598 infinite. nil means don't log at all. */
600 Lisp_Object Vmessage_log_max
;
602 /* The name of the *Messages* buffer, a string. */
604 static Lisp_Object Vmessages_buffer_name
;
606 /* Current, index 0, and last displayed echo area message. Either
607 buffers from echo_buffers, or nil to indicate no message. */
609 Lisp_Object echo_area_buffer
[2];
611 /* The buffers referenced from echo_area_buffer. */
613 static Lisp_Object echo_buffer
[2];
615 /* A vector saved used in with_area_buffer to reduce consing. */
617 static Lisp_Object Vwith_echo_area_save_vector
;
619 /* Non-zero means display_echo_area should display the last echo area
620 message again. Set by redisplay_preserve_echo_area. */
622 static int display_last_displayed_message_p
;
624 /* Nonzero if echo area is being used by print; zero if being used by
627 int message_buf_print
;
629 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
631 Lisp_Object Qinhibit_menubar_update
;
632 int inhibit_menubar_update
;
634 /* When evaluating expressions from menu bar items (enable conditions,
635 for instance), this is the frame they are being processed for. */
637 Lisp_Object Vmenu_updating_frame
;
639 /* Maximum height for resizing mini-windows. Either a float
640 specifying a fraction of the available height, or an integer
641 specifying a number of lines. */
643 Lisp_Object Vmax_mini_window_height
;
645 /* Non-zero means messages should be displayed with truncated
646 lines instead of being continued. */
648 int message_truncate_lines
;
649 Lisp_Object Qmessage_truncate_lines
;
651 /* Set to 1 in clear_message to make redisplay_internal aware
652 of an emptied echo area. */
654 static int message_cleared_p
;
656 /* How to blink the default frame cursor off. */
657 Lisp_Object Vblink_cursor_alist
;
659 /* A scratch glyph row with contents used for generating truncation
660 glyphs. Also used in direct_output_for_insert. */
662 #define MAX_SCRATCH_GLYPHS 100
663 struct glyph_row scratch_glyph_row
;
664 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
666 /* Ascent and height of the last line processed by move_it_to. */
668 static int last_max_ascent
, last_height
;
670 /* Non-zero if there's a help-echo in the echo area. */
672 int help_echo_showing_p
;
674 /* If >= 0, computed, exact values of mode-line and header-line height
675 to use in the macros CURRENT_MODE_LINE_HEIGHT and
676 CURRENT_HEADER_LINE_HEIGHT. */
678 int current_mode_line_height
, current_header_line_height
;
680 /* The maximum distance to look ahead for text properties. Values
681 that are too small let us call compute_char_face and similar
682 functions too often which is expensive. Values that are too large
683 let us call compute_char_face and alike too often because we
684 might not be interested in text properties that far away. */
686 #define TEXT_PROP_DISTANCE_LIMIT 100
690 /* Variables to turn off display optimizations from Lisp. */
692 int inhibit_try_window_id
, inhibit_try_window_reusing
;
693 int inhibit_try_cursor_movement
;
695 /* Non-zero means print traces of redisplay if compiled with
698 int trace_redisplay_p
;
700 #endif /* GLYPH_DEBUG */
702 #ifdef DEBUG_TRACE_MOVE
703 /* Non-zero means trace with TRACE_MOVE to stderr. */
706 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
708 #define TRACE_MOVE(x) (void) 0
711 /* Non-zero means automatically scroll windows horizontally to make
714 int automatic_hscrolling_p
;
715 Lisp_Object Qauto_hscroll_mode
;
717 /* How close to the margin can point get before the window is scrolled
719 EMACS_INT hscroll_margin
;
721 /* How much to scroll horizontally when point is inside the above margin. */
722 Lisp_Object Vhscroll_step
;
724 /* The variable `resize-mini-windows'. If nil, don't resize
725 mini-windows. If t, always resize them to fit the text they
726 display. If `grow-only', let mini-windows grow only until they
729 Lisp_Object Vresize_mini_windows
;
731 /* Buffer being redisplayed -- for redisplay_window_error. */
733 struct buffer
*displayed_buffer
;
735 /* Space between overline and text. */
737 EMACS_INT overline_margin
;
739 /* Require underline to be at least this many screen pixels below baseline
740 This to avoid underline "merging" with the base of letters at small
741 font sizes, particularly when x_use_underline_position_properties is on. */
743 EMACS_INT underline_minimum_offset
;
745 /* Value returned from text property handlers (see below). */
750 HANDLED_RECOMPUTE_PROPS
,
751 HANDLED_OVERLAY_STRING_CONSUMED
,
755 /* A description of text properties that redisplay is interested
760 /* The name of the property. */
763 /* A unique index for the property. */
766 /* A handler function called to set up iterator IT from the property
767 at IT's current position. Value is used to steer handle_stop. */
768 enum prop_handled (*handler
) P_ ((struct it
*it
));
771 static enum prop_handled handle_face_prop
P_ ((struct it
*));
772 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
773 static enum prop_handled handle_display_prop
P_ ((struct it
*));
774 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
775 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
776 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
778 /* Properties handled by iterators. */
780 static struct props it_props
[] =
782 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
783 /* Handle `face' before `display' because some sub-properties of
784 `display' need to know the face. */
785 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
786 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
787 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
788 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
792 /* Value is the position described by X. If X is a marker, value is
793 the marker_position of X. Otherwise, value is X. */
795 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
797 /* Enumeration returned by some move_it_.* functions internally. */
801 /* Not used. Undefined value. */
804 /* Move ended at the requested buffer position or ZV. */
805 MOVE_POS_MATCH_OR_ZV
,
807 /* Move ended at the requested X pixel position. */
810 /* Move within a line ended at the end of a line that must be
814 /* Move within a line ended at the end of a line that would
815 be displayed truncated. */
818 /* Move within a line ended at a line end. */
822 /* This counter is used to clear the face cache every once in a while
823 in redisplay_internal. It is incremented for each redisplay.
824 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
827 #define CLEAR_FACE_CACHE_COUNT 500
828 static int clear_face_cache_count
;
830 /* Similarly for the image cache. */
832 #ifdef HAVE_WINDOW_SYSTEM
833 #define CLEAR_IMAGE_CACHE_COUNT 101
834 static int clear_image_cache_count
;
837 /* Non-zero while redisplay_internal is in progress. */
841 /* Non-zero means don't free realized faces. Bound while freeing
842 realized faces is dangerous because glyph matrices might still
845 int inhibit_free_realized_faces
;
846 Lisp_Object Qinhibit_free_realized_faces
;
848 /* If a string, XTread_socket generates an event to display that string.
849 (The display is done in read_char.) */
851 Lisp_Object help_echo_string
;
852 Lisp_Object help_echo_window
;
853 Lisp_Object help_echo_object
;
856 /* Temporary variable for XTread_socket. */
858 Lisp_Object previous_help_echo_string
;
860 /* Null glyph slice */
862 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
864 /* Platform-independent portion of hourglass implementation. */
866 /* Non-zero means we're allowed to display a hourglass pointer. */
867 int display_hourglass_p
;
869 /* Non-zero means an hourglass cursor is currently shown. */
870 int hourglass_shown_p
;
872 /* If non-null, an asynchronous timer that, when it expires, displays
873 an hourglass cursor on all frames. */
874 struct atimer
*hourglass_atimer
;
876 /* Number of seconds to wait before displaying an hourglass cursor. */
877 Lisp_Object Vhourglass_delay
;
879 /* Default number of seconds to wait before displaying an hourglass
881 #define DEFAULT_HOURGLASS_DELAY 1
884 /* Function prototypes. */
886 static void setup_for_ellipsis
P_ ((struct it
*, int));
887 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
888 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
889 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
890 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
891 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
892 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
894 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
896 static void handle_line_prefix
P_ ((struct it
*));
898 static void pint2str
P_ ((char *, int, int));
899 static void pint2hrstr
P_ ((char *, int, int));
900 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
902 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
903 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
904 static void store_mode_line_noprop_char
P_ ((char));
905 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
906 static void x_consider_frame_title
P_ ((Lisp_Object
));
907 static void handle_stop
P_ ((struct it
*));
908 static void handle_stop_backwards
P_ ((struct it
*, EMACS_INT
));
909 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
910 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
911 static void ensure_echo_area_buffers
P_ ((void));
912 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
913 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
914 static int with_echo_area_buffer
P_ ((struct window
*, int,
915 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
916 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static void clear_garbaged_frames
P_ ((void));
918 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
919 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
920 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
921 static int display_echo_area
P_ ((struct window
*));
922 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
923 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
924 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
925 static int string_char_and_length
P_ ((const unsigned char *, int *));
926 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
928 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
929 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
930 static void insert_left_trunc_glyphs
P_ ((struct it
*));
931 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
933 static void extend_face_to_end_of_line
P_ ((struct it
*));
934 static int append_space_for_newline
P_ ((struct it
*, int));
935 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
936 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
937 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
938 static int trailing_whitespace_p
P_ ((int));
939 static int message_log_check_duplicate
P_ ((int, int, int, int));
940 static void push_it
P_ ((struct it
*));
941 static void pop_it
P_ ((struct it
*));
942 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
943 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
944 static void redisplay_internal
P_ ((int));
945 static int echo_area_display
P_ ((int));
946 static void redisplay_windows
P_ ((Lisp_Object
));
947 static void redisplay_window
P_ ((Lisp_Object
, int));
948 static Lisp_Object
redisplay_window_error ();
949 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
950 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
951 static int update_menu_bar
P_ ((struct frame
*, int, int));
952 static int try_window_reusing_current_matrix
P_ ((struct window
*));
953 static int try_window_id
P_ ((struct window
*));
954 static int display_line
P_ ((struct it
*));
955 static int display_mode_lines
P_ ((struct window
*));
956 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
957 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
958 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
959 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
961 static void display_menu_bar
P_ ((struct window
*));
962 static int display_count_lines
P_ ((int, int, int, int, int *));
963 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
964 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
965 static void compute_line_metrics
P_ ((struct it
*));
966 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
967 static int get_overlay_strings
P_ ((struct it
*, int));
968 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
969 static void next_overlay_string
P_ ((struct it
*));
970 static void reseat
P_ ((struct it
*, struct text_pos
, int));
971 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
972 static void back_to_previous_visible_line_start
P_ ((struct it
*));
973 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
974 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
975 static int next_element_from_ellipsis
P_ ((struct it
*));
976 static int next_element_from_display_vector
P_ ((struct it
*));
977 static int next_element_from_string
P_ ((struct it
*));
978 static int next_element_from_c_string
P_ ((struct it
*));
979 static int next_element_from_buffer
P_ ((struct it
*));
980 static int next_element_from_composition
P_ ((struct it
*));
981 static int next_element_from_image
P_ ((struct it
*));
982 static int next_element_from_stretch
P_ ((struct it
*));
983 static void load_overlay_strings
P_ ((struct it
*, int));
984 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
985 struct display_pos
*));
986 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
987 Lisp_Object
, int, int, int, int));
988 static enum move_it_result
989 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
990 enum move_operation_enum
);
991 void move_it_vertically_backward
P_ ((struct it
*, int));
992 static void init_to_row_start
P_ ((struct it
*, struct window
*,
993 struct glyph_row
*));
994 static int init_to_row_end
P_ ((struct it
*, struct window
*,
995 struct glyph_row
*));
996 static void back_to_previous_line_start
P_ ((struct it
*));
997 static int forward_to_next_line_start
P_ ((struct it
*, int *));
998 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
1000 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
1001 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
1002 static int number_of_chars
P_ ((unsigned char *, int));
1003 static void compute_stop_pos
P_ ((struct it
*));
1004 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1006 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1007 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1008 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1009 Lisp_Object
, Lisp_Object
,
1010 struct text_pos
*, int));
1011 static int underlying_face_id
P_ ((struct it
*));
1012 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1015 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1016 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1018 #ifdef HAVE_WINDOW_SYSTEM
1020 static void update_tool_bar
P_ ((struct frame
*, int));
1021 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1022 static int redisplay_tool_bar
P_ ((struct frame
*));
1023 static void display_tool_bar_line
P_ ((struct it
*, int));
1024 static void notice_overwritten_cursor
P_ ((struct window
*,
1025 enum glyph_row_area
,
1026 int, int, int, int));
1030 #endif /* HAVE_WINDOW_SYSTEM */
1033 /***********************************************************************
1034 Window display dimensions
1035 ***********************************************************************/
1037 /* Return the bottom boundary y-position for text lines in window W.
1038 This is the first y position at which a line cannot start.
1039 It is relative to the top of the window.
1041 This is the height of W minus the height of a mode line, if any. */
1044 window_text_bottom_y (w
)
1047 int height
= WINDOW_TOTAL_HEIGHT (w
);
1049 if (WINDOW_WANTS_MODELINE_P (w
))
1050 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1054 /* Return the pixel width of display area AREA of window W. AREA < 0
1055 means return the total width of W, not including fringes to
1056 the left and right of the window. */
1059 window_box_width (w
, area
)
1063 int cols
= XFASTINT (w
->total_cols
);
1066 if (!w
->pseudo_window_p
)
1068 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1070 if (area
== TEXT_AREA
)
1072 if (INTEGERP (w
->left_margin_cols
))
1073 cols
-= XFASTINT (w
->left_margin_cols
);
1074 if (INTEGERP (w
->right_margin_cols
))
1075 cols
-= XFASTINT (w
->right_margin_cols
);
1076 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1078 else if (area
== LEFT_MARGIN_AREA
)
1080 cols
= (INTEGERP (w
->left_margin_cols
)
1081 ? XFASTINT (w
->left_margin_cols
) : 0);
1084 else if (area
== RIGHT_MARGIN_AREA
)
1086 cols
= (INTEGERP (w
->right_margin_cols
)
1087 ? XFASTINT (w
->right_margin_cols
) : 0);
1092 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1096 /* Return the pixel height of the display area of window W, not
1097 including mode lines of W, if any. */
1100 window_box_height (w
)
1103 struct frame
*f
= XFRAME (w
->frame
);
1104 int height
= WINDOW_TOTAL_HEIGHT (w
);
1106 xassert (height
>= 0);
1108 /* Note: the code below that determines the mode-line/header-line
1109 height is essentially the same as that contained in the macro
1110 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1111 the appropriate glyph row has its `mode_line_p' flag set,
1112 and if it doesn't, uses estimate_mode_line_height instead. */
1114 if (WINDOW_WANTS_MODELINE_P (w
))
1116 struct glyph_row
*ml_row
1117 = (w
->current_matrix
&& w
->current_matrix
->rows
1118 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1120 if (ml_row
&& ml_row
->mode_line_p
)
1121 height
-= ml_row
->height
;
1123 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1126 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1128 struct glyph_row
*hl_row
1129 = (w
->current_matrix
&& w
->current_matrix
->rows
1130 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1132 if (hl_row
&& hl_row
->mode_line_p
)
1133 height
-= hl_row
->height
;
1135 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1138 /* With a very small font and a mode-line that's taller than
1139 default, we might end up with a negative height. */
1140 return max (0, height
);
1143 /* Return the window-relative coordinate of the left edge of display
1144 area AREA of window W. AREA < 0 means return the left edge of the
1145 whole window, to the right of the left fringe of W. */
1148 window_box_left_offset (w
, area
)
1154 if (w
->pseudo_window_p
)
1157 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1159 if (area
== TEXT_AREA
)
1160 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1161 + window_box_width (w
, LEFT_MARGIN_AREA
));
1162 else if (area
== RIGHT_MARGIN_AREA
)
1163 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1164 + window_box_width (w
, LEFT_MARGIN_AREA
)
1165 + window_box_width (w
, TEXT_AREA
)
1166 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1168 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1169 else if (area
== LEFT_MARGIN_AREA
1170 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1171 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1177 /* Return the window-relative coordinate of the right edge of display
1178 area AREA of window W. AREA < 0 means return the left edge of the
1179 whole window, to the left of the right fringe of W. */
1182 window_box_right_offset (w
, area
)
1186 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1189 /* Return the frame-relative coordinate of the left edge of display
1190 area AREA of window W. AREA < 0 means return the left edge of the
1191 whole window, to the right of the left fringe of W. */
1194 window_box_left (w
, area
)
1198 struct frame
*f
= XFRAME (w
->frame
);
1201 if (w
->pseudo_window_p
)
1202 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1204 x
= (WINDOW_LEFT_EDGE_X (w
)
1205 + window_box_left_offset (w
, area
));
1211 /* Return the frame-relative coordinate of the right edge of display
1212 area AREA of window W. AREA < 0 means return the left edge of the
1213 whole window, to the left of the right fringe of W. */
1216 window_box_right (w
, area
)
1220 return window_box_left (w
, area
) + window_box_width (w
, area
);
1223 /* Get the bounding box of the display area AREA of window W, without
1224 mode lines, in frame-relative coordinates. AREA < 0 means the
1225 whole window, not including the left and right fringes of
1226 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1227 coordinates of the upper-left corner of the box. Return in
1228 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1231 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1234 int *box_x
, *box_y
, *box_width
, *box_height
;
1237 *box_width
= window_box_width (w
, area
);
1239 *box_height
= window_box_height (w
);
1241 *box_x
= window_box_left (w
, area
);
1244 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1245 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1246 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1251 /* Get the bounding box of the display area AREA of window W, without
1252 mode lines. AREA < 0 means the whole window, not including the
1253 left and right fringe of the window. Return in *TOP_LEFT_X
1254 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1255 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1256 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1260 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1261 bottom_right_x
, bottom_right_y
)
1264 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1266 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1268 *bottom_right_x
+= *top_left_x
;
1269 *bottom_right_y
+= *top_left_y
;
1274 /***********************************************************************
1276 ***********************************************************************/
1278 /* Return the bottom y-position of the line the iterator IT is in.
1279 This can modify IT's settings. */
1285 int line_height
= it
->max_ascent
+ it
->max_descent
;
1286 int line_top_y
= it
->current_y
;
1288 if (line_height
== 0)
1291 line_height
= last_height
;
1292 else if (IT_CHARPOS (*it
) < ZV
)
1294 move_it_by_lines (it
, 1, 1);
1295 line_height
= (it
->max_ascent
|| it
->max_descent
1296 ? it
->max_ascent
+ it
->max_descent
1301 struct glyph_row
*row
= it
->glyph_row
;
1303 /* Use the default character height. */
1304 it
->glyph_row
= NULL
;
1305 it
->what
= IT_CHARACTER
;
1308 PRODUCE_GLYPHS (it
);
1309 line_height
= it
->ascent
+ it
->descent
;
1310 it
->glyph_row
= row
;
1314 return line_top_y
+ line_height
;
1318 /* Return 1 if position CHARPOS is visible in window W.
1319 CHARPOS < 0 means return info about WINDOW_END position.
1320 If visible, set *X and *Y to pixel coordinates of top left corner.
1321 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1322 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1325 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1327 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1330 struct text_pos top
;
1332 struct buffer
*old_buffer
= NULL
;
1334 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1337 if (XBUFFER (w
->buffer
) != current_buffer
)
1339 old_buffer
= current_buffer
;
1340 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1343 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1345 /* Compute exact mode line heights. */
1346 if (WINDOW_WANTS_MODELINE_P (w
))
1347 current_mode_line_height
1348 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1349 current_buffer
->mode_line_format
);
1351 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1352 current_header_line_height
1353 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1354 current_buffer
->header_line_format
);
1356 start_display (&it
, w
, top
);
1357 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1358 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1360 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1362 /* We have reached CHARPOS, or passed it. How the call to
1363 move_it_to can overshoot: (i) If CHARPOS is on invisible
1364 text, move_it_to stops at the end of the invisible text,
1365 after CHARPOS. (ii) If CHARPOS is in a display vector,
1366 move_it_to stops on its last glyph. */
1367 int top_x
= it
.current_x
;
1368 int top_y
= it
.current_y
;
1369 enum it_method it_method
= it
.method
;
1370 /* Calling line_bottom_y may change it.method, it.position, etc. */
1371 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1372 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1374 if (top_y
< window_top_y
)
1375 visible_p
= bottom_y
> window_top_y
;
1376 else if (top_y
< it
.last_visible_y
)
1380 if (it_method
== GET_FROM_BUFFER
)
1382 Lisp_Object window
, prop
;
1384 XSETWINDOW (window
, w
);
1385 prop
= Fget_char_property (make_number (charpos
),
1386 Qinvisible
, window
);
1388 /* If charpos coincides with invisible text covered with an
1389 ellipsis, use the first glyph of the ellipsis to compute
1390 the pixel positions. */
1391 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1393 struct glyph_row
*row
= it
.glyph_row
;
1394 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1395 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1399 && (!BUFFERP (glyph
->object
)
1400 || glyph
->charpos
< charpos
);
1402 x
+= glyph
->pixel_width
;
1406 else if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1408 /* We stopped on the last glyph of a display vector.
1409 Try and recompute. Hack alert! */
1410 if (charpos
< 2 || top
.charpos
>= charpos
)
1411 top_x
= it
.glyph_row
->x
;
1415 start_display (&it2
, w
, top
);
1416 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1417 get_next_display_element (&it2
);
1418 PRODUCE_GLYPHS (&it2
);
1419 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1420 || it2
.current_x
> it2
.last_visible_x
)
1421 top_x
= it
.glyph_row
->x
;
1424 top_x
= it2
.current_x
;
1425 top_y
= it2
.current_y
;
1431 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1432 *rtop
= max (0, window_top_y
- top_y
);
1433 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1434 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1435 - max (top_y
, window_top_y
)));
1444 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1445 move_it_by_lines (&it
, 1, 0);
1446 if (charpos
< IT_CHARPOS (it
)
1447 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1450 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1452 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1453 *rtop
= max (0, -it2
.current_y
);
1454 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1455 - it
.last_visible_y
));
1456 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1458 - max (it2
.current_y
,
1459 WINDOW_HEADER_LINE_HEIGHT (w
))));
1465 set_buffer_internal_1 (old_buffer
);
1467 current_header_line_height
= current_mode_line_height
= -1;
1469 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1470 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1473 /* Debugging code. */
1475 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1476 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1478 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1485 /* Return the next character from STR which is MAXLEN bytes long.
1486 Return in *LEN the length of the character. This is like
1487 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1488 we find one, we return a `?', but with the length of the invalid
1492 string_char_and_length (str
, len
)
1493 const unsigned char *str
;
1498 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1499 if (!CHAR_VALID_P (c
, 1))
1500 /* We may not change the length here because other places in Emacs
1501 don't use this function, i.e. they silently accept invalid
1510 /* Given a position POS containing a valid character and byte position
1511 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1513 static struct text_pos
1514 string_pos_nchars_ahead (pos
, string
, nchars
)
1515 struct text_pos pos
;
1519 xassert (STRINGP (string
) && nchars
>= 0);
1521 if (STRING_MULTIBYTE (string
))
1523 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1524 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1529 string_char_and_length (p
, &len
);
1530 p
+= len
, rest
-= len
;
1531 xassert (rest
>= 0);
1533 BYTEPOS (pos
) += len
;
1537 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1543 /* Value is the text position, i.e. character and byte position,
1544 for character position CHARPOS in STRING. */
1546 static INLINE
struct text_pos
1547 string_pos (charpos
, string
)
1551 struct text_pos pos
;
1552 xassert (STRINGP (string
));
1553 xassert (charpos
>= 0);
1554 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1559 /* Value is a text position, i.e. character and byte position, for
1560 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1561 means recognize multibyte characters. */
1563 static struct text_pos
1564 c_string_pos (charpos
, s
, multibyte_p
)
1569 struct text_pos pos
;
1571 xassert (s
!= NULL
);
1572 xassert (charpos
>= 0);
1576 int rest
= strlen (s
), len
;
1578 SET_TEXT_POS (pos
, 0, 0);
1581 string_char_and_length (s
, &len
);
1582 s
+= len
, rest
-= len
;
1583 xassert (rest
>= 0);
1585 BYTEPOS (pos
) += len
;
1589 SET_TEXT_POS (pos
, charpos
, charpos
);
1595 /* Value is the number of characters in C string S. MULTIBYTE_P
1596 non-zero means recognize multibyte characters. */
1599 number_of_chars (s
, multibyte_p
)
1607 int rest
= strlen (s
), len
;
1608 unsigned char *p
= (unsigned char *) s
;
1610 for (nchars
= 0; rest
> 0; ++nchars
)
1612 string_char_and_length (p
, &len
);
1613 rest
-= len
, p
+= len
;
1617 nchars
= strlen (s
);
1623 /* Compute byte position NEWPOS->bytepos corresponding to
1624 NEWPOS->charpos. POS is a known position in string STRING.
1625 NEWPOS->charpos must be >= POS.charpos. */
1628 compute_string_pos (newpos
, pos
, string
)
1629 struct text_pos
*newpos
, pos
;
1632 xassert (STRINGP (string
));
1633 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1635 if (STRING_MULTIBYTE (string
))
1636 *newpos
= string_pos_nchars_ahead (pos
, string
,
1637 CHARPOS (*newpos
) - CHARPOS (pos
));
1639 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1643 Return an estimation of the pixel height of mode or header lines on
1644 frame F. FACE_ID specifies what line's height to estimate. */
1647 estimate_mode_line_height (f
, face_id
)
1649 enum face_id face_id
;
1651 #ifdef HAVE_WINDOW_SYSTEM
1652 if (FRAME_WINDOW_P (f
))
1654 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1656 /* This function is called so early when Emacs starts that the face
1657 cache and mode line face are not yet initialized. */
1658 if (FRAME_FACE_CACHE (f
))
1660 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1664 height
= FONT_HEIGHT (face
->font
);
1665 if (face
->box_line_width
> 0)
1666 height
+= 2 * face
->box_line_width
;
1677 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1678 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1679 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1680 not force the value into range. */
1683 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1685 register int pix_x
, pix_y
;
1687 NativeRectangle
*bounds
;
1691 #ifdef HAVE_WINDOW_SYSTEM
1692 if (FRAME_WINDOW_P (f
))
1694 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1695 even for negative values. */
1697 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1699 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1701 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1702 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1705 STORE_NATIVE_RECT (*bounds
,
1706 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1707 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1708 FRAME_COLUMN_WIDTH (f
) - 1,
1709 FRAME_LINE_HEIGHT (f
) - 1);
1715 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1716 pix_x
= FRAME_TOTAL_COLS (f
);
1720 else if (pix_y
> FRAME_LINES (f
))
1721 pix_y
= FRAME_LINES (f
);
1731 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1732 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1733 can't tell the positions because W's display is not up to date,
1737 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1740 int *frame_x
, *frame_y
;
1742 #ifdef HAVE_WINDOW_SYSTEM
1743 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1747 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1748 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1750 if (display_completed
)
1752 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1753 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1754 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1760 hpos
+= glyph
->pixel_width
;
1764 /* If first glyph is partially visible, its first visible position is still 0. */
1776 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1777 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1788 #ifdef HAVE_WINDOW_SYSTEM
1790 /* Find the glyph under window-relative coordinates X/Y in window W.
1791 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1792 strings. Return in *HPOS and *VPOS the row and column number of
1793 the glyph found. Return in *AREA the glyph area containing X.
1794 Value is a pointer to the glyph found or null if X/Y is not on
1795 text, or we can't tell because W's current matrix is not up to
1800 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1803 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1805 struct glyph
*glyph
, *end
;
1806 struct glyph_row
*row
= NULL
;
1809 /* Find row containing Y. Give up if some row is not enabled. */
1810 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1812 row
= MATRIX_ROW (w
->current_matrix
, i
);
1813 if (!row
->enabled_p
)
1815 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1822 /* Give up if Y is not in the window. */
1823 if (i
== w
->current_matrix
->nrows
)
1826 /* Get the glyph area containing X. */
1827 if (w
->pseudo_window_p
)
1834 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1836 *area
= LEFT_MARGIN_AREA
;
1837 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1839 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1842 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1846 *area
= RIGHT_MARGIN_AREA
;
1847 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1851 /* Find glyph containing X. */
1852 glyph
= row
->glyphs
[*area
];
1853 end
= glyph
+ row
->used
[*area
];
1855 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1857 x
-= glyph
->pixel_width
;
1867 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1870 *hpos
= glyph
- row
->glyphs
[*area
];
1876 Convert frame-relative x/y to coordinates relative to window W.
1877 Takes pseudo-windows into account. */
1880 frame_to_window_pixel_xy (w
, x
, y
)
1884 if (w
->pseudo_window_p
)
1886 /* A pseudo-window is always full-width, and starts at the
1887 left edge of the frame, plus a frame border. */
1888 struct frame
*f
= XFRAME (w
->frame
);
1889 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1890 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1894 *x
-= WINDOW_LEFT_EDGE_X (w
);
1895 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1900 Return in RECTS[] at most N clipping rectangles for glyph string S.
1901 Return the number of stored rectangles. */
1904 get_glyph_string_clip_rects (s
, rects
, n
)
1905 struct glyph_string
*s
;
1906 NativeRectangle
*rects
;
1914 if (s
->row
->full_width_p
)
1916 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1917 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1918 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1920 /* Unless displaying a mode or menu bar line, which are always
1921 fully visible, clip to the visible part of the row. */
1922 if (s
->w
->pseudo_window_p
)
1923 r
.height
= s
->row
->visible_height
;
1925 r
.height
= s
->height
;
1929 /* This is a text line that may be partially visible. */
1930 r
.x
= window_box_left (s
->w
, s
->area
);
1931 r
.width
= window_box_width (s
->w
, s
->area
);
1932 r
.height
= s
->row
->visible_height
;
1936 if (r
.x
< s
->clip_head
->x
)
1938 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1939 r
.width
-= s
->clip_head
->x
- r
.x
;
1942 r
.x
= s
->clip_head
->x
;
1945 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1947 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1948 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1953 /* If S draws overlapping rows, it's sufficient to use the top and
1954 bottom of the window for clipping because this glyph string
1955 intentionally draws over other lines. */
1956 if (s
->for_overlaps
)
1958 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1959 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1961 /* Alas, the above simple strategy does not work for the
1962 environments with anti-aliased text: if the same text is
1963 drawn onto the same place multiple times, it gets thicker.
1964 If the overlap we are processing is for the erased cursor, we
1965 take the intersection with the rectagle of the cursor. */
1966 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1968 XRectangle rc
, r_save
= r
;
1970 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1971 rc
.y
= s
->w
->phys_cursor
.y
;
1972 rc
.width
= s
->w
->phys_cursor_width
;
1973 rc
.height
= s
->w
->phys_cursor_height
;
1975 x_intersect_rectangles (&r_save
, &rc
, &r
);
1980 /* Don't use S->y for clipping because it doesn't take partially
1981 visible lines into account. For example, it can be negative for
1982 partially visible lines at the top of a window. */
1983 if (!s
->row
->full_width_p
1984 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1985 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1987 r
.y
= max (0, s
->row
->y
);
1990 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1992 /* If drawing the cursor, don't let glyph draw outside its
1993 advertised boundaries. Cleartype does this under some circumstances. */
1994 if (s
->hl
== DRAW_CURSOR
)
1996 struct glyph
*glyph
= s
->first_glyph
;
2001 r
.width
-= s
->x
- r
.x
;
2004 r
.width
= min (r
.width
, glyph
->pixel_width
);
2006 /* If r.y is below window bottom, ensure that we still see a cursor. */
2007 height
= min (glyph
->ascent
+ glyph
->descent
,
2008 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2009 max_y
= window_text_bottom_y (s
->w
) - height
;
2010 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2011 if (s
->ybase
- glyph
->ascent
> max_y
)
2018 /* Don't draw cursor glyph taller than our actual glyph. */
2019 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2020 if (height
< r
.height
)
2022 max_y
= r
.y
+ r
.height
;
2023 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2024 r
.height
= min (max_y
- r
.y
, height
);
2031 XRectangle r_save
= r
;
2033 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2037 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2038 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2040 #ifdef CONVERT_FROM_XRECT
2041 CONVERT_FROM_XRECT (r
, *rects
);
2049 /* If we are processing overlapping and allowed to return
2050 multiple clipping rectangles, we exclude the row of the glyph
2051 string from the clipping rectangle. This is to avoid drawing
2052 the same text on the environment with anti-aliasing. */
2053 #ifdef CONVERT_FROM_XRECT
2056 XRectangle
*rs
= rects
;
2058 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2060 if (s
->for_overlaps
& OVERLAPS_PRED
)
2063 if (r
.y
+ r
.height
> row_y
)
2066 rs
[i
].height
= row_y
- r
.y
;
2072 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2075 if (r
.y
< row_y
+ s
->row
->visible_height
)
2077 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2079 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2080 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2089 #ifdef CONVERT_FROM_XRECT
2090 for (i
= 0; i
< n
; i
++)
2091 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2098 Return in *NR the clipping rectangle for glyph string S. */
2101 get_glyph_string_clip_rect (s
, nr
)
2102 struct glyph_string
*s
;
2103 NativeRectangle
*nr
;
2105 get_glyph_string_clip_rects (s
, nr
, 1);
2110 Return the position and height of the phys cursor in window W.
2111 Set w->phys_cursor_width to width of phys cursor.
2115 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2117 struct glyph_row
*row
;
2118 struct glyph
*glyph
;
2119 int *xp
, *yp
, *heightp
;
2121 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2122 int x
, y
, wd
, h
, h0
, y0
;
2124 /* Compute the width of the rectangle to draw. If on a stretch
2125 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2126 rectangle as wide as the glyph, but use a canonical character
2128 wd
= glyph
->pixel_width
- 1;
2129 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2133 x
= w
->phys_cursor
.x
;
2140 if (glyph
->type
== STRETCH_GLYPH
2141 && !x_stretch_cursor_p
)
2142 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2143 w
->phys_cursor_width
= wd
;
2145 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2147 /* If y is below window bottom, ensure that we still see a cursor. */
2148 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2150 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2151 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2153 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2156 h
= max (h
- (y0
- y
) + 1, h0
);
2161 y0
= window_text_bottom_y (w
) - h0
;
2169 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2170 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2175 * Remember which glyph the mouse is over.
2179 remember_mouse_glyph (f
, gx
, gy
, rect
)
2182 NativeRectangle
*rect
;
2186 struct glyph_row
*r
, *gr
, *end_row
;
2187 enum window_part part
;
2188 enum glyph_row_area area
;
2189 int x
, y
, width
, height
;
2191 /* Try to determine frame pixel position and size of the glyph under
2192 frame pixel coordinates X/Y on frame F. */
2194 if (!f
->glyphs_initialized_p
2195 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2198 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2199 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2203 w
= XWINDOW (window
);
2204 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2205 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2207 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2208 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2210 if (w
->pseudo_window_p
)
2213 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2219 case ON_LEFT_MARGIN
:
2220 area
= LEFT_MARGIN_AREA
;
2223 case ON_RIGHT_MARGIN
:
2224 area
= RIGHT_MARGIN_AREA
;
2227 case ON_HEADER_LINE
:
2229 gr
= (part
== ON_HEADER_LINE
2230 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2231 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2234 goto text_glyph_row_found
;
2241 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2242 if (r
->y
+ r
->height
> y
)
2248 text_glyph_row_found
:
2251 struct glyph
*g
= gr
->glyphs
[area
];
2252 struct glyph
*end
= g
+ gr
->used
[area
];
2254 height
= gr
->height
;
2255 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2256 if (gx
+ g
->pixel_width
> x
)
2261 if (g
->type
== IMAGE_GLYPH
)
2263 /* Don't remember when mouse is over image, as
2264 image may have hot-spots. */
2265 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2268 width
= g
->pixel_width
;
2272 /* Use nominal char spacing at end of line. */
2274 gx
+= (x
/ width
) * width
;
2277 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2278 gx
+= window_box_left_offset (w
, area
);
2282 /* Use nominal line height at end of window. */
2283 gx
= (x
/ width
) * width
;
2285 gy
+= (y
/ height
) * height
;
2289 case ON_LEFT_FRINGE
:
2290 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2291 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2292 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2293 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2296 case ON_RIGHT_FRINGE
:
2297 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2298 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2299 : window_box_right_offset (w
, TEXT_AREA
));
2300 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2304 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2306 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2307 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2308 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2310 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2314 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2315 if (r
->y
+ r
->height
> y
)
2322 height
= gr
->height
;
2325 /* Use nominal line height at end of window. */
2327 gy
+= (y
/ height
) * height
;
2334 /* If there is no glyph under the mouse, then we divide the screen
2335 into a grid of the smallest glyph in the frame, and use that
2338 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2339 round down even for negative values. */
2345 gx
= (gx
/ width
) * width
;
2346 gy
= (gy
/ height
) * height
;
2351 gx
+= WINDOW_LEFT_EDGE_X (w
);
2352 gy
+= WINDOW_TOP_EDGE_Y (w
);
2355 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2357 /* Visible feedback for debugging. */
2360 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2361 f
->output_data
.x
->normal_gc
,
2362 gx
, gy
, width
, height
);
2368 #endif /* HAVE_WINDOW_SYSTEM */
2371 /***********************************************************************
2372 Lisp form evaluation
2373 ***********************************************************************/
2375 /* Error handler for safe_eval and safe_call. */
2378 safe_eval_handler (arg
)
2381 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2386 /* Evaluate SEXPR and return the result, or nil if something went
2387 wrong. Prevent redisplay during the evaluation. */
2389 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2390 Return the result, or nil if something went wrong. Prevent
2391 redisplay during the evaluation. */
2394 safe_call (nargs
, args
)
2400 if (inhibit_eval_during_redisplay
)
2404 int count
= SPECPDL_INDEX ();
2405 struct gcpro gcpro1
;
2408 gcpro1
.nvars
= nargs
;
2409 specbind (Qinhibit_redisplay
, Qt
);
2410 /* Use Qt to ensure debugger does not run,
2411 so there is no possibility of wanting to redisplay. */
2412 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2415 val
= unbind_to (count
, val
);
2422 /* Call function FN with one argument ARG.
2423 Return the result, or nil if something went wrong. */
2426 safe_call1 (fn
, arg
)
2427 Lisp_Object fn
, arg
;
2429 Lisp_Object args
[2];
2432 return safe_call (2, args
);
2435 static Lisp_Object Qeval
;
2438 safe_eval (Lisp_Object sexpr
)
2440 return safe_call1 (Qeval
, sexpr
);
2443 /* Call function FN with one argument ARG.
2444 Return the result, or nil if something went wrong. */
2447 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2449 Lisp_Object args
[3];
2453 return safe_call (3, args
);
2458 /***********************************************************************
2460 ***********************************************************************/
2464 /* Define CHECK_IT to perform sanity checks on iterators.
2465 This is for debugging. It is too slow to do unconditionally. */
2471 if (it
->method
== GET_FROM_STRING
)
2473 xassert (STRINGP (it
->string
));
2474 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2478 xassert (IT_STRING_CHARPOS (*it
) < 0);
2479 if (it
->method
== GET_FROM_BUFFER
)
2481 /* Check that character and byte positions agree. */
2482 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2487 xassert (it
->current
.dpvec_index
>= 0);
2489 xassert (it
->current
.dpvec_index
< 0);
2492 #define CHECK_IT(IT) check_it ((IT))
2496 #define CHECK_IT(IT) (void) 0
2503 /* Check that the window end of window W is what we expect it
2504 to be---the last row in the current matrix displaying text. */
2507 check_window_end (w
)
2510 if (!MINI_WINDOW_P (w
)
2511 && !NILP (w
->window_end_valid
))
2513 struct glyph_row
*row
;
2514 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2515 XFASTINT (w
->window_end_vpos
)),
2517 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2518 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2522 #define CHECK_WINDOW_END(W) check_window_end ((W))
2524 #else /* not GLYPH_DEBUG */
2526 #define CHECK_WINDOW_END(W) (void) 0
2528 #endif /* not GLYPH_DEBUG */
2532 /***********************************************************************
2533 Iterator initialization
2534 ***********************************************************************/
2536 /* Initialize IT for displaying current_buffer in window W, starting
2537 at character position CHARPOS. CHARPOS < 0 means that no buffer
2538 position is specified which is useful when the iterator is assigned
2539 a position later. BYTEPOS is the byte position corresponding to
2540 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2542 If ROW is not null, calls to produce_glyphs with IT as parameter
2543 will produce glyphs in that row.
2545 BASE_FACE_ID is the id of a base face to use. It must be one of
2546 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2547 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2548 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2550 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2551 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2552 will be initialized to use the corresponding mode line glyph row of
2553 the desired matrix of W. */
2556 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2559 int charpos
, bytepos
;
2560 struct glyph_row
*row
;
2561 enum face_id base_face_id
;
2563 int highlight_region_p
;
2564 enum face_id remapped_base_face_id
= base_face_id
;
2566 /* Some precondition checks. */
2567 xassert (w
!= NULL
&& it
!= NULL
);
2568 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2571 /* If face attributes have been changed since the last redisplay,
2572 free realized faces now because they depend on face definitions
2573 that might have changed. Don't free faces while there might be
2574 desired matrices pending which reference these faces. */
2575 if (face_change_count
&& !inhibit_free_realized_faces
)
2577 face_change_count
= 0;
2578 free_all_realized_faces (Qnil
);
2581 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2582 if (! NILP (Vface_remapping_alist
))
2583 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2585 /* Use one of the mode line rows of W's desired matrix if
2589 if (base_face_id
== MODE_LINE_FACE_ID
2590 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2591 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2592 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2593 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2597 bzero (it
, sizeof *it
);
2598 it
->current
.overlay_string_index
= -1;
2599 it
->current
.dpvec_index
= -1;
2600 it
->base_face_id
= remapped_base_face_id
;
2602 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2604 /* The window in which we iterate over current_buffer: */
2605 XSETWINDOW (it
->window
, w
);
2607 it
->f
= XFRAME (w
->frame
);
2611 /* Extra space between lines (on window systems only). */
2612 if (base_face_id
== DEFAULT_FACE_ID
2613 && FRAME_WINDOW_P (it
->f
))
2615 if (NATNUMP (current_buffer
->extra_line_spacing
))
2616 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2617 else if (FLOATP (current_buffer
->extra_line_spacing
))
2618 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2619 * FRAME_LINE_HEIGHT (it
->f
));
2620 else if (it
->f
->extra_line_spacing
> 0)
2621 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2622 it
->max_extra_line_spacing
= 0;
2625 /* If realized faces have been removed, e.g. because of face
2626 attribute changes of named faces, recompute them. When running
2627 in batch mode, the face cache of the initial frame is null. If
2628 we happen to get called, make a dummy face cache. */
2629 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2630 init_frame_faces (it
->f
);
2631 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2632 recompute_basic_faces (it
->f
);
2634 /* Current value of the `slice', `space-width', and 'height' properties. */
2635 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2636 it
->space_width
= Qnil
;
2637 it
->font_height
= Qnil
;
2638 it
->override_ascent
= -1;
2640 /* Are control characters displayed as `^C'? */
2641 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2643 /* -1 means everything between a CR and the following line end
2644 is invisible. >0 means lines indented more than this value are
2646 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2647 ? XFASTINT (current_buffer
->selective_display
)
2648 : (!NILP (current_buffer
->selective_display
)
2650 it
->selective_display_ellipsis_p
2651 = !NILP (current_buffer
->selective_display_ellipses
);
2653 /* Display table to use. */
2654 it
->dp
= window_display_table (w
);
2656 /* Are multibyte characters enabled in current_buffer? */
2657 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2659 /* Do we need to reorder bidirectional text? */
2660 it
->bidi_p
= !NILP (current_buffer
->bidi_display_reordering
);
2662 /* Non-zero if we should highlight the region. */
2664 = (!NILP (Vtransient_mark_mode
)
2665 && !NILP (current_buffer
->mark_active
)
2666 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2668 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2669 start and end of a visible region in window IT->w. Set both to
2670 -1 to indicate no region. */
2671 if (highlight_region_p
2672 /* Maybe highlight only in selected window. */
2673 && (/* Either show region everywhere. */
2674 highlight_nonselected_windows
2675 /* Or show region in the selected window. */
2676 || w
== XWINDOW (selected_window
)
2677 /* Or show the region if we are in the mini-buffer and W is
2678 the window the mini-buffer refers to. */
2679 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2680 && WINDOWP (minibuf_selected_window
)
2681 && w
== XWINDOW (minibuf_selected_window
))))
2683 int charpos
= marker_position (current_buffer
->mark
);
2684 it
->region_beg_charpos
= min (PT
, charpos
);
2685 it
->region_end_charpos
= max (PT
, charpos
);
2688 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2690 /* Get the position at which the redisplay_end_trigger hook should
2691 be run, if it is to be run at all. */
2692 if (MARKERP (w
->redisplay_end_trigger
)
2693 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2694 it
->redisplay_end_trigger_charpos
2695 = marker_position (w
->redisplay_end_trigger
);
2696 else if (INTEGERP (w
->redisplay_end_trigger
))
2697 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2699 /* Correct bogus values of tab_width. */
2700 it
->tab_width
= XINT (current_buffer
->tab_width
);
2701 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2704 /* Are lines in the display truncated? */
2705 if (base_face_id
!= DEFAULT_FACE_ID
2706 || XINT (it
->w
->hscroll
)
2707 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2708 && ((!NILP (Vtruncate_partial_width_windows
)
2709 && !INTEGERP (Vtruncate_partial_width_windows
))
2710 || (INTEGERP (Vtruncate_partial_width_windows
)
2711 && (WINDOW_TOTAL_COLS (it
->w
)
2712 < XINT (Vtruncate_partial_width_windows
))))))
2713 it
->line_wrap
= TRUNCATE
;
2714 else if (NILP (current_buffer
->truncate_lines
))
2715 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2716 ? WINDOW_WRAP
: WORD_WRAP
;
2718 it
->line_wrap
= TRUNCATE
;
2720 /* Get dimensions of truncation and continuation glyphs. These are
2721 displayed as fringe bitmaps under X, so we don't need them for such
2723 if (!FRAME_WINDOW_P (it
->f
))
2725 if (it
->line_wrap
== TRUNCATE
)
2727 /* We will need the truncation glyph. */
2728 xassert (it
->glyph_row
== NULL
);
2729 produce_special_glyphs (it
, IT_TRUNCATION
);
2730 it
->truncation_pixel_width
= it
->pixel_width
;
2734 /* We will need the continuation glyph. */
2735 xassert (it
->glyph_row
== NULL
);
2736 produce_special_glyphs (it
, IT_CONTINUATION
);
2737 it
->continuation_pixel_width
= it
->pixel_width
;
2740 /* Reset these values to zero because the produce_special_glyphs
2741 above has changed them. */
2742 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2743 it
->phys_ascent
= it
->phys_descent
= 0;
2746 /* Set this after getting the dimensions of truncation and
2747 continuation glyphs, so that we don't produce glyphs when calling
2748 produce_special_glyphs, above. */
2749 it
->glyph_row
= row
;
2750 it
->area
= TEXT_AREA
;
2752 /* Forget any previous info about this row being reversed. */
2754 it
->glyph_row
->reversed_p
= 0;
2756 /* Get the dimensions of the display area. The display area
2757 consists of the visible window area plus a horizontally scrolled
2758 part to the left of the window. All x-values are relative to the
2759 start of this total display area. */
2760 if (base_face_id
!= DEFAULT_FACE_ID
)
2762 /* Mode lines, menu bar in terminal frames. */
2763 it
->first_visible_x
= 0;
2764 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2769 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2770 it
->last_visible_x
= (it
->first_visible_x
2771 + window_box_width (w
, TEXT_AREA
));
2773 /* If we truncate lines, leave room for the truncator glyph(s) at
2774 the right margin. Otherwise, leave room for the continuation
2775 glyph(s). Truncation and continuation glyphs are not inserted
2776 for window-based redisplay. */
2777 if (!FRAME_WINDOW_P (it
->f
))
2779 if (it
->line_wrap
== TRUNCATE
)
2780 it
->last_visible_x
-= it
->truncation_pixel_width
;
2782 it
->last_visible_x
-= it
->continuation_pixel_width
;
2785 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2786 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2789 /* Leave room for a border glyph. */
2790 if (!FRAME_WINDOW_P (it
->f
)
2791 && !WINDOW_RIGHTMOST_P (it
->w
))
2792 it
->last_visible_x
-= 1;
2794 it
->last_visible_y
= window_text_bottom_y (w
);
2796 /* For mode lines and alike, arrange for the first glyph having a
2797 left box line if the face specifies a box. */
2798 if (base_face_id
!= DEFAULT_FACE_ID
)
2802 it
->face_id
= remapped_base_face_id
;
2804 /* If we have a boxed mode line, make the first character appear
2805 with a left box line. */
2806 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2807 if (face
->box
!= FACE_NO_BOX
)
2808 it
->start_of_box_run_p
= 1;
2811 /* If we are to reorder bidirectional text, init the bidi
2815 /* Note the paragraph direction that this buffer wants to
2817 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2818 it
->paragraph_embedding
= L2R
;
2819 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2820 it
->paragraph_embedding
= R2L
;
2822 it
->paragraph_embedding
= NEUTRAL_DIR
;
2823 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2826 /* If a buffer position was specified, set the iterator there,
2827 getting overlays and face properties from that position. */
2828 if (charpos
>= BUF_BEG (current_buffer
))
2830 it
->end_charpos
= ZV
;
2832 IT_CHARPOS (*it
) = charpos
;
2834 /* Compute byte position if not specified. */
2835 if (bytepos
< charpos
)
2836 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2838 IT_BYTEPOS (*it
) = bytepos
;
2840 it
->start
= it
->current
;
2842 /* Compute faces etc. */
2843 reseat (it
, it
->current
.pos
, 1);
2850 /* Initialize IT for the display of window W with window start POS. */
2853 start_display (it
, w
, pos
)
2856 struct text_pos pos
;
2858 struct glyph_row
*row
;
2859 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2861 row
= w
->desired_matrix
->rows
+ first_vpos
;
2862 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2863 it
->first_vpos
= first_vpos
;
2865 /* Don't reseat to previous visible line start if current start
2866 position is in a string or image. */
2867 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2869 int start_at_line_beg_p
;
2870 int first_y
= it
->current_y
;
2872 /* If window start is not at a line start, skip forward to POS to
2873 get the correct continuation lines width. */
2874 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2875 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2876 if (!start_at_line_beg_p
)
2880 reseat_at_previous_visible_line_start (it
);
2881 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2883 new_x
= it
->current_x
+ it
->pixel_width
;
2885 /* If lines are continued, this line may end in the middle
2886 of a multi-glyph character (e.g. a control character
2887 displayed as \003, or in the middle of an overlay
2888 string). In this case move_it_to above will not have
2889 taken us to the start of the continuation line but to the
2890 end of the continued line. */
2891 if (it
->current_x
> 0
2892 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2893 && (/* And glyph doesn't fit on the line. */
2894 new_x
> it
->last_visible_x
2895 /* Or it fits exactly and we're on a window
2897 || (new_x
== it
->last_visible_x
2898 && FRAME_WINDOW_P (it
->f
))))
2900 if (it
->current
.dpvec_index
>= 0
2901 || it
->current
.overlay_string_index
>= 0)
2903 set_iterator_to_next (it
, 1);
2904 move_it_in_display_line_to (it
, -1, -1, 0);
2907 it
->continuation_lines_width
+= it
->current_x
;
2910 /* We're starting a new display line, not affected by the
2911 height of the continued line, so clear the appropriate
2912 fields in the iterator structure. */
2913 it
->max_ascent
= it
->max_descent
= 0;
2914 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2916 it
->current_y
= first_y
;
2918 it
->current_x
= it
->hpos
= 0;
2924 /* Return 1 if POS is a position in ellipses displayed for invisible
2925 text. W is the window we display, for text property lookup. */
2928 in_ellipses_for_invisible_text_p (pos
, w
)
2929 struct display_pos
*pos
;
2932 Lisp_Object prop
, window
;
2934 int charpos
= CHARPOS (pos
->pos
);
2936 /* If POS specifies a position in a display vector, this might
2937 be for an ellipsis displayed for invisible text. We won't
2938 get the iterator set up for delivering that ellipsis unless
2939 we make sure that it gets aware of the invisible text. */
2940 if (pos
->dpvec_index
>= 0
2941 && pos
->overlay_string_index
< 0
2942 && CHARPOS (pos
->string_pos
) < 0
2944 && (XSETWINDOW (window
, w
),
2945 prop
= Fget_char_property (make_number (charpos
),
2946 Qinvisible
, window
),
2947 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2949 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2951 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2958 /* Initialize IT for stepping through current_buffer in window W,
2959 starting at position POS that includes overlay string and display
2960 vector/ control character translation position information. Value
2961 is zero if there are overlay strings with newlines at POS. */
2964 init_from_display_pos (it
, w
, pos
)
2967 struct display_pos
*pos
;
2969 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2970 int i
, overlay_strings_with_newlines
= 0;
2972 /* If POS specifies a position in a display vector, this might
2973 be for an ellipsis displayed for invisible text. We won't
2974 get the iterator set up for delivering that ellipsis unless
2975 we make sure that it gets aware of the invisible text. */
2976 if (in_ellipses_for_invisible_text_p (pos
, w
))
2982 /* Keep in mind: the call to reseat in init_iterator skips invisible
2983 text, so we might end up at a position different from POS. This
2984 is only a problem when POS is a row start after a newline and an
2985 overlay starts there with an after-string, and the overlay has an
2986 invisible property. Since we don't skip invisible text in
2987 display_line and elsewhere immediately after consuming the
2988 newline before the row start, such a POS will not be in a string,
2989 but the call to init_iterator below will move us to the
2991 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2993 /* This only scans the current chunk -- it should scan all chunks.
2994 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2995 to 16 in 22.1 to make this a lesser problem. */
2996 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2998 const char *s
= SDATA (it
->overlay_strings
[i
]);
2999 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3001 while (s
< e
&& *s
!= '\n')
3006 overlay_strings_with_newlines
= 1;
3011 /* If position is within an overlay string, set up IT to the right
3013 if (pos
->overlay_string_index
>= 0)
3017 /* If the first overlay string happens to have a `display'
3018 property for an image, the iterator will be set up for that
3019 image, and we have to undo that setup first before we can
3020 correct the overlay string index. */
3021 if (it
->method
== GET_FROM_IMAGE
)
3024 /* We already have the first chunk of overlay strings in
3025 IT->overlay_strings. Load more until the one for
3026 pos->overlay_string_index is in IT->overlay_strings. */
3027 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3029 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3030 it
->current
.overlay_string_index
= 0;
3033 load_overlay_strings (it
, 0);
3034 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3038 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3039 relative_index
= (it
->current
.overlay_string_index
3040 % OVERLAY_STRING_CHUNK_SIZE
);
3041 it
->string
= it
->overlay_strings
[relative_index
];
3042 xassert (STRINGP (it
->string
));
3043 it
->current
.string_pos
= pos
->string_pos
;
3044 it
->method
= GET_FROM_STRING
;
3047 if (CHARPOS (pos
->string_pos
) >= 0)
3049 /* Recorded position is not in an overlay string, but in another
3050 string. This can only be a string from a `display' property.
3051 IT should already be filled with that string. */
3052 it
->current
.string_pos
= pos
->string_pos
;
3053 xassert (STRINGP (it
->string
));
3056 /* Restore position in display vector translations, control
3057 character translations or ellipses. */
3058 if (pos
->dpvec_index
>= 0)
3060 if (it
->dpvec
== NULL
)
3061 get_next_display_element (it
);
3062 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3063 it
->current
.dpvec_index
= pos
->dpvec_index
;
3067 return !overlay_strings_with_newlines
;
3071 /* Initialize IT for stepping through current_buffer in window W
3072 starting at ROW->start. */
3075 init_to_row_start (it
, w
, row
)
3078 struct glyph_row
*row
;
3080 init_from_display_pos (it
, w
, &row
->start
);
3081 it
->start
= row
->start
;
3082 it
->continuation_lines_width
= row
->continuation_lines_width
;
3087 /* Initialize IT for stepping through current_buffer in window W
3088 starting in the line following ROW, i.e. starting at ROW->end.
3089 Value is zero if there are overlay strings with newlines at ROW's
3093 init_to_row_end (it
, w
, row
)
3096 struct glyph_row
*row
;
3100 if (init_from_display_pos (it
, w
, &row
->end
))
3102 if (row
->continued_p
)
3103 it
->continuation_lines_width
3104 = row
->continuation_lines_width
+ row
->pixel_width
;
3115 /***********************************************************************
3117 ***********************************************************************/
3119 /* Called when IT reaches IT->stop_charpos. Handle text property and
3120 overlay changes. Set IT->stop_charpos to the next position where
3127 enum prop_handled handled
;
3128 int handle_overlay_change_p
;
3132 it
->current
.dpvec_index
= -1;
3133 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3134 it
->ignore_overlay_strings_at_pos_p
= 0;
3137 /* Use face of preceding text for ellipsis (if invisible) */
3138 if (it
->selective_display_ellipsis_p
)
3139 it
->saved_face_id
= it
->face_id
;
3143 handled
= HANDLED_NORMALLY
;
3145 /* Call text property handlers. */
3146 for (p
= it_props
; p
->handler
; ++p
)
3148 handled
= p
->handler (it
);
3150 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3152 else if (handled
== HANDLED_RETURN
)
3154 /* We still want to show before and after strings from
3155 overlays even if the actual buffer text is replaced. */
3156 if (!handle_overlay_change_p
3158 || !get_overlay_strings_1 (it
, 0, 0))
3161 setup_for_ellipsis (it
, 0);
3162 /* When handling a display spec, we might load an
3163 empty string. In that case, discard it here. We
3164 used to discard it in handle_single_display_spec,
3165 but that causes get_overlay_strings_1, above, to
3166 ignore overlay strings that we must check. */
3167 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3171 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3175 it
->ignore_overlay_strings_at_pos_p
= 1;
3176 it
->string_from_display_prop_p
= 0;
3177 handle_overlay_change_p
= 0;
3179 handled
= HANDLED_RECOMPUTE_PROPS
;
3182 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3183 handle_overlay_change_p
= 0;
3186 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3188 /* Don't check for overlay strings below when set to deliver
3189 characters from a display vector. */
3190 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3191 handle_overlay_change_p
= 0;
3193 /* Handle overlay changes.
3194 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3195 if it finds overlays. */
3196 if (handle_overlay_change_p
)
3197 handled
= handle_overlay_change (it
);
3202 setup_for_ellipsis (it
, 0);
3206 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3208 /* Determine where to stop next. */
3209 if (handled
== HANDLED_NORMALLY
)
3210 compute_stop_pos (it
);
3214 /* Compute IT->stop_charpos from text property and overlay change
3215 information for IT's current position. */
3218 compute_stop_pos (it
)
3221 register INTERVAL iv
, next_iv
;
3222 Lisp_Object object
, limit
, position
;
3223 EMACS_INT charpos
, bytepos
;
3225 /* If nowhere else, stop at the end. */
3226 it
->stop_charpos
= it
->end_charpos
;
3228 if (STRINGP (it
->string
))
3230 /* Strings are usually short, so don't limit the search for
3232 object
= it
->string
;
3234 charpos
= IT_STRING_CHARPOS (*it
);
3235 bytepos
= IT_STRING_BYTEPOS (*it
);
3241 /* If next overlay change is in front of the current stop pos
3242 (which is IT->end_charpos), stop there. Note: value of
3243 next_overlay_change is point-max if no overlay change
3245 charpos
= IT_CHARPOS (*it
);
3246 bytepos
= IT_BYTEPOS (*it
);
3247 pos
= next_overlay_change (charpos
);
3248 if (pos
< it
->stop_charpos
)
3249 it
->stop_charpos
= pos
;
3251 /* If showing the region, we have to stop at the region
3252 start or end because the face might change there. */
3253 if (it
->region_beg_charpos
> 0)
3255 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3256 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3257 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3258 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3261 /* Set up variables for computing the stop position from text
3262 property changes. */
3263 XSETBUFFER (object
, current_buffer
);
3264 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3267 /* Get the interval containing IT's position. Value is a null
3268 interval if there isn't such an interval. */
3269 position
= make_number (charpos
);
3270 iv
= validate_interval_range (object
, &position
, &position
, 0);
3271 if (!NULL_INTERVAL_P (iv
))
3273 Lisp_Object values_here
[LAST_PROP_IDX
];
3276 /* Get properties here. */
3277 for (p
= it_props
; p
->handler
; ++p
)
3278 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3280 /* Look for an interval following iv that has different
3282 for (next_iv
= next_interval (iv
);
3283 (!NULL_INTERVAL_P (next_iv
)
3285 || XFASTINT (limit
) > next_iv
->position
));
3286 next_iv
= next_interval (next_iv
))
3288 for (p
= it_props
; p
->handler
; ++p
)
3290 Lisp_Object new_value
;
3292 new_value
= textget (next_iv
->plist
, *p
->name
);
3293 if (!EQ (values_here
[p
->idx
], new_value
))
3301 if (!NULL_INTERVAL_P (next_iv
))
3303 if (INTEGERP (limit
)
3304 && next_iv
->position
>= XFASTINT (limit
))
3305 /* No text property change up to limit. */
3306 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3308 /* Text properties change in next_iv. */
3309 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3313 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3314 it
->stop_charpos
, it
->string
);
3316 xassert (STRINGP (it
->string
)
3317 || (it
->stop_charpos
>= BEGV
3318 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3322 /* Return the position of the next overlay change after POS in
3323 current_buffer. Value is point-max if no overlay change
3324 follows. This is like `next-overlay-change' but doesn't use
3328 next_overlay_change (pos
)
3333 Lisp_Object
*overlays
;
3336 /* Get all overlays at the given position. */
3337 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3339 /* If any of these overlays ends before endpos,
3340 use its ending point instead. */
3341 for (i
= 0; i
< noverlays
; ++i
)
3346 oend
= OVERLAY_END (overlays
[i
]);
3347 oendpos
= OVERLAY_POSITION (oend
);
3348 endpos
= min (endpos
, oendpos
);
3356 /***********************************************************************
3358 ***********************************************************************/
3360 /* Handle changes in the `fontified' property of the current buffer by
3361 calling hook functions from Qfontification_functions to fontify
3364 static enum prop_handled
3365 handle_fontified_prop (it
)
3368 Lisp_Object prop
, pos
;
3369 enum prop_handled handled
= HANDLED_NORMALLY
;
3371 if (!NILP (Vmemory_full
))
3374 /* Get the value of the `fontified' property at IT's current buffer
3375 position. (The `fontified' property doesn't have a special
3376 meaning in strings.) If the value is nil, call functions from
3377 Qfontification_functions. */
3378 if (!STRINGP (it
->string
)
3380 && !NILP (Vfontification_functions
)
3381 && !NILP (Vrun_hooks
)
3382 && (pos
= make_number (IT_CHARPOS (*it
)),
3383 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3384 /* Ignore the special cased nil value always present at EOB since
3385 no amount of fontifying will be able to change it. */
3386 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3388 int count
= SPECPDL_INDEX ();
3391 val
= Vfontification_functions
;
3392 specbind (Qfontification_functions
, Qnil
);
3394 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3395 safe_call1 (val
, pos
);
3398 Lisp_Object globals
, fn
;
3399 struct gcpro gcpro1
, gcpro2
;
3402 GCPRO2 (val
, globals
);
3404 for (; CONSP (val
); val
= XCDR (val
))
3410 /* A value of t indicates this hook has a local
3411 binding; it means to run the global binding too.
3412 In a global value, t should not occur. If it
3413 does, we must ignore it to avoid an endless
3415 for (globals
= Fdefault_value (Qfontification_functions
);
3417 globals
= XCDR (globals
))
3419 fn
= XCAR (globals
);
3421 safe_call1 (fn
, pos
);
3425 safe_call1 (fn
, pos
);
3431 unbind_to (count
, Qnil
);
3433 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3434 something. This avoids an endless loop if they failed to
3435 fontify the text for which reason ever. */
3436 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3437 handled
= HANDLED_RECOMPUTE_PROPS
;
3445 /***********************************************************************
3447 ***********************************************************************/
3449 /* Set up iterator IT from face properties at its current position.
3450 Called from handle_stop. */
3452 static enum prop_handled
3453 handle_face_prop (it
)
3457 EMACS_INT next_stop
;
3459 if (!STRINGP (it
->string
))
3462 = face_at_buffer_position (it
->w
,
3464 it
->region_beg_charpos
,
3465 it
->region_end_charpos
,
3468 + TEXT_PROP_DISTANCE_LIMIT
),
3469 0, it
->base_face_id
);
3471 /* Is this a start of a run of characters with box face?
3472 Caveat: this can be called for a freshly initialized
3473 iterator; face_id is -1 in this case. We know that the new
3474 face will not change until limit, i.e. if the new face has a
3475 box, all characters up to limit will have one. But, as
3476 usual, we don't know whether limit is really the end. */
3477 if (new_face_id
!= it
->face_id
)
3479 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3481 /* If new face has a box but old face has not, this is
3482 the start of a run of characters with box, i.e. it has
3483 a shadow on the left side. The value of face_id of the
3484 iterator will be -1 if this is the initial call that gets
3485 the face. In this case, we have to look in front of IT's
3486 position and see whether there is a face != new_face_id. */
3487 it
->start_of_box_run_p
3488 = (new_face
->box
!= FACE_NO_BOX
3489 && (it
->face_id
>= 0
3490 || IT_CHARPOS (*it
) == BEG
3491 || new_face_id
!= face_before_it_pos (it
)));
3492 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3497 int base_face_id
, bufpos
;
3499 Lisp_Object from_overlay
3500 = (it
->current
.overlay_string_index
>= 0
3501 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3504 /* See if we got to this string directly or indirectly from
3505 an overlay property. That includes the before-string or
3506 after-string of an overlay, strings in display properties
3507 provided by an overlay, their text properties, etc.
3509 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3510 if (! NILP (from_overlay
))
3511 for (i
= it
->sp
- 1; i
>= 0; i
--)
3513 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3515 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3516 else if (! NILP (it
->stack
[i
].from_overlay
))
3517 from_overlay
= it
->stack
[i
].from_overlay
;
3519 if (!NILP (from_overlay
))
3523 if (! NILP (from_overlay
))
3525 bufpos
= IT_CHARPOS (*it
);
3526 /* For a string from an overlay, the base face depends
3527 only on text properties and ignores overlays. */
3529 = face_for_overlay_string (it
->w
,
3531 it
->region_beg_charpos
,
3532 it
->region_end_charpos
,
3535 + TEXT_PROP_DISTANCE_LIMIT
),
3543 /* For strings from a `display' property, use the face at
3544 IT's current buffer position as the base face to merge
3545 with, so that overlay strings appear in the same face as
3546 surrounding text, unless they specify their own
3548 base_face_id
= underlying_face_id (it
);
3551 new_face_id
= face_at_string_position (it
->w
,
3553 IT_STRING_CHARPOS (*it
),
3555 it
->region_beg_charpos
,
3556 it
->region_end_charpos
,
3560 /* Is this a start of a run of characters with box? Caveat:
3561 this can be called for a freshly allocated iterator; face_id
3562 is -1 is this case. We know that the new face will not
3563 change until the next check pos, i.e. if the new face has a
3564 box, all characters up to that position will have a
3565 box. But, as usual, we don't know whether that position
3566 is really the end. */
3567 if (new_face_id
!= it
->face_id
)
3569 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3570 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3572 /* If new face has a box but old face hasn't, this is the
3573 start of a run of characters with box, i.e. it has a
3574 shadow on the left side. */
3575 it
->start_of_box_run_p
3576 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3577 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3581 it
->face_id
= new_face_id
;
3582 return HANDLED_NORMALLY
;
3586 /* Return the ID of the face ``underlying'' IT's current position,
3587 which is in a string. If the iterator is associated with a
3588 buffer, return the face at IT's current buffer position.
3589 Otherwise, use the iterator's base_face_id. */
3592 underlying_face_id (it
)
3595 int face_id
= it
->base_face_id
, i
;
3597 xassert (STRINGP (it
->string
));
3599 for (i
= it
->sp
- 1; i
>= 0; --i
)
3600 if (NILP (it
->stack
[i
].string
))
3601 face_id
= it
->stack
[i
].face_id
;
3607 /* Compute the face one character before or after the current position
3608 of IT. BEFORE_P non-zero means get the face in front of IT's
3609 position. Value is the id of the face. */
3612 face_before_or_after_it_pos (it
, before_p
)
3617 EMACS_INT next_check_charpos
;
3618 struct text_pos pos
;
3620 xassert (it
->s
== NULL
);
3622 if (STRINGP (it
->string
))
3624 int bufpos
, base_face_id
;
3626 /* No face change past the end of the string (for the case
3627 we are padding with spaces). No face change before the
3629 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3630 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3633 /* Set pos to the position before or after IT's current position. */
3635 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3637 /* For composition, we must check the character after the
3639 pos
= (it
->what
== IT_COMPOSITION
3640 ? string_pos (IT_STRING_CHARPOS (*it
)
3641 + it
->cmp_it
.nchars
, it
->string
)
3642 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3644 if (it
->current
.overlay_string_index
>= 0)
3645 bufpos
= IT_CHARPOS (*it
);
3649 base_face_id
= underlying_face_id (it
);
3651 /* Get the face for ASCII, or unibyte. */
3652 face_id
= face_at_string_position (it
->w
,
3656 it
->region_beg_charpos
,
3657 it
->region_end_charpos
,
3658 &next_check_charpos
,
3661 /* Correct the face for charsets different from ASCII. Do it
3662 for the multibyte case only. The face returned above is
3663 suitable for unibyte text if IT->string is unibyte. */
3664 if (STRING_MULTIBYTE (it
->string
))
3666 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3667 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3669 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3671 c
= string_char_and_length (p
, &len
);
3672 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3677 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3678 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3681 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3682 pos
= it
->current
.pos
;
3685 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3688 if (it
->what
== IT_COMPOSITION
)
3689 /* For composition, we must check the position after the
3691 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3693 INC_TEXT_POS (pos
, it
->multibyte_p
);
3696 /* Determine face for CHARSET_ASCII, or unibyte. */
3697 face_id
= face_at_buffer_position (it
->w
,
3699 it
->region_beg_charpos
,
3700 it
->region_end_charpos
,
3701 &next_check_charpos
,
3704 /* Correct the face for charsets different from ASCII. Do it
3705 for the multibyte case only. The face returned above is
3706 suitable for unibyte text if current_buffer is unibyte. */
3707 if (it
->multibyte_p
)
3709 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3710 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3711 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3720 /***********************************************************************
3722 ***********************************************************************/
3724 /* Set up iterator IT from invisible properties at its current
3725 position. Called from handle_stop. */
3727 static enum prop_handled
3728 handle_invisible_prop (it
)
3731 enum prop_handled handled
= HANDLED_NORMALLY
;
3733 if (STRINGP (it
->string
))
3735 extern Lisp_Object Qinvisible
;
3736 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3738 /* Get the value of the invisible text property at the
3739 current position. Value will be nil if there is no such
3741 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3742 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3745 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3747 handled
= HANDLED_RECOMPUTE_PROPS
;
3749 /* Get the position at which the next change of the
3750 invisible text property can be found in IT->string.
3751 Value will be nil if the property value is the same for
3752 all the rest of IT->string. */
3753 XSETINT (limit
, SCHARS (it
->string
));
3754 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3757 /* Text at current position is invisible. The next
3758 change in the property is at position end_charpos.
3759 Move IT's current position to that position. */
3760 if (INTEGERP (end_charpos
)
3761 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3763 struct text_pos old
;
3764 old
= it
->current
.string_pos
;
3765 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3766 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3770 /* The rest of the string is invisible. If this is an
3771 overlay string, proceed with the next overlay string
3772 or whatever comes and return a character from there. */
3773 if (it
->current
.overlay_string_index
>= 0)
3775 next_overlay_string (it
);
3776 /* Don't check for overlay strings when we just
3777 finished processing them. */
3778 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3782 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3783 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3791 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3792 Lisp_Object pos
, prop
, overlay
;
3794 /* First of all, is there invisible text at this position? */
3795 tem
= start_charpos
= IT_CHARPOS (*it
);
3796 pos
= make_number (tem
);
3797 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3799 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3801 /* If we are on invisible text, skip over it. */
3802 if (invis_p
&& start_charpos
< it
->end_charpos
)
3804 /* Record whether we have to display an ellipsis for the
3806 int display_ellipsis_p
= invis_p
== 2;
3808 handled
= HANDLED_RECOMPUTE_PROPS
;
3810 /* Loop skipping over invisible text. The loop is left at
3811 ZV or with IT on the first char being visible again. */
3814 /* Try to skip some invisible text. Return value is the
3815 position reached which can be equal to where we start
3816 if there is nothing invisible there. This skips both
3817 over invisible text properties and overlays with
3818 invisible property. */
3819 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3821 /* If we skipped nothing at all we weren't at invisible
3822 text in the first place. If everything to the end of
3823 the buffer was skipped, end the loop. */
3824 if (newpos
== tem
|| newpos
>= ZV
)
3828 /* We skipped some characters but not necessarily
3829 all there are. Check if we ended up on visible
3830 text. Fget_char_property returns the property of
3831 the char before the given position, i.e. if we
3832 get invis_p = 0, this means that the char at
3833 newpos is visible. */
3834 pos
= make_number (newpos
);
3835 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3836 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3839 /* If we ended up on invisible text, proceed to
3840 skip starting with next_stop. */
3844 /* If there are adjacent invisible texts, don't lose the
3845 second one's ellipsis. */
3847 display_ellipsis_p
= 1;
3851 /* The position newpos is now either ZV or on visible text. */
3852 if (it
->bidi_p
&& newpos
< ZV
)
3854 /* With bidi iteration, the region of invisible text
3855 could start and/or end in the middle of a non-base
3856 embedding level. Therefore, we need to skip
3857 invisible text using the bidi iterator, starting at
3858 IT's current position, until we find ourselves
3859 outside the invisible text. Skipping invisible text
3860 _after_ bidi iteration avoids affecting the visual
3861 order of the displayed text when invisible properties
3862 are added or removed. */
3863 if (it
->bidi_it
.first_elt
)
3865 /* If we were `reseat'ed to a new paragraph,
3866 determine the paragraph base direction. We need
3867 to do it now because next_element_from_buffer may
3868 not have a chance to do it, if we are going to
3869 skip any text at the beginning, which resets the
3871 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3875 bidi_get_next_char_visually (&it
->bidi_it
);
3877 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3878 && it
->bidi_it
.charpos
< newpos
);
3879 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3880 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3881 /* If we overstepped NEWPOS, record its position in the
3882 iterator, so that we skip invisible text if later the
3883 bidi iteration lands us in the invisible region
3885 if (IT_CHARPOS (*it
) >= newpos
)
3886 it
->prev_stop
= newpos
;
3890 IT_CHARPOS (*it
) = newpos
;
3891 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3894 /* If there are before-strings at the start of invisible
3895 text, and the text is invisible because of a text
3896 property, arrange to show before-strings because 20.x did
3897 it that way. (If the text is invisible because of an
3898 overlay property instead of a text property, this is
3899 already handled in the overlay code.) */
3901 && get_overlay_strings (it
, it
->stop_charpos
))
3903 handled
= HANDLED_RECOMPUTE_PROPS
;
3904 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3906 else if (display_ellipsis_p
)
3908 /* Make sure that the glyphs of the ellipsis will get
3909 correct `charpos' values. If we would not update
3910 it->position here, the glyphs would belong to the
3911 last visible character _before_ the invisible
3912 text, which confuses `set_cursor_from_row'.
3914 We use the last invisible position instead of the
3915 first because this way the cursor is always drawn on
3916 the first "." of the ellipsis, whenever PT is inside
3917 the invisible text. Otherwise the cursor would be
3918 placed _after_ the ellipsis when the point is after the
3919 first invisible character. */
3920 if (!STRINGP (it
->object
))
3922 it
->position
.charpos
= newpos
- 1;
3923 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3926 /* Let the ellipsis display before
3927 considering any properties of the following char.
3928 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3929 handled
= HANDLED_RETURN
;
3938 /* Make iterator IT return `...' next.
3939 Replaces LEN characters from buffer. */
3942 setup_for_ellipsis (it
, len
)
3946 /* Use the display table definition for `...'. Invalid glyphs
3947 will be handled by the method returning elements from dpvec. */
3948 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3950 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3951 it
->dpvec
= v
->contents
;
3952 it
->dpend
= v
->contents
+ v
->size
;
3956 /* Default `...'. */
3957 it
->dpvec
= default_invis_vector
;
3958 it
->dpend
= default_invis_vector
+ 3;
3961 it
->dpvec_char_len
= len
;
3962 it
->current
.dpvec_index
= 0;
3963 it
->dpvec_face_id
= -1;
3965 /* Remember the current face id in case glyphs specify faces.
3966 IT's face is restored in set_iterator_to_next.
3967 saved_face_id was set to preceding char's face in handle_stop. */
3968 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3969 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3971 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3977 /***********************************************************************
3979 ***********************************************************************/
3981 /* Set up iterator IT from `display' property at its current position.
3982 Called from handle_stop.
3983 We return HANDLED_RETURN if some part of the display property
3984 overrides the display of the buffer text itself.
3985 Otherwise we return HANDLED_NORMALLY. */
3987 static enum prop_handled
3988 handle_display_prop (it
)
3991 Lisp_Object prop
, object
, overlay
;
3992 struct text_pos
*position
;
3993 /* Nonzero if some property replaces the display of the text itself. */
3994 int display_replaced_p
= 0;
3996 if (STRINGP (it
->string
))
3998 object
= it
->string
;
3999 position
= &it
->current
.string_pos
;
4003 XSETWINDOW (object
, it
->w
);
4004 position
= &it
->current
.pos
;
4007 /* Reset those iterator values set from display property values. */
4008 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4009 it
->space_width
= Qnil
;
4010 it
->font_height
= Qnil
;
4013 /* We don't support recursive `display' properties, i.e. string
4014 values that have a string `display' property, that have a string
4015 `display' property etc. */
4016 if (!it
->string_from_display_prop_p
)
4017 it
->area
= TEXT_AREA
;
4019 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
4020 Qdisplay
, object
, &overlay
);
4022 return HANDLED_NORMALLY
;
4023 /* Now OVERLAY is the overlay that gave us this property, or nil
4024 if it was a text property. */
4026 if (!STRINGP (it
->string
))
4027 object
= it
->w
->buffer
;
4030 /* Simple properties. */
4031 && !EQ (XCAR (prop
), Qimage
)
4032 && !EQ (XCAR (prop
), Qspace
)
4033 && !EQ (XCAR (prop
), Qwhen
)
4034 && !EQ (XCAR (prop
), Qslice
)
4035 && !EQ (XCAR (prop
), Qspace_width
)
4036 && !EQ (XCAR (prop
), Qheight
)
4037 && !EQ (XCAR (prop
), Qraise
)
4038 /* Marginal area specifications. */
4039 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
4040 && !EQ (XCAR (prop
), Qleft_fringe
)
4041 && !EQ (XCAR (prop
), Qright_fringe
)
4042 && !NILP (XCAR (prop
)))
4044 for (; CONSP (prop
); prop
= XCDR (prop
))
4046 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4047 position
, display_replaced_p
))
4049 display_replaced_p
= 1;
4050 /* If some text in a string is replaced, `position' no
4051 longer points to the position of `object'. */
4052 if (STRINGP (object
))
4057 else if (VECTORP (prop
))
4060 for (i
= 0; i
< ASIZE (prop
); ++i
)
4061 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4062 position
, display_replaced_p
))
4064 display_replaced_p
= 1;
4065 /* If some text in a string is replaced, `position' no
4066 longer points to the position of `object'. */
4067 if (STRINGP (object
))
4073 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4075 display_replaced_p
= 1;
4078 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4082 /* Value is the position of the end of the `display' property starting
4083 at START_POS in OBJECT. */
4085 static struct text_pos
4086 display_prop_end (it
, object
, start_pos
)
4089 struct text_pos start_pos
;
4092 struct text_pos end_pos
;
4094 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4095 Qdisplay
, object
, Qnil
);
4096 CHARPOS (end_pos
) = XFASTINT (end
);
4097 if (STRINGP (object
))
4098 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4100 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4106 /* Set up IT from a single `display' specification PROP. OBJECT
4107 is the object in which the `display' property was found. *POSITION
4108 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4109 means that we previously saw a display specification which already
4110 replaced text display with something else, for example an image;
4111 we ignore such properties after the first one has been processed.
4113 OVERLAY is the overlay this `display' property came from,
4114 or nil if it was a text property.
4116 If PROP is a `space' or `image' specification, and in some other
4117 cases too, set *POSITION to the position where the `display'
4120 Value is non-zero if something was found which replaces the display
4121 of buffer or string text. */
4124 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4125 display_replaced_before_p
)
4129 Lisp_Object overlay
;
4130 struct text_pos
*position
;
4131 int display_replaced_before_p
;
4134 Lisp_Object location
, value
;
4135 struct text_pos start_pos
, save_pos
;
4138 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4139 If the result is non-nil, use VALUE instead of SPEC. */
4141 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4150 if (!NILP (form
) && !EQ (form
, Qt
))
4152 int count
= SPECPDL_INDEX ();
4153 struct gcpro gcpro1
;
4155 /* Bind `object' to the object having the `display' property, a
4156 buffer or string. Bind `position' to the position in the
4157 object where the property was found, and `buffer-position'
4158 to the current position in the buffer. */
4159 specbind (Qobject
, object
);
4160 specbind (Qposition
, make_number (CHARPOS (*position
)));
4161 specbind (Qbuffer_position
,
4162 make_number (STRINGP (object
)
4163 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4165 form
= safe_eval (form
);
4167 unbind_to (count
, Qnil
);
4173 /* Handle `(height HEIGHT)' specifications. */
4175 && EQ (XCAR (spec
), Qheight
)
4176 && CONSP (XCDR (spec
)))
4178 if (!FRAME_WINDOW_P (it
->f
))
4181 it
->font_height
= XCAR (XCDR (spec
));
4182 if (!NILP (it
->font_height
))
4184 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4185 int new_height
= -1;
4187 if (CONSP (it
->font_height
)
4188 && (EQ (XCAR (it
->font_height
), Qplus
)
4189 || EQ (XCAR (it
->font_height
), Qminus
))
4190 && CONSP (XCDR (it
->font_height
))
4191 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4193 /* `(+ N)' or `(- N)' where N is an integer. */
4194 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4195 if (EQ (XCAR (it
->font_height
), Qplus
))
4197 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4199 else if (FUNCTIONP (it
->font_height
))
4201 /* Call function with current height as argument.
4202 Value is the new height. */
4204 height
= safe_call1 (it
->font_height
,
4205 face
->lface
[LFACE_HEIGHT_INDEX
]);
4206 if (NUMBERP (height
))
4207 new_height
= XFLOATINT (height
);
4209 else if (NUMBERP (it
->font_height
))
4211 /* Value is a multiple of the canonical char height. */
4214 face
= FACE_FROM_ID (it
->f
,
4215 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4216 new_height
= (XFLOATINT (it
->font_height
)
4217 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4221 /* Evaluate IT->font_height with `height' bound to the
4222 current specified height to get the new height. */
4223 int count
= SPECPDL_INDEX ();
4225 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4226 value
= safe_eval (it
->font_height
);
4227 unbind_to (count
, Qnil
);
4229 if (NUMBERP (value
))
4230 new_height
= XFLOATINT (value
);
4234 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4240 /* Handle `(space-width WIDTH)'. */
4242 && EQ (XCAR (spec
), Qspace_width
)
4243 && CONSP (XCDR (spec
)))
4245 if (!FRAME_WINDOW_P (it
->f
))
4248 value
= XCAR (XCDR (spec
));
4249 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4250 it
->space_width
= value
;
4255 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4257 && EQ (XCAR (spec
), Qslice
))
4261 if (!FRAME_WINDOW_P (it
->f
))
4264 if (tem
= XCDR (spec
), CONSP (tem
))
4266 it
->slice
.x
= XCAR (tem
);
4267 if (tem
= XCDR (tem
), CONSP (tem
))
4269 it
->slice
.y
= XCAR (tem
);
4270 if (tem
= XCDR (tem
), CONSP (tem
))
4272 it
->slice
.width
= XCAR (tem
);
4273 if (tem
= XCDR (tem
), CONSP (tem
))
4274 it
->slice
.height
= XCAR (tem
);
4282 /* Handle `(raise FACTOR)'. */
4284 && EQ (XCAR (spec
), Qraise
)
4285 && CONSP (XCDR (spec
)))
4287 if (!FRAME_WINDOW_P (it
->f
))
4290 #ifdef HAVE_WINDOW_SYSTEM
4291 value
= XCAR (XCDR (spec
));
4292 if (NUMBERP (value
))
4294 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4295 it
->voffset
= - (XFLOATINT (value
)
4296 * (FONT_HEIGHT (face
->font
)));
4298 #endif /* HAVE_WINDOW_SYSTEM */
4303 /* Don't handle the other kinds of display specifications
4304 inside a string that we got from a `display' property. */
4305 if (it
->string_from_display_prop_p
)
4308 /* Characters having this form of property are not displayed, so
4309 we have to find the end of the property. */
4310 start_pos
= *position
;
4311 *position
= display_prop_end (it
, object
, start_pos
);
4314 /* Stop the scan at that end position--we assume that all
4315 text properties change there. */
4316 it
->stop_charpos
= position
->charpos
;
4318 /* Handle `(left-fringe BITMAP [FACE])'
4319 and `(right-fringe BITMAP [FACE])'. */
4321 && (EQ (XCAR (spec
), Qleft_fringe
)
4322 || EQ (XCAR (spec
), Qright_fringe
))
4323 && CONSP (XCDR (spec
)))
4325 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4328 if (!FRAME_WINDOW_P (it
->f
))
4329 /* If we return here, POSITION has been advanced
4330 across the text with this property. */
4333 #ifdef HAVE_WINDOW_SYSTEM
4334 value
= XCAR (XCDR (spec
));
4335 if (!SYMBOLP (value
)
4336 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4337 /* If we return here, POSITION has been advanced
4338 across the text with this property. */
4341 if (CONSP (XCDR (XCDR (spec
))))
4343 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4344 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4350 /* Save current settings of IT so that we can restore them
4351 when we are finished with the glyph property value. */
4353 save_pos
= it
->position
;
4354 it
->position
= *position
;
4356 it
->position
= save_pos
;
4358 it
->area
= TEXT_AREA
;
4359 it
->what
= IT_IMAGE
;
4360 it
->image_id
= -1; /* no image */
4361 it
->position
= start_pos
;
4362 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4363 it
->method
= GET_FROM_IMAGE
;
4364 it
->from_overlay
= Qnil
;
4365 it
->face_id
= face_id
;
4367 /* Say that we haven't consumed the characters with
4368 `display' property yet. The call to pop_it in
4369 set_iterator_to_next will clean this up. */
4370 *position
= start_pos
;
4372 if (EQ (XCAR (spec
), Qleft_fringe
))
4374 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4375 it
->left_user_fringe_face_id
= face_id
;
4379 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4380 it
->right_user_fringe_face_id
= face_id
;
4382 #endif /* HAVE_WINDOW_SYSTEM */
4386 /* Prepare to handle `((margin left-margin) ...)',
4387 `((margin right-margin) ...)' and `((margin nil) ...)'
4388 prefixes for display specifications. */
4389 location
= Qunbound
;
4390 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4394 value
= XCDR (spec
);
4396 value
= XCAR (value
);
4399 if (EQ (XCAR (tem
), Qmargin
)
4400 && (tem
= XCDR (tem
),
4401 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4403 || EQ (tem
, Qleft_margin
)
4404 || EQ (tem
, Qright_margin
))))
4408 if (EQ (location
, Qunbound
))
4414 /* After this point, VALUE is the property after any
4415 margin prefix has been stripped. It must be a string,
4416 an image specification, or `(space ...)'.
4418 LOCATION specifies where to display: `left-margin',
4419 `right-margin' or nil. */
4421 valid_p
= (STRINGP (value
)
4422 #ifdef HAVE_WINDOW_SYSTEM
4423 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4424 #endif /* not HAVE_WINDOW_SYSTEM */
4425 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4427 if (valid_p
&& !display_replaced_before_p
)
4429 /* Save current settings of IT so that we can restore them
4430 when we are finished with the glyph property value. */
4431 save_pos
= it
->position
;
4432 it
->position
= *position
;
4434 it
->position
= save_pos
;
4435 it
->from_overlay
= overlay
;
4437 if (NILP (location
))
4438 it
->area
= TEXT_AREA
;
4439 else if (EQ (location
, Qleft_margin
))
4440 it
->area
= LEFT_MARGIN_AREA
;
4442 it
->area
= RIGHT_MARGIN_AREA
;
4444 if (STRINGP (value
))
4447 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4448 it
->current
.overlay_string_index
= -1;
4449 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4450 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4451 it
->method
= GET_FROM_STRING
;
4452 it
->stop_charpos
= 0;
4453 it
->string_from_display_prop_p
= 1;
4454 /* Say that we haven't consumed the characters with
4455 `display' property yet. The call to pop_it in
4456 set_iterator_to_next will clean this up. */
4457 if (BUFFERP (object
))
4458 *position
= start_pos
;
4460 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4462 it
->method
= GET_FROM_STRETCH
;
4464 *position
= it
->position
= start_pos
;
4466 #ifdef HAVE_WINDOW_SYSTEM
4469 it
->what
= IT_IMAGE
;
4470 it
->image_id
= lookup_image (it
->f
, value
);
4471 it
->position
= start_pos
;
4472 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4473 it
->method
= GET_FROM_IMAGE
;
4475 /* Say that we haven't consumed the characters with
4476 `display' property yet. The call to pop_it in
4477 set_iterator_to_next will clean this up. */
4478 *position
= start_pos
;
4480 #endif /* HAVE_WINDOW_SYSTEM */
4485 /* Invalid property or property not supported. Restore
4486 POSITION to what it was before. */
4487 *position
= start_pos
;
4492 /* Check if SPEC is a display sub-property value whose text should be
4493 treated as intangible. */
4496 single_display_spec_intangible_p (prop
)
4499 /* Skip over `when FORM'. */
4500 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4514 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4515 we don't need to treat text as intangible. */
4516 if (EQ (XCAR (prop
), Qmargin
))
4524 || EQ (XCAR (prop
), Qleft_margin
)
4525 || EQ (XCAR (prop
), Qright_margin
))
4529 return (CONSP (prop
)
4530 && (EQ (XCAR (prop
), Qimage
)
4531 || EQ (XCAR (prop
), Qspace
)));
4535 /* Check if PROP is a display property value whose text should be
4536 treated as intangible. */
4539 display_prop_intangible_p (prop
)
4543 && CONSP (XCAR (prop
))
4544 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4546 /* A list of sub-properties. */
4547 while (CONSP (prop
))
4549 if (single_display_spec_intangible_p (XCAR (prop
)))
4554 else if (VECTORP (prop
))
4556 /* A vector of sub-properties. */
4558 for (i
= 0; i
< ASIZE (prop
); ++i
)
4559 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4563 return single_display_spec_intangible_p (prop
);
4569 /* Return 1 if PROP is a display sub-property value containing STRING. */
4572 single_display_spec_string_p (prop
, string
)
4573 Lisp_Object prop
, string
;
4575 if (EQ (string
, prop
))
4578 /* Skip over `when FORM'. */
4579 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4588 /* Skip over `margin LOCATION'. */
4589 if (EQ (XCAR (prop
), Qmargin
))
4600 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4604 /* Return 1 if STRING appears in the `display' property PROP. */
4607 display_prop_string_p (prop
, string
)
4608 Lisp_Object prop
, string
;
4611 && CONSP (XCAR (prop
))
4612 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4614 /* A list of sub-properties. */
4615 while (CONSP (prop
))
4617 if (single_display_spec_string_p (XCAR (prop
), string
))
4622 else if (VECTORP (prop
))
4624 /* A vector of sub-properties. */
4626 for (i
= 0; i
< ASIZE (prop
); ++i
)
4627 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4631 return single_display_spec_string_p (prop
, string
);
4636 /* Look for STRING in overlays and text properties in W's buffer,
4637 between character positions FROM and TO (excluding TO).
4638 BACK_P non-zero means look back (in this case, TO is supposed to be
4640 Value is the first character position where STRING was found, or
4641 zero if it wasn't found before hitting TO.
4643 W's buffer must be current.
4645 This function may only use code that doesn't eval because it is
4646 called asynchronously from note_mouse_highlight. */
4649 string_buffer_position_lim (w
, string
, from
, to
, back_p
)
4655 Lisp_Object limit
, prop
, pos
;
4658 pos
= make_number (from
);
4660 if (!back_p
) /* looking forward */
4662 limit
= make_number (min (to
, ZV
));
4663 while (!found
&& !EQ (pos
, limit
))
4665 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4666 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4669 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4673 else /* looking back */
4675 limit
= make_number (max (to
, BEGV
));
4676 while (!found
&& !EQ (pos
, limit
))
4678 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4679 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4682 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4687 return found
? XINT (pos
) : 0;
4690 /* Determine which buffer position in W's buffer STRING comes from.
4691 AROUND_CHARPOS is an approximate position where it could come from.
4692 Value is the buffer position or 0 if it couldn't be determined.
4694 W's buffer must be current.
4696 This function is necessary because we don't record buffer positions
4697 in glyphs generated from strings (to keep struct glyph small).
4698 This function may only use code that doesn't eval because it is
4699 called asynchronously from note_mouse_highlight. */
4702 string_buffer_position (w
, string
, around_charpos
)
4705 EMACS_INT around_charpos
;
4707 Lisp_Object limit
, prop
, pos
;
4708 const int MAX_DISTANCE
= 1000;
4709 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4710 around_charpos
+ MAX_DISTANCE
,
4714 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4715 around_charpos
- MAX_DISTANCE
, 1);
4721 /***********************************************************************
4722 `composition' property
4723 ***********************************************************************/
4725 /* Set up iterator IT from `composition' property at its current
4726 position. Called from handle_stop. */
4728 static enum prop_handled
4729 handle_composition_prop (it
)
4732 Lisp_Object prop
, string
;
4733 EMACS_INT pos
, pos_byte
, start
, end
;
4735 if (STRINGP (it
->string
))
4739 pos
= IT_STRING_CHARPOS (*it
);
4740 pos_byte
= IT_STRING_BYTEPOS (*it
);
4741 string
= it
->string
;
4742 s
= SDATA (string
) + pos_byte
;
4743 it
->c
= STRING_CHAR (s
);
4747 pos
= IT_CHARPOS (*it
);
4748 pos_byte
= IT_BYTEPOS (*it
);
4750 it
->c
= FETCH_CHAR (pos_byte
);
4753 /* If there's a valid composition and point is not inside of the
4754 composition (in the case that the composition is from the current
4755 buffer), draw a glyph composed from the composition components. */
4756 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4757 && COMPOSITION_VALID_P (start
, end
, prop
)
4758 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4762 if (STRINGP (it
->string
))
4763 pos_byte
= string_char_to_byte (it
->string
, start
);
4765 pos_byte
= CHAR_TO_BYTE (start
);
4767 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4770 if (it
->cmp_it
.id
>= 0)
4773 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4774 it
->cmp_it
.nglyphs
= -1;
4778 return HANDLED_NORMALLY
;
4783 /***********************************************************************
4785 ***********************************************************************/
4787 /* The following structure is used to record overlay strings for
4788 later sorting in load_overlay_strings. */
4790 struct overlay_entry
4792 Lisp_Object overlay
;
4799 /* Set up iterator IT from overlay strings at its current position.
4800 Called from handle_stop. */
4802 static enum prop_handled
4803 handle_overlay_change (it
)
4806 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4807 return HANDLED_RECOMPUTE_PROPS
;
4809 return HANDLED_NORMALLY
;
4813 /* Set up the next overlay string for delivery by IT, if there is an
4814 overlay string to deliver. Called by set_iterator_to_next when the
4815 end of the current overlay string is reached. If there are more
4816 overlay strings to display, IT->string and
4817 IT->current.overlay_string_index are set appropriately here.
4818 Otherwise IT->string is set to nil. */
4821 next_overlay_string (it
)
4824 ++it
->current
.overlay_string_index
;
4825 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4827 /* No more overlay strings. Restore IT's settings to what
4828 they were before overlay strings were processed, and
4829 continue to deliver from current_buffer. */
4831 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4834 || (NILP (it
->string
)
4835 && it
->method
== GET_FROM_BUFFER
4836 && it
->stop_charpos
>= BEGV
4837 && it
->stop_charpos
<= it
->end_charpos
));
4838 it
->current
.overlay_string_index
= -1;
4839 it
->n_overlay_strings
= 0;
4841 /* If we're at the end of the buffer, record that we have
4842 processed the overlay strings there already, so that
4843 next_element_from_buffer doesn't try it again. */
4844 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4845 it
->overlay_strings_at_end_processed_p
= 1;
4849 /* There are more overlay strings to process. If
4850 IT->current.overlay_string_index has advanced to a position
4851 where we must load IT->overlay_strings with more strings, do
4853 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4855 if (it
->current
.overlay_string_index
&& i
== 0)
4856 load_overlay_strings (it
, 0);
4858 /* Initialize IT to deliver display elements from the overlay
4860 it
->string
= it
->overlay_strings
[i
];
4861 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4862 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4863 it
->method
= GET_FROM_STRING
;
4864 it
->stop_charpos
= 0;
4865 if (it
->cmp_it
.stop_pos
>= 0)
4866 it
->cmp_it
.stop_pos
= 0;
4873 /* Compare two overlay_entry structures E1 and E2. Used as a
4874 comparison function for qsort in load_overlay_strings. Overlay
4875 strings for the same position are sorted so that
4877 1. All after-strings come in front of before-strings, except
4878 when they come from the same overlay.
4880 2. Within after-strings, strings are sorted so that overlay strings
4881 from overlays with higher priorities come first.
4883 2. Within before-strings, strings are sorted so that overlay
4884 strings from overlays with higher priorities come last.
4886 Value is analogous to strcmp. */
4890 compare_overlay_entries (e1
, e2
)
4893 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4894 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4897 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4899 /* Let after-strings appear in front of before-strings if
4900 they come from different overlays. */
4901 if (EQ (entry1
->overlay
, entry2
->overlay
))
4902 result
= entry1
->after_string_p
? 1 : -1;
4904 result
= entry1
->after_string_p
? -1 : 1;
4906 else if (entry1
->after_string_p
)
4907 /* After-strings sorted in order of decreasing priority. */
4908 result
= entry2
->priority
- entry1
->priority
;
4910 /* Before-strings sorted in order of increasing priority. */
4911 result
= entry1
->priority
- entry2
->priority
;
4917 /* Load the vector IT->overlay_strings with overlay strings from IT's
4918 current buffer position, or from CHARPOS if that is > 0. Set
4919 IT->n_overlays to the total number of overlay strings found.
4921 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4922 a time. On entry into load_overlay_strings,
4923 IT->current.overlay_string_index gives the number of overlay
4924 strings that have already been loaded by previous calls to this
4927 IT->add_overlay_start contains an additional overlay start
4928 position to consider for taking overlay strings from, if non-zero.
4929 This position comes into play when the overlay has an `invisible'
4930 property, and both before and after-strings. When we've skipped to
4931 the end of the overlay, because of its `invisible' property, we
4932 nevertheless want its before-string to appear.
4933 IT->add_overlay_start will contain the overlay start position
4936 Overlay strings are sorted so that after-string strings come in
4937 front of before-string strings. Within before and after-strings,
4938 strings are sorted by overlay priority. See also function
4939 compare_overlay_entries. */
4942 load_overlay_strings (it
, charpos
)
4946 extern Lisp_Object Qwindow
, Qpriority
;
4947 Lisp_Object overlay
, window
, str
, invisible
;
4948 struct Lisp_Overlay
*ov
;
4951 int n
= 0, i
, j
, invis_p
;
4952 struct overlay_entry
*entries
4953 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4956 charpos
= IT_CHARPOS (*it
);
4958 /* Append the overlay string STRING of overlay OVERLAY to vector
4959 `entries' which has size `size' and currently contains `n'
4960 elements. AFTER_P non-zero means STRING is an after-string of
4962 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4965 Lisp_Object priority; \
4969 int new_size = 2 * size; \
4970 struct overlay_entry *old = entries; \
4972 (struct overlay_entry *) alloca (new_size \
4973 * sizeof *entries); \
4974 bcopy (old, entries, size * sizeof *entries); \
4978 entries[n].string = (STRING); \
4979 entries[n].overlay = (OVERLAY); \
4980 priority = Foverlay_get ((OVERLAY), Qpriority); \
4981 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4982 entries[n].after_string_p = (AFTER_P); \
4987 /* Process overlay before the overlay center. */
4988 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4990 XSETMISC (overlay
, ov
);
4991 xassert (OVERLAYP (overlay
));
4992 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4993 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4998 /* Skip this overlay if it doesn't start or end at IT's current
5000 if (end
!= charpos
&& start
!= charpos
)
5003 /* Skip this overlay if it doesn't apply to IT->w. */
5004 window
= Foverlay_get (overlay
, Qwindow
);
5005 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5008 /* If the text ``under'' the overlay is invisible, both before-
5009 and after-strings from this overlay are visible; start and
5010 end position are indistinguishable. */
5011 invisible
= Foverlay_get (overlay
, Qinvisible
);
5012 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5014 /* If overlay has a non-empty before-string, record it. */
5015 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5016 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5018 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5020 /* If overlay has a non-empty after-string, record it. */
5021 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5022 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5024 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5027 /* Process overlays after the overlay center. */
5028 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5030 XSETMISC (overlay
, ov
);
5031 xassert (OVERLAYP (overlay
));
5032 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5033 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5035 if (start
> charpos
)
5038 /* Skip this overlay if it doesn't start or end at IT's current
5040 if (end
!= charpos
&& start
!= charpos
)
5043 /* Skip this overlay if it doesn't apply to IT->w. */
5044 window
= Foverlay_get (overlay
, Qwindow
);
5045 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5048 /* If the text ``under'' the overlay is invisible, it has a zero
5049 dimension, and both before- and after-strings apply. */
5050 invisible
= Foverlay_get (overlay
, Qinvisible
);
5051 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5053 /* If overlay has a non-empty before-string, record it. */
5054 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5055 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5057 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5059 /* If overlay has a non-empty after-string, record it. */
5060 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5061 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5063 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5066 #undef RECORD_OVERLAY_STRING
5070 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5072 /* Record the total number of strings to process. */
5073 it
->n_overlay_strings
= n
;
5075 /* IT->current.overlay_string_index is the number of overlay strings
5076 that have already been consumed by IT. Copy some of the
5077 remaining overlay strings to IT->overlay_strings. */
5079 j
= it
->current
.overlay_string_index
;
5080 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5082 it
->overlay_strings
[i
] = entries
[j
].string
;
5083 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5090 /* Get the first chunk of overlay strings at IT's current buffer
5091 position, or at CHARPOS if that is > 0. Value is non-zero if at
5092 least one overlay string was found. */
5095 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5100 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5101 process. This fills IT->overlay_strings with strings, and sets
5102 IT->n_overlay_strings to the total number of strings to process.
5103 IT->pos.overlay_string_index has to be set temporarily to zero
5104 because load_overlay_strings needs this; it must be set to -1
5105 when no overlay strings are found because a zero value would
5106 indicate a position in the first overlay string. */
5107 it
->current
.overlay_string_index
= 0;
5108 load_overlay_strings (it
, charpos
);
5110 /* If we found overlay strings, set up IT to deliver display
5111 elements from the first one. Otherwise set up IT to deliver
5112 from current_buffer. */
5113 if (it
->n_overlay_strings
)
5115 /* Make sure we know settings in current_buffer, so that we can
5116 restore meaningful values when we're done with the overlay
5119 compute_stop_pos (it
);
5120 xassert (it
->face_id
>= 0);
5122 /* Save IT's settings. They are restored after all overlay
5123 strings have been processed. */
5124 xassert (!compute_stop_p
|| it
->sp
== 0);
5126 /* When called from handle_stop, there might be an empty display
5127 string loaded. In that case, don't bother saving it. */
5128 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5131 /* Set up IT to deliver display elements from the first overlay
5133 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5134 it
->string
= it
->overlay_strings
[0];
5135 it
->from_overlay
= Qnil
;
5136 it
->stop_charpos
= 0;
5137 xassert (STRINGP (it
->string
));
5138 it
->end_charpos
= SCHARS (it
->string
);
5139 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5140 it
->method
= GET_FROM_STRING
;
5144 it
->current
.overlay_string_index
= -1;
5149 get_overlay_strings (it
, charpos
)
5154 it
->method
= GET_FROM_BUFFER
;
5156 (void) get_overlay_strings_1 (it
, charpos
, 1);
5160 /* Value is non-zero if we found at least one overlay string. */
5161 return STRINGP (it
->string
);
5166 /***********************************************************************
5167 Saving and restoring state
5168 ***********************************************************************/
5170 /* Save current settings of IT on IT->stack. Called, for example,
5171 before setting up IT for an overlay string, to be able to restore
5172 IT's settings to what they were after the overlay string has been
5179 struct iterator_stack_entry
*p
;
5181 xassert (it
->sp
< IT_STACK_SIZE
);
5182 p
= it
->stack
+ it
->sp
;
5184 p
->stop_charpos
= it
->stop_charpos
;
5185 p
->prev_stop
= it
->prev_stop
;
5186 p
->base_level_stop
= it
->base_level_stop
;
5187 p
->cmp_it
= it
->cmp_it
;
5188 xassert (it
->face_id
>= 0);
5189 p
->face_id
= it
->face_id
;
5190 p
->string
= it
->string
;
5191 p
->method
= it
->method
;
5192 p
->from_overlay
= it
->from_overlay
;
5195 case GET_FROM_IMAGE
:
5196 p
->u
.image
.object
= it
->object
;
5197 p
->u
.image
.image_id
= it
->image_id
;
5198 p
->u
.image
.slice
= it
->slice
;
5200 case GET_FROM_STRETCH
:
5201 p
->u
.stretch
.object
= it
->object
;
5204 p
->position
= it
->position
;
5205 p
->current
= it
->current
;
5206 p
->end_charpos
= it
->end_charpos
;
5207 p
->string_nchars
= it
->string_nchars
;
5209 p
->multibyte_p
= it
->multibyte_p
;
5210 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5211 p
->space_width
= it
->space_width
;
5212 p
->font_height
= it
->font_height
;
5213 p
->voffset
= it
->voffset
;
5214 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5215 p
->display_ellipsis_p
= 0;
5216 p
->line_wrap
= it
->line_wrap
;
5221 /* Restore IT's settings from IT->stack. Called, for example, when no
5222 more overlay strings must be processed, and we return to delivering
5223 display elements from a buffer, or when the end of a string from a
5224 `display' property is reached and we return to delivering display
5225 elements from an overlay string, or from a buffer. */
5231 struct iterator_stack_entry
*p
;
5233 xassert (it
->sp
> 0);
5235 p
= it
->stack
+ it
->sp
;
5236 it
->stop_charpos
= p
->stop_charpos
;
5237 it
->prev_stop
= p
->prev_stop
;
5238 it
->base_level_stop
= p
->base_level_stop
;
5239 it
->cmp_it
= p
->cmp_it
;
5240 it
->face_id
= p
->face_id
;
5241 it
->current
= p
->current
;
5242 it
->position
= p
->position
;
5243 it
->string
= p
->string
;
5244 it
->from_overlay
= p
->from_overlay
;
5245 if (NILP (it
->string
))
5246 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5247 it
->method
= p
->method
;
5250 case GET_FROM_IMAGE
:
5251 it
->image_id
= p
->u
.image
.image_id
;
5252 it
->object
= p
->u
.image
.object
;
5253 it
->slice
= p
->u
.image
.slice
;
5255 case GET_FROM_STRETCH
:
5256 it
->object
= p
->u
.comp
.object
;
5258 case GET_FROM_BUFFER
:
5259 it
->object
= it
->w
->buffer
;
5261 case GET_FROM_STRING
:
5262 it
->object
= it
->string
;
5264 case GET_FROM_DISPLAY_VECTOR
:
5266 it
->method
= GET_FROM_C_STRING
;
5267 else if (STRINGP (it
->string
))
5268 it
->method
= GET_FROM_STRING
;
5271 it
->method
= GET_FROM_BUFFER
;
5272 it
->object
= it
->w
->buffer
;
5275 it
->end_charpos
= p
->end_charpos
;
5276 it
->string_nchars
= p
->string_nchars
;
5278 it
->multibyte_p
= p
->multibyte_p
;
5279 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5280 it
->space_width
= p
->space_width
;
5281 it
->font_height
= p
->font_height
;
5282 it
->voffset
= p
->voffset
;
5283 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5284 it
->line_wrap
= p
->line_wrap
;
5289 /***********************************************************************
5291 ***********************************************************************/
5293 /* Set IT's current position to the previous line start. */
5296 back_to_previous_line_start (it
)
5299 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5300 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5304 /* Move IT to the next line start.
5306 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5307 we skipped over part of the text (as opposed to moving the iterator
5308 continuously over the text). Otherwise, don't change the value
5311 Newlines may come from buffer text, overlay strings, or strings
5312 displayed via the `display' property. That's the reason we can't
5313 simply use find_next_newline_no_quit.
5315 Note that this function may not skip over invisible text that is so
5316 because of text properties and immediately follows a newline. If
5317 it would, function reseat_at_next_visible_line_start, when called
5318 from set_iterator_to_next, would effectively make invisible
5319 characters following a newline part of the wrong glyph row, which
5320 leads to wrong cursor motion. */
5323 forward_to_next_line_start (it
, skipped_p
)
5327 int old_selective
, newline_found_p
, n
;
5328 const int MAX_NEWLINE_DISTANCE
= 500;
5330 /* If already on a newline, just consume it to avoid unintended
5331 skipping over invisible text below. */
5332 if (it
->what
== IT_CHARACTER
5334 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5336 set_iterator_to_next (it
, 0);
5341 /* Don't handle selective display in the following. It's (a)
5342 unnecessary because it's done by the caller, and (b) leads to an
5343 infinite recursion because next_element_from_ellipsis indirectly
5344 calls this function. */
5345 old_selective
= it
->selective
;
5348 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5349 from buffer text. */
5350 for (n
= newline_found_p
= 0;
5351 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5352 n
+= STRINGP (it
->string
) ? 0 : 1)
5354 if (!get_next_display_element (it
))
5356 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5357 set_iterator_to_next (it
, 0);
5360 /* If we didn't find a newline near enough, see if we can use a
5362 if (!newline_found_p
)
5364 int start
= IT_CHARPOS (*it
);
5365 int limit
= find_next_newline_no_quit (start
, 1);
5368 xassert (!STRINGP (it
->string
));
5370 /* If there isn't any `display' property in sight, and no
5371 overlays, we can just use the position of the newline in
5373 if (it
->stop_charpos
>= limit
5374 || ((pos
= Fnext_single_property_change (make_number (start
),
5376 Qnil
, make_number (limit
)),
5378 && next_overlay_change (start
) == ZV
))
5380 IT_CHARPOS (*it
) = limit
;
5381 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5382 *skipped_p
= newline_found_p
= 1;
5386 while (get_next_display_element (it
)
5387 && !newline_found_p
)
5389 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5390 set_iterator_to_next (it
, 0);
5395 it
->selective
= old_selective
;
5396 return newline_found_p
;
5400 /* Set IT's current position to the previous visible line start. Skip
5401 invisible text that is so either due to text properties or due to
5402 selective display. Caution: this does not change IT->current_x and
5406 back_to_previous_visible_line_start (it
)
5409 while (IT_CHARPOS (*it
) > BEGV
)
5411 back_to_previous_line_start (it
);
5413 if (IT_CHARPOS (*it
) <= BEGV
)
5416 /* If selective > 0, then lines indented more than its value are
5418 if (it
->selective
> 0
5419 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5420 (double) it
->selective
)) /* iftc */
5423 /* Check the newline before point for invisibility. */
5426 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5427 Qinvisible
, it
->window
);
5428 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5432 if (IT_CHARPOS (*it
) <= BEGV
)
5439 Lisp_Object val
, overlay
;
5441 /* If newline is part of a composition, continue from start of composition */
5442 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5443 && beg
< IT_CHARPOS (*it
))
5446 /* If newline is replaced by a display property, find start of overlay
5447 or interval and continue search from that point. */
5449 pos
= --IT_CHARPOS (it2
);
5452 it2
.string_from_display_prop_p
= 0;
5453 if (handle_display_prop (&it2
) == HANDLED_RETURN
5454 && !NILP (val
= get_char_property_and_overlay
5455 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5456 && (OVERLAYP (overlay
)
5457 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5458 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5461 /* Newline is not replaced by anything -- so we are done. */
5467 IT_CHARPOS (*it
) = beg
;
5468 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5472 it
->continuation_lines_width
= 0;
5474 xassert (IT_CHARPOS (*it
) >= BEGV
);
5475 xassert (IT_CHARPOS (*it
) == BEGV
5476 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5481 /* Reseat iterator IT at the previous visible line start. Skip
5482 invisible text that is so either due to text properties or due to
5483 selective display. At the end, update IT's overlay information,
5484 face information etc. */
5487 reseat_at_previous_visible_line_start (it
)
5490 back_to_previous_visible_line_start (it
);
5491 reseat (it
, it
->current
.pos
, 1);
5496 /* Reseat iterator IT on the next visible line start in the current
5497 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5498 preceding the line start. Skip over invisible text that is so
5499 because of selective display. Compute faces, overlays etc at the
5500 new position. Note that this function does not skip over text that
5501 is invisible because of text properties. */
5504 reseat_at_next_visible_line_start (it
, on_newline_p
)
5508 int newline_found_p
, skipped_p
= 0;
5510 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5512 /* Skip over lines that are invisible because they are indented
5513 more than the value of IT->selective. */
5514 if (it
->selective
> 0)
5515 while (IT_CHARPOS (*it
) < ZV
5516 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5517 (double) it
->selective
)) /* iftc */
5519 xassert (IT_BYTEPOS (*it
) == BEGV
5520 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5521 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5524 /* Position on the newline if that's what's requested. */
5525 if (on_newline_p
&& newline_found_p
)
5527 if (STRINGP (it
->string
))
5529 if (IT_STRING_CHARPOS (*it
) > 0)
5531 --IT_STRING_CHARPOS (*it
);
5532 --IT_STRING_BYTEPOS (*it
);
5535 else if (IT_CHARPOS (*it
) > BEGV
)
5539 reseat (it
, it
->current
.pos
, 0);
5543 reseat (it
, it
->current
.pos
, 0);
5550 /***********************************************************************
5551 Changing an iterator's position
5552 ***********************************************************************/
5554 /* Change IT's current position to POS in current_buffer. If FORCE_P
5555 is non-zero, always check for text properties at the new position.
5556 Otherwise, text properties are only looked up if POS >=
5557 IT->check_charpos of a property. */
5560 reseat (it
, pos
, force_p
)
5562 struct text_pos pos
;
5565 int original_pos
= IT_CHARPOS (*it
);
5567 reseat_1 (it
, pos
, 0);
5569 /* Determine where to check text properties. Avoid doing it
5570 where possible because text property lookup is very expensive. */
5572 || CHARPOS (pos
) > it
->stop_charpos
5573 || CHARPOS (pos
) < original_pos
)
5577 /* For bidi iteration, we need to prime prev_stop and
5578 base_level_stop with our best estimations. */
5579 if (CHARPOS (pos
) < it
->prev_stop
)
5581 handle_stop_backwards (it
, BEGV
);
5582 if (CHARPOS (pos
) < it
->base_level_stop
)
5583 it
->base_level_stop
= 0;
5585 else if (CHARPOS (pos
) > it
->stop_charpos
5586 && it
->stop_charpos
>= BEGV
)
5587 handle_stop_backwards (it
, it
->stop_charpos
);
5594 it
->prev_stop
= it
->base_level_stop
= 0;
5603 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5604 IT->stop_pos to POS, also. */
5607 reseat_1 (it
, pos
, set_stop_p
)
5609 struct text_pos pos
;
5612 /* Don't call this function when scanning a C string. */
5613 xassert (it
->s
== NULL
);
5615 /* POS must be a reasonable value. */
5616 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5618 it
->current
.pos
= it
->position
= pos
;
5619 it
->end_charpos
= ZV
;
5621 it
->current
.dpvec_index
= -1;
5622 it
->current
.overlay_string_index
= -1;
5623 IT_STRING_CHARPOS (*it
) = -1;
5624 IT_STRING_BYTEPOS (*it
) = -1;
5626 it
->string_from_display_prop_p
= 0;
5627 it
->method
= GET_FROM_BUFFER
;
5628 it
->object
= it
->w
->buffer
;
5629 it
->area
= TEXT_AREA
;
5630 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5632 it
->string_from_display_prop_p
= 0;
5633 it
->face_before_selective_p
= 0;
5635 it
->bidi_it
.first_elt
= 1;
5639 it
->stop_charpos
= CHARPOS (pos
);
5640 it
->base_level_stop
= CHARPOS (pos
);
5645 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5646 If S is non-null, it is a C string to iterate over. Otherwise,
5647 STRING gives a Lisp string to iterate over.
5649 If PRECISION > 0, don't return more then PRECISION number of
5650 characters from the string.
5652 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5653 characters have been returned. FIELD_WIDTH < 0 means an infinite
5656 MULTIBYTE = 0 means disable processing of multibyte characters,
5657 MULTIBYTE > 0 means enable it,
5658 MULTIBYTE < 0 means use IT->multibyte_p.
5660 IT must be initialized via a prior call to init_iterator before
5661 calling this function. */
5664 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5669 int precision
, field_width
, multibyte
;
5671 /* No region in strings. */
5672 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5674 /* No text property checks performed by default, but see below. */
5675 it
->stop_charpos
= -1;
5677 /* Set iterator position and end position. */
5678 bzero (&it
->current
, sizeof it
->current
);
5679 it
->current
.overlay_string_index
= -1;
5680 it
->current
.dpvec_index
= -1;
5681 xassert (charpos
>= 0);
5683 /* If STRING is specified, use its multibyteness, otherwise use the
5684 setting of MULTIBYTE, if specified. */
5686 it
->multibyte_p
= multibyte
> 0;
5690 xassert (STRINGP (string
));
5691 it
->string
= string
;
5693 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5694 it
->method
= GET_FROM_STRING
;
5695 it
->current
.string_pos
= string_pos (charpos
, string
);
5702 /* Note that we use IT->current.pos, not it->current.string_pos,
5703 for displaying C strings. */
5704 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5705 if (it
->multibyte_p
)
5707 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5708 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5712 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5713 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5716 it
->method
= GET_FROM_C_STRING
;
5719 /* PRECISION > 0 means don't return more than PRECISION characters
5721 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5722 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5724 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5725 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5726 FIELD_WIDTH < 0 means infinite field width. This is useful for
5727 padding with `-' at the end of a mode line. */
5728 if (field_width
< 0)
5729 field_width
= INFINITY
;
5730 if (field_width
> it
->end_charpos
- charpos
)
5731 it
->end_charpos
= charpos
+ field_width
;
5733 /* Use the standard display table for displaying strings. */
5734 if (DISP_TABLE_P (Vstandard_display_table
))
5735 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5737 it
->stop_charpos
= charpos
;
5738 if (s
== NULL
&& it
->multibyte_p
)
5740 EMACS_INT endpos
= SCHARS (it
->string
);
5741 if (endpos
> it
->end_charpos
)
5742 endpos
= it
->end_charpos
;
5743 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5751 /***********************************************************************
5753 ***********************************************************************/
5755 /* Map enum it_method value to corresponding next_element_from_* function. */
5757 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5759 next_element_from_buffer
,
5760 next_element_from_display_vector
,
5761 next_element_from_string
,
5762 next_element_from_c_string
,
5763 next_element_from_image
,
5764 next_element_from_stretch
5767 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5770 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5771 (possibly with the following characters). */
5773 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5774 ((IT)->cmp_it.id >= 0 \
5775 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5776 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5777 END_CHARPOS, (IT)->w, \
5778 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5782 /* Load IT's display element fields with information about the next
5783 display element from the current position of IT. Value is zero if
5784 end of buffer (or C string) is reached. */
5786 static struct frame
*last_escape_glyph_frame
= NULL
;
5787 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5788 static int last_escape_glyph_merged_face_id
= 0;
5791 get_next_display_element (it
)
5794 /* Non-zero means that we found a display element. Zero means that
5795 we hit the end of what we iterate over. Performance note: the
5796 function pointer `method' used here turns out to be faster than
5797 using a sequence of if-statements. */
5801 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5803 if (it
->what
== IT_CHARACTER
)
5805 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5806 and only if (a) the resolved directionality of that character
5808 /* FIXME: Do we need an exception for characters from display
5810 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5811 it
->c
= bidi_mirror_char (it
->c
);
5812 /* Map via display table or translate control characters.
5813 IT->c, IT->len etc. have been set to the next character by
5814 the function call above. If we have a display table, and it
5815 contains an entry for IT->c, translate it. Don't do this if
5816 IT->c itself comes from a display table, otherwise we could
5817 end up in an infinite recursion. (An alternative could be to
5818 count the recursion depth of this function and signal an
5819 error when a certain maximum depth is reached.) Is it worth
5821 if (success_p
&& it
->dpvec
== NULL
)
5824 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5825 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5826 nbsp_or_shy
= char_is_other
;
5827 int decoded
= it
->c
;
5830 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5833 struct Lisp_Vector
*v
= XVECTOR (dv
);
5835 /* Return the first character from the display table
5836 entry, if not empty. If empty, don't display the
5837 current character. */
5840 it
->dpvec_char_len
= it
->len
;
5841 it
->dpvec
= v
->contents
;
5842 it
->dpend
= v
->contents
+ v
->size
;
5843 it
->current
.dpvec_index
= 0;
5844 it
->dpvec_face_id
= -1;
5845 it
->saved_face_id
= it
->face_id
;
5846 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5851 set_iterator_to_next (it
, 0);
5856 if (unibyte_display_via_language_environment
5857 && !ASCII_CHAR_P (it
->c
))
5858 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5860 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5862 if (it
->multibyte_p
)
5863 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5864 : it
->c
== 0xAD ? char_is_soft_hyphen
5866 else if (unibyte_display_via_language_environment
)
5867 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5868 : decoded
== 0xAD ? char_is_soft_hyphen
5872 /* Translate control characters into `\003' or `^C' form.
5873 Control characters coming from a display table entry are
5874 currently not translated because we use IT->dpvec to hold
5875 the translation. This could easily be changed but I
5876 don't believe that it is worth doing.
5878 If it->multibyte_p is nonzero, non-printable non-ASCII
5879 characters are also translated to octal form.
5881 If it->multibyte_p is zero, eight-bit characters that
5882 don't have corresponding multibyte char code are also
5883 translated to octal form. */
5885 ? (it
->area
!= TEXT_AREA
5886 /* In mode line, treat \n, \t like other crl chars. */
5889 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5890 || (it
->c
!= '\n' && it
->c
!= '\t'))
5893 ? ! CHAR_PRINTABLE_P (it
->c
)
5894 : (! unibyte_display_via_language_environment
5896 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5898 /* IT->c is a control character which must be displayed
5899 either as '\003' or as `^C' where the '\\' and '^'
5900 can be defined in the display table. Fill
5901 IT->ctl_chars with glyphs for what we have to
5902 display. Then, set IT->dpvec to these glyphs. */
5905 int face_id
, lface_id
= 0 ;
5908 /* Handle control characters with ^. */
5910 if (it
->c
< 128 && it
->ctl_arrow_p
)
5914 g
= '^'; /* default glyph for Control */
5915 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5917 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5918 && GLYPH_CODE_CHAR_VALID_P (gc
))
5920 g
= GLYPH_CODE_CHAR (gc
);
5921 lface_id
= GLYPH_CODE_FACE (gc
);
5925 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5927 else if (it
->f
== last_escape_glyph_frame
5928 && it
->face_id
== last_escape_glyph_face_id
)
5930 face_id
= last_escape_glyph_merged_face_id
;
5934 /* Merge the escape-glyph face into the current face. */
5935 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5937 last_escape_glyph_frame
= it
->f
;
5938 last_escape_glyph_face_id
= it
->face_id
;
5939 last_escape_glyph_merged_face_id
= face_id
;
5942 XSETINT (it
->ctl_chars
[0], g
);
5943 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5945 goto display_control
;
5948 /* Handle non-break space in the mode where it only gets
5951 if (EQ (Vnobreak_char_display
, Qt
)
5952 && nbsp_or_shy
== char_is_nbsp
)
5954 /* Merge the no-break-space face into the current face. */
5955 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5959 XSETINT (it
->ctl_chars
[0], ' ');
5961 goto display_control
;
5964 /* Handle sequences that start with the "escape glyph". */
5966 /* the default escape glyph is \. */
5967 escape_glyph
= '\\';
5970 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5971 && GLYPH_CODE_CHAR_VALID_P (gc
))
5973 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5974 lface_id
= GLYPH_CODE_FACE (gc
);
5978 /* The display table specified a face.
5979 Merge it into face_id and also into escape_glyph. */
5980 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5983 else if (it
->f
== last_escape_glyph_frame
5984 && it
->face_id
== last_escape_glyph_face_id
)
5986 face_id
= last_escape_glyph_merged_face_id
;
5990 /* Merge the escape-glyph face into the current face. */
5991 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5993 last_escape_glyph_frame
= it
->f
;
5994 last_escape_glyph_face_id
= it
->face_id
;
5995 last_escape_glyph_merged_face_id
= face_id
;
5998 /* Handle soft hyphens in the mode where they only get
6001 if (EQ (Vnobreak_char_display
, Qt
)
6002 && nbsp_or_shy
== char_is_soft_hyphen
)
6005 XSETINT (it
->ctl_chars
[0], '-');
6007 goto display_control
;
6010 /* Handle non-break space and soft hyphen
6011 with the escape glyph. */
6015 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6016 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6017 XSETINT (it
->ctl_chars
[1], it
->c
);
6019 goto display_control
;
6023 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6027 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
6028 if (CHAR_BYTE8_P (it
->c
))
6030 str
[0] = CHAR_TO_BYTE8 (it
->c
);
6033 else if (it
->c
< 256)
6040 /* It's an invalid character, which shouldn't
6041 happen actually, but due to bugs it may
6042 happen. Let's print the char as is, there's
6043 not much meaningful we can do with it. */
6045 str
[1] = it
->c
>> 8;
6046 str
[2] = it
->c
>> 16;
6047 str
[3] = it
->c
>> 24;
6051 for (i
= 0; i
< len
; i
++)
6054 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6055 /* Insert three more glyphs into IT->ctl_chars for
6056 the octal display of the character. */
6057 g
= ((str
[i
] >> 6) & 7) + '0';
6058 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6059 g
= ((str
[i
] >> 3) & 7) + '0';
6060 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6061 g
= (str
[i
] & 7) + '0';
6062 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6068 /* Set up IT->dpvec and return first character from it. */
6069 it
->dpvec_char_len
= it
->len
;
6070 it
->dpvec
= it
->ctl_chars
;
6071 it
->dpend
= it
->dpvec
+ ctl_len
;
6072 it
->current
.dpvec_index
= 0;
6073 it
->dpvec_face_id
= face_id
;
6074 it
->saved_face_id
= it
->face_id
;
6075 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6082 #ifdef HAVE_WINDOW_SYSTEM
6083 /* Adjust face id for a multibyte character. There are no multibyte
6084 character in unibyte text. */
6085 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6088 && FRAME_WINDOW_P (it
->f
))
6090 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6092 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6094 /* Automatic composition with glyph-string. */
6095 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6097 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6101 int pos
= (it
->s
? -1
6102 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6103 : IT_CHARPOS (*it
));
6105 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6110 /* Is this character the last one of a run of characters with
6111 box? If yes, set IT->end_of_box_run_p to 1. */
6115 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6117 int face_id
= underlying_face_id (it
);
6118 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6122 if (face
->box
== FACE_NO_BOX
)
6124 /* If the box comes from face properties in a
6125 display string, check faces in that string. */
6126 int string_face_id
= face_after_it_pos (it
);
6127 it
->end_of_box_run_p
6128 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6131 /* Otherwise, the box comes from the underlying face.
6132 If this is the last string character displayed, check
6133 the next buffer location. */
6134 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6135 && (it
->current
.overlay_string_index
6136 == it
->n_overlay_strings
- 1))
6140 struct text_pos pos
= it
->current
.pos
;
6141 INC_TEXT_POS (pos
, it
->multibyte_p
);
6143 next_face_id
= face_at_buffer_position
6144 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6145 it
->region_end_charpos
, &ignore
,
6146 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6148 it
->end_of_box_run_p
6149 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6156 int face_id
= face_after_it_pos (it
);
6157 it
->end_of_box_run_p
6158 = (face_id
!= it
->face_id
6159 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6163 /* Value is 0 if end of buffer or string reached. */
6168 /* Move IT to the next display element.
6170 RESEAT_P non-zero means if called on a newline in buffer text,
6171 skip to the next visible line start.
6173 Functions get_next_display_element and set_iterator_to_next are
6174 separate because I find this arrangement easier to handle than a
6175 get_next_display_element function that also increments IT's
6176 position. The way it is we can first look at an iterator's current
6177 display element, decide whether it fits on a line, and if it does,
6178 increment the iterator position. The other way around we probably
6179 would either need a flag indicating whether the iterator has to be
6180 incremented the next time, or we would have to implement a
6181 decrement position function which would not be easy to write. */
6184 set_iterator_to_next (it
, reseat_p
)
6188 /* Reset flags indicating start and end of a sequence of characters
6189 with box. Reset them at the start of this function because
6190 moving the iterator to a new position might set them. */
6191 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6195 case GET_FROM_BUFFER
:
6196 /* The current display element of IT is a character from
6197 current_buffer. Advance in the buffer, and maybe skip over
6198 invisible lines that are so because of selective display. */
6199 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6200 reseat_at_next_visible_line_start (it
, 0);
6201 else if (it
->cmp_it
.id
>= 0)
6203 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6204 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6205 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6206 it
->cmp_it
.from
= it
->cmp_it
.to
;
6210 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6211 IT_BYTEPOS (*it
), it
->stop_charpos
,
6217 xassert (it
->len
!= 0);
6221 IT_BYTEPOS (*it
) += it
->len
;
6222 IT_CHARPOS (*it
) += 1;
6226 /* If this is a new paragraph, determine its base
6227 direction (a.k.a. its base embedding level). */
6228 if (it
->bidi_it
.new_paragraph
)
6229 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6230 bidi_get_next_char_visually (&it
->bidi_it
);
6231 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6232 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6234 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6238 case GET_FROM_C_STRING
:
6239 /* Current display element of IT is from a C string. */
6240 IT_BYTEPOS (*it
) += it
->len
;
6241 IT_CHARPOS (*it
) += 1;
6244 case GET_FROM_DISPLAY_VECTOR
:
6245 /* Current display element of IT is from a display table entry.
6246 Advance in the display table definition. Reset it to null if
6247 end reached, and continue with characters from buffers/
6249 ++it
->current
.dpvec_index
;
6251 /* Restore face of the iterator to what they were before the
6252 display vector entry (these entries may contain faces). */
6253 it
->face_id
= it
->saved_face_id
;
6255 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6257 int recheck_faces
= it
->ellipsis_p
;
6260 it
->method
= GET_FROM_C_STRING
;
6261 else if (STRINGP (it
->string
))
6262 it
->method
= GET_FROM_STRING
;
6265 it
->method
= GET_FROM_BUFFER
;
6266 it
->object
= it
->w
->buffer
;
6270 it
->current
.dpvec_index
= -1;
6272 /* Skip over characters which were displayed via IT->dpvec. */
6273 if (it
->dpvec_char_len
< 0)
6274 reseat_at_next_visible_line_start (it
, 1);
6275 else if (it
->dpvec_char_len
> 0)
6277 if (it
->method
== GET_FROM_STRING
6278 && it
->n_overlay_strings
> 0)
6279 it
->ignore_overlay_strings_at_pos_p
= 1;
6280 it
->len
= it
->dpvec_char_len
;
6281 set_iterator_to_next (it
, reseat_p
);
6284 /* Maybe recheck faces after display vector */
6286 it
->stop_charpos
= IT_CHARPOS (*it
);
6290 case GET_FROM_STRING
:
6291 /* Current display element is a character from a Lisp string. */
6292 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6293 if (it
->cmp_it
.id
>= 0)
6295 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6296 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6297 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6298 it
->cmp_it
.from
= it
->cmp_it
.to
;
6302 composition_compute_stop_pos (&it
->cmp_it
,
6303 IT_STRING_CHARPOS (*it
),
6304 IT_STRING_BYTEPOS (*it
),
6305 it
->stop_charpos
, it
->string
);
6310 IT_STRING_BYTEPOS (*it
) += it
->len
;
6311 IT_STRING_CHARPOS (*it
) += 1;
6314 consider_string_end
:
6316 if (it
->current
.overlay_string_index
>= 0)
6318 /* IT->string is an overlay string. Advance to the
6319 next, if there is one. */
6320 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6323 next_overlay_string (it
);
6325 setup_for_ellipsis (it
, 0);
6330 /* IT->string is not an overlay string. If we reached
6331 its end, and there is something on IT->stack, proceed
6332 with what is on the stack. This can be either another
6333 string, this time an overlay string, or a buffer. */
6334 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6338 if (it
->method
== GET_FROM_STRING
)
6339 goto consider_string_end
;
6344 case GET_FROM_IMAGE
:
6345 case GET_FROM_STRETCH
:
6346 /* The position etc with which we have to proceed are on
6347 the stack. The position may be at the end of a string,
6348 if the `display' property takes up the whole string. */
6349 xassert (it
->sp
> 0);
6351 if (it
->method
== GET_FROM_STRING
)
6352 goto consider_string_end
;
6356 /* There are no other methods defined, so this should be a bug. */
6360 xassert (it
->method
!= GET_FROM_STRING
6361 || (STRINGP (it
->string
)
6362 && IT_STRING_CHARPOS (*it
) >= 0));
6365 /* Load IT's display element fields with information about the next
6366 display element which comes from a display table entry or from the
6367 result of translating a control character to one of the forms `^C'
6370 IT->dpvec holds the glyphs to return as characters.
6371 IT->saved_face_id holds the face id before the display vector--it
6372 is restored into IT->face_id in set_iterator_to_next. */
6375 next_element_from_display_vector (it
)
6381 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6383 it
->face_id
= it
->saved_face_id
;
6385 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6386 That seemed totally bogus - so I changed it... */
6387 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6389 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6391 it
->c
= GLYPH_CODE_CHAR (gc
);
6392 it
->len
= CHAR_BYTES (it
->c
);
6394 /* The entry may contain a face id to use. Such a face id is
6395 the id of a Lisp face, not a realized face. A face id of
6396 zero means no face is specified. */
6397 if (it
->dpvec_face_id
>= 0)
6398 it
->face_id
= it
->dpvec_face_id
;
6401 int lface_id
= GLYPH_CODE_FACE (gc
);
6403 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6408 /* Display table entry is invalid. Return a space. */
6409 it
->c
= ' ', it
->len
= 1;
6411 /* Don't change position and object of the iterator here. They are
6412 still the values of the character that had this display table
6413 entry or was translated, and that's what we want. */
6414 it
->what
= IT_CHARACTER
;
6419 /* Load IT with the next display element from Lisp string IT->string.
6420 IT->current.string_pos is the current position within the string.
6421 If IT->current.overlay_string_index >= 0, the Lisp string is an
6425 next_element_from_string (it
)
6428 struct text_pos position
;
6430 xassert (STRINGP (it
->string
));
6431 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6432 position
= it
->current
.string_pos
;
6434 /* Time to check for invisible text? */
6435 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6436 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6440 /* Since a handler may have changed IT->method, we must
6442 return GET_NEXT_DISPLAY_ELEMENT (it
);
6445 if (it
->current
.overlay_string_index
>= 0)
6447 /* Get the next character from an overlay string. In overlay
6448 strings, There is no field width or padding with spaces to
6450 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6455 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6456 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6457 && next_element_from_composition (it
))
6461 else if (STRING_MULTIBYTE (it
->string
))
6463 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6464 const unsigned char *s
= (SDATA (it
->string
)
6465 + IT_STRING_BYTEPOS (*it
));
6466 it
->c
= string_char_and_length (s
, &it
->len
);
6470 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6476 /* Get the next character from a Lisp string that is not an
6477 overlay string. Such strings come from the mode line, for
6478 example. We may have to pad with spaces, or truncate the
6479 string. See also next_element_from_c_string. */
6480 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6485 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6487 /* Pad with spaces. */
6488 it
->c
= ' ', it
->len
= 1;
6489 CHARPOS (position
) = BYTEPOS (position
) = -1;
6491 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6492 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6493 && next_element_from_composition (it
))
6497 else if (STRING_MULTIBYTE (it
->string
))
6499 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6500 const unsigned char *s
= (SDATA (it
->string
)
6501 + IT_STRING_BYTEPOS (*it
));
6502 it
->c
= string_char_and_length (s
, &it
->len
);
6506 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6511 /* Record what we have and where it came from. */
6512 it
->what
= IT_CHARACTER
;
6513 it
->object
= it
->string
;
6514 it
->position
= position
;
6519 /* Load IT with next display element from C string IT->s.
6520 IT->string_nchars is the maximum number of characters to return
6521 from the string. IT->end_charpos may be greater than
6522 IT->string_nchars when this function is called, in which case we
6523 may have to return padding spaces. Value is zero if end of string
6524 reached, including padding spaces. */
6527 next_element_from_c_string (it
)
6533 it
->what
= IT_CHARACTER
;
6534 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6537 /* IT's position can be greater IT->string_nchars in case a field
6538 width or precision has been specified when the iterator was
6540 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6542 /* End of the game. */
6546 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6548 /* Pad with spaces. */
6549 it
->c
= ' ', it
->len
= 1;
6550 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6552 else if (it
->multibyte_p
)
6554 /* Implementation note: The calls to strlen apparently aren't a
6555 performance problem because there is no noticeable performance
6556 difference between Emacs running in unibyte or multibyte mode. */
6557 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6558 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6561 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6567 /* Set up IT to return characters from an ellipsis, if appropriate.
6568 The definition of the ellipsis glyphs may come from a display table
6569 entry. This function fills IT with the first glyph from the
6570 ellipsis if an ellipsis is to be displayed. */
6573 next_element_from_ellipsis (it
)
6576 if (it
->selective_display_ellipsis_p
)
6577 setup_for_ellipsis (it
, it
->len
);
6580 /* The face at the current position may be different from the
6581 face we find after the invisible text. Remember what it
6582 was in IT->saved_face_id, and signal that it's there by
6583 setting face_before_selective_p. */
6584 it
->saved_face_id
= it
->face_id
;
6585 it
->method
= GET_FROM_BUFFER
;
6586 it
->object
= it
->w
->buffer
;
6587 reseat_at_next_visible_line_start (it
, 1);
6588 it
->face_before_selective_p
= 1;
6591 return GET_NEXT_DISPLAY_ELEMENT (it
);
6595 /* Deliver an image display element. The iterator IT is already
6596 filled with image information (done in handle_display_prop). Value
6601 next_element_from_image (it
)
6604 it
->what
= IT_IMAGE
;
6609 /* Fill iterator IT with next display element from a stretch glyph
6610 property. IT->object is the value of the text property. Value is
6614 next_element_from_stretch (it
)
6617 it
->what
= IT_STRETCH
;
6621 /* Scan forward from CHARPOS in the current buffer, until we find a
6622 stop position > current IT's position. Then handle the stop
6623 position before that. This is called when we bump into a stop
6624 position while reordering bidirectional text. */
6627 handle_stop_backwards (it
, charpos
)
6631 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6632 struct display_pos save_current
= it
->current
;
6633 struct text_pos save_position
= it
->position
;
6634 struct text_pos pos1
;
6635 EMACS_INT next_stop
;
6637 /* Scan in strict logical order. */
6641 it
->prev_stop
= charpos
;
6642 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6643 reseat_1 (it
, pos1
, 0);
6644 compute_stop_pos (it
);
6645 /* We must advance forward, right? */
6646 if (it
->stop_charpos
<= it
->prev_stop
)
6648 charpos
= it
->stop_charpos
;
6650 while (charpos
<= where_we_are
);
6652 next_stop
= it
->stop_charpos
;
6653 it
->stop_charpos
= it
->prev_stop
;
6655 it
->current
= save_current
;
6656 it
->position
= save_position
;
6658 it
->stop_charpos
= next_stop
;
6661 /* Load IT with the next display element from current_buffer. Value
6662 is zero if end of buffer reached. IT->stop_charpos is the next
6663 position at which to stop and check for text properties or buffer
6667 next_element_from_buffer (it
)
6672 xassert (IT_CHARPOS (*it
) >= BEGV
);
6674 /* With bidi reordering, the character to display might not be the
6675 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6676 we were reseat()ed to a new buffer position, which is potentially
6677 a different paragraph. */
6678 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6680 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6681 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6682 /* If we are at the beginning of a line, we can produce the next
6683 element right away. */
6684 if (it
->bidi_it
.bytepos
== BEGV_BYTE
6685 /* FIXME: Should support all Unicode line separators. */
6686 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6687 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6689 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6690 bidi_get_next_char_visually (&it
->bidi_it
);
6694 int orig_bytepos
= IT_BYTEPOS (*it
);
6696 /* We need to prime the bidi iterator starting at the line's
6697 beginning, before we will be able to produce the next
6699 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6700 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6701 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6702 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6703 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6706 /* Now return to buffer position where we were asked to
6707 get the next display element, and produce that. */
6708 bidi_get_next_char_visually (&it
->bidi_it
);
6710 while (it
->bidi_it
.bytepos
!= orig_bytepos
6711 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6714 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6715 /* Adjust IT's position information to where we ended up. */
6716 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6717 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6718 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6721 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6723 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6725 int overlay_strings_follow_p
;
6727 /* End of the game, except when overlay strings follow that
6728 haven't been returned yet. */
6729 if (it
->overlay_strings_at_end_processed_p
)
6730 overlay_strings_follow_p
= 0;
6733 it
->overlay_strings_at_end_processed_p
= 1;
6734 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6737 if (overlay_strings_follow_p
)
6738 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6742 it
->position
= it
->current
.pos
;
6746 else if (!(!it
->bidi_p
6747 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6748 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6750 /* With bidi non-linear iteration, we could find ourselves
6751 far beyond the last computed stop_charpos, with several
6752 other stop positions in between that we missed. Scan
6753 them all now, in buffer's logical order, until we find
6754 and handle the last stop_charpos that precedes our
6755 current position. */
6756 handle_stop_backwards (it
, it
->stop_charpos
);
6757 return GET_NEXT_DISPLAY_ELEMENT (it
);
6763 /* Take note of the stop position we just moved across,
6764 for when we will move back across it. */
6765 it
->prev_stop
= it
->stop_charpos
;
6766 /* If we are at base paragraph embedding level, take
6767 note of the last stop position seen at this
6769 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6770 it
->base_level_stop
= it
->stop_charpos
;
6773 return GET_NEXT_DISPLAY_ELEMENT (it
);
6777 /* We can sometimes back up for reasons that have nothing
6778 to do with bidi reordering. E.g., compositions. The
6779 code below is only needed when we are above the base
6780 embedding level, so test for that explicitly. */
6781 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6782 && IT_CHARPOS (*it
) < it
->prev_stop
)
6784 if (it
->base_level_stop
<= 0)
6785 it
->base_level_stop
= BEGV
;
6786 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6788 handle_stop_backwards (it
, it
->base_level_stop
);
6789 return GET_NEXT_DISPLAY_ELEMENT (it
);
6793 /* No face changes, overlays etc. in sight, so just return a
6794 character from current_buffer. */
6797 /* Maybe run the redisplay end trigger hook. Performance note:
6798 This doesn't seem to cost measurable time. */
6799 if (it
->redisplay_end_trigger_charpos
6801 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6802 run_redisplay_end_trigger_hook (it
);
6804 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6806 && next_element_from_composition (it
))
6811 /* Get the next character, maybe multibyte. */
6812 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6813 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6814 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6816 it
->c
= *p
, it
->len
= 1;
6818 /* Record what we have and where it came from. */
6819 it
->what
= IT_CHARACTER
;
6820 it
->object
= it
->w
->buffer
;
6821 it
->position
= it
->current
.pos
;
6823 /* Normally we return the character found above, except when we
6824 really want to return an ellipsis for selective display. */
6829 /* A value of selective > 0 means hide lines indented more
6830 than that number of columns. */
6831 if (it
->selective
> 0
6832 && IT_CHARPOS (*it
) + 1 < ZV
6833 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6834 IT_BYTEPOS (*it
) + 1,
6835 (double) it
->selective
)) /* iftc */
6837 success_p
= next_element_from_ellipsis (it
);
6838 it
->dpvec_char_len
= -1;
6841 else if (it
->c
== '\r' && it
->selective
== -1)
6843 /* A value of selective == -1 means that everything from the
6844 CR to the end of the line is invisible, with maybe an
6845 ellipsis displayed for it. */
6846 success_p
= next_element_from_ellipsis (it
);
6847 it
->dpvec_char_len
= -1;
6852 /* Value is zero if end of buffer reached. */
6853 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6858 /* Run the redisplay end trigger hook for IT. */
6861 run_redisplay_end_trigger_hook (it
)
6864 Lisp_Object args
[3];
6866 /* IT->glyph_row should be non-null, i.e. we should be actually
6867 displaying something, or otherwise we should not run the hook. */
6868 xassert (it
->glyph_row
);
6870 /* Set up hook arguments. */
6871 args
[0] = Qredisplay_end_trigger_functions
;
6872 args
[1] = it
->window
;
6873 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6874 it
->redisplay_end_trigger_charpos
= 0;
6876 /* Since we are *trying* to run these functions, don't try to run
6877 them again, even if they get an error. */
6878 it
->w
->redisplay_end_trigger
= Qnil
;
6879 Frun_hook_with_args (3, args
);
6881 /* Notice if it changed the face of the character we are on. */
6882 handle_face_prop (it
);
6886 /* Deliver a composition display element. Unlike the other
6887 next_element_from_XXX, this function is not registered in the array
6888 get_next_element[]. It is called from next_element_from_buffer and
6889 next_element_from_string when necessary. */
6892 next_element_from_composition (it
)
6895 it
->what
= IT_COMPOSITION
;
6896 it
->len
= it
->cmp_it
.nbytes
;
6897 if (STRINGP (it
->string
))
6901 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6902 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6905 it
->position
= it
->current
.string_pos
;
6906 it
->object
= it
->string
;
6907 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6908 IT_STRING_BYTEPOS (*it
), it
->string
);
6914 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6915 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6918 it
->position
= it
->current
.pos
;
6919 it
->object
= it
->w
->buffer
;
6920 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6921 IT_BYTEPOS (*it
), Qnil
);
6928 /***********************************************************************
6929 Moving an iterator without producing glyphs
6930 ***********************************************************************/
6932 /* Check if iterator is at a position corresponding to a valid buffer
6933 position after some move_it_ call. */
6935 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6936 ((it)->method == GET_FROM_STRING \
6937 ? IT_STRING_CHARPOS (*it) == 0 \
6941 /* Move iterator IT to a specified buffer or X position within one
6942 line on the display without producing glyphs.
6944 OP should be a bit mask including some or all of these bits:
6945 MOVE_TO_X: Stop upon reaching x-position TO_X.
6946 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6947 Regardless of OP's value, stop upon reaching the end of the display line.
6949 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6950 This means, in particular, that TO_X includes window's horizontal
6953 The return value has several possible values that
6954 say what condition caused the scan to stop:
6956 MOVE_POS_MATCH_OR_ZV
6957 - when TO_POS or ZV was reached.
6960 -when TO_X was reached before TO_POS or ZV were reached.
6963 - when we reached the end of the display area and the line must
6967 - when we reached the end of the display area and the line is
6971 - when we stopped at a line end, i.e. a newline or a CR and selective
6974 static enum move_it_result
6975 move_it_in_display_line_to (struct it
*it
,
6976 EMACS_INT to_charpos
, int to_x
,
6977 enum move_operation_enum op
)
6979 enum move_it_result result
= MOVE_UNDEFINED
;
6980 struct glyph_row
*saved_glyph_row
;
6981 struct it wrap_it
, atpos_it
, atx_it
;
6983 enum it_method prev_method
= it
->method
;
6984 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6986 /* Don't produce glyphs in produce_glyphs. */
6987 saved_glyph_row
= it
->glyph_row
;
6988 it
->glyph_row
= NULL
;
6990 /* Use wrap_it to save a copy of IT wherever a word wrap could
6991 occur. Use atpos_it to save a copy of IT at the desired buffer
6992 position, if found, so that we can scan ahead and check if the
6993 word later overshoots the window edge. Use atx_it similarly, for
6999 #define BUFFER_POS_REACHED_P() \
7000 ((op & MOVE_TO_POS) != 0 \
7001 && BUFFERP (it->object) \
7002 && IT_CHARPOS (*it) == to_charpos \
7003 && (it->method == GET_FROM_BUFFER \
7004 || (it->method == GET_FROM_DISPLAY_VECTOR \
7005 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7007 /* If there's a line-/wrap-prefix, handle it. */
7008 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7009 && it
->current_y
< it
->last_visible_y
)
7010 handle_line_prefix (it
);
7014 int x
, i
, ascent
= 0, descent
= 0;
7016 /* Utility macro to reset an iterator with x, ascent, and descent. */
7017 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7018 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7019 (IT)->max_descent = descent)
7021 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7023 if ((op
& MOVE_TO_POS
) != 0
7024 && BUFFERP (it
->object
)
7025 && it
->method
== GET_FROM_BUFFER
7026 && (prev_method
== GET_FROM_IMAGE
7027 || prev_method
== GET_FROM_STRETCH
)
7028 /* Passed TO_CHARPOS from left to right. */
7029 && ((prev_pos
< to_charpos
7030 && IT_CHARPOS (*it
) > to_charpos
)
7031 /* Passed TO_CHARPOS from right to left. */
7032 || (prev_pos
> to_charpos
)
7033 && IT_CHARPOS (*it
) < to_charpos
))
7035 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7037 result
= MOVE_POS_MATCH_OR_ZV
;
7040 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7041 /* If wrap_it is valid, the current position might be in a
7042 word that is wrapped. So, save the iterator in
7043 atpos_it and continue to see if wrapping happens. */
7047 prev_method
= it
->method
;
7048 if (it
->method
== GET_FROM_BUFFER
)
7049 prev_pos
= IT_CHARPOS (*it
);
7050 /* Stop when ZV reached.
7051 We used to stop here when TO_CHARPOS reached as well, but that is
7052 too soon if this glyph does not fit on this line. So we handle it
7053 explicitly below. */
7054 if (!get_next_display_element (it
))
7056 result
= MOVE_POS_MATCH_OR_ZV
;
7060 if (it
->line_wrap
== TRUNCATE
)
7062 if (BUFFER_POS_REACHED_P ())
7064 result
= MOVE_POS_MATCH_OR_ZV
;
7070 if (it
->line_wrap
== WORD_WRAP
)
7072 if (IT_DISPLAYING_WHITESPACE (it
))
7076 /* We have reached a glyph that follows one or more
7077 whitespace characters. If the position is
7078 already found, we are done. */
7079 if (atpos_it
.sp
>= 0)
7082 result
= MOVE_POS_MATCH_OR_ZV
;
7088 result
= MOVE_X_REACHED
;
7091 /* Otherwise, we can wrap here. */
7098 /* Remember the line height for the current line, in case
7099 the next element doesn't fit on the line. */
7100 ascent
= it
->max_ascent
;
7101 descent
= it
->max_descent
;
7103 /* The call to produce_glyphs will get the metrics of the
7104 display element IT is loaded with. Record the x-position
7105 before this display element, in case it doesn't fit on the
7109 PRODUCE_GLYPHS (it
);
7111 if (it
->area
!= TEXT_AREA
)
7113 set_iterator_to_next (it
, 1);
7117 /* The number of glyphs we get back in IT->nglyphs will normally
7118 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7119 character on a terminal frame, or (iii) a line end. For the
7120 second case, IT->nglyphs - 1 padding glyphs will be present.
7121 (On X frames, there is only one glyph produced for a
7122 composite character.)
7124 The behavior implemented below means, for continuation lines,
7125 that as many spaces of a TAB as fit on the current line are
7126 displayed there. For terminal frames, as many glyphs of a
7127 multi-glyph character are displayed in the current line, too.
7128 This is what the old redisplay code did, and we keep it that
7129 way. Under X, the whole shape of a complex character must
7130 fit on the line or it will be completely displayed in the
7133 Note that both for tabs and padding glyphs, all glyphs have
7137 /* More than one glyph or glyph doesn't fit on line. All
7138 glyphs have the same width. */
7139 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7141 int x_before_this_char
= x
;
7142 int hpos_before_this_char
= it
->hpos
;
7144 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7146 new_x
= x
+ single_glyph_width
;
7148 /* We want to leave anything reaching TO_X to the caller. */
7149 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7151 if (BUFFER_POS_REACHED_P ())
7153 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7154 goto buffer_pos_reached
;
7155 if (atpos_it
.sp
< 0)
7158 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7163 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7166 result
= MOVE_X_REACHED
;
7172 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7177 if (/* Lines are continued. */
7178 it
->line_wrap
!= TRUNCATE
7179 && (/* And glyph doesn't fit on the line. */
7180 new_x
> it
->last_visible_x
7181 /* Or it fits exactly and we're on a window
7183 || (new_x
== it
->last_visible_x
7184 && FRAME_WINDOW_P (it
->f
))))
7186 if (/* IT->hpos == 0 means the very first glyph
7187 doesn't fit on the line, e.g. a wide image. */
7189 || (new_x
== it
->last_visible_x
7190 && FRAME_WINDOW_P (it
->f
)))
7193 it
->current_x
= new_x
;
7195 /* The character's last glyph just barely fits
7197 if (i
== it
->nglyphs
- 1)
7199 /* If this is the destination position,
7200 return a position *before* it in this row,
7201 now that we know it fits in this row. */
7202 if (BUFFER_POS_REACHED_P ())
7204 if (it
->line_wrap
!= WORD_WRAP
7207 it
->hpos
= hpos_before_this_char
;
7208 it
->current_x
= x_before_this_char
;
7209 result
= MOVE_POS_MATCH_OR_ZV
;
7212 if (it
->line_wrap
== WORD_WRAP
7216 atpos_it
.current_x
= x_before_this_char
;
7217 atpos_it
.hpos
= hpos_before_this_char
;
7221 set_iterator_to_next (it
, 1);
7222 /* On graphical terminals, newlines may
7223 "overflow" into the fringe if
7224 overflow-newline-into-fringe is non-nil.
7225 On text-only terminals, newlines may
7226 overflow into the last glyph on the
7228 if (!FRAME_WINDOW_P (it
->f
)
7229 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7231 if (!get_next_display_element (it
))
7233 result
= MOVE_POS_MATCH_OR_ZV
;
7236 if (BUFFER_POS_REACHED_P ())
7238 if (ITERATOR_AT_END_OF_LINE_P (it
))
7239 result
= MOVE_POS_MATCH_OR_ZV
;
7241 result
= MOVE_LINE_CONTINUED
;
7244 if (ITERATOR_AT_END_OF_LINE_P (it
))
7246 result
= MOVE_NEWLINE_OR_CR
;
7253 IT_RESET_X_ASCENT_DESCENT (it
);
7255 if (wrap_it
.sp
>= 0)
7262 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7264 result
= MOVE_LINE_CONTINUED
;
7268 if (BUFFER_POS_REACHED_P ())
7270 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7271 goto buffer_pos_reached
;
7272 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7275 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7279 if (new_x
> it
->first_visible_x
)
7281 /* Glyph is visible. Increment number of glyphs that
7282 would be displayed. */
7287 if (result
!= MOVE_UNDEFINED
)
7290 else if (BUFFER_POS_REACHED_P ())
7293 IT_RESET_X_ASCENT_DESCENT (it
);
7294 result
= MOVE_POS_MATCH_OR_ZV
;
7297 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7299 /* Stop when TO_X specified and reached. This check is
7300 necessary here because of lines consisting of a line end,
7301 only. The line end will not produce any glyphs and we
7302 would never get MOVE_X_REACHED. */
7303 xassert (it
->nglyphs
== 0);
7304 result
= MOVE_X_REACHED
;
7308 /* Is this a line end? If yes, we're done. */
7309 if (ITERATOR_AT_END_OF_LINE_P (it
))
7311 result
= MOVE_NEWLINE_OR_CR
;
7315 if (it
->method
== GET_FROM_BUFFER
)
7316 prev_pos
= IT_CHARPOS (*it
);
7317 /* The current display element has been consumed. Advance
7319 set_iterator_to_next (it
, 1);
7321 /* Stop if lines are truncated and IT's current x-position is
7322 past the right edge of the window now. */
7323 if (it
->line_wrap
== TRUNCATE
7324 && it
->current_x
>= it
->last_visible_x
)
7326 if (!FRAME_WINDOW_P (it
->f
)
7327 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7329 if (!get_next_display_element (it
)
7330 || BUFFER_POS_REACHED_P ())
7332 result
= MOVE_POS_MATCH_OR_ZV
;
7335 if (ITERATOR_AT_END_OF_LINE_P (it
))
7337 result
= MOVE_NEWLINE_OR_CR
;
7341 result
= MOVE_LINE_TRUNCATED
;
7344 #undef IT_RESET_X_ASCENT_DESCENT
7347 #undef BUFFER_POS_REACHED_P
7349 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7350 restore the saved iterator. */
7351 if (atpos_it
.sp
>= 0)
7353 else if (atx_it
.sp
>= 0)
7358 /* Restore the iterator settings altered at the beginning of this
7360 it
->glyph_row
= saved_glyph_row
;
7364 /* For external use. */
7366 move_it_in_display_line (struct it
*it
,
7367 EMACS_INT to_charpos
, int to_x
,
7368 enum move_operation_enum op
)
7370 if (it
->line_wrap
== WORD_WRAP
7371 && (op
& MOVE_TO_X
))
7373 struct it save_it
= *it
;
7374 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7375 /* When word-wrap is on, TO_X may lie past the end
7376 of a wrapped line. Then it->current is the
7377 character on the next line, so backtrack to the
7378 space before the wrap point. */
7379 if (skip
== MOVE_LINE_CONTINUED
)
7381 int prev_x
= max (it
->current_x
- 1, 0);
7383 move_it_in_display_line_to
7384 (it
, -1, prev_x
, MOVE_TO_X
);
7388 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7392 /* Move IT forward until it satisfies one or more of the criteria in
7393 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7395 OP is a bit-mask that specifies where to stop, and in particular,
7396 which of those four position arguments makes a difference. See the
7397 description of enum move_operation_enum.
7399 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7400 screen line, this function will set IT to the next position >
7404 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7406 int to_charpos
, to_x
, to_y
, to_vpos
;
7409 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7410 int line_height
, line_start_x
= 0, reached
= 0;
7414 if (op
& MOVE_TO_VPOS
)
7416 /* If no TO_CHARPOS and no TO_X specified, stop at the
7417 start of the line TO_VPOS. */
7418 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7420 if (it
->vpos
== to_vpos
)
7426 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7430 /* TO_VPOS >= 0 means stop at TO_X in the line at
7431 TO_VPOS, or at TO_POS, whichever comes first. */
7432 if (it
->vpos
== to_vpos
)
7438 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7440 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7445 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7447 /* We have reached TO_X but not in the line we want. */
7448 skip
= move_it_in_display_line_to (it
, to_charpos
,
7450 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7458 else if (op
& MOVE_TO_Y
)
7460 struct it it_backup
;
7462 if (it
->line_wrap
== WORD_WRAP
)
7465 /* TO_Y specified means stop at TO_X in the line containing
7466 TO_Y---or at TO_CHARPOS if this is reached first. The
7467 problem is that we can't really tell whether the line
7468 contains TO_Y before we have completely scanned it, and
7469 this may skip past TO_X. What we do is to first scan to
7472 If TO_X is not specified, use a TO_X of zero. The reason
7473 is to make the outcome of this function more predictable.
7474 If we didn't use TO_X == 0, we would stop at the end of
7475 the line which is probably not what a caller would expect
7477 skip
= move_it_in_display_line_to
7478 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7479 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7481 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7482 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7484 else if (skip
== MOVE_X_REACHED
)
7486 /* If TO_X was reached, we want to know whether TO_Y is
7487 in the line. We know this is the case if the already
7488 scanned glyphs make the line tall enough. Otherwise,
7489 we must check by scanning the rest of the line. */
7490 line_height
= it
->max_ascent
+ it
->max_descent
;
7491 if (to_y
>= it
->current_y
7492 && to_y
< it
->current_y
+ line_height
)
7498 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7499 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7501 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7502 line_height
= it
->max_ascent
+ it
->max_descent
;
7503 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7505 if (to_y
>= it
->current_y
7506 && to_y
< it
->current_y
+ line_height
)
7508 /* If TO_Y is in this line and TO_X was reached
7509 above, we scanned too far. We have to restore
7510 IT's settings to the ones before skipping. */
7517 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7523 /* Check whether TO_Y is in this line. */
7524 line_height
= it
->max_ascent
+ it
->max_descent
;
7525 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7527 if (to_y
>= it
->current_y
7528 && to_y
< it
->current_y
+ line_height
)
7530 /* When word-wrap is on, TO_X may lie past the end
7531 of a wrapped line. Then it->current is the
7532 character on the next line, so backtrack to the
7533 space before the wrap point. */
7534 if (skip
== MOVE_LINE_CONTINUED
7535 && it
->line_wrap
== WORD_WRAP
)
7537 int prev_x
= max (it
->current_x
- 1, 0);
7539 skip
= move_it_in_display_line_to
7540 (it
, -1, prev_x
, MOVE_TO_X
);
7549 else if (BUFFERP (it
->object
)
7550 && (it
->method
== GET_FROM_BUFFER
7551 || it
->method
== GET_FROM_STRETCH
)
7552 && IT_CHARPOS (*it
) >= to_charpos
)
7553 skip
= MOVE_POS_MATCH_OR_ZV
;
7555 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7559 case MOVE_POS_MATCH_OR_ZV
:
7563 case MOVE_NEWLINE_OR_CR
:
7564 set_iterator_to_next (it
, 1);
7565 it
->continuation_lines_width
= 0;
7568 case MOVE_LINE_TRUNCATED
:
7569 it
->continuation_lines_width
= 0;
7570 reseat_at_next_visible_line_start (it
, 0);
7571 if ((op
& MOVE_TO_POS
) != 0
7572 && IT_CHARPOS (*it
) > to_charpos
)
7579 case MOVE_LINE_CONTINUED
:
7580 /* For continued lines ending in a tab, some of the glyphs
7581 associated with the tab are displayed on the current
7582 line. Since it->current_x does not include these glyphs,
7583 we use it->last_visible_x instead. */
7586 it
->continuation_lines_width
+= it
->last_visible_x
;
7587 /* When moving by vpos, ensure that the iterator really
7588 advances to the next line (bug#847, bug#969). Fixme:
7589 do we need to do this in other circumstances? */
7590 if (it
->current_x
!= it
->last_visible_x
7591 && (op
& MOVE_TO_VPOS
)
7592 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7594 line_start_x
= it
->current_x
+ it
->pixel_width
7595 - it
->last_visible_x
;
7596 set_iterator_to_next (it
, 0);
7600 it
->continuation_lines_width
+= it
->current_x
;
7607 /* Reset/increment for the next run. */
7608 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7609 it
->current_x
= line_start_x
;
7612 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7614 last_height
= it
->max_ascent
+ it
->max_descent
;
7615 last_max_ascent
= it
->max_ascent
;
7616 it
->max_ascent
= it
->max_descent
= 0;
7621 /* On text terminals, we may stop at the end of a line in the middle
7622 of a multi-character glyph. If the glyph itself is continued,
7623 i.e. it is actually displayed on the next line, don't treat this
7624 stopping point as valid; move to the next line instead (unless
7625 that brings us offscreen). */
7626 if (!FRAME_WINDOW_P (it
->f
)
7628 && IT_CHARPOS (*it
) == to_charpos
7629 && it
->what
== IT_CHARACTER
7631 && it
->line_wrap
== WINDOW_WRAP
7632 && it
->current_x
== it
->last_visible_x
- 1
7635 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7637 it
->continuation_lines_width
+= it
->current_x
;
7638 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7639 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7641 last_height
= it
->max_ascent
+ it
->max_descent
;
7642 last_max_ascent
= it
->max_ascent
;
7645 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7649 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7651 If DY > 0, move IT backward at least that many pixels. DY = 0
7652 means move IT backward to the preceding line start or BEGV. This
7653 function may move over more than DY pixels if IT->current_y - DY
7654 ends up in the middle of a line; in this case IT->current_y will be
7655 set to the top of the line moved to. */
7658 move_it_vertically_backward (it
, dy
)
7669 start_pos
= IT_CHARPOS (*it
);
7671 /* Estimate how many newlines we must move back. */
7672 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7674 /* Set the iterator's position that many lines back. */
7675 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7676 back_to_previous_visible_line_start (it
);
7678 /* Reseat the iterator here. When moving backward, we don't want
7679 reseat to skip forward over invisible text, set up the iterator
7680 to deliver from overlay strings at the new position etc. So,
7681 use reseat_1 here. */
7682 reseat_1 (it
, it
->current
.pos
, 1);
7684 /* We are now surely at a line start. */
7685 it
->current_x
= it
->hpos
= 0;
7686 it
->continuation_lines_width
= 0;
7688 /* Move forward and see what y-distance we moved. First move to the
7689 start of the next line so that we get its height. We need this
7690 height to be able to tell whether we reached the specified
7693 it2
.max_ascent
= it2
.max_descent
= 0;
7696 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7697 MOVE_TO_POS
| MOVE_TO_VPOS
);
7699 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7700 xassert (IT_CHARPOS (*it
) >= BEGV
);
7703 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7704 xassert (IT_CHARPOS (*it
) >= BEGV
);
7705 /* H is the actual vertical distance from the position in *IT
7706 and the starting position. */
7707 h
= it2
.current_y
- it
->current_y
;
7708 /* NLINES is the distance in number of lines. */
7709 nlines
= it2
.vpos
- it
->vpos
;
7711 /* Correct IT's y and vpos position
7712 so that they are relative to the starting point. */
7718 /* DY == 0 means move to the start of the screen line. The
7719 value of nlines is > 0 if continuation lines were involved. */
7721 move_it_by_lines (it
, nlines
, 1);
7725 /* The y-position we try to reach, relative to *IT.
7726 Note that H has been subtracted in front of the if-statement. */
7727 int target_y
= it
->current_y
+ h
- dy
;
7728 int y0
= it3
.current_y
;
7729 int y1
= line_bottom_y (&it3
);
7730 int line_height
= y1
- y0
;
7732 /* If we did not reach target_y, try to move further backward if
7733 we can. If we moved too far backward, try to move forward. */
7734 if (target_y
< it
->current_y
7735 /* This is heuristic. In a window that's 3 lines high, with
7736 a line height of 13 pixels each, recentering with point
7737 on the bottom line will try to move -39/2 = 19 pixels
7738 backward. Try to avoid moving into the first line. */
7739 && (it
->current_y
- target_y
7740 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7741 && IT_CHARPOS (*it
) > BEGV
)
7743 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7744 target_y
- it
->current_y
));
7745 dy
= it
->current_y
- target_y
;
7746 goto move_further_back
;
7748 else if (target_y
>= it
->current_y
+ line_height
7749 && IT_CHARPOS (*it
) < ZV
)
7751 /* Should move forward by at least one line, maybe more.
7753 Note: Calling move_it_by_lines can be expensive on
7754 terminal frames, where compute_motion is used (via
7755 vmotion) to do the job, when there are very long lines
7756 and truncate-lines is nil. That's the reason for
7757 treating terminal frames specially here. */
7759 if (!FRAME_WINDOW_P (it
->f
))
7760 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7765 move_it_by_lines (it
, 1, 1);
7767 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7774 /* Move IT by a specified amount of pixel lines DY. DY negative means
7775 move backwards. DY = 0 means move to start of screen line. At the
7776 end, IT will be on the start of a screen line. */
7779 move_it_vertically (it
, dy
)
7784 move_it_vertically_backward (it
, -dy
);
7787 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7788 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7789 MOVE_TO_POS
| MOVE_TO_Y
);
7790 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7792 /* If buffer ends in ZV without a newline, move to the start of
7793 the line to satisfy the post-condition. */
7794 if (IT_CHARPOS (*it
) == ZV
7796 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7797 move_it_by_lines (it
, 0, 0);
7802 /* Move iterator IT past the end of the text line it is in. */
7805 move_it_past_eol (it
)
7808 enum move_it_result rc
;
7810 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7811 if (rc
== MOVE_NEWLINE_OR_CR
)
7812 set_iterator_to_next (it
, 0);
7816 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7817 negative means move up. DVPOS == 0 means move to the start of the
7818 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7819 NEED_Y_P is zero, IT->current_y will be left unchanged.
7821 Further optimization ideas: If we would know that IT->f doesn't use
7822 a face with proportional font, we could be faster for
7823 truncate-lines nil. */
7826 move_it_by_lines (it
, dvpos
, need_y_p
)
7828 int dvpos
, need_y_p
;
7830 struct position pos
;
7832 /* The commented-out optimization uses vmotion on terminals. This
7833 gives bad results, because elements like it->what, on which
7834 callers such as pos_visible_p rely, aren't updated. */
7835 /* if (!FRAME_WINDOW_P (it->f))
7837 struct text_pos textpos;
7839 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7840 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7841 reseat (it, textpos, 1);
7842 it->vpos += pos.vpos;
7843 it->current_y += pos.vpos;
7849 /* DVPOS == 0 means move to the start of the screen line. */
7850 move_it_vertically_backward (it
, 0);
7851 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7852 /* Let next call to line_bottom_y calculate real line height */
7857 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7858 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7859 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7864 int start_charpos
, i
;
7866 /* Start at the beginning of the screen line containing IT's
7867 position. This may actually move vertically backwards,
7868 in case of overlays, so adjust dvpos accordingly. */
7870 move_it_vertically_backward (it
, 0);
7873 /* Go back -DVPOS visible lines and reseat the iterator there. */
7874 start_charpos
= IT_CHARPOS (*it
);
7875 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7876 back_to_previous_visible_line_start (it
);
7877 reseat (it
, it
->current
.pos
, 1);
7879 /* Move further back if we end up in a string or an image. */
7880 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7882 /* First try to move to start of display line. */
7884 move_it_vertically_backward (it
, 0);
7886 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7888 /* If start of line is still in string or image,
7889 move further back. */
7890 back_to_previous_visible_line_start (it
);
7891 reseat (it
, it
->current
.pos
, 1);
7895 it
->current_x
= it
->hpos
= 0;
7897 /* Above call may have moved too far if continuation lines
7898 are involved. Scan forward and see if it did. */
7900 it2
.vpos
= it2
.current_y
= 0;
7901 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7902 it
->vpos
-= it2
.vpos
;
7903 it
->current_y
-= it2
.current_y
;
7904 it
->current_x
= it
->hpos
= 0;
7906 /* If we moved too far back, move IT some lines forward. */
7907 if (it2
.vpos
> -dvpos
)
7909 int delta
= it2
.vpos
+ dvpos
;
7911 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7912 /* Move back again if we got too far ahead. */
7913 if (IT_CHARPOS (*it
) >= start_charpos
)
7919 /* Return 1 if IT points into the middle of a display vector. */
7922 in_display_vector_p (it
)
7925 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7926 && it
->current
.dpvec_index
> 0
7927 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7931 /***********************************************************************
7933 ***********************************************************************/
7936 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7940 add_to_log (format
, arg1
, arg2
)
7942 Lisp_Object arg1
, arg2
;
7944 Lisp_Object args
[3];
7945 Lisp_Object msg
, fmt
;
7948 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7951 /* Do nothing if called asynchronously. Inserting text into
7952 a buffer may call after-change-functions and alike and
7953 that would means running Lisp asynchronously. */
7954 if (handling_signal
)
7958 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7960 args
[0] = fmt
= build_string (format
);
7963 msg
= Fformat (3, args
);
7965 len
= SBYTES (msg
) + 1;
7966 SAFE_ALLOCA (buffer
, char *, len
);
7967 bcopy (SDATA (msg
), buffer
, len
);
7969 message_dolog (buffer
, len
- 1, 1, 0);
7976 /* Output a newline in the *Messages* buffer if "needs" one. */
7979 message_log_maybe_newline ()
7981 if (message_log_need_newline
)
7982 message_dolog ("", 0, 1, 0);
7986 /* Add a string M of length NBYTES to the message log, optionally
7987 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7988 nonzero, means interpret the contents of M as multibyte. This
7989 function calls low-level routines in order to bypass text property
7990 hooks, etc. which might not be safe to run.
7992 This may GC (insert may run before/after change hooks),
7993 so the buffer M must NOT point to a Lisp string. */
7996 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7998 int nbytes
, nlflag
, multibyte
;
8000 if (!NILP (Vmemory_full
))
8003 if (!NILP (Vmessage_log_max
))
8005 struct buffer
*oldbuf
;
8006 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8007 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8008 int point_at_end
= 0;
8010 Lisp_Object old_deactivate_mark
, tem
;
8011 struct gcpro gcpro1
;
8013 old_deactivate_mark
= Vdeactivate_mark
;
8014 oldbuf
= current_buffer
;
8015 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8016 current_buffer
->undo_list
= Qt
;
8018 oldpoint
= message_dolog_marker1
;
8019 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8020 oldbegv
= message_dolog_marker2
;
8021 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8022 oldzv
= message_dolog_marker3
;
8023 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8024 GCPRO1 (old_deactivate_mark
);
8032 BEGV_BYTE
= BEG_BYTE
;
8035 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8037 /* Insert the string--maybe converting multibyte to single byte
8038 or vice versa, so that all the text fits the buffer. */
8040 && NILP (current_buffer
->enable_multibyte_characters
))
8042 int i
, c
, char_bytes
;
8043 unsigned char work
[1];
8045 /* Convert a multibyte string to single-byte
8046 for the *Message* buffer. */
8047 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8049 c
= string_char_and_length (m
+ i
, &char_bytes
);
8050 work
[0] = (ASCII_CHAR_P (c
)
8052 : multibyte_char_to_unibyte (c
, Qnil
));
8053 insert_1_both (work
, 1, 1, 1, 0, 0);
8056 else if (! multibyte
8057 && ! NILP (current_buffer
->enable_multibyte_characters
))
8059 int i
, c
, char_bytes
;
8060 unsigned char *msg
= (unsigned char *) m
;
8061 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8062 /* Convert a single-byte string to multibyte
8063 for the *Message* buffer. */
8064 for (i
= 0; i
< nbytes
; i
++)
8067 MAKE_CHAR_MULTIBYTE (c
);
8068 char_bytes
= CHAR_STRING (c
, str
);
8069 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8073 insert_1 (m
, nbytes
, 1, 0, 0);
8077 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8078 insert_1 ("\n", 1, 1, 0, 0);
8080 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8082 this_bol_byte
= PT_BYTE
;
8084 /* See if this line duplicates the previous one.
8085 If so, combine duplicates. */
8088 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8090 prev_bol_byte
= PT_BYTE
;
8092 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8093 this_bol
, this_bol_byte
);
8096 del_range_both (prev_bol
, prev_bol_byte
,
8097 this_bol
, this_bol_byte
, 0);
8103 /* If you change this format, don't forget to also
8104 change message_log_check_duplicate. */
8105 sprintf (dupstr
, " [%d times]", dup
);
8106 duplen
= strlen (dupstr
);
8107 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8108 insert_1 (dupstr
, duplen
, 1, 0, 1);
8113 /* If we have more than the desired maximum number of lines
8114 in the *Messages* buffer now, delete the oldest ones.
8115 This is safe because we don't have undo in this buffer. */
8117 if (NATNUMP (Vmessage_log_max
))
8119 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8120 -XFASTINT (Vmessage_log_max
) - 1, 0);
8121 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8124 BEGV
= XMARKER (oldbegv
)->charpos
;
8125 BEGV_BYTE
= marker_byte_position (oldbegv
);
8134 ZV
= XMARKER (oldzv
)->charpos
;
8135 ZV_BYTE
= marker_byte_position (oldzv
);
8139 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8141 /* We can't do Fgoto_char (oldpoint) because it will run some
8143 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8144 XMARKER (oldpoint
)->bytepos
);
8147 unchain_marker (XMARKER (oldpoint
));
8148 unchain_marker (XMARKER (oldbegv
));
8149 unchain_marker (XMARKER (oldzv
));
8151 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8152 set_buffer_internal (oldbuf
);
8154 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8155 message_log_need_newline
= !nlflag
;
8156 Vdeactivate_mark
= old_deactivate_mark
;
8161 /* We are at the end of the buffer after just having inserted a newline.
8162 (Note: We depend on the fact we won't be crossing the gap.)
8163 Check to see if the most recent message looks a lot like the previous one.
8164 Return 0 if different, 1 if the new one should just replace it, or a
8165 value N > 1 if we should also append " [N times]". */
8168 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8169 int prev_bol
, this_bol
;
8170 int prev_bol_byte
, this_bol_byte
;
8173 int len
= Z_BYTE
- 1 - this_bol_byte
;
8175 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8176 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8178 for (i
= 0; i
< len
; i
++)
8180 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8188 if (*p1
++ == ' ' && *p1
++ == '[')
8191 while (*p1
>= '0' && *p1
<= '9')
8192 n
= n
* 10 + *p1
++ - '0';
8193 if (strncmp (p1
, " times]\n", 8) == 0)
8200 /* Display an echo area message M with a specified length of NBYTES
8201 bytes. The string may include null characters. If M is 0, clear
8202 out any existing message, and let the mini-buffer text show
8205 This may GC, so the buffer M must NOT point to a Lisp string. */
8208 message2 (m
, nbytes
, multibyte
)
8213 /* First flush out any partial line written with print. */
8214 message_log_maybe_newline ();
8216 message_dolog (m
, nbytes
, 1, multibyte
);
8217 message2_nolog (m
, nbytes
, multibyte
);
8221 /* The non-logging counterpart of message2. */
8224 message2_nolog (m
, nbytes
, multibyte
)
8226 int nbytes
, multibyte
;
8228 struct frame
*sf
= SELECTED_FRAME ();
8229 message_enable_multibyte
= multibyte
;
8231 if (FRAME_INITIAL_P (sf
))
8233 if (noninteractive_need_newline
)
8234 putc ('\n', stderr
);
8235 noninteractive_need_newline
= 0;
8237 fwrite (m
, nbytes
, 1, stderr
);
8238 if (cursor_in_echo_area
== 0)
8239 fprintf (stderr
, "\n");
8242 /* A null message buffer means that the frame hasn't really been
8243 initialized yet. Error messages get reported properly by
8244 cmd_error, so this must be just an informative message; toss it. */
8245 else if (INTERACTIVE
8246 && sf
->glyphs_initialized_p
8247 && FRAME_MESSAGE_BUF (sf
))
8249 Lisp_Object mini_window
;
8252 /* Get the frame containing the mini-buffer
8253 that the selected frame is using. */
8254 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8255 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8257 FRAME_SAMPLE_VISIBILITY (f
);
8258 if (FRAME_VISIBLE_P (sf
)
8259 && ! FRAME_VISIBLE_P (f
))
8260 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8264 set_message (m
, Qnil
, nbytes
, multibyte
);
8265 if (minibuffer_auto_raise
)
8266 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8269 clear_message (1, 1);
8271 do_pending_window_change (0);
8272 echo_area_display (1);
8273 do_pending_window_change (0);
8274 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8275 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8280 /* Display an echo area message M with a specified length of NBYTES
8281 bytes. The string may include null characters. If M is not a
8282 string, clear out any existing message, and let the mini-buffer
8285 This function cancels echoing. */
8288 message3 (m
, nbytes
, multibyte
)
8293 struct gcpro gcpro1
;
8296 clear_message (1,1);
8299 /* First flush out any partial line written with print. */
8300 message_log_maybe_newline ();
8306 SAFE_ALLOCA (buffer
, char *, nbytes
);
8307 bcopy (SDATA (m
), buffer
, nbytes
);
8308 message_dolog (buffer
, nbytes
, 1, multibyte
);
8311 message3_nolog (m
, nbytes
, multibyte
);
8317 /* The non-logging version of message3.
8318 This does not cancel echoing, because it is used for echoing.
8319 Perhaps we need to make a separate function for echoing
8320 and make this cancel echoing. */
8323 message3_nolog (m
, nbytes
, multibyte
)
8325 int nbytes
, multibyte
;
8327 struct frame
*sf
= SELECTED_FRAME ();
8328 message_enable_multibyte
= multibyte
;
8330 if (FRAME_INITIAL_P (sf
))
8332 if (noninteractive_need_newline
)
8333 putc ('\n', stderr
);
8334 noninteractive_need_newline
= 0;
8336 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8337 if (cursor_in_echo_area
== 0)
8338 fprintf (stderr
, "\n");
8341 /* A null message buffer means that the frame hasn't really been
8342 initialized yet. Error messages get reported properly by
8343 cmd_error, so this must be just an informative message; toss it. */
8344 else if (INTERACTIVE
8345 && sf
->glyphs_initialized_p
8346 && FRAME_MESSAGE_BUF (sf
))
8348 Lisp_Object mini_window
;
8352 /* Get the frame containing the mini-buffer
8353 that the selected frame is using. */
8354 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8355 frame
= XWINDOW (mini_window
)->frame
;
8358 FRAME_SAMPLE_VISIBILITY (f
);
8359 if (FRAME_VISIBLE_P (sf
)
8360 && !FRAME_VISIBLE_P (f
))
8361 Fmake_frame_visible (frame
);
8363 if (STRINGP (m
) && SCHARS (m
) > 0)
8365 set_message (NULL
, m
, nbytes
, multibyte
);
8366 if (minibuffer_auto_raise
)
8367 Fraise_frame (frame
);
8368 /* Assume we are not echoing.
8369 (If we are, echo_now will override this.) */
8370 echo_message_buffer
= Qnil
;
8373 clear_message (1, 1);
8375 do_pending_window_change (0);
8376 echo_area_display (1);
8377 do_pending_window_change (0);
8378 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8379 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8384 /* Display a null-terminated echo area message M. If M is 0, clear
8385 out any existing message, and let the mini-buffer text show through.
8387 The buffer M must continue to exist until after the echo area gets
8388 cleared or some other message gets displayed there. Do not pass
8389 text that is stored in a Lisp string. Do not pass text in a buffer
8390 that was alloca'd. */
8396 message2 (m
, (m
? strlen (m
) : 0), 0);
8400 /* The non-logging counterpart of message1. */
8406 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8409 /* Display a message M which contains a single %s
8410 which gets replaced with STRING. */
8413 message_with_string (m
, string
, log
)
8418 CHECK_STRING (string
);
8424 if (noninteractive_need_newline
)
8425 putc ('\n', stderr
);
8426 noninteractive_need_newline
= 0;
8427 fprintf (stderr
, m
, SDATA (string
));
8428 if (!cursor_in_echo_area
)
8429 fprintf (stderr
, "\n");
8433 else if (INTERACTIVE
)
8435 /* The frame whose minibuffer we're going to display the message on.
8436 It may be larger than the selected frame, so we need
8437 to use its buffer, not the selected frame's buffer. */
8438 Lisp_Object mini_window
;
8439 struct frame
*f
, *sf
= SELECTED_FRAME ();
8441 /* Get the frame containing the minibuffer
8442 that the selected frame is using. */
8443 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8444 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8446 /* A null message buffer means that the frame hasn't really been
8447 initialized yet. Error messages get reported properly by
8448 cmd_error, so this must be just an informative message; toss it. */
8449 if (FRAME_MESSAGE_BUF (f
))
8451 Lisp_Object args
[2], message
;
8452 struct gcpro gcpro1
, gcpro2
;
8454 args
[0] = build_string (m
);
8455 args
[1] = message
= string
;
8456 GCPRO2 (args
[0], message
);
8459 message
= Fformat (2, args
);
8462 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8464 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8468 /* Print should start at the beginning of the message
8469 buffer next time. */
8470 message_buf_print
= 0;
8476 /* Dump an informative message to the minibuf. If M is 0, clear out
8477 any existing message, and let the mini-buffer text show through. */
8481 message (m
, a1
, a2
, a3
)
8483 EMACS_INT a1
, a2
, a3
;
8489 if (noninteractive_need_newline
)
8490 putc ('\n', stderr
);
8491 noninteractive_need_newline
= 0;
8492 fprintf (stderr
, m
, a1
, a2
, a3
);
8493 if (cursor_in_echo_area
== 0)
8494 fprintf (stderr
, "\n");
8498 else if (INTERACTIVE
)
8500 /* The frame whose mini-buffer we're going to display the message
8501 on. It may be larger than the selected frame, so we need to
8502 use its buffer, not the selected frame's buffer. */
8503 Lisp_Object mini_window
;
8504 struct frame
*f
, *sf
= SELECTED_FRAME ();
8506 /* Get the frame containing the mini-buffer
8507 that the selected frame is using. */
8508 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8509 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8511 /* A null message buffer means that the frame hasn't really been
8512 initialized yet. Error messages get reported properly by
8513 cmd_error, so this must be just an informative message; toss
8515 if (FRAME_MESSAGE_BUF (f
))
8526 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8527 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8529 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8530 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8532 #endif /* NO_ARG_ARRAY */
8534 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8539 /* Print should start at the beginning of the message
8540 buffer next time. */
8541 message_buf_print
= 0;
8547 /* The non-logging version of message. */
8550 message_nolog (m
, a1
, a2
, a3
)
8552 EMACS_INT a1
, a2
, a3
;
8554 Lisp_Object old_log_max
;
8555 old_log_max
= Vmessage_log_max
;
8556 Vmessage_log_max
= Qnil
;
8557 message (m
, a1
, a2
, a3
);
8558 Vmessage_log_max
= old_log_max
;
8562 /* Display the current message in the current mini-buffer. This is
8563 only called from error handlers in process.c, and is not time
8569 if (!NILP (echo_area_buffer
[0]))
8572 string
= Fcurrent_message ();
8573 message3 (string
, SBYTES (string
),
8574 !NILP (current_buffer
->enable_multibyte_characters
));
8579 /* Make sure echo area buffers in `echo_buffers' are live.
8580 If they aren't, make new ones. */
8583 ensure_echo_area_buffers ()
8587 for (i
= 0; i
< 2; ++i
)
8588 if (!BUFFERP (echo_buffer
[i
])
8589 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8592 Lisp_Object old_buffer
;
8595 old_buffer
= echo_buffer
[i
];
8596 sprintf (name
, " *Echo Area %d*", i
);
8597 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8598 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8599 /* to force word wrap in echo area -
8600 it was decided to postpone this*/
8601 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8603 for (j
= 0; j
< 2; ++j
)
8604 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8605 echo_area_buffer
[j
] = echo_buffer
[i
];
8610 /* Call FN with args A1..A4 with either the current or last displayed
8611 echo_area_buffer as current buffer.
8613 WHICH zero means use the current message buffer
8614 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8615 from echo_buffer[] and clear it.
8617 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8618 suitable buffer from echo_buffer[] and clear it.
8620 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8621 that the current message becomes the last displayed one, make
8622 choose a suitable buffer for echo_area_buffer[0], and clear it.
8624 Value is what FN returns. */
8627 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8630 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8636 int this_one
, the_other
, clear_buffer_p
, rc
;
8637 int count
= SPECPDL_INDEX ();
8639 /* If buffers aren't live, make new ones. */
8640 ensure_echo_area_buffers ();
8645 this_one
= 0, the_other
= 1;
8647 this_one
= 1, the_other
= 0;
8650 this_one
= 0, the_other
= 1;
8653 /* We need a fresh one in case the current echo buffer equals
8654 the one containing the last displayed echo area message. */
8655 if (!NILP (echo_area_buffer
[this_one
])
8656 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8657 echo_area_buffer
[this_one
] = Qnil
;
8660 /* Choose a suitable buffer from echo_buffer[] is we don't
8662 if (NILP (echo_area_buffer
[this_one
]))
8664 echo_area_buffer
[this_one
]
8665 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8666 ? echo_buffer
[the_other
]
8667 : echo_buffer
[this_one
]);
8671 buffer
= echo_area_buffer
[this_one
];
8673 /* Don't get confused by reusing the buffer used for echoing
8674 for a different purpose. */
8675 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8678 record_unwind_protect (unwind_with_echo_area_buffer
,
8679 with_echo_area_buffer_unwind_data (w
));
8681 /* Make the echo area buffer current. Note that for display
8682 purposes, it is not necessary that the displayed window's buffer
8683 == current_buffer, except for text property lookup. So, let's
8684 only set that buffer temporarily here without doing a full
8685 Fset_window_buffer. We must also change w->pointm, though,
8686 because otherwise an assertions in unshow_buffer fails, and Emacs
8688 set_buffer_internal_1 (XBUFFER (buffer
));
8692 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8695 current_buffer
->undo_list
= Qt
;
8696 current_buffer
->read_only
= Qnil
;
8697 specbind (Qinhibit_read_only
, Qt
);
8698 specbind (Qinhibit_modification_hooks
, Qt
);
8700 if (clear_buffer_p
&& Z
> BEG
)
8703 xassert (BEGV
>= BEG
);
8704 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8706 rc
= fn (a1
, a2
, a3
, a4
);
8708 xassert (BEGV
>= BEG
);
8709 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8711 unbind_to (count
, Qnil
);
8716 /* Save state that should be preserved around the call to the function
8717 FN called in with_echo_area_buffer. */
8720 with_echo_area_buffer_unwind_data (w
)
8724 Lisp_Object vector
, tmp
;
8726 /* Reduce consing by keeping one vector in
8727 Vwith_echo_area_save_vector. */
8728 vector
= Vwith_echo_area_save_vector
;
8729 Vwith_echo_area_save_vector
= Qnil
;
8732 vector
= Fmake_vector (make_number (7), Qnil
);
8734 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8735 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8736 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8740 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8741 ASET (vector
, i
, w
->buffer
); ++i
;
8742 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8743 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8748 for (; i
< end
; ++i
)
8749 ASET (vector
, i
, Qnil
);
8752 xassert (i
== ASIZE (vector
));
8757 /* Restore global state from VECTOR which was created by
8758 with_echo_area_buffer_unwind_data. */
8761 unwind_with_echo_area_buffer (vector
)
8764 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8765 Vdeactivate_mark
= AREF (vector
, 1);
8766 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8768 if (WINDOWP (AREF (vector
, 3)))
8771 Lisp_Object buffer
, charpos
, bytepos
;
8773 w
= XWINDOW (AREF (vector
, 3));
8774 buffer
= AREF (vector
, 4);
8775 charpos
= AREF (vector
, 5);
8776 bytepos
= AREF (vector
, 6);
8779 set_marker_both (w
->pointm
, buffer
,
8780 XFASTINT (charpos
), XFASTINT (bytepos
));
8783 Vwith_echo_area_save_vector
= vector
;
8788 /* Set up the echo area for use by print functions. MULTIBYTE_P
8789 non-zero means we will print multibyte. */
8792 setup_echo_area_for_printing (multibyte_p
)
8795 /* If we can't find an echo area any more, exit. */
8796 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8799 ensure_echo_area_buffers ();
8801 if (!message_buf_print
)
8803 /* A message has been output since the last time we printed.
8804 Choose a fresh echo area buffer. */
8805 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8806 echo_area_buffer
[0] = echo_buffer
[1];
8808 echo_area_buffer
[0] = echo_buffer
[0];
8810 /* Switch to that buffer and clear it. */
8811 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8812 current_buffer
->truncate_lines
= Qnil
;
8816 int count
= SPECPDL_INDEX ();
8817 specbind (Qinhibit_read_only
, Qt
);
8818 /* Note that undo recording is always disabled. */
8820 unbind_to (count
, Qnil
);
8822 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8824 /* Set up the buffer for the multibyteness we need. */
8826 != !NILP (current_buffer
->enable_multibyte_characters
))
8827 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8829 /* Raise the frame containing the echo area. */
8830 if (minibuffer_auto_raise
)
8832 struct frame
*sf
= SELECTED_FRAME ();
8833 Lisp_Object mini_window
;
8834 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8835 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8838 message_log_maybe_newline ();
8839 message_buf_print
= 1;
8843 if (NILP (echo_area_buffer
[0]))
8845 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8846 echo_area_buffer
[0] = echo_buffer
[1];
8848 echo_area_buffer
[0] = echo_buffer
[0];
8851 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8853 /* Someone switched buffers between print requests. */
8854 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8855 current_buffer
->truncate_lines
= Qnil
;
8861 /* Display an echo area message in window W. Value is non-zero if W's
8862 height is changed. If display_last_displayed_message_p is
8863 non-zero, display the message that was last displayed, otherwise
8864 display the current message. */
8867 display_echo_area (w
)
8870 int i
, no_message_p
, window_height_changed_p
, count
;
8872 /* Temporarily disable garbage collections while displaying the echo
8873 area. This is done because a GC can print a message itself.
8874 That message would modify the echo area buffer's contents while a
8875 redisplay of the buffer is going on, and seriously confuse
8877 count
= inhibit_garbage_collection ();
8879 /* If there is no message, we must call display_echo_area_1
8880 nevertheless because it resizes the window. But we will have to
8881 reset the echo_area_buffer in question to nil at the end because
8882 with_echo_area_buffer will sets it to an empty buffer. */
8883 i
= display_last_displayed_message_p
? 1 : 0;
8884 no_message_p
= NILP (echo_area_buffer
[i
]);
8886 window_height_changed_p
8887 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8888 display_echo_area_1
,
8889 (EMACS_INT
) w
, Qnil
, 0, 0);
8892 echo_area_buffer
[i
] = Qnil
;
8894 unbind_to (count
, Qnil
);
8895 return window_height_changed_p
;
8899 /* Helper for display_echo_area. Display the current buffer which
8900 contains the current echo area message in window W, a mini-window,
8901 a pointer to which is passed in A1. A2..A4 are currently not used.
8902 Change the height of W so that all of the message is displayed.
8903 Value is non-zero if height of W was changed. */
8906 display_echo_area_1 (a1
, a2
, a3
, a4
)
8911 struct window
*w
= (struct window
*) a1
;
8913 struct text_pos start
;
8914 int window_height_changed_p
= 0;
8916 /* Do this before displaying, so that we have a large enough glyph
8917 matrix for the display. If we can't get enough space for the
8918 whole text, display the last N lines. That works by setting w->start. */
8919 window_height_changed_p
= resize_mini_window (w
, 0);
8921 /* Use the starting position chosen by resize_mini_window. */
8922 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8925 clear_glyph_matrix (w
->desired_matrix
);
8926 XSETWINDOW (window
, w
);
8927 try_window (window
, start
, 0);
8929 return window_height_changed_p
;
8933 /* Resize the echo area window to exactly the size needed for the
8934 currently displayed message, if there is one. If a mini-buffer
8935 is active, don't shrink it. */
8938 resize_echo_area_exactly ()
8940 if (BUFFERP (echo_area_buffer
[0])
8941 && WINDOWP (echo_area_window
))
8943 struct window
*w
= XWINDOW (echo_area_window
);
8945 Lisp_Object resize_exactly
;
8947 if (minibuf_level
== 0)
8948 resize_exactly
= Qt
;
8950 resize_exactly
= Qnil
;
8952 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8953 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8956 ++windows_or_buffers_changed
;
8957 ++update_mode_lines
;
8958 redisplay_internal (0);
8964 /* Callback function for with_echo_area_buffer, when used from
8965 resize_echo_area_exactly. A1 contains a pointer to the window to
8966 resize, EXACTLY non-nil means resize the mini-window exactly to the
8967 size of the text displayed. A3 and A4 are not used. Value is what
8968 resize_mini_window returns. */
8971 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8973 Lisp_Object exactly
;
8976 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8980 /* Resize mini-window W to fit the size of its contents. EXACT_P
8981 means size the window exactly to the size needed. Otherwise, it's
8982 only enlarged until W's buffer is empty.
8984 Set W->start to the right place to begin display. If the whole
8985 contents fit, start at the beginning. Otherwise, start so as
8986 to make the end of the contents appear. This is particularly
8987 important for y-or-n-p, but seems desirable generally.
8989 Value is non-zero if the window height has been changed. */
8992 resize_mini_window (w
, exact_p
)
8996 struct frame
*f
= XFRAME (w
->frame
);
8997 int window_height_changed_p
= 0;
8999 xassert (MINI_WINDOW_P (w
));
9001 /* By default, start display at the beginning. */
9002 set_marker_both (w
->start
, w
->buffer
,
9003 BUF_BEGV (XBUFFER (w
->buffer
)),
9004 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9006 /* Don't resize windows while redisplaying a window; it would
9007 confuse redisplay functions when the size of the window they are
9008 displaying changes from under them. Such a resizing can happen,
9009 for instance, when which-func prints a long message while
9010 we are running fontification-functions. We're running these
9011 functions with safe_call which binds inhibit-redisplay to t. */
9012 if (!NILP (Vinhibit_redisplay
))
9015 /* Nil means don't try to resize. */
9016 if (NILP (Vresize_mini_windows
)
9017 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9020 if (!FRAME_MINIBUF_ONLY_P (f
))
9023 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9024 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9025 int height
, max_height
;
9026 int unit
= FRAME_LINE_HEIGHT (f
);
9027 struct text_pos start
;
9028 struct buffer
*old_current_buffer
= NULL
;
9030 if (current_buffer
!= XBUFFER (w
->buffer
))
9032 old_current_buffer
= current_buffer
;
9033 set_buffer_internal (XBUFFER (w
->buffer
));
9036 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9038 /* Compute the max. number of lines specified by the user. */
9039 if (FLOATP (Vmax_mini_window_height
))
9040 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9041 else if (INTEGERP (Vmax_mini_window_height
))
9042 max_height
= XINT (Vmax_mini_window_height
);
9044 max_height
= total_height
/ 4;
9046 /* Correct that max. height if it's bogus. */
9047 max_height
= max (1, max_height
);
9048 max_height
= min (total_height
, max_height
);
9050 /* Find out the height of the text in the window. */
9051 if (it
.line_wrap
== TRUNCATE
)
9056 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9057 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9058 height
= it
.current_y
+ last_height
;
9060 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9061 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9062 height
= (height
+ unit
- 1) / unit
;
9065 /* Compute a suitable window start. */
9066 if (height
> max_height
)
9068 height
= max_height
;
9069 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9070 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9071 start
= it
.current
.pos
;
9074 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9075 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9077 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9079 /* Let it grow only, until we display an empty message, in which
9080 case the window shrinks again. */
9081 if (height
> WINDOW_TOTAL_LINES (w
))
9083 int old_height
= WINDOW_TOTAL_LINES (w
);
9084 freeze_window_starts (f
, 1);
9085 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9086 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9088 else if (height
< WINDOW_TOTAL_LINES (w
)
9089 && (exact_p
|| BEGV
== ZV
))
9091 int old_height
= WINDOW_TOTAL_LINES (w
);
9092 freeze_window_starts (f
, 0);
9093 shrink_mini_window (w
);
9094 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9099 /* Always resize to exact size needed. */
9100 if (height
> WINDOW_TOTAL_LINES (w
))
9102 int old_height
= WINDOW_TOTAL_LINES (w
);
9103 freeze_window_starts (f
, 1);
9104 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9105 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9107 else if (height
< WINDOW_TOTAL_LINES (w
))
9109 int old_height
= WINDOW_TOTAL_LINES (w
);
9110 freeze_window_starts (f
, 0);
9111 shrink_mini_window (w
);
9115 freeze_window_starts (f
, 1);
9116 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9119 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9123 if (old_current_buffer
)
9124 set_buffer_internal (old_current_buffer
);
9127 return window_height_changed_p
;
9131 /* Value is the current message, a string, or nil if there is no
9139 if (!BUFFERP (echo_area_buffer
[0]))
9143 with_echo_area_buffer (0, 0, current_message_1
,
9144 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9146 echo_area_buffer
[0] = Qnil
;
9154 current_message_1 (a1
, a2
, a3
, a4
)
9159 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9162 *msg
= make_buffer_string (BEG
, Z
, 1);
9169 /* Push the current message on Vmessage_stack for later restauration
9170 by restore_message. Value is non-zero if the current message isn't
9171 empty. This is a relatively infrequent operation, so it's not
9172 worth optimizing. */
9178 msg
= current_message ();
9179 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9180 return STRINGP (msg
);
9184 /* Restore message display from the top of Vmessage_stack. */
9191 xassert (CONSP (Vmessage_stack
));
9192 msg
= XCAR (Vmessage_stack
);
9194 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9196 message3_nolog (msg
, 0, 0);
9200 /* Handler for record_unwind_protect calling pop_message. */
9203 pop_message_unwind (dummy
)
9210 /* Pop the top-most entry off Vmessage_stack. */
9215 xassert (CONSP (Vmessage_stack
));
9216 Vmessage_stack
= XCDR (Vmessage_stack
);
9220 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9221 exits. If the stack is not empty, we have a missing pop_message
9225 check_message_stack ()
9227 if (!NILP (Vmessage_stack
))
9232 /* Truncate to NCHARS what will be displayed in the echo area the next
9233 time we display it---but don't redisplay it now. */
9236 truncate_echo_area (nchars
)
9240 echo_area_buffer
[0] = Qnil
;
9241 /* A null message buffer means that the frame hasn't really been
9242 initialized yet. Error messages get reported properly by
9243 cmd_error, so this must be just an informative message; toss it. */
9244 else if (!noninteractive
9246 && !NILP (echo_area_buffer
[0]))
9248 struct frame
*sf
= SELECTED_FRAME ();
9249 if (FRAME_MESSAGE_BUF (sf
))
9250 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9255 /* Helper function for truncate_echo_area. Truncate the current
9256 message to at most NCHARS characters. */
9259 truncate_message_1 (nchars
, a2
, a3
, a4
)
9264 if (BEG
+ nchars
< Z
)
9265 del_range (BEG
+ nchars
, Z
);
9267 echo_area_buffer
[0] = Qnil
;
9272 /* Set the current message to a substring of S or STRING.
9274 If STRING is a Lisp string, set the message to the first NBYTES
9275 bytes from STRING. NBYTES zero means use the whole string. If
9276 STRING is multibyte, the message will be displayed multibyte.
9278 If S is not null, set the message to the first LEN bytes of S. LEN
9279 zero means use the whole string. MULTIBYTE_P non-zero means S is
9280 multibyte. Display the message multibyte in that case.
9282 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9283 to t before calling set_message_1 (which calls insert).
9287 set_message (s
, string
, nbytes
, multibyte_p
)
9290 int nbytes
, multibyte_p
;
9292 message_enable_multibyte
9293 = ((s
&& multibyte_p
)
9294 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9296 with_echo_area_buffer (0, -1, set_message_1
,
9297 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9298 message_buf_print
= 0;
9299 help_echo_showing_p
= 0;
9303 /* Helper function for set_message. Arguments have the same meaning
9304 as there, with A1 corresponding to S and A2 corresponding to STRING
9305 This function is called with the echo area buffer being
9309 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9312 EMACS_INT nbytes
, multibyte_p
;
9314 const char *s
= (const char *) a1
;
9315 Lisp_Object string
= a2
;
9317 /* Change multibyteness of the echo buffer appropriately. */
9318 if (message_enable_multibyte
9319 != !NILP (current_buffer
->enable_multibyte_characters
))
9320 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9322 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9324 /* Insert new message at BEG. */
9325 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9327 if (STRINGP (string
))
9332 nbytes
= SBYTES (string
);
9333 nchars
= string_byte_to_char (string
, nbytes
);
9335 /* This function takes care of single/multibyte conversion. We
9336 just have to ensure that the echo area buffer has the right
9337 setting of enable_multibyte_characters. */
9338 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9343 nbytes
= strlen (s
);
9345 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9347 /* Convert from multi-byte to single-byte. */
9349 unsigned char work
[1];
9351 /* Convert a multibyte string to single-byte. */
9352 for (i
= 0; i
< nbytes
; i
+= n
)
9354 c
= string_char_and_length (s
+ i
, &n
);
9355 work
[0] = (ASCII_CHAR_P (c
)
9357 : multibyte_char_to_unibyte (c
, Qnil
));
9358 insert_1_both (work
, 1, 1, 1, 0, 0);
9361 else if (!multibyte_p
9362 && !NILP (current_buffer
->enable_multibyte_characters
))
9364 /* Convert from single-byte to multi-byte. */
9366 const unsigned char *msg
= (const unsigned char *) s
;
9367 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9369 /* Convert a single-byte string to multibyte. */
9370 for (i
= 0; i
< nbytes
; i
++)
9373 MAKE_CHAR_MULTIBYTE (c
);
9374 n
= CHAR_STRING (c
, str
);
9375 insert_1_both (str
, 1, n
, 1, 0, 0);
9379 insert_1 (s
, nbytes
, 1, 0, 0);
9386 /* Clear messages. CURRENT_P non-zero means clear the current
9387 message. LAST_DISPLAYED_P non-zero means clear the message
9391 clear_message (current_p
, last_displayed_p
)
9392 int current_p
, last_displayed_p
;
9396 echo_area_buffer
[0] = Qnil
;
9397 message_cleared_p
= 1;
9400 if (last_displayed_p
)
9401 echo_area_buffer
[1] = Qnil
;
9403 message_buf_print
= 0;
9406 /* Clear garbaged frames.
9408 This function is used where the old redisplay called
9409 redraw_garbaged_frames which in turn called redraw_frame which in
9410 turn called clear_frame. The call to clear_frame was a source of
9411 flickering. I believe a clear_frame is not necessary. It should
9412 suffice in the new redisplay to invalidate all current matrices,
9413 and ensure a complete redisplay of all windows. */
9416 clear_garbaged_frames ()
9420 Lisp_Object tail
, frame
;
9421 int changed_count
= 0;
9423 FOR_EACH_FRAME (tail
, frame
)
9425 struct frame
*f
= XFRAME (frame
);
9427 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9431 Fredraw_frame (frame
);
9432 f
->force_flush_display_p
= 1;
9434 clear_current_matrices (f
);
9443 ++windows_or_buffers_changed
;
9448 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9449 is non-zero update selected_frame. Value is non-zero if the
9450 mini-windows height has been changed. */
9453 echo_area_display (update_frame_p
)
9456 Lisp_Object mini_window
;
9459 int window_height_changed_p
= 0;
9460 struct frame
*sf
= SELECTED_FRAME ();
9462 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9463 w
= XWINDOW (mini_window
);
9464 f
= XFRAME (WINDOW_FRAME (w
));
9466 /* Don't display if frame is invisible or not yet initialized. */
9467 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9470 #ifdef HAVE_WINDOW_SYSTEM
9471 /* When Emacs starts, selected_frame may be the initial terminal
9472 frame. If we let this through, a message would be displayed on
9474 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9476 #endif /* HAVE_WINDOW_SYSTEM */
9478 /* Redraw garbaged frames. */
9480 clear_garbaged_frames ();
9482 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9484 echo_area_window
= mini_window
;
9485 window_height_changed_p
= display_echo_area (w
);
9486 w
->must_be_updated_p
= 1;
9488 /* Update the display, unless called from redisplay_internal.
9489 Also don't update the screen during redisplay itself. The
9490 update will happen at the end of redisplay, and an update
9491 here could cause confusion. */
9492 if (update_frame_p
&& !redisplaying_p
)
9496 /* If the display update has been interrupted by pending
9497 input, update mode lines in the frame. Due to the
9498 pending input, it might have been that redisplay hasn't
9499 been called, so that mode lines above the echo area are
9500 garbaged. This looks odd, so we prevent it here. */
9501 if (!display_completed
)
9502 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9504 if (window_height_changed_p
9505 /* Don't do this if Emacs is shutting down. Redisplay
9506 needs to run hooks. */
9507 && !NILP (Vrun_hooks
))
9509 /* Must update other windows. Likewise as in other
9510 cases, don't let this update be interrupted by
9512 int count
= SPECPDL_INDEX ();
9513 specbind (Qredisplay_dont_pause
, Qt
);
9514 windows_or_buffers_changed
= 1;
9515 redisplay_internal (0);
9516 unbind_to (count
, Qnil
);
9518 else if (FRAME_WINDOW_P (f
) && n
== 0)
9520 /* Window configuration is the same as before.
9521 Can do with a display update of the echo area,
9522 unless we displayed some mode lines. */
9523 update_single_window (w
, 1);
9524 FRAME_RIF (f
)->flush_display (f
);
9527 update_frame (f
, 1, 1);
9529 /* If cursor is in the echo area, make sure that the next
9530 redisplay displays the minibuffer, so that the cursor will
9531 be replaced with what the minibuffer wants. */
9532 if (cursor_in_echo_area
)
9533 ++windows_or_buffers_changed
;
9536 else if (!EQ (mini_window
, selected_window
))
9537 windows_or_buffers_changed
++;
9539 /* Last displayed message is now the current message. */
9540 echo_area_buffer
[1] = echo_area_buffer
[0];
9541 /* Inform read_char that we're not echoing. */
9542 echo_message_buffer
= Qnil
;
9544 /* Prevent redisplay optimization in redisplay_internal by resetting
9545 this_line_start_pos. This is done because the mini-buffer now
9546 displays the message instead of its buffer text. */
9547 if (EQ (mini_window
, selected_window
))
9548 CHARPOS (this_line_start_pos
) = 0;
9550 return window_height_changed_p
;
9555 /***********************************************************************
9556 Mode Lines and Frame Titles
9557 ***********************************************************************/
9559 /* A buffer for constructing non-propertized mode-line strings and
9560 frame titles in it; allocated from the heap in init_xdisp and
9561 resized as needed in store_mode_line_noprop_char. */
9563 static char *mode_line_noprop_buf
;
9565 /* The buffer's end, and a current output position in it. */
9567 static char *mode_line_noprop_buf_end
;
9568 static char *mode_line_noprop_ptr
;
9570 #define MODE_LINE_NOPROP_LEN(start) \
9571 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9574 MODE_LINE_DISPLAY
= 0,
9580 /* Alist that caches the results of :propertize.
9581 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9582 static Lisp_Object mode_line_proptrans_alist
;
9584 /* List of strings making up the mode-line. */
9585 static Lisp_Object mode_line_string_list
;
9587 /* Base face property when building propertized mode line string. */
9588 static Lisp_Object mode_line_string_face
;
9589 static Lisp_Object mode_line_string_face_prop
;
9592 /* Unwind data for mode line strings */
9594 static Lisp_Object Vmode_line_unwind_vector
;
9597 format_mode_line_unwind_data (struct buffer
*obuf
,
9601 Lisp_Object vector
, tmp
;
9603 /* Reduce consing by keeping one vector in
9604 Vwith_echo_area_save_vector. */
9605 vector
= Vmode_line_unwind_vector
;
9606 Vmode_line_unwind_vector
= Qnil
;
9609 vector
= Fmake_vector (make_number (8), Qnil
);
9611 ASET (vector
, 0, make_number (mode_line_target
));
9612 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9613 ASET (vector
, 2, mode_line_string_list
);
9614 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9615 ASET (vector
, 4, mode_line_string_face
);
9616 ASET (vector
, 5, mode_line_string_face_prop
);
9619 XSETBUFFER (tmp
, obuf
);
9622 ASET (vector
, 6, tmp
);
9623 ASET (vector
, 7, owin
);
9629 unwind_format_mode_line (vector
)
9632 mode_line_target
= XINT (AREF (vector
, 0));
9633 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9634 mode_line_string_list
= AREF (vector
, 2);
9635 if (! EQ (AREF (vector
, 3), Qt
))
9636 mode_line_proptrans_alist
= AREF (vector
, 3);
9637 mode_line_string_face
= AREF (vector
, 4);
9638 mode_line_string_face_prop
= AREF (vector
, 5);
9640 if (!NILP (AREF (vector
, 7)))
9641 /* Select window before buffer, since it may change the buffer. */
9642 Fselect_window (AREF (vector
, 7), Qt
);
9644 if (!NILP (AREF (vector
, 6)))
9646 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9647 ASET (vector
, 6, Qnil
);
9650 Vmode_line_unwind_vector
= vector
;
9655 /* Store a single character C for the frame title in mode_line_noprop_buf.
9656 Re-allocate mode_line_noprop_buf if necessary. */
9660 store_mode_line_noprop_char (char c
)
9662 store_mode_line_noprop_char (c
)
9666 /* If output position has reached the end of the allocated buffer,
9667 double the buffer's size. */
9668 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9670 int len
= MODE_LINE_NOPROP_LEN (0);
9671 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9672 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9673 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9674 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9677 *mode_line_noprop_ptr
++ = c
;
9681 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9682 mode_line_noprop_ptr. STR is the string to store. Do not copy
9683 characters that yield more columns than PRECISION; PRECISION <= 0
9684 means copy the whole string. Pad with spaces until FIELD_WIDTH
9685 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9686 pad. Called from display_mode_element when it is used to build a
9690 store_mode_line_noprop (str
, field_width
, precision
)
9691 const unsigned char *str
;
9692 int field_width
, precision
;
9697 /* Copy at most PRECISION chars from STR. */
9698 nbytes
= strlen (str
);
9699 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9701 store_mode_line_noprop_char (*str
++);
9703 /* Fill up with spaces until FIELD_WIDTH reached. */
9704 while (field_width
> 0
9707 store_mode_line_noprop_char (' ');
9714 /***********************************************************************
9716 ***********************************************************************/
9718 #ifdef HAVE_WINDOW_SYSTEM
9720 /* Set the title of FRAME, if it has changed. The title format is
9721 Vicon_title_format if FRAME is iconified, otherwise it is
9722 frame_title_format. */
9725 x_consider_frame_title (frame
)
9728 struct frame
*f
= XFRAME (frame
);
9730 if (FRAME_WINDOW_P (f
)
9731 || FRAME_MINIBUF_ONLY_P (f
)
9732 || f
->explicit_name
)
9734 /* Do we have more than one visible frame on this X display? */
9741 int count
= SPECPDL_INDEX ();
9743 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9745 Lisp_Object other_frame
= XCAR (tail
);
9746 struct frame
*tf
= XFRAME (other_frame
);
9749 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9750 && !FRAME_MINIBUF_ONLY_P (tf
)
9751 && !EQ (other_frame
, tip_frame
)
9752 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9756 /* Set global variable indicating that multiple frames exist. */
9757 multiple_frames
= CONSP (tail
);
9759 /* Switch to the buffer of selected window of the frame. Set up
9760 mode_line_target so that display_mode_element will output into
9761 mode_line_noprop_buf; then display the title. */
9762 record_unwind_protect (unwind_format_mode_line
,
9763 format_mode_line_unwind_data
9764 (current_buffer
, selected_window
, 0));
9766 Fselect_window (f
->selected_window
, Qt
);
9767 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9768 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9770 mode_line_target
= MODE_LINE_TITLE
;
9771 title_start
= MODE_LINE_NOPROP_LEN (0);
9772 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9773 NULL
, DEFAULT_FACE_ID
);
9774 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9775 len
= MODE_LINE_NOPROP_LEN (title_start
);
9776 title
= mode_line_noprop_buf
+ title_start
;
9777 unbind_to (count
, Qnil
);
9779 /* Set the title only if it's changed. This avoids consing in
9780 the common case where it hasn't. (If it turns out that we've
9781 already wasted too much time by walking through the list with
9782 display_mode_element, then we might need to optimize at a
9783 higher level than this.) */
9784 if (! STRINGP (f
->name
)
9785 || SBYTES (f
->name
) != len
9786 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9791 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9794 ns_set_name_as_filename (f
);
9796 x_implicitly_set_name (f
, make_string(title
, len
),
9802 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9807 /* do this also for frames with explicit names */
9808 ns_implicitly_set_icon_type(f
);
9809 ns_set_doc_edited(f
, Fbuffer_modified_p
9810 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9816 #endif /* not HAVE_WINDOW_SYSTEM */
9821 /***********************************************************************
9823 ***********************************************************************/
9826 /* Prepare for redisplay by updating menu-bar item lists when
9827 appropriate. This can call eval. */
9830 prepare_menu_bars ()
9833 struct gcpro gcpro1
, gcpro2
;
9835 Lisp_Object tooltip_frame
;
9837 #ifdef HAVE_WINDOW_SYSTEM
9838 tooltip_frame
= tip_frame
;
9840 tooltip_frame
= Qnil
;
9843 /* Update all frame titles based on their buffer names, etc. We do
9844 this before the menu bars so that the buffer-menu will show the
9845 up-to-date frame titles. */
9846 #ifdef HAVE_WINDOW_SYSTEM
9847 if (windows_or_buffers_changed
|| update_mode_lines
)
9849 Lisp_Object tail
, frame
;
9851 FOR_EACH_FRAME (tail
, frame
)
9854 if (!EQ (frame
, tooltip_frame
)
9855 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9856 x_consider_frame_title (frame
);
9859 #endif /* HAVE_WINDOW_SYSTEM */
9861 /* Update the menu bar item lists, if appropriate. This has to be
9862 done before any actual redisplay or generation of display lines. */
9863 all_windows
= (update_mode_lines
9864 || buffer_shared
> 1
9865 || windows_or_buffers_changed
);
9868 Lisp_Object tail
, frame
;
9869 int count
= SPECPDL_INDEX ();
9870 /* 1 means that update_menu_bar has run its hooks
9871 so any further calls to update_menu_bar shouldn't do so again. */
9872 int menu_bar_hooks_run
= 0;
9874 record_unwind_save_match_data ();
9876 FOR_EACH_FRAME (tail
, frame
)
9880 /* Ignore tooltip frame. */
9881 if (EQ (frame
, tooltip_frame
))
9884 /* If a window on this frame changed size, report that to
9885 the user and clear the size-change flag. */
9886 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9888 Lisp_Object functions
;
9890 /* Clear flag first in case we get an error below. */
9891 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9892 functions
= Vwindow_size_change_functions
;
9893 GCPRO2 (tail
, functions
);
9895 while (CONSP (functions
))
9897 if (!EQ (XCAR (functions
), Qt
))
9898 call1 (XCAR (functions
), frame
);
9899 functions
= XCDR (functions
);
9905 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9906 #ifdef HAVE_WINDOW_SYSTEM
9907 update_tool_bar (f
, 0);
9912 unbind_to (count
, Qnil
);
9916 struct frame
*sf
= SELECTED_FRAME ();
9917 update_menu_bar (sf
, 1, 0);
9918 #ifdef HAVE_WINDOW_SYSTEM
9919 update_tool_bar (sf
, 1);
9923 /* Motif needs this. See comment in xmenu.c. Turn it off when
9924 pending_menu_activation is not defined. */
9925 #ifdef USE_X_TOOLKIT
9926 pending_menu_activation
= 0;
9931 /* Update the menu bar item list for frame F. This has to be done
9932 before we start to fill in any display lines, because it can call
9935 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9937 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9938 already ran the menu bar hooks for this redisplay, so there
9939 is no need to run them again. The return value is the
9940 updated value of this flag, to pass to the next call. */
9943 update_menu_bar (f
, save_match_data
, hooks_run
)
9945 int save_match_data
;
9949 register struct window
*w
;
9951 /* If called recursively during a menu update, do nothing. This can
9952 happen when, for instance, an activate-menubar-hook causes a
9954 if (inhibit_menubar_update
)
9957 window
= FRAME_SELECTED_WINDOW (f
);
9958 w
= XWINDOW (window
);
9960 if (FRAME_WINDOW_P (f
)
9962 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9963 || defined (HAVE_NS) || defined (USE_GTK)
9964 FRAME_EXTERNAL_MENU_BAR (f
)
9966 FRAME_MENU_BAR_LINES (f
) > 0
9968 : FRAME_MENU_BAR_LINES (f
) > 0)
9970 /* If the user has switched buffers or windows, we need to
9971 recompute to reflect the new bindings. But we'll
9972 recompute when update_mode_lines is set too; that means
9973 that people can use force-mode-line-update to request
9974 that the menu bar be recomputed. The adverse effect on
9975 the rest of the redisplay algorithm is about the same as
9976 windows_or_buffers_changed anyway. */
9977 if (windows_or_buffers_changed
9978 /* This used to test w->update_mode_line, but we believe
9979 there is no need to recompute the menu in that case. */
9980 || update_mode_lines
9981 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9982 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9983 != !NILP (w
->last_had_star
))
9984 || ((!NILP (Vtransient_mark_mode
)
9985 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9986 != !NILP (w
->region_showing
)))
9988 struct buffer
*prev
= current_buffer
;
9989 int count
= SPECPDL_INDEX ();
9991 specbind (Qinhibit_menubar_update
, Qt
);
9993 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9994 if (save_match_data
)
9995 record_unwind_save_match_data ();
9996 if (NILP (Voverriding_local_map_menu_flag
))
9998 specbind (Qoverriding_terminal_local_map
, Qnil
);
9999 specbind (Qoverriding_local_map
, Qnil
);
10004 /* Run the Lucid hook. */
10005 safe_run_hooks (Qactivate_menubar_hook
);
10007 /* If it has changed current-menubar from previous value,
10008 really recompute the menu-bar from the value. */
10009 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10010 call0 (Qrecompute_lucid_menubar
);
10012 safe_run_hooks (Qmenu_bar_update_hook
);
10017 XSETFRAME (Vmenu_updating_frame
, f
);
10018 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10020 /* Redisplay the menu bar in case we changed it. */
10021 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10022 || defined (HAVE_NS) || defined (USE_GTK)
10023 if (FRAME_WINDOW_P (f
))
10025 #if defined (HAVE_NS)
10026 /* All frames on Mac OS share the same menubar. So only
10027 the selected frame should be allowed to set it. */
10028 if (f
== SELECTED_FRAME ())
10030 set_frame_menubar (f
, 0, 0);
10033 /* On a terminal screen, the menu bar is an ordinary screen
10034 line, and this makes it get updated. */
10035 w
->update_mode_line
= Qt
;
10036 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10037 /* In the non-toolkit version, the menu bar is an ordinary screen
10038 line, and this makes it get updated. */
10039 w
->update_mode_line
= Qt
;
10040 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10042 unbind_to (count
, Qnil
);
10043 set_buffer_internal_1 (prev
);
10052 /***********************************************************************
10054 ***********************************************************************/
10056 #ifdef HAVE_WINDOW_SYSTEM
10059 Nominal cursor position -- where to draw output.
10060 HPOS and VPOS are window relative glyph matrix coordinates.
10061 X and Y are window relative pixel coordinates. */
10063 struct cursor_pos output_cursor
;
10067 Set the global variable output_cursor to CURSOR. All cursor
10068 positions are relative to updated_window. */
10071 set_output_cursor (cursor
)
10072 struct cursor_pos
*cursor
;
10074 output_cursor
.hpos
= cursor
->hpos
;
10075 output_cursor
.vpos
= cursor
->vpos
;
10076 output_cursor
.x
= cursor
->x
;
10077 output_cursor
.y
= cursor
->y
;
10082 Set a nominal cursor position.
10084 HPOS and VPOS are column/row positions in a window glyph matrix. X
10085 and Y are window text area relative pixel positions.
10087 If this is done during an update, updated_window will contain the
10088 window that is being updated and the position is the future output
10089 cursor position for that window. If updated_window is null, use
10090 selected_window and display the cursor at the given position. */
10093 x_cursor_to (vpos
, hpos
, y
, x
)
10094 int vpos
, hpos
, y
, x
;
10098 /* If updated_window is not set, work on selected_window. */
10099 if (updated_window
)
10100 w
= updated_window
;
10102 w
= XWINDOW (selected_window
);
10104 /* Set the output cursor. */
10105 output_cursor
.hpos
= hpos
;
10106 output_cursor
.vpos
= vpos
;
10107 output_cursor
.x
= x
;
10108 output_cursor
.y
= y
;
10110 /* If not called as part of an update, really display the cursor.
10111 This will also set the cursor position of W. */
10112 if (updated_window
== NULL
)
10115 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10116 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10117 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10122 #endif /* HAVE_WINDOW_SYSTEM */
10125 /***********************************************************************
10127 ***********************************************************************/
10129 #ifdef HAVE_WINDOW_SYSTEM
10131 /* Where the mouse was last time we reported a mouse event. */
10133 FRAME_PTR last_mouse_frame
;
10135 /* Tool-bar item index of the item on which a mouse button was pressed
10138 int last_tool_bar_item
;
10142 update_tool_bar_unwind (frame
)
10145 selected_frame
= frame
;
10149 /* Update the tool-bar item list for frame F. This has to be done
10150 before we start to fill in any display lines. Called from
10151 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10152 and restore it here. */
10155 update_tool_bar (f
, save_match_data
)
10157 int save_match_data
;
10159 #if defined (USE_GTK) || defined (HAVE_NS)
10160 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10162 int do_update
= WINDOWP (f
->tool_bar_window
)
10163 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10168 Lisp_Object window
;
10171 window
= FRAME_SELECTED_WINDOW (f
);
10172 w
= XWINDOW (window
);
10174 /* If the user has switched buffers or windows, we need to
10175 recompute to reflect the new bindings. But we'll
10176 recompute when update_mode_lines is set too; that means
10177 that people can use force-mode-line-update to request
10178 that the menu bar be recomputed. The adverse effect on
10179 the rest of the redisplay algorithm is about the same as
10180 windows_or_buffers_changed anyway. */
10181 if (windows_or_buffers_changed
10182 || !NILP (w
->update_mode_line
)
10183 || update_mode_lines
10184 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10185 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10186 != !NILP (w
->last_had_star
))
10187 || ((!NILP (Vtransient_mark_mode
)
10188 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10189 != !NILP (w
->region_showing
)))
10191 struct buffer
*prev
= current_buffer
;
10192 int count
= SPECPDL_INDEX ();
10193 Lisp_Object frame
, new_tool_bar
;
10194 int new_n_tool_bar
;
10195 struct gcpro gcpro1
;
10197 /* Set current_buffer to the buffer of the selected
10198 window of the frame, so that we get the right local
10200 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10202 /* Save match data, if we must. */
10203 if (save_match_data
)
10204 record_unwind_save_match_data ();
10206 /* Make sure that we don't accidentally use bogus keymaps. */
10207 if (NILP (Voverriding_local_map_menu_flag
))
10209 specbind (Qoverriding_terminal_local_map
, Qnil
);
10210 specbind (Qoverriding_local_map
, Qnil
);
10213 GCPRO1 (new_tool_bar
);
10215 /* We must temporarily set the selected frame to this frame
10216 before calling tool_bar_items, because the calculation of
10217 the tool-bar keymap uses the selected frame (see
10218 `tool-bar-make-keymap' in tool-bar.el). */
10219 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10220 XSETFRAME (frame
, f
);
10221 selected_frame
= frame
;
10223 /* Build desired tool-bar items from keymaps. */
10224 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10227 /* Redisplay the tool-bar if we changed it. */
10228 if (new_n_tool_bar
!= f
->n_tool_bar_items
10229 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10231 /* Redisplay that happens asynchronously due to an expose event
10232 may access f->tool_bar_items. Make sure we update both
10233 variables within BLOCK_INPUT so no such event interrupts. */
10235 f
->tool_bar_items
= new_tool_bar
;
10236 f
->n_tool_bar_items
= new_n_tool_bar
;
10237 w
->update_mode_line
= Qt
;
10243 unbind_to (count
, Qnil
);
10244 set_buffer_internal_1 (prev
);
10250 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10251 F's desired tool-bar contents. F->tool_bar_items must have
10252 been set up previously by calling prepare_menu_bars. */
10255 build_desired_tool_bar_string (f
)
10258 int i
, size
, size_needed
;
10259 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10260 Lisp_Object image
, plist
, props
;
10262 image
= plist
= props
= Qnil
;
10263 GCPRO3 (image
, plist
, props
);
10265 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10266 Otherwise, make a new string. */
10268 /* The size of the string we might be able to reuse. */
10269 size
= (STRINGP (f
->desired_tool_bar_string
)
10270 ? SCHARS (f
->desired_tool_bar_string
)
10273 /* We need one space in the string for each image. */
10274 size_needed
= f
->n_tool_bar_items
;
10276 /* Reuse f->desired_tool_bar_string, if possible. */
10277 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10278 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10279 make_number (' '));
10282 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10283 Fremove_text_properties (make_number (0), make_number (size
),
10284 props
, f
->desired_tool_bar_string
);
10287 /* Put a `display' property on the string for the images to display,
10288 put a `menu_item' property on tool-bar items with a value that
10289 is the index of the item in F's tool-bar item vector. */
10290 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10292 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10294 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10295 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10296 int hmargin
, vmargin
, relief
, idx
, end
;
10297 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10299 /* If image is a vector, choose the image according to the
10301 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10302 if (VECTORP (image
))
10306 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10307 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10310 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10311 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10313 xassert (ASIZE (image
) >= idx
);
10314 image
= AREF (image
, idx
);
10319 /* Ignore invalid image specifications. */
10320 if (!valid_image_p (image
))
10323 /* Display the tool-bar button pressed, or depressed. */
10324 plist
= Fcopy_sequence (XCDR (image
));
10326 /* Compute margin and relief to draw. */
10327 relief
= (tool_bar_button_relief
>= 0
10328 ? tool_bar_button_relief
10329 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10330 hmargin
= vmargin
= relief
;
10332 if (INTEGERP (Vtool_bar_button_margin
)
10333 && XINT (Vtool_bar_button_margin
) > 0)
10335 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10336 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10338 else if (CONSP (Vtool_bar_button_margin
))
10340 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10341 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10342 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10344 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10345 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10346 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10349 if (auto_raise_tool_bar_buttons_p
)
10351 /* Add a `:relief' property to the image spec if the item is
10355 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10362 /* If image is selected, display it pressed, i.e. with a
10363 negative relief. If it's not selected, display it with a
10365 plist
= Fplist_put (plist
, QCrelief
,
10367 ? make_number (-relief
)
10368 : make_number (relief
)));
10373 /* Put a margin around the image. */
10374 if (hmargin
|| vmargin
)
10376 if (hmargin
== vmargin
)
10377 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10379 plist
= Fplist_put (plist
, QCmargin
,
10380 Fcons (make_number (hmargin
),
10381 make_number (vmargin
)));
10384 /* If button is not enabled, and we don't have special images
10385 for the disabled state, make the image appear disabled by
10386 applying an appropriate algorithm to it. */
10387 if (!enabled_p
&& idx
< 0)
10388 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10390 /* Put a `display' text property on the string for the image to
10391 display. Put a `menu-item' property on the string that gives
10392 the start of this item's properties in the tool-bar items
10394 image
= Fcons (Qimage
, plist
);
10395 props
= list4 (Qdisplay
, image
,
10396 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10398 /* Let the last image hide all remaining spaces in the tool bar
10399 string. The string can be longer than needed when we reuse a
10400 previous string. */
10401 if (i
+ 1 == f
->n_tool_bar_items
)
10402 end
= SCHARS (f
->desired_tool_bar_string
);
10405 Fadd_text_properties (make_number (i
), make_number (end
),
10406 props
, f
->desired_tool_bar_string
);
10414 /* Display one line of the tool-bar of frame IT->f.
10416 HEIGHT specifies the desired height of the tool-bar line.
10417 If the actual height of the glyph row is less than HEIGHT, the
10418 row's height is increased to HEIGHT, and the icons are centered
10419 vertically in the new height.
10421 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10422 count a final empty row in case the tool-bar width exactly matches
10427 display_tool_bar_line (it
, height
)
10431 struct glyph_row
*row
= it
->glyph_row
;
10432 int max_x
= it
->last_visible_x
;
10433 struct glyph
*last
;
10435 prepare_desired_row (row
);
10436 row
->y
= it
->current_y
;
10438 /* Note that this isn't made use of if the face hasn't a box,
10439 so there's no need to check the face here. */
10440 it
->start_of_box_run_p
= 1;
10442 while (it
->current_x
< max_x
)
10444 int x
, n_glyphs_before
, i
, nglyphs
;
10445 struct it it_before
;
10447 /* Get the next display element. */
10448 if (!get_next_display_element (it
))
10450 /* Don't count empty row if we are counting needed tool-bar lines. */
10451 if (height
< 0 && !it
->hpos
)
10456 /* Produce glyphs. */
10457 n_glyphs_before
= row
->used
[TEXT_AREA
];
10460 PRODUCE_GLYPHS (it
);
10462 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10464 x
= it_before
.current_x
;
10465 while (i
< nglyphs
)
10467 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10469 if (x
+ glyph
->pixel_width
> max_x
)
10471 /* Glyph doesn't fit on line. Backtrack. */
10472 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10474 /* If this is the only glyph on this line, it will never fit on the
10475 toolbar, so skip it. But ensure there is at least one glyph,
10476 so we don't accidentally disable the tool-bar. */
10477 if (n_glyphs_before
== 0
10478 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10484 x
+= glyph
->pixel_width
;
10488 /* Stop at line ends. */
10489 if (ITERATOR_AT_END_OF_LINE_P (it
))
10492 set_iterator_to_next (it
, 1);
10497 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10499 /* Use default face for the border below the tool bar.
10501 FIXME: When auto-resize-tool-bars is grow-only, there is
10502 no additional border below the possibly empty tool-bar lines.
10503 So to make the extra empty lines look "normal", we have to
10504 use the tool-bar face for the border too. */
10505 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10506 it
->face_id
= DEFAULT_FACE_ID
;
10508 extend_face_to_end_of_line (it
);
10509 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10510 last
->right_box_line_p
= 1;
10511 if (last
== row
->glyphs
[TEXT_AREA
])
10512 last
->left_box_line_p
= 1;
10514 /* Make line the desired height and center it vertically. */
10515 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10517 /* Don't add more than one line height. */
10518 height
%= FRAME_LINE_HEIGHT (it
->f
);
10519 it
->max_ascent
+= height
/ 2;
10520 it
->max_descent
+= (height
+ 1) / 2;
10523 compute_line_metrics (it
);
10525 /* If line is empty, make it occupy the rest of the tool-bar. */
10526 if (!row
->displays_text_p
)
10528 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10529 row
->visible_height
= row
->height
;
10530 row
->ascent
= row
->phys_ascent
= 0;
10531 row
->extra_line_spacing
= 0;
10534 row
->full_width_p
= 1;
10535 row
->continued_p
= 0;
10536 row
->truncated_on_left_p
= 0;
10537 row
->truncated_on_right_p
= 0;
10539 it
->current_x
= it
->hpos
= 0;
10540 it
->current_y
+= row
->height
;
10546 /* Max tool-bar height. */
10548 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10549 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10551 /* Value is the number of screen lines needed to make all tool-bar
10552 items of frame F visible. The number of actual rows needed is
10553 returned in *N_ROWS if non-NULL. */
10556 tool_bar_lines_needed (f
, n_rows
)
10560 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10562 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10563 the desired matrix, so use (unused) mode-line row as temporary row to
10564 avoid destroying the first tool-bar row. */
10565 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10567 /* Initialize an iterator for iteration over
10568 F->desired_tool_bar_string in the tool-bar window of frame F. */
10569 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10570 it
.first_visible_x
= 0;
10571 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10572 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10574 while (!ITERATOR_AT_END_P (&it
))
10576 clear_glyph_row (temp_row
);
10577 it
.glyph_row
= temp_row
;
10578 display_tool_bar_line (&it
, -1);
10580 clear_glyph_row (temp_row
);
10582 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10584 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10586 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10590 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10592 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10601 frame
= selected_frame
;
10603 CHECK_FRAME (frame
);
10604 f
= XFRAME (frame
);
10606 if (WINDOWP (f
->tool_bar_window
)
10607 || (w
= XWINDOW (f
->tool_bar_window
),
10608 WINDOW_TOTAL_LINES (w
) > 0))
10610 update_tool_bar (f
, 1);
10611 if (f
->n_tool_bar_items
)
10613 build_desired_tool_bar_string (f
);
10614 nlines
= tool_bar_lines_needed (f
, NULL
);
10618 return make_number (nlines
);
10622 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10623 height should be changed. */
10626 redisplay_tool_bar (f
)
10631 struct glyph_row
*row
;
10633 #if defined (USE_GTK) || defined (HAVE_NS)
10634 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10635 update_frame_tool_bar (f
);
10639 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10640 do anything. This means you must start with tool-bar-lines
10641 non-zero to get the auto-sizing effect. Or in other words, you
10642 can turn off tool-bars by specifying tool-bar-lines zero. */
10643 if (!WINDOWP (f
->tool_bar_window
)
10644 || (w
= XWINDOW (f
->tool_bar_window
),
10645 WINDOW_TOTAL_LINES (w
) == 0))
10648 /* Set up an iterator for the tool-bar window. */
10649 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10650 it
.first_visible_x
= 0;
10651 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10652 row
= it
.glyph_row
;
10654 /* Build a string that represents the contents of the tool-bar. */
10655 build_desired_tool_bar_string (f
);
10656 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10658 if (f
->n_tool_bar_rows
== 0)
10662 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10663 nlines
!= WINDOW_TOTAL_LINES (w
)))
10665 extern Lisp_Object Qtool_bar_lines
;
10667 int old_height
= WINDOW_TOTAL_LINES (w
);
10669 XSETFRAME (frame
, f
);
10670 Fmodify_frame_parameters (frame
,
10671 Fcons (Fcons (Qtool_bar_lines
,
10672 make_number (nlines
)),
10674 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10676 clear_glyph_matrix (w
->desired_matrix
);
10677 fonts_changed_p
= 1;
10683 /* Display as many lines as needed to display all tool-bar items. */
10685 if (f
->n_tool_bar_rows
> 0)
10687 int border
, rows
, height
, extra
;
10689 if (INTEGERP (Vtool_bar_border
))
10690 border
= XINT (Vtool_bar_border
);
10691 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10692 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10693 else if (EQ (Vtool_bar_border
, Qborder_width
))
10694 border
= f
->border_width
;
10700 rows
= f
->n_tool_bar_rows
;
10701 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10702 extra
= it
.last_visible_y
- border
- height
* rows
;
10704 while (it
.current_y
< it
.last_visible_y
)
10707 if (extra
> 0 && rows
-- > 0)
10709 h
= (extra
+ rows
- 1) / rows
;
10712 display_tool_bar_line (&it
, height
+ h
);
10717 while (it
.current_y
< it
.last_visible_y
)
10718 display_tool_bar_line (&it
, 0);
10721 /* It doesn't make much sense to try scrolling in the tool-bar
10722 window, so don't do it. */
10723 w
->desired_matrix
->no_scrolling_p
= 1;
10724 w
->must_be_updated_p
= 1;
10726 if (!NILP (Vauto_resize_tool_bars
))
10728 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10729 int change_height_p
= 0;
10731 /* If we couldn't display everything, change the tool-bar's
10732 height if there is room for more. */
10733 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10734 && it
.current_y
< max_tool_bar_height
)
10735 change_height_p
= 1;
10737 row
= it
.glyph_row
- 1;
10739 /* If there are blank lines at the end, except for a partially
10740 visible blank line at the end that is smaller than
10741 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10742 if (!row
->displays_text_p
10743 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10744 change_height_p
= 1;
10746 /* If row displays tool-bar items, but is partially visible,
10747 change the tool-bar's height. */
10748 if (row
->displays_text_p
10749 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10750 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10751 change_height_p
= 1;
10753 /* Resize windows as needed by changing the `tool-bar-lines'
10754 frame parameter. */
10755 if (change_height_p
)
10757 extern Lisp_Object Qtool_bar_lines
;
10759 int old_height
= WINDOW_TOTAL_LINES (w
);
10761 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10763 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10764 && !f
->minimize_tool_bar_window_p
)
10765 ? (nlines
> old_height
)
10766 : (nlines
!= old_height
));
10767 f
->minimize_tool_bar_window_p
= 0;
10769 if (change_height_p
)
10771 XSETFRAME (frame
, f
);
10772 Fmodify_frame_parameters (frame
,
10773 Fcons (Fcons (Qtool_bar_lines
,
10774 make_number (nlines
)),
10776 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10778 clear_glyph_matrix (w
->desired_matrix
);
10779 f
->n_tool_bar_rows
= nrows
;
10780 fonts_changed_p
= 1;
10787 f
->minimize_tool_bar_window_p
= 0;
10792 /* Get information about the tool-bar item which is displayed in GLYPH
10793 on frame F. Return in *PROP_IDX the index where tool-bar item
10794 properties start in F->tool_bar_items. Value is zero if
10795 GLYPH doesn't display a tool-bar item. */
10798 tool_bar_item_info (f
, glyph
, prop_idx
)
10800 struct glyph
*glyph
;
10807 /* This function can be called asynchronously, which means we must
10808 exclude any possibility that Fget_text_property signals an
10810 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10811 charpos
= max (0, charpos
);
10813 /* Get the text property `menu-item' at pos. The value of that
10814 property is the start index of this item's properties in
10815 F->tool_bar_items. */
10816 prop
= Fget_text_property (make_number (charpos
),
10817 Qmenu_item
, f
->current_tool_bar_string
);
10818 if (INTEGERP (prop
))
10820 *prop_idx
= XINT (prop
);
10830 /* Get information about the tool-bar item at position X/Y on frame F.
10831 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10832 the current matrix of the tool-bar window of F, or NULL if not
10833 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10834 item in F->tool_bar_items. Value is
10836 -1 if X/Y is not on a tool-bar item
10837 0 if X/Y is on the same item that was highlighted before.
10841 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10844 struct glyph
**glyph
;
10845 int *hpos
, *vpos
, *prop_idx
;
10847 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10848 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10851 /* Find the glyph under X/Y. */
10852 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10853 if (*glyph
== NULL
)
10856 /* Get the start of this tool-bar item's properties in
10857 f->tool_bar_items. */
10858 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10861 /* Is mouse on the highlighted item? */
10862 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10863 && *vpos
>= dpyinfo
->mouse_face_beg_row
10864 && *vpos
<= dpyinfo
->mouse_face_end_row
10865 && (*vpos
> dpyinfo
->mouse_face_beg_row
10866 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10867 && (*vpos
< dpyinfo
->mouse_face_end_row
10868 || *hpos
< dpyinfo
->mouse_face_end_col
10869 || dpyinfo
->mouse_face_past_end
))
10877 Handle mouse button event on the tool-bar of frame F, at
10878 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10879 0 for button release. MODIFIERS is event modifiers for button
10883 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10886 unsigned int modifiers
;
10888 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10889 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10890 int hpos
, vpos
, prop_idx
;
10891 struct glyph
*glyph
;
10892 Lisp_Object enabled_p
;
10894 /* If not on the highlighted tool-bar item, return. */
10895 frame_to_window_pixel_xy (w
, &x
, &y
);
10896 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10899 /* If item is disabled, do nothing. */
10900 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10901 if (NILP (enabled_p
))
10906 /* Show item in pressed state. */
10907 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10908 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10909 last_tool_bar_item
= prop_idx
;
10913 Lisp_Object key
, frame
;
10914 struct input_event event
;
10915 EVENT_INIT (event
);
10917 /* Show item in released state. */
10918 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10919 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10921 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10923 XSETFRAME (frame
, f
);
10924 event
.kind
= TOOL_BAR_EVENT
;
10925 event
.frame_or_window
= frame
;
10927 kbd_buffer_store_event (&event
);
10929 event
.kind
= TOOL_BAR_EVENT
;
10930 event
.frame_or_window
= frame
;
10932 event
.modifiers
= modifiers
;
10933 kbd_buffer_store_event (&event
);
10934 last_tool_bar_item
= -1;
10939 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10940 tool-bar window-relative coordinates X/Y. Called from
10941 note_mouse_highlight. */
10944 note_tool_bar_highlight (f
, x
, y
)
10948 Lisp_Object window
= f
->tool_bar_window
;
10949 struct window
*w
= XWINDOW (window
);
10950 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10952 struct glyph
*glyph
;
10953 struct glyph_row
*row
;
10955 Lisp_Object enabled_p
;
10957 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10958 int mouse_down_p
, rc
;
10960 /* Function note_mouse_highlight is called with negative x(y
10961 values when mouse moves outside of the frame. */
10962 if (x
<= 0 || y
<= 0)
10964 clear_mouse_face (dpyinfo
);
10968 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10971 /* Not on tool-bar item. */
10972 clear_mouse_face (dpyinfo
);
10976 /* On same tool-bar item as before. */
10977 goto set_help_echo
;
10979 clear_mouse_face (dpyinfo
);
10981 /* Mouse is down, but on different tool-bar item? */
10982 mouse_down_p
= (dpyinfo
->grabbed
10983 && f
== last_mouse_frame
10984 && FRAME_LIVE_P (f
));
10986 && last_tool_bar_item
!= prop_idx
)
10989 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10990 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10992 /* If tool-bar item is not enabled, don't highlight it. */
10993 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10994 if (!NILP (enabled_p
))
10996 /* Compute the x-position of the glyph. In front and past the
10997 image is a space. We include this in the highlighted area. */
10998 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10999 for (i
= x
= 0; i
< hpos
; ++i
)
11000 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11002 /* Record this as the current active region. */
11003 dpyinfo
->mouse_face_beg_col
= hpos
;
11004 dpyinfo
->mouse_face_beg_row
= vpos
;
11005 dpyinfo
->mouse_face_beg_x
= x
;
11006 dpyinfo
->mouse_face_beg_y
= row
->y
;
11007 dpyinfo
->mouse_face_past_end
= 0;
11009 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
11010 dpyinfo
->mouse_face_end_row
= vpos
;
11011 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11012 dpyinfo
->mouse_face_end_y
= row
->y
;
11013 dpyinfo
->mouse_face_window
= window
;
11014 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11016 /* Display it as active. */
11017 show_mouse_face (dpyinfo
, draw
);
11018 dpyinfo
->mouse_face_image_state
= draw
;
11023 /* Set help_echo_string to a help string to display for this tool-bar item.
11024 XTread_socket does the rest. */
11025 help_echo_object
= help_echo_window
= Qnil
;
11026 help_echo_pos
= -1;
11027 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11028 if (NILP (help_echo_string
))
11029 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11032 #endif /* HAVE_WINDOW_SYSTEM */
11036 /************************************************************************
11037 Horizontal scrolling
11038 ************************************************************************/
11040 static int hscroll_window_tree
P_ ((Lisp_Object
));
11041 static int hscroll_windows
P_ ((Lisp_Object
));
11043 /* For all leaf windows in the window tree rooted at WINDOW, set their
11044 hscroll value so that PT is (i) visible in the window, and (ii) so
11045 that it is not within a certain margin at the window's left and
11046 right border. Value is non-zero if any window's hscroll has been
11050 hscroll_window_tree (window
)
11051 Lisp_Object window
;
11053 int hscrolled_p
= 0;
11054 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11055 int hscroll_step_abs
= 0;
11056 double hscroll_step_rel
= 0;
11058 if (hscroll_relative_p
)
11060 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11061 if (hscroll_step_rel
< 0)
11063 hscroll_relative_p
= 0;
11064 hscroll_step_abs
= 0;
11067 else if (INTEGERP (Vhscroll_step
))
11069 hscroll_step_abs
= XINT (Vhscroll_step
);
11070 if (hscroll_step_abs
< 0)
11071 hscroll_step_abs
= 0;
11074 hscroll_step_abs
= 0;
11076 while (WINDOWP (window
))
11078 struct window
*w
= XWINDOW (window
);
11080 if (WINDOWP (w
->hchild
))
11081 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11082 else if (WINDOWP (w
->vchild
))
11083 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11084 else if (w
->cursor
.vpos
>= 0)
11087 int text_area_width
;
11088 struct glyph_row
*current_cursor_row
11089 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11090 struct glyph_row
*desired_cursor_row
11091 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11092 struct glyph_row
*cursor_row
11093 = (desired_cursor_row
->enabled_p
11094 ? desired_cursor_row
11095 : current_cursor_row
);
11097 text_area_width
= window_box_width (w
, TEXT_AREA
);
11099 /* Scroll when cursor is inside this scroll margin. */
11100 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11102 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11103 && ((XFASTINT (w
->hscroll
)
11104 && w
->cursor
.x
<= h_margin
)
11105 || (cursor_row
->enabled_p
11106 && cursor_row
->truncated_on_right_p
11107 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11111 struct buffer
*saved_current_buffer
;
11115 /* Find point in a display of infinite width. */
11116 saved_current_buffer
= current_buffer
;
11117 current_buffer
= XBUFFER (w
->buffer
);
11119 if (w
== XWINDOW (selected_window
))
11120 pt
= BUF_PT (current_buffer
);
11123 pt
= marker_position (w
->pointm
);
11124 pt
= max (BEGV
, pt
);
11128 /* Move iterator to pt starting at cursor_row->start in
11129 a line with infinite width. */
11130 init_to_row_start (&it
, w
, cursor_row
);
11131 it
.last_visible_x
= INFINITY
;
11132 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11133 current_buffer
= saved_current_buffer
;
11135 /* Position cursor in window. */
11136 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11137 hscroll
= max (0, (it
.current_x
11138 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11139 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11140 : (text_area_width
/ 2))))
11141 / FRAME_COLUMN_WIDTH (it
.f
);
11142 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11144 if (hscroll_relative_p
)
11145 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11148 wanted_x
= text_area_width
11149 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11152 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11156 if (hscroll_relative_p
)
11157 wanted_x
= text_area_width
* hscroll_step_rel
11160 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11163 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11165 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11167 /* Don't call Fset_window_hscroll if value hasn't
11168 changed because it will prevent redisplay
11170 if (XFASTINT (w
->hscroll
) != hscroll
)
11172 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11173 w
->hscroll
= make_number (hscroll
);
11182 /* Value is non-zero if hscroll of any leaf window has been changed. */
11183 return hscrolled_p
;
11187 /* Set hscroll so that cursor is visible and not inside horizontal
11188 scroll margins for all windows in the tree rooted at WINDOW. See
11189 also hscroll_window_tree above. Value is non-zero if any window's
11190 hscroll has been changed. If it has, desired matrices on the frame
11191 of WINDOW are cleared. */
11194 hscroll_windows (window
)
11195 Lisp_Object window
;
11197 int hscrolled_p
= hscroll_window_tree (window
);
11199 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11200 return hscrolled_p
;
11205 /************************************************************************
11207 ************************************************************************/
11209 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11210 to a non-zero value. This is sometimes handy to have in a debugger
11215 /* First and last unchanged row for try_window_id. */
11217 int debug_first_unchanged_at_end_vpos
;
11218 int debug_last_unchanged_at_beg_vpos
;
11220 /* Delta vpos and y. */
11222 int debug_dvpos
, debug_dy
;
11224 /* Delta in characters and bytes for try_window_id. */
11226 int debug_delta
, debug_delta_bytes
;
11228 /* Values of window_end_pos and window_end_vpos at the end of
11231 EMACS_INT debug_end_pos
, debug_end_vpos
;
11233 /* Append a string to W->desired_matrix->method. FMT is a printf
11234 format string. A1...A9 are a supplement for a variable-length
11235 argument list. If trace_redisplay_p is non-zero also printf the
11236 resulting string to stderr. */
11239 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11242 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11245 char *method
= w
->desired_matrix
->method
;
11246 int len
= strlen (method
);
11247 int size
= sizeof w
->desired_matrix
->method
;
11248 int remaining
= size
- len
- 1;
11250 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11251 if (len
&& remaining
)
11254 --remaining
, ++len
;
11257 strncpy (method
+ len
, buffer
, remaining
);
11259 if (trace_redisplay_p
)
11260 fprintf (stderr
, "%p (%s): %s\n",
11262 ((BUFFERP (w
->buffer
)
11263 && STRINGP (XBUFFER (w
->buffer
)->name
))
11264 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11269 #endif /* GLYPH_DEBUG */
11272 /* Value is non-zero if all changes in window W, which displays
11273 current_buffer, are in the text between START and END. START is a
11274 buffer position, END is given as a distance from Z. Used in
11275 redisplay_internal for display optimization. */
11278 text_outside_line_unchanged_p (w
, start
, end
)
11282 int unchanged_p
= 1;
11284 /* If text or overlays have changed, see where. */
11285 if (XFASTINT (w
->last_modified
) < MODIFF
11286 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11288 /* Gap in the line? */
11289 if (GPT
< start
|| Z
- GPT
< end
)
11292 /* Changes start in front of the line, or end after it? */
11294 && (BEG_UNCHANGED
< start
- 1
11295 || END_UNCHANGED
< end
))
11298 /* If selective display, can't optimize if changes start at the
11299 beginning of the line. */
11301 && INTEGERP (current_buffer
->selective_display
)
11302 && XINT (current_buffer
->selective_display
) > 0
11303 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11306 /* If there are overlays at the start or end of the line, these
11307 may have overlay strings with newlines in them. A change at
11308 START, for instance, may actually concern the display of such
11309 overlay strings as well, and they are displayed on different
11310 lines. So, quickly rule out this case. (For the future, it
11311 might be desirable to implement something more telling than
11312 just BEG/END_UNCHANGED.) */
11315 if (BEG
+ BEG_UNCHANGED
== start
11316 && overlay_touches_p (start
))
11318 if (END_UNCHANGED
== end
11319 && overlay_touches_p (Z
- end
))
11323 /* Under bidi reordering, adding or deleting a character in the
11324 beginning of a paragraph, before the first strong directional
11325 character, can change the base direction of the paragraph (unless
11326 the buffer specifies a fixed paragraph direction), which will
11327 require to redisplay the whole paragraph. It might be worthwhile
11328 to find the paragraph limits and widen the range of redisplayed
11329 lines to that, but for now just give up this optimization. */
11330 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11331 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11335 return unchanged_p
;
11339 /* Do a frame update, taking possible shortcuts into account. This is
11340 the main external entry point for redisplay.
11342 If the last redisplay displayed an echo area message and that message
11343 is no longer requested, we clear the echo area or bring back the
11344 mini-buffer if that is in use. */
11349 redisplay_internal (0);
11354 overlay_arrow_string_or_property (var
)
11359 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11362 return Voverlay_arrow_string
;
11365 /* Return 1 if there are any overlay-arrows in current_buffer. */
11367 overlay_arrow_in_current_buffer_p ()
11371 for (vlist
= Voverlay_arrow_variable_list
;
11373 vlist
= XCDR (vlist
))
11375 Lisp_Object var
= XCAR (vlist
);
11378 if (!SYMBOLP (var
))
11380 val
= find_symbol_value (var
);
11382 && current_buffer
== XMARKER (val
)->buffer
)
11389 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11393 overlay_arrows_changed_p ()
11397 for (vlist
= Voverlay_arrow_variable_list
;
11399 vlist
= XCDR (vlist
))
11401 Lisp_Object var
= XCAR (vlist
);
11402 Lisp_Object val
, pstr
;
11404 if (!SYMBOLP (var
))
11406 val
= find_symbol_value (var
);
11407 if (!MARKERP (val
))
11409 if (! EQ (COERCE_MARKER (val
),
11410 Fget (var
, Qlast_arrow_position
))
11411 || ! (pstr
= overlay_arrow_string_or_property (var
),
11412 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11418 /* Mark overlay arrows to be updated on next redisplay. */
11421 update_overlay_arrows (up_to_date
)
11426 for (vlist
= Voverlay_arrow_variable_list
;
11428 vlist
= XCDR (vlist
))
11430 Lisp_Object var
= XCAR (vlist
);
11432 if (!SYMBOLP (var
))
11435 if (up_to_date
> 0)
11437 Lisp_Object val
= find_symbol_value (var
);
11438 Fput (var
, Qlast_arrow_position
,
11439 COERCE_MARKER (val
));
11440 Fput (var
, Qlast_arrow_string
,
11441 overlay_arrow_string_or_property (var
));
11443 else if (up_to_date
< 0
11444 || !NILP (Fget (var
, Qlast_arrow_position
)))
11446 Fput (var
, Qlast_arrow_position
, Qt
);
11447 Fput (var
, Qlast_arrow_string
, Qt
);
11453 /* Return overlay arrow string to display at row.
11454 Return integer (bitmap number) for arrow bitmap in left fringe.
11455 Return nil if no overlay arrow. */
11458 overlay_arrow_at_row (it
, row
)
11460 struct glyph_row
*row
;
11464 for (vlist
= Voverlay_arrow_variable_list
;
11466 vlist
= XCDR (vlist
))
11468 Lisp_Object var
= XCAR (vlist
);
11471 if (!SYMBOLP (var
))
11474 val
= find_symbol_value (var
);
11477 && current_buffer
== XMARKER (val
)->buffer
11478 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11480 if (FRAME_WINDOW_P (it
->f
)
11481 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11483 #ifdef HAVE_WINDOW_SYSTEM
11484 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11487 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11488 return make_number (fringe_bitmap
);
11491 return make_number (-1); /* Use default arrow bitmap */
11493 return overlay_arrow_string_or_property (var
);
11500 /* Return 1 if point moved out of or into a composition. Otherwise
11501 return 0. PREV_BUF and PREV_PT are the last point buffer and
11502 position. BUF and PT are the current point buffer and position. */
11505 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11506 struct buffer
*prev_buf
, *buf
;
11509 EMACS_INT start
, end
;
11511 Lisp_Object buffer
;
11513 XSETBUFFER (buffer
, buf
);
11514 /* Check a composition at the last point if point moved within the
11516 if (prev_buf
== buf
)
11519 /* Point didn't move. */
11522 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11523 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11524 && COMPOSITION_VALID_P (start
, end
, prop
)
11525 && start
< prev_pt
&& end
> prev_pt
)
11526 /* The last point was within the composition. Return 1 iff
11527 point moved out of the composition. */
11528 return (pt
<= start
|| pt
>= end
);
11531 /* Check a composition at the current point. */
11532 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11533 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11534 && COMPOSITION_VALID_P (start
, end
, prop
)
11535 && start
< pt
&& end
> pt
);
11539 /* Reconsider the setting of B->clip_changed which is displayed
11543 reconsider_clip_changes (w
, b
)
11547 if (b
->clip_changed
11548 && !NILP (w
->window_end_valid
)
11549 && w
->current_matrix
->buffer
== b
11550 && w
->current_matrix
->zv
== BUF_ZV (b
)
11551 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11552 b
->clip_changed
= 0;
11554 /* If display wasn't paused, and W is not a tool bar window, see if
11555 point has been moved into or out of a composition. In that case,
11556 we set b->clip_changed to 1 to force updating the screen. If
11557 b->clip_changed has already been set to 1, we can skip this
11559 if (!b
->clip_changed
11560 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11564 if (w
== XWINDOW (selected_window
))
11565 pt
= BUF_PT (current_buffer
);
11567 pt
= marker_position (w
->pointm
);
11569 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11570 || pt
!= XINT (w
->last_point
))
11571 && check_point_in_composition (w
->current_matrix
->buffer
,
11572 XINT (w
->last_point
),
11573 XBUFFER (w
->buffer
), pt
))
11574 b
->clip_changed
= 1;
11579 /* Select FRAME to forward the values of frame-local variables into C
11580 variables so that the redisplay routines can access those values
11584 select_frame_for_redisplay (frame
)
11587 Lisp_Object tail
, symbol
, val
;
11588 Lisp_Object old
= selected_frame
;
11589 struct Lisp_Symbol
*sym
;
11591 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11593 selected_frame
= frame
;
11597 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11598 if (CONSP (XCAR (tail
))
11599 && (symbol
= XCAR (XCAR (tail
)),
11601 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11603 (BUFFER_LOCAL_VALUEP (val
)))
11604 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11605 /* Use find_symbol_value rather than Fsymbol_value
11606 to avoid an error if it is void. */
11607 find_symbol_value (symbol
);
11608 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11612 #define STOP_POLLING \
11613 do { if (! polling_stopped_here) stop_polling (); \
11614 polling_stopped_here = 1; } while (0)
11616 #define RESUME_POLLING \
11617 do { if (polling_stopped_here) start_polling (); \
11618 polling_stopped_here = 0; } while (0)
11621 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11622 response to any user action; therefore, we should preserve the echo
11623 area. (Actually, our caller does that job.) Perhaps in the future
11624 avoid recentering windows if it is not necessary; currently that
11625 causes some problems. */
11628 redisplay_internal (preserve_echo_area
)
11629 int preserve_echo_area
;
11631 struct window
*w
= XWINDOW (selected_window
);
11634 int must_finish
= 0;
11635 struct text_pos tlbufpos
, tlendpos
;
11636 int number_of_visible_frames
;
11639 int polling_stopped_here
= 0;
11640 Lisp_Object old_frame
= selected_frame
;
11642 /* Non-zero means redisplay has to consider all windows on all
11643 frames. Zero means, only selected_window is considered. */
11644 int consider_all_windows_p
;
11646 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11648 /* No redisplay if running in batch mode or frame is not yet fully
11649 initialized, or redisplay is explicitly turned off by setting
11650 Vinhibit_redisplay. */
11651 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11652 || !NILP (Vinhibit_redisplay
))
11655 /* Don't examine these until after testing Vinhibit_redisplay.
11656 When Emacs is shutting down, perhaps because its connection to
11657 X has dropped, we should not look at them at all. */
11658 f
= XFRAME (w
->frame
);
11659 sf
= SELECTED_FRAME ();
11661 if (!f
->glyphs_initialized_p
)
11664 /* The flag redisplay_performed_directly_p is set by
11665 direct_output_for_insert when it already did the whole screen
11666 update necessary. */
11667 if (redisplay_performed_directly_p
)
11669 redisplay_performed_directly_p
= 0;
11670 if (!hscroll_windows (selected_window
))
11674 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11675 if (popup_activated ())
11679 /* I don't think this happens but let's be paranoid. */
11680 if (redisplaying_p
)
11683 /* Record a function that resets redisplaying_p to its old value
11684 when we leave this function. */
11685 count
= SPECPDL_INDEX ();
11686 record_unwind_protect (unwind_redisplay
,
11687 Fcons (make_number (redisplaying_p
), selected_frame
));
11689 specbind (Qinhibit_free_realized_faces
, Qnil
);
11692 Lisp_Object tail
, frame
;
11694 FOR_EACH_FRAME (tail
, frame
)
11696 struct frame
*f
= XFRAME (frame
);
11697 f
->already_hscrolled_p
= 0;
11702 if (!EQ (old_frame
, selected_frame
)
11703 && FRAME_LIVE_P (XFRAME (old_frame
)))
11704 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11705 selected_frame and selected_window to be temporarily out-of-sync so
11706 when we come back here via `goto retry', we need to resync because we
11707 may need to run Elisp code (via prepare_menu_bars). */
11708 select_frame_for_redisplay (old_frame
);
11711 reconsider_clip_changes (w
, current_buffer
);
11712 last_escape_glyph_frame
= NULL
;
11713 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11715 /* If new fonts have been loaded that make a glyph matrix adjustment
11716 necessary, do it. */
11717 if (fonts_changed_p
)
11719 adjust_glyphs (NULL
);
11720 ++windows_or_buffers_changed
;
11721 fonts_changed_p
= 0;
11724 /* If face_change_count is non-zero, init_iterator will free all
11725 realized faces, which includes the faces referenced from current
11726 matrices. So, we can't reuse current matrices in this case. */
11727 if (face_change_count
)
11728 ++windows_or_buffers_changed
;
11730 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11731 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11733 /* Since frames on a single ASCII terminal share the same
11734 display area, displaying a different frame means redisplay
11735 the whole thing. */
11736 windows_or_buffers_changed
++;
11737 SET_FRAME_GARBAGED (sf
);
11739 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11741 FRAME_TTY (sf
)->previous_frame
= sf
;
11744 /* Set the visible flags for all frames. Do this before checking
11745 for resized or garbaged frames; they want to know if their frames
11746 are visible. See the comment in frame.h for
11747 FRAME_SAMPLE_VISIBILITY. */
11749 Lisp_Object tail
, frame
;
11751 number_of_visible_frames
= 0;
11753 FOR_EACH_FRAME (tail
, frame
)
11755 struct frame
*f
= XFRAME (frame
);
11757 FRAME_SAMPLE_VISIBILITY (f
);
11758 if (FRAME_VISIBLE_P (f
))
11759 ++number_of_visible_frames
;
11760 clear_desired_matrices (f
);
11764 /* Notice any pending interrupt request to change frame size. */
11765 do_pending_window_change (1);
11767 /* Clear frames marked as garbaged. */
11768 if (frame_garbaged
)
11769 clear_garbaged_frames ();
11771 /* Build menubar and tool-bar items. */
11772 if (NILP (Vmemory_full
))
11773 prepare_menu_bars ();
11775 if (windows_or_buffers_changed
)
11776 update_mode_lines
++;
11778 /* Detect case that we need to write or remove a star in the mode line. */
11779 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11781 w
->update_mode_line
= Qt
;
11782 if (buffer_shared
> 1)
11783 update_mode_lines
++;
11786 /* Avoid invocation of point motion hooks by `current_column' below. */
11787 count1
= SPECPDL_INDEX ();
11788 specbind (Qinhibit_point_motion_hooks
, Qt
);
11790 /* If %c is in the mode line, update it if needed. */
11791 if (!NILP (w
->column_number_displayed
)
11792 /* This alternative quickly identifies a common case
11793 where no change is needed. */
11794 && !(PT
== XFASTINT (w
->last_point
)
11795 && XFASTINT (w
->last_modified
) >= MODIFF
11796 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11797 && (XFASTINT (w
->column_number_displayed
)
11798 != (int) current_column ())) /* iftc */
11799 w
->update_mode_line
= Qt
;
11801 unbind_to (count1
, Qnil
);
11803 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11805 /* The variable buffer_shared is set in redisplay_window and
11806 indicates that we redisplay a buffer in different windows. See
11808 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11809 || cursor_type_changed
);
11811 /* If specs for an arrow have changed, do thorough redisplay
11812 to ensure we remove any arrow that should no longer exist. */
11813 if (overlay_arrows_changed_p ())
11814 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11816 /* Normally the message* functions will have already displayed and
11817 updated the echo area, but the frame may have been trashed, or
11818 the update may have been preempted, so display the echo area
11819 again here. Checking message_cleared_p captures the case that
11820 the echo area should be cleared. */
11821 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11822 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11823 || (message_cleared_p
11824 && minibuf_level
== 0
11825 /* If the mini-window is currently selected, this means the
11826 echo-area doesn't show through. */
11827 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11829 int window_height_changed_p
= echo_area_display (0);
11832 /* If we don't display the current message, don't clear the
11833 message_cleared_p flag, because, if we did, we wouldn't clear
11834 the echo area in the next redisplay which doesn't preserve
11836 if (!display_last_displayed_message_p
)
11837 message_cleared_p
= 0;
11839 if (fonts_changed_p
)
11841 else if (window_height_changed_p
)
11843 consider_all_windows_p
= 1;
11844 ++update_mode_lines
;
11845 ++windows_or_buffers_changed
;
11847 /* If window configuration was changed, frames may have been
11848 marked garbaged. Clear them or we will experience
11849 surprises wrt scrolling. */
11850 if (frame_garbaged
)
11851 clear_garbaged_frames ();
11854 else if (EQ (selected_window
, minibuf_window
)
11855 && (current_buffer
->clip_changed
11856 || XFASTINT (w
->last_modified
) < MODIFF
11857 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11858 && resize_mini_window (w
, 0))
11860 /* Resized active mini-window to fit the size of what it is
11861 showing if its contents might have changed. */
11863 /* FIXME: this causes all frames to be updated, which seems unnecessary
11864 since only the current frame needs to be considered. This function needs
11865 to be rewritten with two variables, consider_all_windows and
11866 consider_all_frames. */
11867 consider_all_windows_p
= 1;
11868 ++windows_or_buffers_changed
;
11869 ++update_mode_lines
;
11871 /* If window configuration was changed, frames may have been
11872 marked garbaged. Clear them or we will experience
11873 surprises wrt scrolling. */
11874 if (frame_garbaged
)
11875 clear_garbaged_frames ();
11879 /* If showing the region, and mark has changed, we must redisplay
11880 the whole window. The assignment to this_line_start_pos prevents
11881 the optimization directly below this if-statement. */
11882 if (((!NILP (Vtransient_mark_mode
)
11883 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11884 != !NILP (w
->region_showing
))
11885 || (!NILP (w
->region_showing
)
11886 && !EQ (w
->region_showing
,
11887 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11888 CHARPOS (this_line_start_pos
) = 0;
11890 /* Optimize the case that only the line containing the cursor in the
11891 selected window has changed. Variables starting with this_ are
11892 set in display_line and record information about the line
11893 containing the cursor. */
11894 tlbufpos
= this_line_start_pos
;
11895 tlendpos
= this_line_end_pos
;
11896 if (!consider_all_windows_p
11897 && CHARPOS (tlbufpos
) > 0
11898 && NILP (w
->update_mode_line
)
11899 && !current_buffer
->clip_changed
11900 && !current_buffer
->prevent_redisplay_optimizations_p
11901 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11902 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11903 /* Make sure recorded data applies to current buffer, etc. */
11904 && this_line_buffer
== current_buffer
11905 && current_buffer
== XBUFFER (w
->buffer
)
11906 && NILP (w
->force_start
)
11907 && NILP (w
->optional_new_start
)
11908 /* Point must be on the line that we have info recorded about. */
11909 && PT
>= CHARPOS (tlbufpos
)
11910 && PT
<= Z
- CHARPOS (tlendpos
)
11911 /* All text outside that line, including its final newline,
11912 must be unchanged. */
11913 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11914 CHARPOS (tlendpos
)))
11916 if (CHARPOS (tlbufpos
) > BEGV
11917 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11918 && (CHARPOS (tlbufpos
) == ZV
11919 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11920 /* Former continuation line has disappeared by becoming empty. */
11922 else if (XFASTINT (w
->last_modified
) < MODIFF
11923 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11924 || MINI_WINDOW_P (w
))
11926 /* We have to handle the case of continuation around a
11927 wide-column character (see the comment in indent.c around
11930 For instance, in the following case:
11932 -------- Insert --------
11933 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11934 J_I_ ==> J_I_ `^^' are cursors.
11938 As we have to redraw the line above, we cannot use this
11942 int line_height_before
= this_line_pixel_height
;
11944 /* Note that start_display will handle the case that the
11945 line starting at tlbufpos is a continuation line. */
11946 start_display (&it
, w
, tlbufpos
);
11948 /* Implementation note: It this still necessary? */
11949 if (it
.current_x
!= this_line_start_x
)
11952 TRACE ((stderr
, "trying display optimization 1\n"));
11953 w
->cursor
.vpos
= -1;
11954 overlay_arrow_seen
= 0;
11955 it
.vpos
= this_line_vpos
;
11956 it
.current_y
= this_line_y
;
11957 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11958 display_line (&it
);
11960 /* If line contains point, is not continued,
11961 and ends at same distance from eob as before, we win. */
11962 if (w
->cursor
.vpos
>= 0
11963 /* Line is not continued, otherwise this_line_start_pos
11964 would have been set to 0 in display_line. */
11965 && CHARPOS (this_line_start_pos
)
11966 /* Line ends as before. */
11967 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11968 /* Line has same height as before. Otherwise other lines
11969 would have to be shifted up or down. */
11970 && this_line_pixel_height
== line_height_before
)
11972 /* If this is not the window's last line, we must adjust
11973 the charstarts of the lines below. */
11974 if (it
.current_y
< it
.last_visible_y
)
11976 struct glyph_row
*row
11977 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11978 int delta
, delta_bytes
;
11980 /* We used to distinguish between two cases here,
11981 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11982 when the line ends in a newline or the end of the
11983 buffer's accessible portion. But both cases did
11984 the same, so they were collapsed. */
11986 - CHARPOS (tlendpos
)
11987 - MATRIX_ROW_START_CHARPOS (row
));
11988 delta_bytes
= (Z_BYTE
11989 - BYTEPOS (tlendpos
)
11990 - MATRIX_ROW_START_BYTEPOS (row
));
11992 increment_matrix_positions (w
->current_matrix
,
11993 this_line_vpos
+ 1,
11994 w
->current_matrix
->nrows
,
11995 delta
, delta_bytes
);
11998 /* If this row displays text now but previously didn't,
11999 or vice versa, w->window_end_vpos may have to be
12001 if ((it
.glyph_row
- 1)->displays_text_p
)
12003 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12004 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12006 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12007 && this_line_vpos
> 0)
12008 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12009 w
->window_end_valid
= Qnil
;
12011 /* Update hint: No need to try to scroll in update_window. */
12012 w
->desired_matrix
->no_scrolling_p
= 1;
12015 *w
->desired_matrix
->method
= 0;
12016 debug_method_add (w
, "optimization 1");
12018 #ifdef HAVE_WINDOW_SYSTEM
12019 update_window_fringes (w
, 0);
12026 else if (/* Cursor position hasn't changed. */
12027 PT
== XFASTINT (w
->last_point
)
12028 /* Make sure the cursor was last displayed
12029 in this window. Otherwise we have to reposition it. */
12030 && 0 <= w
->cursor
.vpos
12031 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12035 do_pending_window_change (1);
12037 /* We used to always goto end_of_redisplay here, but this
12038 isn't enough if we have a blinking cursor. */
12039 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12040 goto end_of_redisplay
;
12044 /* If highlighting the region, or if the cursor is in the echo area,
12045 then we can't just move the cursor. */
12046 else if (! (!NILP (Vtransient_mark_mode
)
12047 && !NILP (current_buffer
->mark_active
))
12048 && (EQ (selected_window
, current_buffer
->last_selected_window
)
12049 || highlight_nonselected_windows
)
12050 && NILP (w
->region_showing
)
12051 && NILP (Vshow_trailing_whitespace
)
12052 && !cursor_in_echo_area
)
12055 struct glyph_row
*row
;
12057 /* Skip from tlbufpos to PT and see where it is. Note that
12058 PT may be in invisible text. If so, we will end at the
12059 next visible position. */
12060 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12061 NULL
, DEFAULT_FACE_ID
);
12062 it
.current_x
= this_line_start_x
;
12063 it
.current_y
= this_line_y
;
12064 it
.vpos
= this_line_vpos
;
12066 /* The call to move_it_to stops in front of PT, but
12067 moves over before-strings. */
12068 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12070 if (it
.vpos
== this_line_vpos
12071 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12074 xassert (this_line_vpos
== it
.vpos
);
12075 xassert (this_line_y
== it
.current_y
);
12076 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12078 *w
->desired_matrix
->method
= 0;
12079 debug_method_add (w
, "optimization 3");
12088 /* Text changed drastically or point moved off of line. */
12089 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12092 CHARPOS (this_line_start_pos
) = 0;
12093 consider_all_windows_p
|= buffer_shared
> 1;
12094 ++clear_face_cache_count
;
12095 #ifdef HAVE_WINDOW_SYSTEM
12096 ++clear_image_cache_count
;
12099 /* Build desired matrices, and update the display. If
12100 consider_all_windows_p is non-zero, do it for all windows on all
12101 frames. Otherwise do it for selected_window, only. */
12103 if (consider_all_windows_p
)
12105 Lisp_Object tail
, frame
;
12107 FOR_EACH_FRAME (tail
, frame
)
12108 XFRAME (frame
)->updated_p
= 0;
12110 /* Recompute # windows showing selected buffer. This will be
12111 incremented each time such a window is displayed. */
12114 FOR_EACH_FRAME (tail
, frame
)
12116 struct frame
*f
= XFRAME (frame
);
12118 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12120 if (! EQ (frame
, selected_frame
))
12121 /* Select the frame, for the sake of frame-local
12123 select_frame_for_redisplay (frame
);
12125 /* Mark all the scroll bars to be removed; we'll redeem
12126 the ones we want when we redisplay their windows. */
12127 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12128 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12130 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12131 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12133 /* The X error handler may have deleted that frame. */
12134 if (!FRAME_LIVE_P (f
))
12137 /* Any scroll bars which redisplay_windows should have
12138 nuked should now go away. */
12139 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12140 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12142 /* If fonts changed, display again. */
12143 /* ??? rms: I suspect it is a mistake to jump all the way
12144 back to retry here. It should just retry this frame. */
12145 if (fonts_changed_p
)
12148 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12150 /* See if we have to hscroll. */
12151 if (!f
->already_hscrolled_p
)
12153 f
->already_hscrolled_p
= 1;
12154 if (hscroll_windows (f
->root_window
))
12158 /* Prevent various kinds of signals during display
12159 update. stdio is not robust about handling
12160 signals, which can cause an apparent I/O
12162 if (interrupt_input
)
12163 unrequest_sigio ();
12166 /* Update the display. */
12167 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12168 pause
|= update_frame (f
, 0, 0);
12174 if (!EQ (old_frame
, selected_frame
)
12175 && FRAME_LIVE_P (XFRAME (old_frame
)))
12176 /* We played a bit fast-and-loose above and allowed selected_frame
12177 and selected_window to be temporarily out-of-sync but let's make
12178 sure this stays contained. */
12179 select_frame_for_redisplay (old_frame
);
12180 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12184 /* Do the mark_window_display_accurate after all windows have
12185 been redisplayed because this call resets flags in buffers
12186 which are needed for proper redisplay. */
12187 FOR_EACH_FRAME (tail
, frame
)
12189 struct frame
*f
= XFRAME (frame
);
12192 mark_window_display_accurate (f
->root_window
, 1);
12193 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12194 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12199 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12201 Lisp_Object mini_window
;
12202 struct frame
*mini_frame
;
12204 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12205 /* Use list_of_error, not Qerror, so that
12206 we catch only errors and don't run the debugger. */
12207 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12209 redisplay_window_error
);
12211 /* Compare desired and current matrices, perform output. */
12214 /* If fonts changed, display again. */
12215 if (fonts_changed_p
)
12218 /* Prevent various kinds of signals during display update.
12219 stdio is not robust about handling signals,
12220 which can cause an apparent I/O error. */
12221 if (interrupt_input
)
12222 unrequest_sigio ();
12225 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12227 if (hscroll_windows (selected_window
))
12230 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12231 pause
= update_frame (sf
, 0, 0);
12234 /* We may have called echo_area_display at the top of this
12235 function. If the echo area is on another frame, that may
12236 have put text on a frame other than the selected one, so the
12237 above call to update_frame would not have caught it. Catch
12239 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12240 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12242 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12244 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12245 pause
|= update_frame (mini_frame
, 0, 0);
12246 if (!pause
&& hscroll_windows (mini_window
))
12251 /* If display was paused because of pending input, make sure we do a
12252 thorough update the next time. */
12255 /* Prevent the optimization at the beginning of
12256 redisplay_internal that tries a single-line update of the
12257 line containing the cursor in the selected window. */
12258 CHARPOS (this_line_start_pos
) = 0;
12260 /* Let the overlay arrow be updated the next time. */
12261 update_overlay_arrows (0);
12263 /* If we pause after scrolling, some rows in the current
12264 matrices of some windows are not valid. */
12265 if (!WINDOW_FULL_WIDTH_P (w
)
12266 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12267 update_mode_lines
= 1;
12271 if (!consider_all_windows_p
)
12273 /* This has already been done above if
12274 consider_all_windows_p is set. */
12275 mark_window_display_accurate_1 (w
, 1);
12277 /* Say overlay arrows are up to date. */
12278 update_overlay_arrows (1);
12280 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12281 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12284 update_mode_lines
= 0;
12285 windows_or_buffers_changed
= 0;
12286 cursor_type_changed
= 0;
12289 /* Start SIGIO interrupts coming again. Having them off during the
12290 code above makes it less likely one will discard output, but not
12291 impossible, since there might be stuff in the system buffer here.
12292 But it is much hairier to try to do anything about that. */
12293 if (interrupt_input
)
12297 /* If a frame has become visible which was not before, redisplay
12298 again, so that we display it. Expose events for such a frame
12299 (which it gets when becoming visible) don't call the parts of
12300 redisplay constructing glyphs, so simply exposing a frame won't
12301 display anything in this case. So, we have to display these
12302 frames here explicitly. */
12305 Lisp_Object tail
, frame
;
12308 FOR_EACH_FRAME (tail
, frame
)
12310 int this_is_visible
= 0;
12312 if (XFRAME (frame
)->visible
)
12313 this_is_visible
= 1;
12314 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12315 if (XFRAME (frame
)->visible
)
12316 this_is_visible
= 1;
12318 if (this_is_visible
)
12322 if (new_count
!= number_of_visible_frames
)
12323 windows_or_buffers_changed
++;
12326 /* Change frame size now if a change is pending. */
12327 do_pending_window_change (1);
12329 /* If we just did a pending size change, or have additional
12330 visible frames, redisplay again. */
12331 if (windows_or_buffers_changed
&& !pause
)
12334 /* Clear the face cache eventually. */
12335 if (consider_all_windows_p
)
12337 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12339 clear_face_cache (0);
12340 clear_face_cache_count
= 0;
12342 #ifdef HAVE_WINDOW_SYSTEM
12343 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12345 clear_image_caches (Qnil
);
12346 clear_image_cache_count
= 0;
12348 #endif /* HAVE_WINDOW_SYSTEM */
12352 unbind_to (count
, Qnil
);
12357 /* Redisplay, but leave alone any recent echo area message unless
12358 another message has been requested in its place.
12360 This is useful in situations where you need to redisplay but no
12361 user action has occurred, making it inappropriate for the message
12362 area to be cleared. See tracking_off and
12363 wait_reading_process_output for examples of these situations.
12365 FROM_WHERE is an integer saying from where this function was
12366 called. This is useful for debugging. */
12369 redisplay_preserve_echo_area (from_where
)
12372 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12374 if (!NILP (echo_area_buffer
[1]))
12376 /* We have a previously displayed message, but no current
12377 message. Redisplay the previous message. */
12378 display_last_displayed_message_p
= 1;
12379 redisplay_internal (1);
12380 display_last_displayed_message_p
= 0;
12383 redisplay_internal (1);
12385 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12386 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12387 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12391 /* Function registered with record_unwind_protect in
12392 redisplay_internal. Reset redisplaying_p to the value it had
12393 before redisplay_internal was called, and clear
12394 prevent_freeing_realized_faces_p. It also selects the previously
12395 selected frame, unless it has been deleted (by an X connection
12396 failure during redisplay, for example). */
12399 unwind_redisplay (val
)
12402 Lisp_Object old_redisplaying_p
, old_frame
;
12404 old_redisplaying_p
= XCAR (val
);
12405 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12406 old_frame
= XCDR (val
);
12407 if (! EQ (old_frame
, selected_frame
)
12408 && FRAME_LIVE_P (XFRAME (old_frame
)))
12409 select_frame_for_redisplay (old_frame
);
12414 /* Mark the display of window W as accurate or inaccurate. If
12415 ACCURATE_P is non-zero mark display of W as accurate. If
12416 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12417 redisplay_internal is called. */
12420 mark_window_display_accurate_1 (w
, accurate_p
)
12424 if (BUFFERP (w
->buffer
))
12426 struct buffer
*b
= XBUFFER (w
->buffer
);
12429 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12430 w
->last_overlay_modified
12431 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12433 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12437 b
->clip_changed
= 0;
12438 b
->prevent_redisplay_optimizations_p
= 0;
12440 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12441 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12442 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12443 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12445 w
->current_matrix
->buffer
= b
;
12446 w
->current_matrix
->begv
= BUF_BEGV (b
);
12447 w
->current_matrix
->zv
= BUF_ZV (b
);
12449 w
->last_cursor
= w
->cursor
;
12450 w
->last_cursor_off_p
= w
->cursor_off_p
;
12452 if (w
== XWINDOW (selected_window
))
12453 w
->last_point
= make_number (BUF_PT (b
));
12455 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12461 w
->window_end_valid
= w
->buffer
;
12462 w
->update_mode_line
= Qnil
;
12467 /* Mark the display of windows in the window tree rooted at WINDOW as
12468 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12469 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12470 be redisplayed the next time redisplay_internal is called. */
12473 mark_window_display_accurate (window
, accurate_p
)
12474 Lisp_Object window
;
12479 for (; !NILP (window
); window
= w
->next
)
12481 w
= XWINDOW (window
);
12482 mark_window_display_accurate_1 (w
, accurate_p
);
12484 if (!NILP (w
->vchild
))
12485 mark_window_display_accurate (w
->vchild
, accurate_p
);
12486 if (!NILP (w
->hchild
))
12487 mark_window_display_accurate (w
->hchild
, accurate_p
);
12492 update_overlay_arrows (1);
12496 /* Force a thorough redisplay the next time by setting
12497 last_arrow_position and last_arrow_string to t, which is
12498 unequal to any useful value of Voverlay_arrow_... */
12499 update_overlay_arrows (-1);
12504 /* Return value in display table DP (Lisp_Char_Table *) for character
12505 C. Since a display table doesn't have any parent, we don't have to
12506 follow parent. Do not call this function directly but use the
12507 macro DISP_CHAR_VECTOR. */
12510 disp_char_vector (dp
, c
)
12511 struct Lisp_Char_Table
*dp
;
12516 if (ASCII_CHAR_P (c
))
12519 if (SUB_CHAR_TABLE_P (val
))
12520 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12526 XSETCHAR_TABLE (table
, dp
);
12527 val
= char_table_ref (table
, c
);
12536 /***********************************************************************
12538 ***********************************************************************/
12540 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12543 redisplay_windows (window
)
12544 Lisp_Object window
;
12546 while (!NILP (window
))
12548 struct window
*w
= XWINDOW (window
);
12550 if (!NILP (w
->hchild
))
12551 redisplay_windows (w
->hchild
);
12552 else if (!NILP (w
->vchild
))
12553 redisplay_windows (w
->vchild
);
12554 else if (!NILP (w
->buffer
))
12556 displayed_buffer
= XBUFFER (w
->buffer
);
12557 /* Use list_of_error, not Qerror, so that
12558 we catch only errors and don't run the debugger. */
12559 internal_condition_case_1 (redisplay_window_0
, window
,
12561 redisplay_window_error
);
12569 redisplay_window_error ()
12571 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12576 redisplay_window_0 (window
)
12577 Lisp_Object window
;
12579 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12580 redisplay_window (window
, 0);
12585 redisplay_window_1 (window
)
12586 Lisp_Object window
;
12588 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12589 redisplay_window (window
, 1);
12594 /* Increment GLYPH until it reaches END or CONDITION fails while
12595 adding (GLYPH)->pixel_width to X. */
12597 #define SKIP_GLYPHS(glyph, end, x, condition) \
12600 (x) += (glyph)->pixel_width; \
12603 while ((glyph) < (end) && (condition))
12606 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12607 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12608 which positions recorded in ROW differ from current buffer
12611 Return 0 if cursor is not on this row, 1 otherwise. */
12614 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12616 struct glyph_row
*row
;
12617 struct glyph_matrix
*matrix
;
12618 int delta
, delta_bytes
, dy
, dvpos
;
12620 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12621 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12622 struct glyph
*cursor
= NULL
;
12623 /* The last known character position in row. */
12624 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12627 EMACS_INT pt_old
= PT
- delta
;
12628 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12629 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12630 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12631 /* Non-zero means we've found a match for cursor position, but that
12632 glyph has the avoid_cursor_p flag set. */
12633 int match_with_avoid_cursor
= 0;
12634 /* Non-zero means we've seen at least one glyph that came from a
12636 int string_seen
= 0;
12637 /* Largest buffer position seen so far during scan of glyph row. */
12638 EMACS_INT bpos_max
= last_pos
;
12639 /* Last buffer position covered by an overlay string with an integer
12640 `cursor' property. */
12641 EMACS_INT bpos_covered
= 0;
12643 /* Skip over glyphs not having an object at the start and the end of
12644 the row. These are special glyphs like truncation marks on
12645 terminal frames. */
12646 if (row
->displays_text_p
)
12648 if (!row
->reversed_p
)
12651 && INTEGERP (glyph
->object
)
12652 && glyph
->charpos
< 0)
12654 x
+= glyph
->pixel_width
;
12658 && INTEGERP ((end
- 1)->object
)
12659 /* CHARPOS is zero for blanks inserted by
12660 extend_face_to_end_of_line. */
12661 && (end
- 1)->charpos
<= 0)
12663 glyph_before
= glyph
- 1;
12670 /* If the glyph row is reversed, we need to process it from back
12671 to front, so swap the edge pointers. */
12673 glyph
+= row
->used
[TEXT_AREA
] - 1;
12674 /* Reverse the known positions in the row. */
12675 last_pos
= pos_after
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12676 pos_before
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12678 while (glyph
> end
+ 1
12679 && INTEGERP (glyph
->object
)
12680 && glyph
->charpos
< 0)
12683 x
-= glyph
->pixel_width
;
12685 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12687 /* By default, put the cursor on the rightmost glyph. */
12688 for (g
= end
+ 1; g
< glyph
; g
++)
12689 x
+= g
->pixel_width
;
12692 && INTEGERP ((end
+ 1)->object
)
12693 && (end
+ 1)->charpos
<= 0)
12695 glyph_before
= glyph
+ 1;
12699 else if (row
->reversed_p
)
12701 /* In R2L rows that don't display text, put the cursor on the
12702 rightmost glyph. Case in point: an empty last line that is
12703 part of an R2L paragraph. */
12705 x
= -1; /* will be computed below, at lable compute_x */
12708 /* Step 1: Try to find the glyph whose character position
12709 corresponds to point. If that's not possible, find 2 glyphs
12710 whose character positions are the closest to point, one before
12711 point, the other after it. */
12712 if (!row
->reversed_p
)
12713 while (/* not marched to end of glyph row */
12715 /* glyph was not inserted by redisplay for internal purposes */
12716 && !INTEGERP (glyph
->object
))
12718 if (BUFFERP (glyph
->object
))
12720 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12722 if (glyph
->charpos
> bpos_max
)
12723 bpos_max
= glyph
->charpos
;
12724 if (!glyph
->avoid_cursor_p
)
12726 /* If we hit point, we've found the glyph on which to
12727 display the cursor. */
12730 match_with_avoid_cursor
= 0;
12733 /* See if we've found a better approximation to
12734 POS_BEFORE or to POS_AFTER. Note that we want the
12735 first (leftmost) glyph of all those that are the
12736 closest from below, and the last (rightmost) of all
12737 those from above. */
12738 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12740 pos_before
= glyph
->charpos
;
12741 glyph_before
= glyph
;
12743 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12745 pos_after
= glyph
->charpos
;
12746 glyph_after
= glyph
;
12749 else if (dpos
== 0)
12750 match_with_avoid_cursor
= 1;
12752 else if (STRINGP (glyph
->object
))
12754 Lisp_Object chprop
;
12755 int glyph_pos
= glyph
->charpos
;
12757 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12759 if (INTEGERP (chprop
))
12761 bpos_covered
= bpos_max
+ XINT (chprop
);
12762 /* If the `cursor' property covers buffer positions up
12763 to and including point, we should display cursor on
12765 /* Implementation note: bpos_max == pt_old when, e.g.,
12766 we are in an empty line, where bpos_max is set to
12767 MATRIX_ROW_START_CHARPOS, see above. */
12768 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12777 x
+= glyph
->pixel_width
;
12780 else if (glyph
> end
) /* row is reversed */
12781 while (!INTEGERP (glyph
->object
))
12783 if (BUFFERP (glyph
->object
))
12785 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12787 if (glyph
->charpos
> bpos_max
)
12788 bpos_max
= glyph
->charpos
;
12789 if (!glyph
->avoid_cursor_p
)
12793 match_with_avoid_cursor
= 0;
12796 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12798 pos_before
= glyph
->charpos
;
12799 glyph_before
= glyph
;
12801 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12803 pos_after
= glyph
->charpos
;
12804 glyph_after
= glyph
;
12807 else if (dpos
== 0)
12808 match_with_avoid_cursor
= 1;
12810 else if (STRINGP (glyph
->object
))
12812 Lisp_Object chprop
;
12813 int glyph_pos
= glyph
->charpos
;
12815 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12817 if (INTEGERP (chprop
))
12819 bpos_covered
= bpos_max
+ XINT (chprop
);
12820 /* If the `cursor' property covers buffer positions up
12821 to and including point, we should display cursor on
12823 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12834 x
-= glyph
->pixel_width
;
12837 /* Step 2: If we didn't find an exact match for point, we need to
12838 look for a proper place to put the cursor among glyphs between
12839 GLYPH_BEFORE and GLYPH_AFTER. */
12840 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12841 && bpos_covered
< pt_old
)
12843 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12845 EMACS_INT ellipsis_pos
;
12847 /* Scan back over the ellipsis glyphs. */
12848 if (!row
->reversed_p
)
12850 ellipsis_pos
= (glyph
- 1)->charpos
;
12851 while (glyph
> row
->glyphs
[TEXT_AREA
]
12852 && (glyph
- 1)->charpos
== ellipsis_pos
)
12853 glyph
--, x
-= glyph
->pixel_width
;
12854 /* That loop always goes one position too far, including
12855 the glyph before the ellipsis. So scan forward over
12857 x
+= glyph
->pixel_width
;
12860 else /* row is reversed */
12862 ellipsis_pos
= (glyph
+ 1)->charpos
;
12863 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12864 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12865 glyph
++, x
+= glyph
->pixel_width
;
12866 x
-= glyph
->pixel_width
;
12870 else if (match_with_avoid_cursor
12871 /* zero-width characters produce no glyphs */
12872 || eabs (glyph_after
- glyph_before
) == 1)
12874 cursor
= glyph_after
;
12877 else if (string_seen
)
12879 int incr
= row
->reversed_p
? -1 : +1;
12881 /* Need to find the glyph that came out of a string which is
12882 present at point. That glyph is somewhere between
12883 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12884 positioned between POS_BEFORE and POS_AFTER in the
12886 struct glyph
*stop
= glyph_after
;
12887 EMACS_INT pos
= pos_before
;
12890 for (glyph
= glyph_before
+ incr
;
12891 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12894 /* Any glyphs that come from the buffer are here because
12895 of bidi reordering. Skip them, and only pay
12896 attention to glyphs that came from some string. */
12897 if (STRINGP (glyph
->object
))
12902 str
= glyph
->object
;
12903 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12906 /* If the string from which this glyph came is
12907 found in the buffer at point, then we've
12908 found the glyph we've been looking for. */
12911 /* The glyphs from this string could have
12912 been reordered. Find the one with the
12913 smallest string position. Or there could
12914 be a character in the string with the
12915 `cursor' property, which means display
12916 cursor on that character's glyph. */
12917 int strpos
= glyph
->charpos
;
12920 for (glyph
+= incr
;
12921 EQ (glyph
->object
, str
);
12925 int gpos
= glyph
->charpos
;
12927 cprop
= Fget_char_property (make_number (gpos
),
12935 if (glyph
->charpos
< strpos
)
12937 strpos
= glyph
->charpos
;
12944 pos
= tem
+ 1; /* don't find previous instances */
12946 /* This string is not what we want; skip all of the
12947 glyphs that came from it. */
12950 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12951 && EQ (glyph
->object
, str
));
12957 /* If we reached the end of the line, and END was from a string,
12958 the cursor is not on this line. */
12960 && STRINGP ((glyph
- incr
)->object
)
12961 && row
->continued_p
)
12967 if (cursor
!= NULL
)
12973 /* Need to compute x that corresponds to GLYPH. */
12974 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12976 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12978 x
+= g
->pixel_width
;
12982 /* ROW could be part of a continued line, which might have other
12983 rows whose start and end charpos occlude point. Only set
12984 w->cursor if we found a better approximation to the cursor
12985 position than we have from previously examined rows. */
12986 if (w
->cursor
.vpos
>= 0
12987 /* Make sure cursor.vpos specifies a row whose start and end
12988 charpos occlude point. This is because some callers of this
12989 function leave cursor.vpos at the row where the cursor was
12990 displayed during the last redisplay cycle. */
12991 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12992 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12995 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12997 /* Keep the candidate whose buffer position is the closest to
12999 if (BUFFERP (g1
->object
)
13000 && (g1
->charpos
== pt_old
/* an exact match always wins */
13001 || (BUFFERP (glyph
->object
)
13002 && eabs (g1
->charpos
- pt_old
)
13003 < eabs (glyph
->charpos
- pt_old
))))
13005 /* If this candidate gives an exact match, use that. */
13006 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13007 /* Otherwise, keep the candidate that comes from a row
13008 spanning less buffer positions. This may win when one or
13009 both candidate positions are on glyphs that came from
13010 display strings, for which we cannot compare buffer
13012 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13013 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13014 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13017 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13019 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13020 w
->cursor
.y
= row
->y
+ dy
;
13022 if (w
== XWINDOW (selected_window
))
13024 if (!row
->continued_p
13025 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13028 this_line_buffer
= XBUFFER (w
->buffer
);
13030 CHARPOS (this_line_start_pos
)
13031 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13032 BYTEPOS (this_line_start_pos
)
13033 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13035 CHARPOS (this_line_end_pos
)
13036 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13037 BYTEPOS (this_line_end_pos
)
13038 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13040 this_line_y
= w
->cursor
.y
;
13041 this_line_pixel_height
= row
->height
;
13042 this_line_vpos
= w
->cursor
.vpos
;
13043 this_line_start_x
= row
->x
;
13046 CHARPOS (this_line_start_pos
) = 0;
13053 /* Run window scroll functions, if any, for WINDOW with new window
13054 start STARTP. Sets the window start of WINDOW to that position.
13056 We assume that the window's buffer is really current. */
13058 static INLINE
struct text_pos
13059 run_window_scroll_functions (window
, startp
)
13060 Lisp_Object window
;
13061 struct text_pos startp
;
13063 struct window
*w
= XWINDOW (window
);
13064 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13066 if (current_buffer
!= XBUFFER (w
->buffer
))
13069 if (!NILP (Vwindow_scroll_functions
))
13071 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13072 make_number (CHARPOS (startp
)));
13073 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13074 /* In case the hook functions switch buffers. */
13075 if (current_buffer
!= XBUFFER (w
->buffer
))
13076 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13083 /* Make sure the line containing the cursor is fully visible.
13084 A value of 1 means there is nothing to be done.
13085 (Either the line is fully visible, or it cannot be made so,
13086 or we cannot tell.)
13088 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13089 is higher than window.
13091 A value of 0 means the caller should do scrolling
13092 as if point had gone off the screen. */
13095 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13098 int current_matrix_p
;
13100 struct glyph_matrix
*matrix
;
13101 struct glyph_row
*row
;
13104 if (!make_cursor_line_fully_visible_p
)
13107 /* It's not always possible to find the cursor, e.g, when a window
13108 is full of overlay strings. Don't do anything in that case. */
13109 if (w
->cursor
.vpos
< 0)
13112 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13113 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13115 /* If the cursor row is not partially visible, there's nothing to do. */
13116 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13119 /* If the row the cursor is in is taller than the window's height,
13120 it's not clear what to do, so do nothing. */
13121 window_height
= window_box_height (w
);
13122 if (row
->height
>= window_height
)
13124 if (!force_p
|| MINI_WINDOW_P (w
)
13125 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13132 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13133 non-zero means only WINDOW is redisplayed in redisplay_internal.
13134 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13135 in redisplay_window to bring a partially visible line into view in
13136 the case that only the cursor has moved.
13138 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13139 last screen line's vertical height extends past the end of the screen.
13143 1 if scrolling succeeded
13145 0 if scrolling didn't find point.
13147 -1 if new fonts have been loaded so that we must interrupt
13148 redisplay, adjust glyph matrices, and try again. */
13154 SCROLLING_NEED_LARGER_MATRICES
13158 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13159 scroll_step
, temp_scroll_step
, last_line_misfit
)
13160 Lisp_Object window
;
13161 int just_this_one_p
;
13162 EMACS_INT scroll_conservatively
, scroll_step
;
13163 int temp_scroll_step
;
13164 int last_line_misfit
;
13166 struct window
*w
= XWINDOW (window
);
13167 struct frame
*f
= XFRAME (w
->frame
);
13168 struct text_pos pos
, startp
;
13170 int this_scroll_margin
, scroll_max
, rc
, height
;
13171 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13172 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13173 Lisp_Object aggressive
;
13174 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13177 debug_method_add (w
, "try_scrolling");
13180 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13182 /* Compute scroll margin height in pixels. We scroll when point is
13183 within this distance from the top or bottom of the window. */
13184 if (scroll_margin
> 0)
13185 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13186 * FRAME_LINE_HEIGHT (f
);
13188 this_scroll_margin
= 0;
13190 /* Force scroll_conservatively to have a reasonable value, to avoid
13191 overflow while computing how much to scroll. Note that the user
13192 can supply scroll-conservatively equal to `most-positive-fixnum',
13193 which can be larger than INT_MAX. */
13194 if (scroll_conservatively
> scroll_limit
)
13196 scroll_conservatively
= scroll_limit
;
13197 scroll_max
= INT_MAX
;
13199 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13200 /* Compute how much we should try to scroll maximally to bring
13201 point into view. */
13202 scroll_max
= (max (scroll_step
,
13203 max (scroll_conservatively
, temp_scroll_step
))
13204 * FRAME_LINE_HEIGHT (f
));
13205 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13206 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13207 /* We're trying to scroll because of aggressive scrolling but no
13208 scroll_step is set. Choose an arbitrary one. */
13209 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13215 /* Decide whether to scroll down. */
13216 if (PT
> CHARPOS (startp
))
13218 int scroll_margin_y
;
13220 /* Compute the pixel ypos of the scroll margin, then move it to
13221 either that ypos or PT, whichever comes first. */
13222 start_display (&it
, w
, startp
);
13223 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13224 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13225 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13226 (MOVE_TO_POS
| MOVE_TO_Y
));
13228 if (PT
> CHARPOS (it
.current
.pos
))
13230 int y0
= line_bottom_y (&it
);
13232 /* Compute the distance from the scroll margin to PT
13233 (including the height of the cursor line). Moving the
13234 iterator unconditionally to PT can be slow if PT is far
13235 away, so stop 10 lines past the window bottom (is there a
13236 way to do the right thing quickly?). */
13237 move_it_to (&it
, PT
, -1,
13238 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13239 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13240 dy
= line_bottom_y (&it
) - y0
;
13242 if (dy
> scroll_max
)
13243 return SCROLLING_FAILED
;
13251 /* Point is in or below the bottom scroll margin, so move the
13252 window start down. If scrolling conservatively, move it just
13253 enough down to make point visible. If scroll_step is set,
13254 move it down by scroll_step. */
13255 if (scroll_conservatively
)
13257 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13258 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13259 else if (scroll_step
|| temp_scroll_step
)
13260 amount_to_scroll
= scroll_max
;
13263 aggressive
= current_buffer
->scroll_up_aggressively
;
13264 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13265 if (NUMBERP (aggressive
))
13267 double float_amount
= XFLOATINT (aggressive
) * height
;
13268 amount_to_scroll
= float_amount
;
13269 if (amount_to_scroll
== 0 && float_amount
> 0)
13270 amount_to_scroll
= 1;
13274 if (amount_to_scroll
<= 0)
13275 return SCROLLING_FAILED
;
13277 start_display (&it
, w
, startp
);
13278 move_it_vertically (&it
, amount_to_scroll
);
13280 /* If STARTP is unchanged, move it down another screen line. */
13281 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13282 move_it_by_lines (&it
, 1, 1);
13283 startp
= it
.current
.pos
;
13287 struct text_pos scroll_margin_pos
= startp
;
13289 /* See if point is inside the scroll margin at the top of the
13291 if (this_scroll_margin
)
13293 start_display (&it
, w
, startp
);
13294 move_it_vertically (&it
, this_scroll_margin
);
13295 scroll_margin_pos
= it
.current
.pos
;
13298 if (PT
< CHARPOS (scroll_margin_pos
))
13300 /* Point is in the scroll margin at the top of the window or
13301 above what is displayed in the window. */
13304 /* Compute the vertical distance from PT to the scroll
13305 margin position. Give up if distance is greater than
13307 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13308 start_display (&it
, w
, pos
);
13310 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13311 it
.last_visible_y
, -1,
13312 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13313 dy
= it
.current_y
- y0
;
13314 if (dy
> scroll_max
)
13315 return SCROLLING_FAILED
;
13317 /* Compute new window start. */
13318 start_display (&it
, w
, startp
);
13320 if (scroll_conservatively
)
13322 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13323 else if (scroll_step
|| temp_scroll_step
)
13324 amount_to_scroll
= scroll_max
;
13327 aggressive
= current_buffer
->scroll_down_aggressively
;
13328 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13329 if (NUMBERP (aggressive
))
13331 double float_amount
= XFLOATINT (aggressive
) * height
;
13332 amount_to_scroll
= float_amount
;
13333 if (amount_to_scroll
== 0 && float_amount
> 0)
13334 amount_to_scroll
= 1;
13338 if (amount_to_scroll
<= 0)
13339 return SCROLLING_FAILED
;
13341 move_it_vertically_backward (&it
, amount_to_scroll
);
13342 startp
= it
.current
.pos
;
13346 /* Run window scroll functions. */
13347 startp
= run_window_scroll_functions (window
, startp
);
13349 /* Display the window. Give up if new fonts are loaded, or if point
13351 if (!try_window (window
, startp
, 0))
13352 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13353 else if (w
->cursor
.vpos
< 0)
13355 clear_glyph_matrix (w
->desired_matrix
);
13356 rc
= SCROLLING_FAILED
;
13360 /* Maybe forget recorded base line for line number display. */
13361 if (!just_this_one_p
13362 || current_buffer
->clip_changed
13363 || BEG_UNCHANGED
< CHARPOS (startp
))
13364 w
->base_line_number
= Qnil
;
13366 /* If cursor ends up on a partially visible line,
13367 treat that as being off the bottom of the screen. */
13368 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13370 clear_glyph_matrix (w
->desired_matrix
);
13371 ++extra_scroll_margin_lines
;
13374 rc
= SCROLLING_SUCCESS
;
13381 /* Compute a suitable window start for window W if display of W starts
13382 on a continuation line. Value is non-zero if a new window start
13385 The new window start will be computed, based on W's width, starting
13386 from the start of the continued line. It is the start of the
13387 screen line with the minimum distance from the old start W->start. */
13390 compute_window_start_on_continuation_line (w
)
13393 struct text_pos pos
, start_pos
;
13394 int window_start_changed_p
= 0;
13396 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13398 /* If window start is on a continuation line... Window start may be
13399 < BEGV in case there's invisible text at the start of the
13400 buffer (M-x rmail, for example). */
13401 if (CHARPOS (start_pos
) > BEGV
13402 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13405 struct glyph_row
*row
;
13407 /* Handle the case that the window start is out of range. */
13408 if (CHARPOS (start_pos
) < BEGV
)
13409 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13410 else if (CHARPOS (start_pos
) > ZV
)
13411 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13413 /* Find the start of the continued line. This should be fast
13414 because scan_buffer is fast (newline cache). */
13415 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13416 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13417 row
, DEFAULT_FACE_ID
);
13418 reseat_at_previous_visible_line_start (&it
);
13420 /* If the line start is "too far" away from the window start,
13421 say it takes too much time to compute a new window start. */
13422 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13423 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13425 int min_distance
, distance
;
13427 /* Move forward by display lines to find the new window
13428 start. If window width was enlarged, the new start can
13429 be expected to be > the old start. If window width was
13430 decreased, the new window start will be < the old start.
13431 So, we're looking for the display line start with the
13432 minimum distance from the old window start. */
13433 pos
= it
.current
.pos
;
13434 min_distance
= INFINITY
;
13435 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13436 distance
< min_distance
)
13438 min_distance
= distance
;
13439 pos
= it
.current
.pos
;
13440 move_it_by_lines (&it
, 1, 0);
13443 /* Set the window start there. */
13444 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13445 window_start_changed_p
= 1;
13449 return window_start_changed_p
;
13453 /* Try cursor movement in case text has not changed in window WINDOW,
13454 with window start STARTP. Value is
13456 CURSOR_MOVEMENT_SUCCESS if successful
13458 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13460 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13461 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13462 we want to scroll as if scroll-step were set to 1. See the code.
13464 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13465 which case we have to abort this redisplay, and adjust matrices
13470 CURSOR_MOVEMENT_SUCCESS
,
13471 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13472 CURSOR_MOVEMENT_MUST_SCROLL
,
13473 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13477 try_cursor_movement (window
, startp
, scroll_step
)
13478 Lisp_Object window
;
13479 struct text_pos startp
;
13482 struct window
*w
= XWINDOW (window
);
13483 struct frame
*f
= XFRAME (w
->frame
);
13484 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13487 if (inhibit_try_cursor_movement
)
13491 /* Handle case where text has not changed, only point, and it has
13492 not moved off the frame. */
13493 if (/* Point may be in this window. */
13494 PT
>= CHARPOS (startp
)
13495 /* Selective display hasn't changed. */
13496 && !current_buffer
->clip_changed
13497 /* Function force-mode-line-update is used to force a thorough
13498 redisplay. It sets either windows_or_buffers_changed or
13499 update_mode_lines. So don't take a shortcut here for these
13501 && !update_mode_lines
13502 && !windows_or_buffers_changed
13503 && !cursor_type_changed
13504 /* Can't use this case if highlighting a region. When a
13505 region exists, cursor movement has to do more than just
13507 && !(!NILP (Vtransient_mark_mode
)
13508 && !NILP (current_buffer
->mark_active
))
13509 && NILP (w
->region_showing
)
13510 && NILP (Vshow_trailing_whitespace
)
13511 /* Right after splitting windows, last_point may be nil. */
13512 && INTEGERP (w
->last_point
)
13513 /* This code is not used for mini-buffer for the sake of the case
13514 of redisplaying to replace an echo area message; since in
13515 that case the mini-buffer contents per se are usually
13516 unchanged. This code is of no real use in the mini-buffer
13517 since the handling of this_line_start_pos, etc., in redisplay
13518 handles the same cases. */
13519 && !EQ (window
, minibuf_window
)
13520 /* When splitting windows or for new windows, it happens that
13521 redisplay is called with a nil window_end_vpos or one being
13522 larger than the window. This should really be fixed in
13523 window.c. I don't have this on my list, now, so we do
13524 approximately the same as the old redisplay code. --gerd. */
13525 && INTEGERP (w
->window_end_vpos
)
13526 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13527 && (FRAME_WINDOW_P (f
)
13528 || !overlay_arrow_in_current_buffer_p ()))
13530 int this_scroll_margin
, top_scroll_margin
;
13531 struct glyph_row
*row
= NULL
;
13534 debug_method_add (w
, "cursor movement");
13537 /* Scroll if point within this distance from the top or bottom
13538 of the window. This is a pixel value. */
13539 if (scroll_margin
> 0)
13541 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13542 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13545 this_scroll_margin
= 0;
13547 top_scroll_margin
= this_scroll_margin
;
13548 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13549 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13551 /* Start with the row the cursor was displayed during the last
13552 not paused redisplay. Give up if that row is not valid. */
13553 if (w
->last_cursor
.vpos
< 0
13554 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13555 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13558 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13559 if (row
->mode_line_p
)
13561 if (!row
->enabled_p
)
13562 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13563 /* If rows are bidi-reordered, back up until we find a row
13564 that does not belong to a continuation line. This is
13565 because we must consider all rows of a continued line as
13566 candidates for cursor positioning, since row start and
13567 end positions change non-linearly with vertical position
13569 /* FIXME: Revisit this when glyph ``spilling'' in
13570 continuation lines' rows is implemented for
13571 bidi-reordered rows. */
13572 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13574 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13576 xassert (row
->enabled_p
);
13578 /* If we hit the beginning of the displayed portion
13579 without finding the first row of a continued
13581 if (row
<= w
->current_matrix
->rows
)
13583 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13591 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13594 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13596 if (PT
> XFASTINT (w
->last_point
))
13598 /* Point has moved forward. */
13599 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13600 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13602 xassert (row
->enabled_p
);
13606 /* The end position of a row equals the start position
13607 of the next row. If PT is there, we would rather
13608 display it in the next line. */
13609 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13610 && MATRIX_ROW_END_CHARPOS (row
) == PT
13611 && !cursor_row_p (w
, row
))
13614 /* If within the scroll margin, scroll. Note that
13615 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13616 the next line would be drawn, and that
13617 this_scroll_margin can be zero. */
13618 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13619 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13620 /* Line is completely visible last line in window
13621 and PT is to be set in the next line. */
13622 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13623 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13624 && !row
->ends_at_zv_p
13625 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13628 else if (PT
< XFASTINT (w
->last_point
))
13630 /* Cursor has to be moved backward. Note that PT >=
13631 CHARPOS (startp) because of the outer if-statement. */
13632 while (!row
->mode_line_p
13633 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13634 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13635 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13636 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13637 row
> w
->current_matrix
->rows
13638 && (row
-1)->ends_in_newline_from_string_p
))))
13639 && (row
->y
> top_scroll_margin
13640 || CHARPOS (startp
) == BEGV
))
13642 xassert (row
->enabled_p
);
13646 /* Consider the following case: Window starts at BEGV,
13647 there is invisible, intangible text at BEGV, so that
13648 display starts at some point START > BEGV. It can
13649 happen that we are called with PT somewhere between
13650 BEGV and START. Try to handle that case. */
13651 if (row
< w
->current_matrix
->rows
13652 || row
->mode_line_p
)
13654 row
= w
->current_matrix
->rows
;
13655 if (row
->mode_line_p
)
13659 /* Due to newlines in overlay strings, we may have to
13660 skip forward over overlay strings. */
13661 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13662 && MATRIX_ROW_END_CHARPOS (row
) == PT
13663 && !cursor_row_p (w
, row
))
13666 /* If within the scroll margin, scroll. */
13667 if (row
->y
< top_scroll_margin
13668 && CHARPOS (startp
) != BEGV
)
13673 /* Cursor did not move. So don't scroll even if cursor line
13674 is partially visible, as it was so before. */
13675 rc
= CURSOR_MOVEMENT_SUCCESS
;
13678 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13679 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13681 /* if PT is not in the glyph row, give up. */
13682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13684 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13685 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13686 && make_cursor_line_fully_visible_p
)
13688 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13689 && !row
->ends_at_zv_p
13690 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13691 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13692 else if (row
->height
> window_box_height (w
))
13694 /* If we end up in a partially visible line, let's
13695 make it fully visible, except when it's taller
13696 than the window, in which case we can't do much
13699 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13703 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13704 if (!cursor_row_fully_visible_p (w
, 0, 1))
13705 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13707 rc
= CURSOR_MOVEMENT_SUCCESS
;
13711 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13712 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13714 /* With bidi-reordered rows, there could be more than
13715 one candidate row whose start and end positions
13716 occlude point. We need to let set_cursor_from_row
13717 find the best candidate. */
13718 /* FIXME: Revisit this when glyph ``spilling'' in
13719 continuation lines' rows is implemented for
13720 bidi-reordered rows. */
13725 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13727 /* As soon as we've found the first suitable row
13728 whose ends_at_zv_p flag is set, we are done. */
13730 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13732 rc
= CURSOR_MOVEMENT_SUCCESS
;
13737 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13738 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13739 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13740 && cursor_row_p (w
, row
));
13741 /* If we didn't find any candidate rows, or exited the
13742 loop before all the candidates were examined, signal
13743 to the caller that this method failed. */
13744 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13746 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13747 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13748 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13750 rc
= CURSOR_MOVEMENT_SUCCESS
;
13756 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13758 rc
= CURSOR_MOVEMENT_SUCCESS
;
13763 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13764 && MATRIX_ROW_START_CHARPOS (row
) == PT
13765 && cursor_row_p (w
, row
));
13774 set_vertical_scroll_bar (w
)
13777 int start
, end
, whole
;
13779 /* Calculate the start and end positions for the current window.
13780 At some point, it would be nice to choose between scrollbars
13781 which reflect the whole buffer size, with special markers
13782 indicating narrowing, and scrollbars which reflect only the
13785 Note that mini-buffers sometimes aren't displaying any text. */
13786 if (!MINI_WINDOW_P (w
)
13787 || (w
== XWINDOW (minibuf_window
)
13788 && NILP (echo_area_buffer
[0])))
13790 struct buffer
*buf
= XBUFFER (w
->buffer
);
13791 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13792 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13793 /* I don't think this is guaranteed to be right. For the
13794 moment, we'll pretend it is. */
13795 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13799 if (whole
< (end
- start
))
13800 whole
= end
- start
;
13803 start
= end
= whole
= 0;
13805 /* Indicate what this scroll bar ought to be displaying now. */
13806 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13807 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13808 (w
, end
- start
, whole
, start
);
13812 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13813 selected_window is redisplayed.
13815 We can return without actually redisplaying the window if
13816 fonts_changed_p is nonzero. In that case, redisplay_internal will
13820 redisplay_window (window
, just_this_one_p
)
13821 Lisp_Object window
;
13822 int just_this_one_p
;
13824 struct window
*w
= XWINDOW (window
);
13825 struct frame
*f
= XFRAME (w
->frame
);
13826 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13827 struct buffer
*old
= current_buffer
;
13828 struct text_pos lpoint
, opoint
, startp
;
13829 int update_mode_line
;
13832 /* Record it now because it's overwritten. */
13833 int current_matrix_up_to_date_p
= 0;
13834 int used_current_matrix_p
= 0;
13835 /* This is less strict than current_matrix_up_to_date_p.
13836 It indictes that the buffer contents and narrowing are unchanged. */
13837 int buffer_unchanged_p
= 0;
13838 int temp_scroll_step
= 0;
13839 int count
= SPECPDL_INDEX ();
13841 int centering_position
= -1;
13842 int last_line_misfit
= 0;
13843 int beg_unchanged
, end_unchanged
;
13845 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13848 /* W must be a leaf window here. */
13849 xassert (!NILP (w
->buffer
));
13851 *w
->desired_matrix
->method
= 0;
13855 reconsider_clip_changes (w
, buffer
);
13857 /* Has the mode line to be updated? */
13858 update_mode_line
= (!NILP (w
->update_mode_line
)
13859 || update_mode_lines
13860 || buffer
->clip_changed
13861 || buffer
->prevent_redisplay_optimizations_p
);
13863 if (MINI_WINDOW_P (w
))
13865 if (w
== XWINDOW (echo_area_window
)
13866 && !NILP (echo_area_buffer
[0]))
13868 if (update_mode_line
)
13869 /* We may have to update a tty frame's menu bar or a
13870 tool-bar. Example `M-x C-h C-h C-g'. */
13871 goto finish_menu_bars
;
13873 /* We've already displayed the echo area glyphs in this window. */
13874 goto finish_scroll_bars
;
13876 else if ((w
!= XWINDOW (minibuf_window
)
13877 || minibuf_level
== 0)
13878 /* When buffer is nonempty, redisplay window normally. */
13879 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13880 /* Quail displays non-mini buffers in minibuffer window.
13881 In that case, redisplay the window normally. */
13882 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13884 /* W is a mini-buffer window, but it's not active, so clear
13886 int yb
= window_text_bottom_y (w
);
13887 struct glyph_row
*row
;
13890 for (y
= 0, row
= w
->desired_matrix
->rows
;
13892 y
+= row
->height
, ++row
)
13893 blank_row (w
, row
, y
);
13894 goto finish_scroll_bars
;
13897 clear_glyph_matrix (w
->desired_matrix
);
13900 /* Otherwise set up data on this window; select its buffer and point
13902 /* Really select the buffer, for the sake of buffer-local
13904 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13906 current_matrix_up_to_date_p
13907 = (!NILP (w
->window_end_valid
)
13908 && !current_buffer
->clip_changed
13909 && !current_buffer
->prevent_redisplay_optimizations_p
13910 && XFASTINT (w
->last_modified
) >= MODIFF
13911 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13913 /* Run the window-bottom-change-functions
13914 if it is possible that the text on the screen has changed
13915 (either due to modification of the text, or any other reason). */
13916 if (!current_matrix_up_to_date_p
13917 && !NILP (Vwindow_text_change_functions
))
13919 safe_run_hooks (Qwindow_text_change_functions
);
13923 beg_unchanged
= BEG_UNCHANGED
;
13924 end_unchanged
= END_UNCHANGED
;
13926 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13928 specbind (Qinhibit_point_motion_hooks
, Qt
);
13931 = (!NILP (w
->window_end_valid
)
13932 && !current_buffer
->clip_changed
13933 && XFASTINT (w
->last_modified
) >= MODIFF
13934 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13936 /* When windows_or_buffers_changed is non-zero, we can't rely on
13937 the window end being valid, so set it to nil there. */
13938 if (windows_or_buffers_changed
)
13940 /* If window starts on a continuation line, maybe adjust the
13941 window start in case the window's width changed. */
13942 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13943 compute_window_start_on_continuation_line (w
);
13945 w
->window_end_valid
= Qnil
;
13948 /* Some sanity checks. */
13949 CHECK_WINDOW_END (w
);
13950 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13952 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13955 /* If %c is in mode line, update it if needed. */
13956 if (!NILP (w
->column_number_displayed
)
13957 /* This alternative quickly identifies a common case
13958 where no change is needed. */
13959 && !(PT
== XFASTINT (w
->last_point
)
13960 && XFASTINT (w
->last_modified
) >= MODIFF
13961 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13962 && (XFASTINT (w
->column_number_displayed
)
13963 != (int) current_column ())) /* iftc */
13964 update_mode_line
= 1;
13966 /* Count number of windows showing the selected buffer. An indirect
13967 buffer counts as its base buffer. */
13968 if (!just_this_one_p
)
13970 struct buffer
*current_base
, *window_base
;
13971 current_base
= current_buffer
;
13972 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13973 if (current_base
->base_buffer
)
13974 current_base
= current_base
->base_buffer
;
13975 if (window_base
->base_buffer
)
13976 window_base
= window_base
->base_buffer
;
13977 if (current_base
== window_base
)
13981 /* Point refers normally to the selected window. For any other
13982 window, set up appropriate value. */
13983 if (!EQ (window
, selected_window
))
13985 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13986 int new_pt_byte
= marker_byte_position (w
->pointm
);
13990 new_pt_byte
= BEGV_BYTE
;
13991 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13993 else if (new_pt
> (ZV
- 1))
13996 new_pt_byte
= ZV_BYTE
;
13997 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14000 /* We don't use SET_PT so that the point-motion hooks don't run. */
14001 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14004 /* If any of the character widths specified in the display table
14005 have changed, invalidate the width run cache. It's true that
14006 this may be a bit late to catch such changes, but the rest of
14007 redisplay goes (non-fatally) haywire when the display table is
14008 changed, so why should we worry about doing any better? */
14009 if (current_buffer
->width_run_cache
)
14011 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14013 if (! disptab_matches_widthtab (disptab
,
14014 XVECTOR (current_buffer
->width_table
)))
14016 invalidate_region_cache (current_buffer
,
14017 current_buffer
->width_run_cache
,
14019 recompute_width_table (current_buffer
, disptab
);
14023 /* If window-start is screwed up, choose a new one. */
14024 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14027 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14029 /* If someone specified a new starting point but did not insist,
14030 check whether it can be used. */
14031 if (!NILP (w
->optional_new_start
)
14032 && CHARPOS (startp
) >= BEGV
14033 && CHARPOS (startp
) <= ZV
)
14035 w
->optional_new_start
= Qnil
;
14036 start_display (&it
, w
, startp
);
14037 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14038 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14039 if (IT_CHARPOS (it
) == PT
)
14040 w
->force_start
= Qt
;
14041 /* IT may overshoot PT if text at PT is invisible. */
14042 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14043 w
->force_start
= Qt
;
14048 /* Handle case where place to start displaying has been specified,
14049 unless the specified location is outside the accessible range. */
14050 if (!NILP (w
->force_start
)
14051 || w
->frozen_window_start_p
)
14053 /* We set this later on if we have to adjust point. */
14056 w
->force_start
= Qnil
;
14058 w
->window_end_valid
= Qnil
;
14060 /* Forget any recorded base line for line number display. */
14061 if (!buffer_unchanged_p
)
14062 w
->base_line_number
= Qnil
;
14064 /* Redisplay the mode line. Select the buffer properly for that.
14065 Also, run the hook window-scroll-functions
14066 because we have scrolled. */
14067 /* Note, we do this after clearing force_start because
14068 if there's an error, it is better to forget about force_start
14069 than to get into an infinite loop calling the hook functions
14070 and having them get more errors. */
14071 if (!update_mode_line
14072 || ! NILP (Vwindow_scroll_functions
))
14074 update_mode_line
= 1;
14075 w
->update_mode_line
= Qt
;
14076 startp
= run_window_scroll_functions (window
, startp
);
14079 w
->last_modified
= make_number (0);
14080 w
->last_overlay_modified
= make_number (0);
14081 if (CHARPOS (startp
) < BEGV
)
14082 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14083 else if (CHARPOS (startp
) > ZV
)
14084 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14086 /* Redisplay, then check if cursor has been set during the
14087 redisplay. Give up if new fonts were loaded. */
14088 /* We used to issue a CHECK_MARGINS argument to try_window here,
14089 but this causes scrolling to fail when point begins inside
14090 the scroll margin (bug#148) -- cyd */
14091 if (!try_window (window
, startp
, 0))
14093 w
->force_start
= Qt
;
14094 clear_glyph_matrix (w
->desired_matrix
);
14095 goto need_larger_matrices
;
14098 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14100 /* If point does not appear, try to move point so it does
14101 appear. The desired matrix has been built above, so we
14102 can use it here. */
14103 new_vpos
= window_box_height (w
) / 2;
14106 if (!cursor_row_fully_visible_p (w
, 0, 0))
14108 /* Point does appear, but on a line partly visible at end of window.
14109 Move it back to a fully-visible line. */
14110 new_vpos
= window_box_height (w
);
14113 /* If we need to move point for either of the above reasons,
14114 now actually do it. */
14117 struct glyph_row
*row
;
14119 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14120 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14123 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14124 MATRIX_ROW_START_BYTEPOS (row
));
14126 if (w
!= XWINDOW (selected_window
))
14127 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14128 else if (current_buffer
== old
)
14129 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14131 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14133 /* If we are highlighting the region, then we just changed
14134 the region, so redisplay to show it. */
14135 if (!NILP (Vtransient_mark_mode
)
14136 && !NILP (current_buffer
->mark_active
))
14138 clear_glyph_matrix (w
->desired_matrix
);
14139 if (!try_window (window
, startp
, 0))
14140 goto need_larger_matrices
;
14145 debug_method_add (w
, "forced window start");
14150 /* Handle case where text has not changed, only point, and it has
14151 not moved off the frame, and we are not retrying after hscroll.
14152 (current_matrix_up_to_date_p is nonzero when retrying.) */
14153 if (current_matrix_up_to_date_p
14154 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14155 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14159 case CURSOR_MOVEMENT_SUCCESS
:
14160 used_current_matrix_p
= 1;
14163 case CURSOR_MOVEMENT_MUST_SCROLL
:
14164 goto try_to_scroll
;
14170 /* If current starting point was originally the beginning of a line
14171 but no longer is, find a new starting point. */
14172 else if (!NILP (w
->start_at_line_beg
)
14173 && !(CHARPOS (startp
) <= BEGV
14174 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14177 debug_method_add (w
, "recenter 1");
14182 /* Try scrolling with try_window_id. Value is > 0 if update has
14183 been done, it is -1 if we know that the same window start will
14184 not work. It is 0 if unsuccessful for some other reason. */
14185 else if ((tem
= try_window_id (w
)) != 0)
14188 debug_method_add (w
, "try_window_id %d", tem
);
14191 if (fonts_changed_p
)
14192 goto need_larger_matrices
;
14196 /* Otherwise try_window_id has returned -1 which means that we
14197 don't want the alternative below this comment to execute. */
14199 else if (CHARPOS (startp
) >= BEGV
14200 && CHARPOS (startp
) <= ZV
14201 && PT
>= CHARPOS (startp
)
14202 && (CHARPOS (startp
) < ZV
14203 /* Avoid starting at end of buffer. */
14204 || CHARPOS (startp
) == BEGV
14205 || (XFASTINT (w
->last_modified
) >= MODIFF
14206 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14209 /* If first window line is a continuation line, and window start
14210 is inside the modified region, but the first change is before
14211 current window start, we must select a new window start.
14213 However, if this is the result of a down-mouse event (e.g. by
14214 extending the mouse-drag-overlay), we don't want to select a
14215 new window start, since that would change the position under
14216 the mouse, resulting in an unwanted mouse-movement rather
14217 than a simple mouse-click. */
14218 if (NILP (w
->start_at_line_beg
)
14219 && NILP (do_mouse_tracking
)
14220 && CHARPOS (startp
) > BEGV
14221 && CHARPOS (startp
) > BEG
+ beg_unchanged
14222 && CHARPOS (startp
) <= Z
- end_unchanged
14223 /* Even if w->start_at_line_beg is nil, a new window may
14224 start at a line_beg, since that's how set_buffer_window
14225 sets it. So, we need to check the return value of
14226 compute_window_start_on_continuation_line. (See also
14228 && XMARKER (w
->start
)->buffer
== current_buffer
14229 && compute_window_start_on_continuation_line (w
))
14231 w
->force_start
= Qt
;
14232 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14237 debug_method_add (w
, "same window start");
14240 /* Try to redisplay starting at same place as before.
14241 If point has not moved off frame, accept the results. */
14242 if (!current_matrix_up_to_date_p
14243 /* Don't use try_window_reusing_current_matrix in this case
14244 because a window scroll function can have changed the
14246 || !NILP (Vwindow_scroll_functions
)
14247 || MINI_WINDOW_P (w
)
14248 || !(used_current_matrix_p
14249 = try_window_reusing_current_matrix (w
)))
14251 IF_DEBUG (debug_method_add (w
, "1"));
14252 if (try_window (window
, startp
, 1) < 0)
14253 /* -1 means we need to scroll.
14254 0 means we need new matrices, but fonts_changed_p
14255 is set in that case, so we will detect it below. */
14256 goto try_to_scroll
;
14259 if (fonts_changed_p
)
14260 goto need_larger_matrices
;
14262 if (w
->cursor
.vpos
>= 0)
14264 if (!just_this_one_p
14265 || current_buffer
->clip_changed
14266 || BEG_UNCHANGED
< CHARPOS (startp
))
14267 /* Forget any recorded base line for line number display. */
14268 w
->base_line_number
= Qnil
;
14270 if (!cursor_row_fully_visible_p (w
, 1, 0))
14272 clear_glyph_matrix (w
->desired_matrix
);
14273 last_line_misfit
= 1;
14275 /* Drop through and scroll. */
14280 clear_glyph_matrix (w
->desired_matrix
);
14285 w
->last_modified
= make_number (0);
14286 w
->last_overlay_modified
= make_number (0);
14288 /* Redisplay the mode line. Select the buffer properly for that. */
14289 if (!update_mode_line
)
14291 update_mode_line
= 1;
14292 w
->update_mode_line
= Qt
;
14295 /* Try to scroll by specified few lines. */
14296 if ((scroll_conservatively
14298 || temp_scroll_step
14299 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14300 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14301 && !current_buffer
->clip_changed
14302 && CHARPOS (startp
) >= BEGV
14303 && CHARPOS (startp
) <= ZV
)
14305 /* The function returns -1 if new fonts were loaded, 1 if
14306 successful, 0 if not successful. */
14307 int rc
= try_scrolling (window
, just_this_one_p
,
14308 scroll_conservatively
,
14310 temp_scroll_step
, last_line_misfit
);
14313 case SCROLLING_SUCCESS
:
14316 case SCROLLING_NEED_LARGER_MATRICES
:
14317 goto need_larger_matrices
;
14319 case SCROLLING_FAILED
:
14327 /* Finally, just choose place to start which centers point */
14330 if (centering_position
< 0)
14331 centering_position
= window_box_height (w
) / 2;
14334 debug_method_add (w
, "recenter");
14337 /* w->vscroll = 0; */
14339 /* Forget any previously recorded base line for line number display. */
14340 if (!buffer_unchanged_p
)
14341 w
->base_line_number
= Qnil
;
14343 /* Move backward half the height of the window. */
14344 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14345 it
.current_y
= it
.last_visible_y
;
14346 move_it_vertically_backward (&it
, centering_position
);
14347 xassert (IT_CHARPOS (it
) >= BEGV
);
14349 /* The function move_it_vertically_backward may move over more
14350 than the specified y-distance. If it->w is small, e.g. a
14351 mini-buffer window, we may end up in front of the window's
14352 display area. Start displaying at the start of the line
14353 containing PT in this case. */
14354 if (it
.current_y
<= 0)
14356 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14357 move_it_vertically_backward (&it
, 0);
14361 it
.current_x
= it
.hpos
= 0;
14363 /* Set startp here explicitly in case that helps avoid an infinite loop
14364 in case the window-scroll-functions functions get errors. */
14365 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14367 /* Run scroll hooks. */
14368 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14370 /* Redisplay the window. */
14371 if (!current_matrix_up_to_date_p
14372 || windows_or_buffers_changed
14373 || cursor_type_changed
14374 /* Don't use try_window_reusing_current_matrix in this case
14375 because it can have changed the buffer. */
14376 || !NILP (Vwindow_scroll_functions
)
14377 || !just_this_one_p
14378 || MINI_WINDOW_P (w
)
14379 || !(used_current_matrix_p
14380 = try_window_reusing_current_matrix (w
)))
14381 try_window (window
, startp
, 0);
14383 /* If new fonts have been loaded (due to fontsets), give up. We
14384 have to start a new redisplay since we need to re-adjust glyph
14386 if (fonts_changed_p
)
14387 goto need_larger_matrices
;
14389 /* If cursor did not appear assume that the middle of the window is
14390 in the first line of the window. Do it again with the next line.
14391 (Imagine a window of height 100, displaying two lines of height
14392 60. Moving back 50 from it->last_visible_y will end in the first
14394 if (w
->cursor
.vpos
< 0)
14396 if (!NILP (w
->window_end_valid
)
14397 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14399 clear_glyph_matrix (w
->desired_matrix
);
14400 move_it_by_lines (&it
, 1, 0);
14401 try_window (window
, it
.current
.pos
, 0);
14403 else if (PT
< IT_CHARPOS (it
))
14405 clear_glyph_matrix (w
->desired_matrix
);
14406 move_it_by_lines (&it
, -1, 0);
14407 try_window (window
, it
.current
.pos
, 0);
14411 /* Not much we can do about it. */
14415 /* Consider the following case: Window starts at BEGV, there is
14416 invisible, intangible text at BEGV, so that display starts at
14417 some point START > BEGV. It can happen that we are called with
14418 PT somewhere between BEGV and START. Try to handle that case. */
14419 if (w
->cursor
.vpos
< 0)
14421 struct glyph_row
*row
= w
->current_matrix
->rows
;
14422 if (row
->mode_line_p
)
14424 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14427 if (!cursor_row_fully_visible_p (w
, 0, 0))
14429 /* If vscroll is enabled, disable it and try again. */
14433 clear_glyph_matrix (w
->desired_matrix
);
14437 /* If centering point failed to make the whole line visible,
14438 put point at the top instead. That has to make the whole line
14439 visible, if it can be done. */
14440 if (centering_position
== 0)
14443 clear_glyph_matrix (w
->desired_matrix
);
14444 centering_position
= 0;
14450 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14451 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14452 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14455 /* Display the mode line, if we must. */
14456 if ((update_mode_line
14457 /* If window not full width, must redo its mode line
14458 if (a) the window to its side is being redone and
14459 (b) we do a frame-based redisplay. This is a consequence
14460 of how inverted lines are drawn in frame-based redisplay. */
14461 || (!just_this_one_p
14462 && !FRAME_WINDOW_P (f
)
14463 && !WINDOW_FULL_WIDTH_P (w
))
14464 /* Line number to display. */
14465 || INTEGERP (w
->base_line_pos
)
14466 /* Column number is displayed and different from the one displayed. */
14467 || (!NILP (w
->column_number_displayed
)
14468 && (XFASTINT (w
->column_number_displayed
)
14469 != (int) current_column ()))) /* iftc */
14470 /* This means that the window has a mode line. */
14471 && (WINDOW_WANTS_MODELINE_P (w
)
14472 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14474 display_mode_lines (w
);
14476 /* If mode line height has changed, arrange for a thorough
14477 immediate redisplay using the correct mode line height. */
14478 if (WINDOW_WANTS_MODELINE_P (w
)
14479 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14481 fonts_changed_p
= 1;
14482 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14483 = DESIRED_MODE_LINE_HEIGHT (w
);
14486 /* If header line height has changed, arrange for a thorough
14487 immediate redisplay using the correct header line height. */
14488 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14489 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14491 fonts_changed_p
= 1;
14492 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14493 = DESIRED_HEADER_LINE_HEIGHT (w
);
14496 if (fonts_changed_p
)
14497 goto need_larger_matrices
;
14500 if (!line_number_displayed
14501 && !BUFFERP (w
->base_line_pos
))
14503 w
->base_line_pos
= Qnil
;
14504 w
->base_line_number
= Qnil
;
14509 /* When we reach a frame's selected window, redo the frame's menu bar. */
14510 if (update_mode_line
14511 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14513 int redisplay_menu_p
= 0;
14514 int redisplay_tool_bar_p
= 0;
14516 if (FRAME_WINDOW_P (f
))
14518 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14519 || defined (HAVE_NS) || defined (USE_GTK)
14520 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14522 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14526 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14528 if (redisplay_menu_p
)
14529 display_menu_bar (w
);
14531 #ifdef HAVE_WINDOW_SYSTEM
14532 if (FRAME_WINDOW_P (f
))
14534 #if defined (USE_GTK) || defined (HAVE_NS)
14535 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14537 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14538 && (FRAME_TOOL_BAR_LINES (f
) > 0
14539 || !NILP (Vauto_resize_tool_bars
));
14542 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14544 extern int ignore_mouse_drag_p
;
14545 ignore_mouse_drag_p
= 1;
14551 #ifdef HAVE_WINDOW_SYSTEM
14552 if (FRAME_WINDOW_P (f
)
14553 && update_window_fringes (w
, (just_this_one_p
14554 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14555 || w
->pseudo_window_p
)))
14559 if (draw_window_fringes (w
, 1))
14560 x_draw_vertical_border (w
);
14564 #endif /* HAVE_WINDOW_SYSTEM */
14566 /* We go to this label, with fonts_changed_p nonzero,
14567 if it is necessary to try again using larger glyph matrices.
14568 We have to redeem the scroll bar even in this case,
14569 because the loop in redisplay_internal expects that. */
14570 need_larger_matrices
:
14572 finish_scroll_bars
:
14574 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14576 /* Set the thumb's position and size. */
14577 set_vertical_scroll_bar (w
);
14579 /* Note that we actually used the scroll bar attached to this
14580 window, so it shouldn't be deleted at the end of redisplay. */
14581 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14582 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14585 /* Restore current_buffer and value of point in it. */
14586 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14587 set_buffer_internal_1 (old
);
14588 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14589 shorter. This can be caused by log truncation in *Messages*. */
14590 if (CHARPOS (lpoint
) <= ZV
)
14591 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14593 unbind_to (count
, Qnil
);
14597 /* Build the complete desired matrix of WINDOW with a window start
14598 buffer position POS.
14600 Value is 1 if successful. It is zero if fonts were loaded during
14601 redisplay which makes re-adjusting glyph matrices necessary, and -1
14602 if point would appear in the scroll margins.
14603 (We check that only if CHECK_MARGINS is nonzero. */
14606 try_window (window
, pos
, check_margins
)
14607 Lisp_Object window
;
14608 struct text_pos pos
;
14611 struct window
*w
= XWINDOW (window
);
14613 struct glyph_row
*last_text_row
= NULL
;
14614 struct frame
*f
= XFRAME (w
->frame
);
14616 /* Make POS the new window start. */
14617 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14619 /* Mark cursor position as unknown. No overlay arrow seen. */
14620 w
->cursor
.vpos
= -1;
14621 overlay_arrow_seen
= 0;
14623 /* Initialize iterator and info to start at POS. */
14624 start_display (&it
, w
, pos
);
14626 /* Display all lines of W. */
14627 while (it
.current_y
< it
.last_visible_y
)
14629 if (display_line (&it
))
14630 last_text_row
= it
.glyph_row
- 1;
14631 if (fonts_changed_p
)
14635 /* Don't let the cursor end in the scroll margins. */
14637 && !MINI_WINDOW_P (w
))
14639 int this_scroll_margin
;
14641 if (scroll_margin
> 0)
14643 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14644 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14647 this_scroll_margin
= 0;
14649 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14650 && w
->cursor
.y
< this_scroll_margin
14651 && CHARPOS (pos
) > BEGV
14652 && IT_CHARPOS (it
) < ZV
)
14653 /* rms: considering make_cursor_line_fully_visible_p here
14654 seems to give wrong results. We don't want to recenter
14655 when the last line is partly visible, we want to allow
14656 that case to be handled in the usual way. */
14657 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14659 w
->cursor
.vpos
= -1;
14660 clear_glyph_matrix (w
->desired_matrix
);
14665 /* If bottom moved off end of frame, change mode line percentage. */
14666 if (XFASTINT (w
->window_end_pos
) <= 0
14667 && Z
!= IT_CHARPOS (it
))
14668 w
->update_mode_line
= Qt
;
14670 /* Set window_end_pos to the offset of the last character displayed
14671 on the window from the end of current_buffer. Set
14672 window_end_vpos to its row number. */
14675 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14676 w
->window_end_bytepos
14677 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14679 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14681 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14682 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14683 ->displays_text_p
);
14687 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14688 w
->window_end_pos
= make_number (Z
- ZV
);
14689 w
->window_end_vpos
= make_number (0);
14692 /* But that is not valid info until redisplay finishes. */
14693 w
->window_end_valid
= Qnil
;
14699 /************************************************************************
14700 Window redisplay reusing current matrix when buffer has not changed
14701 ************************************************************************/
14703 /* Try redisplay of window W showing an unchanged buffer with a
14704 different window start than the last time it was displayed by
14705 reusing its current matrix. Value is non-zero if successful.
14706 W->start is the new window start. */
14709 try_window_reusing_current_matrix (w
)
14712 struct frame
*f
= XFRAME (w
->frame
);
14713 struct glyph_row
*row
, *bottom_row
;
14716 struct text_pos start
, new_start
;
14717 int nrows_scrolled
, i
;
14718 struct glyph_row
*last_text_row
;
14719 struct glyph_row
*last_reused_text_row
;
14720 struct glyph_row
*start_row
;
14721 int start_vpos
, min_y
, max_y
;
14724 if (inhibit_try_window_reusing
)
14728 if (/* This function doesn't handle terminal frames. */
14729 !FRAME_WINDOW_P (f
)
14730 /* Don't try to reuse the display if windows have been split
14732 || windows_or_buffers_changed
14733 || cursor_type_changed
)
14736 /* Can't do this if region may have changed. */
14737 if ((!NILP (Vtransient_mark_mode
)
14738 && !NILP (current_buffer
->mark_active
))
14739 || !NILP (w
->region_showing
)
14740 || !NILP (Vshow_trailing_whitespace
))
14743 /* If top-line visibility has changed, give up. */
14744 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14745 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14748 /* Give up if old or new display is scrolled vertically. We could
14749 make this function handle this, but right now it doesn't. */
14750 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14751 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14754 /* The variable new_start now holds the new window start. The old
14755 start `start' can be determined from the current matrix. */
14756 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14757 start
= start_row
->start
.pos
;
14758 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14760 /* Clear the desired matrix for the display below. */
14761 clear_glyph_matrix (w
->desired_matrix
);
14763 if (CHARPOS (new_start
) <= CHARPOS (start
))
14767 /* Don't use this method if the display starts with an ellipsis
14768 displayed for invisible text. It's not easy to handle that case
14769 below, and it's certainly not worth the effort since this is
14770 not a frequent case. */
14771 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14774 IF_DEBUG (debug_method_add (w
, "twu1"));
14776 /* Display up to a row that can be reused. The variable
14777 last_text_row is set to the last row displayed that displays
14778 text. Note that it.vpos == 0 if or if not there is a
14779 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14780 start_display (&it
, w
, new_start
);
14781 first_row_y
= it
.current_y
;
14782 w
->cursor
.vpos
= -1;
14783 last_text_row
= last_reused_text_row
= NULL
;
14785 while (it
.current_y
< it
.last_visible_y
14786 && !fonts_changed_p
)
14788 /* If we have reached into the characters in the START row,
14789 that means the line boundaries have changed. So we
14790 can't start copying with the row START. Maybe it will
14791 work to start copying with the following row. */
14792 while (IT_CHARPOS (it
) > CHARPOS (start
))
14794 /* Advance to the next row as the "start". */
14796 start
= start_row
->start
.pos
;
14797 /* If there are no more rows to try, or just one, give up. */
14798 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14799 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14800 || CHARPOS (start
) == ZV
)
14802 clear_glyph_matrix (w
->desired_matrix
);
14806 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14808 /* If we have reached alignment,
14809 we can copy the rest of the rows. */
14810 if (IT_CHARPOS (it
) == CHARPOS (start
))
14813 if (display_line (&it
))
14814 last_text_row
= it
.glyph_row
- 1;
14817 /* A value of current_y < last_visible_y means that we stopped
14818 at the previous window start, which in turn means that we
14819 have at least one reusable row. */
14820 if (it
.current_y
< it
.last_visible_y
)
14822 /* IT.vpos always starts from 0; it counts text lines. */
14823 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14825 /* Find PT if not already found in the lines displayed. */
14826 if (w
->cursor
.vpos
< 0)
14828 int dy
= it
.current_y
- start_row
->y
;
14830 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14831 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14833 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14834 dy
, nrows_scrolled
);
14837 clear_glyph_matrix (w
->desired_matrix
);
14842 /* Scroll the display. Do it before the current matrix is
14843 changed. The problem here is that update has not yet
14844 run, i.e. part of the current matrix is not up to date.
14845 scroll_run_hook will clear the cursor, and use the
14846 current matrix to get the height of the row the cursor is
14848 run
.current_y
= start_row
->y
;
14849 run
.desired_y
= it
.current_y
;
14850 run
.height
= it
.last_visible_y
- it
.current_y
;
14852 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14855 FRAME_RIF (f
)->update_window_begin_hook (w
);
14856 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14857 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14858 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14862 /* Shift current matrix down by nrows_scrolled lines. */
14863 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14864 rotate_matrix (w
->current_matrix
,
14866 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14869 /* Disable lines that must be updated. */
14870 for (i
= 0; i
< nrows_scrolled
; ++i
)
14871 (start_row
+ i
)->enabled_p
= 0;
14873 /* Re-compute Y positions. */
14874 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14875 max_y
= it
.last_visible_y
;
14876 for (row
= start_row
+ nrows_scrolled
;
14880 row
->y
= it
.current_y
;
14881 row
->visible_height
= row
->height
;
14883 if (row
->y
< min_y
)
14884 row
->visible_height
-= min_y
- row
->y
;
14885 if (row
->y
+ row
->height
> max_y
)
14886 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14887 row
->redraw_fringe_bitmaps_p
= 1;
14889 it
.current_y
+= row
->height
;
14891 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14892 last_reused_text_row
= row
;
14893 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14897 /* Disable lines in the current matrix which are now
14898 below the window. */
14899 for (++row
; row
< bottom_row
; ++row
)
14900 row
->enabled_p
= row
->mode_line_p
= 0;
14903 /* Update window_end_pos etc.; last_reused_text_row is the last
14904 reused row from the current matrix containing text, if any.
14905 The value of last_text_row is the last displayed line
14906 containing text. */
14907 if (last_reused_text_row
)
14909 w
->window_end_bytepos
14910 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14912 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14914 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14915 w
->current_matrix
));
14917 else if (last_text_row
)
14919 w
->window_end_bytepos
14920 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14922 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14924 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14928 /* This window must be completely empty. */
14929 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14930 w
->window_end_pos
= make_number (Z
- ZV
);
14931 w
->window_end_vpos
= make_number (0);
14933 w
->window_end_valid
= Qnil
;
14935 /* Update hint: don't try scrolling again in update_window. */
14936 w
->desired_matrix
->no_scrolling_p
= 1;
14939 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14943 else if (CHARPOS (new_start
) > CHARPOS (start
))
14945 struct glyph_row
*pt_row
, *row
;
14946 struct glyph_row
*first_reusable_row
;
14947 struct glyph_row
*first_row_to_display
;
14949 int yb
= window_text_bottom_y (w
);
14951 /* Find the row starting at new_start, if there is one. Don't
14952 reuse a partially visible line at the end. */
14953 first_reusable_row
= start_row
;
14954 while (first_reusable_row
->enabled_p
14955 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14956 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14957 < CHARPOS (new_start
)))
14958 ++first_reusable_row
;
14960 /* Give up if there is no row to reuse. */
14961 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14962 || !first_reusable_row
->enabled_p
14963 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14964 != CHARPOS (new_start
)))
14967 /* We can reuse fully visible rows beginning with
14968 first_reusable_row to the end of the window. Set
14969 first_row_to_display to the first row that cannot be reused.
14970 Set pt_row to the row containing point, if there is any. */
14972 for (first_row_to_display
= first_reusable_row
;
14973 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14974 ++first_row_to_display
)
14976 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14977 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14978 pt_row
= first_row_to_display
;
14981 /* Start displaying at the start of first_row_to_display. */
14982 xassert (first_row_to_display
->y
< yb
);
14983 init_to_row_start (&it
, w
, first_row_to_display
);
14985 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14987 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14989 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14990 + WINDOW_HEADER_LINE_HEIGHT (w
));
14992 /* Display lines beginning with first_row_to_display in the
14993 desired matrix. Set last_text_row to the last row displayed
14994 that displays text. */
14995 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14996 if (pt_row
== NULL
)
14997 w
->cursor
.vpos
= -1;
14998 last_text_row
= NULL
;
14999 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15000 if (display_line (&it
))
15001 last_text_row
= it
.glyph_row
- 1;
15003 /* If point is in a reused row, adjust y and vpos of the cursor
15007 w
->cursor
.vpos
-= nrows_scrolled
;
15008 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15011 /* Give up if point isn't in a row displayed or reused. (This
15012 also handles the case where w->cursor.vpos < nrows_scrolled
15013 after the calls to display_line, which can happen with scroll
15014 margins. See bug#1295.) */
15015 if (w
->cursor
.vpos
< 0)
15017 clear_glyph_matrix (w
->desired_matrix
);
15021 /* Scroll the display. */
15022 run
.current_y
= first_reusable_row
->y
;
15023 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15024 run
.height
= it
.last_visible_y
- run
.current_y
;
15025 dy
= run
.current_y
- run
.desired_y
;
15030 FRAME_RIF (f
)->update_window_begin_hook (w
);
15031 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15032 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15033 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15037 /* Adjust Y positions of reused rows. */
15038 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15039 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15040 max_y
= it
.last_visible_y
;
15041 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15044 row
->visible_height
= row
->height
;
15045 if (row
->y
< min_y
)
15046 row
->visible_height
-= min_y
- row
->y
;
15047 if (row
->y
+ row
->height
> max_y
)
15048 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15049 row
->redraw_fringe_bitmaps_p
= 1;
15052 /* Scroll the current matrix. */
15053 xassert (nrows_scrolled
> 0);
15054 rotate_matrix (w
->current_matrix
,
15056 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15059 /* Disable rows not reused. */
15060 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15061 row
->enabled_p
= 0;
15063 /* Point may have moved to a different line, so we cannot assume that
15064 the previous cursor position is valid; locate the correct row. */
15067 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15068 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15072 w
->cursor
.y
= row
->y
;
15074 if (row
< bottom_row
)
15076 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15077 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15078 struct glyph
*orig_glyph
= glyph
;
15079 struct cursor_pos orig_cursor
= w
->cursor
;
15082 && (!BUFFERP (glyph
->object
)
15083 || glyph
->charpos
!= PT
);
15087 w
->cursor
.x
+= glyph
->pixel_width
;
15089 /* With bidi reordering, charpos changes non-linearly
15090 with hpos, so the right glyph could be to the
15092 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15093 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15095 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15097 glyph
= orig_glyph
- 1;
15098 orig_cursor
.hpos
--;
15099 orig_cursor
.x
-= glyph
->pixel_width
;
15100 for (; glyph
>= start_glyph
15101 && (!BUFFERP (glyph
->object
)
15102 || glyph
->charpos
!= PT
);
15106 w
->cursor
.x
-= glyph
->pixel_width
;
15108 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15109 w
->cursor
= orig_cursor
;
15114 /* Adjust window end. A null value of last_text_row means that
15115 the window end is in reused rows which in turn means that
15116 only its vpos can have changed. */
15119 w
->window_end_bytepos
15120 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15122 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15124 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15129 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15132 w
->window_end_valid
= Qnil
;
15133 w
->desired_matrix
->no_scrolling_p
= 1;
15136 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15146 /************************************************************************
15147 Window redisplay reusing current matrix when buffer has changed
15148 ************************************************************************/
15150 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15151 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15153 static struct glyph_row
*
15154 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15155 struct glyph_row
*));
15158 /* Return the last row in MATRIX displaying text. If row START is
15159 non-null, start searching with that row. IT gives the dimensions
15160 of the display. Value is null if matrix is empty; otherwise it is
15161 a pointer to the row found. */
15163 static struct glyph_row
*
15164 find_last_row_displaying_text (matrix
, it
, start
)
15165 struct glyph_matrix
*matrix
;
15167 struct glyph_row
*start
;
15169 struct glyph_row
*row
, *row_found
;
15171 /* Set row_found to the last row in IT->w's current matrix
15172 displaying text. The loop looks funny but think of partially
15175 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15176 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15178 xassert (row
->enabled_p
);
15180 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15189 /* Return the last row in the current matrix of W that is not affected
15190 by changes at the start of current_buffer that occurred since W's
15191 current matrix was built. Value is null if no such row exists.
15193 BEG_UNCHANGED us the number of characters unchanged at the start of
15194 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15195 first changed character in current_buffer. Characters at positions <
15196 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15197 when the current matrix was built. */
15199 static struct glyph_row
*
15200 find_last_unchanged_at_beg_row (w
)
15203 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15204 struct glyph_row
*row
;
15205 struct glyph_row
*row_found
= NULL
;
15206 int yb
= window_text_bottom_y (w
);
15208 /* Find the last row displaying unchanged text. */
15209 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15210 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15211 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15214 if (/* If row ends before first_changed_pos, it is unchanged,
15215 except in some case. */
15216 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15217 /* When row ends in ZV and we write at ZV it is not
15219 && !row
->ends_at_zv_p
15220 /* When first_changed_pos is the end of a continued line,
15221 row is not unchanged because it may be no longer
15223 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15224 && (row
->continued_p
15225 || row
->exact_window_width_line_p
)))
15228 /* Stop if last visible row. */
15229 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15237 /* Find the first glyph row in the current matrix of W that is not
15238 affected by changes at the end of current_buffer since the
15239 time W's current matrix was built.
15241 Return in *DELTA the number of chars by which buffer positions in
15242 unchanged text at the end of current_buffer must be adjusted.
15244 Return in *DELTA_BYTES the corresponding number of bytes.
15246 Value is null if no such row exists, i.e. all rows are affected by
15249 static struct glyph_row
*
15250 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15252 int *delta
, *delta_bytes
;
15254 struct glyph_row
*row
;
15255 struct glyph_row
*row_found
= NULL
;
15257 *delta
= *delta_bytes
= 0;
15259 /* Display must not have been paused, otherwise the current matrix
15260 is not up to date. */
15261 eassert (!NILP (w
->window_end_valid
));
15263 /* A value of window_end_pos >= END_UNCHANGED means that the window
15264 end is in the range of changed text. If so, there is no
15265 unchanged row at the end of W's current matrix. */
15266 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15269 /* Set row to the last row in W's current matrix displaying text. */
15270 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15272 /* If matrix is entirely empty, no unchanged row exists. */
15273 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15275 /* The value of row is the last glyph row in the matrix having a
15276 meaningful buffer position in it. The end position of row
15277 corresponds to window_end_pos. This allows us to translate
15278 buffer positions in the current matrix to current buffer
15279 positions for characters not in changed text. */
15280 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15281 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15282 int last_unchanged_pos
, last_unchanged_pos_old
;
15283 struct glyph_row
*first_text_row
15284 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15286 *delta
= Z
- Z_old
;
15287 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15289 /* Set last_unchanged_pos to the buffer position of the last
15290 character in the buffer that has not been changed. Z is the
15291 index + 1 of the last character in current_buffer, i.e. by
15292 subtracting END_UNCHANGED we get the index of the last
15293 unchanged character, and we have to add BEG to get its buffer
15295 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15296 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15298 /* Search backward from ROW for a row displaying a line that
15299 starts at a minimum position >= last_unchanged_pos_old. */
15300 for (; row
> first_text_row
; --row
)
15302 /* This used to abort, but it can happen.
15303 It is ok to just stop the search instead here. KFS. */
15304 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15307 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15312 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15318 /* Make sure that glyph rows in the current matrix of window W
15319 reference the same glyph memory as corresponding rows in the
15320 frame's frame matrix. This function is called after scrolling W's
15321 current matrix on a terminal frame in try_window_id and
15322 try_window_reusing_current_matrix. */
15325 sync_frame_with_window_matrix_rows (w
)
15328 struct frame
*f
= XFRAME (w
->frame
);
15329 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15331 /* Preconditions: W must be a leaf window and full-width. Its frame
15332 must have a frame matrix. */
15333 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15334 xassert (WINDOW_FULL_WIDTH_P (w
));
15335 xassert (!FRAME_WINDOW_P (f
));
15337 /* If W is a full-width window, glyph pointers in W's current matrix
15338 have, by definition, to be the same as glyph pointers in the
15339 corresponding frame matrix. Note that frame matrices have no
15340 marginal areas (see build_frame_matrix). */
15341 window_row
= w
->current_matrix
->rows
;
15342 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15343 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15344 while (window_row
< window_row_end
)
15346 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15347 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15349 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15350 frame_row
->glyphs
[TEXT_AREA
] = start
;
15351 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15352 frame_row
->glyphs
[LAST_AREA
] = end
;
15354 /* Disable frame rows whose corresponding window rows have
15355 been disabled in try_window_id. */
15356 if (!window_row
->enabled_p
)
15357 frame_row
->enabled_p
= 0;
15359 ++window_row
, ++frame_row
;
15364 /* Find the glyph row in window W containing CHARPOS. Consider all
15365 rows between START and END (not inclusive). END null means search
15366 all rows to the end of the display area of W. Value is the row
15367 containing CHARPOS or null. */
15370 row_containing_pos (w
, charpos
, start
, end
, dy
)
15373 struct glyph_row
*start
, *end
;
15376 struct glyph_row
*row
= start
;
15377 struct glyph_row
*best_row
= NULL
;
15378 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15381 /* If we happen to start on a header-line, skip that. */
15382 if (row
->mode_line_p
)
15385 if ((end
&& row
>= end
) || !row
->enabled_p
)
15388 last_y
= window_text_bottom_y (w
) - dy
;
15392 /* Give up if we have gone too far. */
15393 if (end
&& row
>= end
)
15395 /* This formerly returned if they were equal.
15396 I think that both quantities are of a "last plus one" type;
15397 if so, when they are equal, the row is within the screen. -- rms. */
15398 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15401 /* If it is in this row, return this row. */
15402 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15403 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15404 /* The end position of a row equals the start
15405 position of the next row. If CHARPOS is there, we
15406 would rather display it in the next line, except
15407 when this line ends in ZV. */
15408 && !row
->ends_at_zv_p
15409 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15410 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15414 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15416 /* In bidi-reordered rows, there could be several rows
15417 occluding point. We need to find the one which fits
15418 CHARPOS the best. */
15419 for (g
= row
->glyphs
[TEXT_AREA
];
15420 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15423 if (!STRINGP (g
->object
))
15425 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15427 mindif
= eabs (g
->charpos
- charpos
);
15440 /* Try to redisplay window W by reusing its existing display. W's
15441 current matrix must be up to date when this function is called,
15442 i.e. window_end_valid must not be nil.
15446 1 if display has been updated
15447 0 if otherwise unsuccessful
15448 -1 if redisplay with same window start is known not to succeed
15450 The following steps are performed:
15452 1. Find the last row in the current matrix of W that is not
15453 affected by changes at the start of current_buffer. If no such row
15456 2. Find the first row in W's current matrix that is not affected by
15457 changes at the end of current_buffer. Maybe there is no such row.
15459 3. Display lines beginning with the row + 1 found in step 1 to the
15460 row found in step 2 or, if step 2 didn't find a row, to the end of
15463 4. If cursor is not known to appear on the window, give up.
15465 5. If display stopped at the row found in step 2, scroll the
15466 display and current matrix as needed.
15468 6. Maybe display some lines at the end of W, if we must. This can
15469 happen under various circumstances, like a partially visible line
15470 becoming fully visible, or because newly displayed lines are displayed
15471 in smaller font sizes.
15473 7. Update W's window end information. */
15479 struct frame
*f
= XFRAME (w
->frame
);
15480 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15481 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15482 struct glyph_row
*last_unchanged_at_beg_row
;
15483 struct glyph_row
*first_unchanged_at_end_row
;
15484 struct glyph_row
*row
;
15485 struct glyph_row
*bottom_row
;
15488 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15489 struct text_pos start_pos
;
15491 int first_unchanged_at_end_vpos
= 0;
15492 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15493 struct text_pos start
;
15494 int first_changed_charpos
, last_changed_charpos
;
15497 if (inhibit_try_window_id
)
15501 /* This is handy for debugging. */
15503 #define GIVE_UP(X) \
15505 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15509 #define GIVE_UP(X) return 0
15512 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15514 /* Don't use this for mini-windows because these can show
15515 messages and mini-buffers, and we don't handle that here. */
15516 if (MINI_WINDOW_P (w
))
15519 /* This flag is used to prevent redisplay optimizations. */
15520 if (windows_or_buffers_changed
|| cursor_type_changed
)
15523 /* Verify that narrowing has not changed.
15524 Also verify that we were not told to prevent redisplay optimizations.
15525 It would be nice to further
15526 reduce the number of cases where this prevents try_window_id. */
15527 if (current_buffer
->clip_changed
15528 || current_buffer
->prevent_redisplay_optimizations_p
)
15531 /* Window must either use window-based redisplay or be full width. */
15532 if (!FRAME_WINDOW_P (f
)
15533 && (!FRAME_LINE_INS_DEL_OK (f
)
15534 || !WINDOW_FULL_WIDTH_P (w
)))
15537 /* Give up if point is known NOT to appear in W. */
15538 if (PT
< CHARPOS (start
))
15541 /* Another way to prevent redisplay optimizations. */
15542 if (XFASTINT (w
->last_modified
) == 0)
15545 /* Verify that window is not hscrolled. */
15546 if (XFASTINT (w
->hscroll
) != 0)
15549 /* Verify that display wasn't paused. */
15550 if (NILP (w
->window_end_valid
))
15553 /* Can't use this if highlighting a region because a cursor movement
15554 will do more than just set the cursor. */
15555 if (!NILP (Vtransient_mark_mode
)
15556 && !NILP (current_buffer
->mark_active
))
15559 /* Likewise if highlighting trailing whitespace. */
15560 if (!NILP (Vshow_trailing_whitespace
))
15563 /* Likewise if showing a region. */
15564 if (!NILP (w
->region_showing
))
15567 /* Can't use this if overlay arrow position and/or string have
15569 if (overlay_arrows_changed_p ())
15572 /* When word-wrap is on, adding a space to the first word of a
15573 wrapped line can change the wrap position, altering the line
15574 above it. It might be worthwhile to handle this more
15575 intelligently, but for now just redisplay from scratch. */
15576 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15579 /* Under bidi reordering, adding or deleting a character in the
15580 beginning of a paragraph, before the first strong directional
15581 character, can change the base direction of the paragraph (unless
15582 the buffer specifies a fixed paragraph direction), which will
15583 require to redisplay the whole paragraph. It might be worthwhile
15584 to find the paragraph limits and widen the range of redisplayed
15585 lines to that, but for now just give up this optimization and
15586 redisplay from scratch. */
15587 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15588 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15591 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15592 only if buffer has really changed. The reason is that the gap is
15593 initially at Z for freshly visited files. The code below would
15594 set end_unchanged to 0 in that case. */
15595 if (MODIFF
> SAVE_MODIFF
15596 /* This seems to happen sometimes after saving a buffer. */
15597 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15599 if (GPT
- BEG
< BEG_UNCHANGED
)
15600 BEG_UNCHANGED
= GPT
- BEG
;
15601 if (Z
- GPT
< END_UNCHANGED
)
15602 END_UNCHANGED
= Z
- GPT
;
15605 /* The position of the first and last character that has been changed. */
15606 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15607 last_changed_charpos
= Z
- END_UNCHANGED
;
15609 /* If window starts after a line end, and the last change is in
15610 front of that newline, then changes don't affect the display.
15611 This case happens with stealth-fontification. Note that although
15612 the display is unchanged, glyph positions in the matrix have to
15613 be adjusted, of course. */
15614 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15615 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15616 && ((last_changed_charpos
< CHARPOS (start
)
15617 && CHARPOS (start
) == BEGV
)
15618 || (last_changed_charpos
< CHARPOS (start
) - 1
15619 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15621 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15622 struct glyph_row
*r0
;
15624 /* Compute how many chars/bytes have been added to or removed
15625 from the buffer. */
15626 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15627 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15629 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15631 /* Give up if PT is not in the window. Note that it already has
15632 been checked at the start of try_window_id that PT is not in
15633 front of the window start. */
15634 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15637 /* If window start is unchanged, we can reuse the whole matrix
15638 as is, after adjusting glyph positions. No need to compute
15639 the window end again, since its offset from Z hasn't changed. */
15640 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15641 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15642 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15643 /* PT must not be in a partially visible line. */
15644 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15645 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15647 /* Adjust positions in the glyph matrix. */
15648 if (delta
|| delta_bytes
)
15650 struct glyph_row
*r1
15651 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15652 increment_matrix_positions (w
->current_matrix
,
15653 MATRIX_ROW_VPOS (r0
, current_matrix
),
15654 MATRIX_ROW_VPOS (r1
, current_matrix
),
15655 delta
, delta_bytes
);
15658 /* Set the cursor. */
15659 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15661 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15668 /* Handle the case that changes are all below what is displayed in
15669 the window, and that PT is in the window. This shortcut cannot
15670 be taken if ZV is visible in the window, and text has been added
15671 there that is visible in the window. */
15672 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15673 /* ZV is not visible in the window, or there are no
15674 changes at ZV, actually. */
15675 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15676 || first_changed_charpos
== last_changed_charpos
))
15678 struct glyph_row
*r0
;
15680 /* Give up if PT is not in the window. Note that it already has
15681 been checked at the start of try_window_id that PT is not in
15682 front of the window start. */
15683 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15686 /* If window start is unchanged, we can reuse the whole matrix
15687 as is, without changing glyph positions since no text has
15688 been added/removed in front of the window end. */
15689 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15690 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15691 /* PT must not be in a partially visible line. */
15692 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15693 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15695 /* We have to compute the window end anew since text
15696 can have been added/removed after it. */
15698 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15699 w
->window_end_bytepos
15700 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15702 /* Set the cursor. */
15703 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15705 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15712 /* Give up if window start is in the changed area.
15714 The condition used to read
15716 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15718 but why that was tested escapes me at the moment. */
15719 if (CHARPOS (start
) >= first_changed_charpos
15720 && CHARPOS (start
) <= last_changed_charpos
)
15723 /* Check that window start agrees with the start of the first glyph
15724 row in its current matrix. Check this after we know the window
15725 start is not in changed text, otherwise positions would not be
15727 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15728 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15731 /* Give up if the window ends in strings. Overlay strings
15732 at the end are difficult to handle, so don't try. */
15733 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15734 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15737 /* Compute the position at which we have to start displaying new
15738 lines. Some of the lines at the top of the window might be
15739 reusable because they are not displaying changed text. Find the
15740 last row in W's current matrix not affected by changes at the
15741 start of current_buffer. Value is null if changes start in the
15742 first line of window. */
15743 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15744 if (last_unchanged_at_beg_row
)
15746 /* Avoid starting to display in the moddle of a character, a TAB
15747 for instance. This is easier than to set up the iterator
15748 exactly, and it's not a frequent case, so the additional
15749 effort wouldn't really pay off. */
15750 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15751 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15752 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15753 --last_unchanged_at_beg_row
;
15755 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15758 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15760 start_pos
= it
.current
.pos
;
15762 /* Start displaying new lines in the desired matrix at the same
15763 vpos we would use in the current matrix, i.e. below
15764 last_unchanged_at_beg_row. */
15765 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15767 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15768 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15770 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15774 /* There are no reusable lines at the start of the window.
15775 Start displaying in the first text line. */
15776 start_display (&it
, w
, start
);
15777 it
.vpos
= it
.first_vpos
;
15778 start_pos
= it
.current
.pos
;
15781 /* Find the first row that is not affected by changes at the end of
15782 the buffer. Value will be null if there is no unchanged row, in
15783 which case we must redisplay to the end of the window. delta
15784 will be set to the value by which buffer positions beginning with
15785 first_unchanged_at_end_row have to be adjusted due to text
15787 first_unchanged_at_end_row
15788 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15789 IF_DEBUG (debug_delta
= delta
);
15790 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15792 /* Set stop_pos to the buffer position up to which we will have to
15793 display new lines. If first_unchanged_at_end_row != NULL, this
15794 is the buffer position of the start of the line displayed in that
15795 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15796 that we don't stop at a buffer position. */
15798 if (first_unchanged_at_end_row
)
15800 xassert (last_unchanged_at_beg_row
== NULL
15801 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15803 /* If this is a continuation line, move forward to the next one
15804 that isn't. Changes in lines above affect this line.
15805 Caution: this may move first_unchanged_at_end_row to a row
15806 not displaying text. */
15807 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15808 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15809 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15810 < it
.last_visible_y
))
15811 ++first_unchanged_at_end_row
;
15813 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15814 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15815 >= it
.last_visible_y
))
15816 first_unchanged_at_end_row
= NULL
;
15819 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15821 first_unchanged_at_end_vpos
15822 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15823 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15826 else if (last_unchanged_at_beg_row
== NULL
)
15832 /* Either there is no unchanged row at the end, or the one we have
15833 now displays text. This is a necessary condition for the window
15834 end pos calculation at the end of this function. */
15835 xassert (first_unchanged_at_end_row
== NULL
15836 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15838 debug_last_unchanged_at_beg_vpos
15839 = (last_unchanged_at_beg_row
15840 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15842 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15844 #endif /* GLYPH_DEBUG != 0 */
15847 /* Display new lines. Set last_text_row to the last new line
15848 displayed which has text on it, i.e. might end up as being the
15849 line where the window_end_vpos is. */
15850 w
->cursor
.vpos
= -1;
15851 last_text_row
= NULL
;
15852 overlay_arrow_seen
= 0;
15853 while (it
.current_y
< it
.last_visible_y
15854 && !fonts_changed_p
15855 && (first_unchanged_at_end_row
== NULL
15856 || IT_CHARPOS (it
) < stop_pos
))
15858 if (display_line (&it
))
15859 last_text_row
= it
.glyph_row
- 1;
15862 if (fonts_changed_p
)
15866 /* Compute differences in buffer positions, y-positions etc. for
15867 lines reused at the bottom of the window. Compute what we can
15869 if (first_unchanged_at_end_row
15870 /* No lines reused because we displayed everything up to the
15871 bottom of the window. */
15872 && it
.current_y
< it
.last_visible_y
)
15875 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15877 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15878 run
.current_y
= first_unchanged_at_end_row
->y
;
15879 run
.desired_y
= run
.current_y
+ dy
;
15880 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15884 delta
= delta_bytes
= dvpos
= dy
15885 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15886 first_unchanged_at_end_row
= NULL
;
15888 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15891 /* Find the cursor if not already found. We have to decide whether
15892 PT will appear on this window (it sometimes doesn't, but this is
15893 not a very frequent case.) This decision has to be made before
15894 the current matrix is altered. A value of cursor.vpos < 0 means
15895 that PT is either in one of the lines beginning at
15896 first_unchanged_at_end_row or below the window. Don't care for
15897 lines that might be displayed later at the window end; as
15898 mentioned, this is not a frequent case. */
15899 if (w
->cursor
.vpos
< 0)
15901 /* Cursor in unchanged rows at the top? */
15902 if (PT
< CHARPOS (start_pos
)
15903 && last_unchanged_at_beg_row
)
15905 row
= row_containing_pos (w
, PT
,
15906 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15907 last_unchanged_at_beg_row
+ 1, 0);
15909 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15912 /* Start from first_unchanged_at_end_row looking for PT. */
15913 else if (first_unchanged_at_end_row
)
15915 row
= row_containing_pos (w
, PT
- delta
,
15916 first_unchanged_at_end_row
, NULL
, 0);
15918 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15919 delta_bytes
, dy
, dvpos
);
15922 /* Give up if cursor was not found. */
15923 if (w
->cursor
.vpos
< 0)
15925 clear_glyph_matrix (w
->desired_matrix
);
15930 /* Don't let the cursor end in the scroll margins. */
15932 int this_scroll_margin
, cursor_height
;
15934 this_scroll_margin
= max (0, scroll_margin
);
15935 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15936 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15937 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15939 if ((w
->cursor
.y
< this_scroll_margin
15940 && CHARPOS (start
) > BEGV
)
15941 /* Old redisplay didn't take scroll margin into account at the bottom,
15942 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15943 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15944 ? cursor_height
+ this_scroll_margin
15945 : 1)) > it
.last_visible_y
)
15947 w
->cursor
.vpos
= -1;
15948 clear_glyph_matrix (w
->desired_matrix
);
15953 /* Scroll the display. Do it before changing the current matrix so
15954 that xterm.c doesn't get confused about where the cursor glyph is
15956 if (dy
&& run
.height
)
15960 if (FRAME_WINDOW_P (f
))
15962 FRAME_RIF (f
)->update_window_begin_hook (w
);
15963 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15964 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15965 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15969 /* Terminal frame. In this case, dvpos gives the number of
15970 lines to scroll by; dvpos < 0 means scroll up. */
15971 int first_unchanged_at_end_vpos
15972 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15973 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15974 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15975 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15976 + window_internal_height (w
));
15978 /* Perform the operation on the screen. */
15981 /* Scroll last_unchanged_at_beg_row to the end of the
15982 window down dvpos lines. */
15983 set_terminal_window (f
, end
);
15985 /* On dumb terminals delete dvpos lines at the end
15986 before inserting dvpos empty lines. */
15987 if (!FRAME_SCROLL_REGION_OK (f
))
15988 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15990 /* Insert dvpos empty lines in front of
15991 last_unchanged_at_beg_row. */
15992 ins_del_lines (f
, from
, dvpos
);
15994 else if (dvpos
< 0)
15996 /* Scroll up last_unchanged_at_beg_vpos to the end of
15997 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15998 set_terminal_window (f
, end
);
16000 /* Delete dvpos lines in front of
16001 last_unchanged_at_beg_vpos. ins_del_lines will set
16002 the cursor to the given vpos and emit |dvpos| delete
16004 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16006 /* On a dumb terminal insert dvpos empty lines at the
16008 if (!FRAME_SCROLL_REGION_OK (f
))
16009 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16012 set_terminal_window (f
, 0);
16018 /* Shift reused rows of the current matrix to the right position.
16019 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16021 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16022 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16025 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16026 bottom_vpos
, dvpos
);
16027 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16030 else if (dvpos
> 0)
16032 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16033 bottom_vpos
, dvpos
);
16034 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16035 first_unchanged_at_end_vpos
+ dvpos
, 0);
16038 /* For frame-based redisplay, make sure that current frame and window
16039 matrix are in sync with respect to glyph memory. */
16040 if (!FRAME_WINDOW_P (f
))
16041 sync_frame_with_window_matrix_rows (w
);
16043 /* Adjust buffer positions in reused rows. */
16044 if (delta
|| delta_bytes
)
16045 increment_matrix_positions (current_matrix
,
16046 first_unchanged_at_end_vpos
+ dvpos
,
16047 bottom_vpos
, delta
, delta_bytes
);
16049 /* Adjust Y positions. */
16051 shift_glyph_matrix (w
, current_matrix
,
16052 first_unchanged_at_end_vpos
+ dvpos
,
16055 if (first_unchanged_at_end_row
)
16057 first_unchanged_at_end_row
+= dvpos
;
16058 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16059 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16060 first_unchanged_at_end_row
= NULL
;
16063 /* If scrolling up, there may be some lines to display at the end of
16065 last_text_row_at_end
= NULL
;
16068 /* Scrolling up can leave for example a partially visible line
16069 at the end of the window to be redisplayed. */
16070 /* Set last_row to the glyph row in the current matrix where the
16071 window end line is found. It has been moved up or down in
16072 the matrix by dvpos. */
16073 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16074 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16076 /* If last_row is the window end line, it should display text. */
16077 xassert (last_row
->displays_text_p
);
16079 /* If window end line was partially visible before, begin
16080 displaying at that line. Otherwise begin displaying with the
16081 line following it. */
16082 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16084 init_to_row_start (&it
, w
, last_row
);
16085 it
.vpos
= last_vpos
;
16086 it
.current_y
= last_row
->y
;
16090 init_to_row_end (&it
, w
, last_row
);
16091 it
.vpos
= 1 + last_vpos
;
16092 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16096 /* We may start in a continuation line. If so, we have to
16097 get the right continuation_lines_width and current_x. */
16098 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16099 it
.hpos
= it
.current_x
= 0;
16101 /* Display the rest of the lines at the window end. */
16102 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16103 while (it
.current_y
< it
.last_visible_y
16104 && !fonts_changed_p
)
16106 /* Is it always sure that the display agrees with lines in
16107 the current matrix? I don't think so, so we mark rows
16108 displayed invalid in the current matrix by setting their
16109 enabled_p flag to zero. */
16110 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16111 if (display_line (&it
))
16112 last_text_row_at_end
= it
.glyph_row
- 1;
16116 /* Update window_end_pos and window_end_vpos. */
16117 if (first_unchanged_at_end_row
16118 && !last_text_row_at_end
)
16120 /* Window end line if one of the preserved rows from the current
16121 matrix. Set row to the last row displaying text in current
16122 matrix starting at first_unchanged_at_end_row, after
16124 xassert (first_unchanged_at_end_row
->displays_text_p
);
16125 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16126 first_unchanged_at_end_row
);
16127 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16129 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16130 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16132 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16133 xassert (w
->window_end_bytepos
>= 0);
16134 IF_DEBUG (debug_method_add (w
, "A"));
16136 else if (last_text_row_at_end
)
16139 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16140 w
->window_end_bytepos
16141 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16143 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16144 xassert (w
->window_end_bytepos
>= 0);
16145 IF_DEBUG (debug_method_add (w
, "B"));
16147 else if (last_text_row
)
16149 /* We have displayed either to the end of the window or at the
16150 end of the window, i.e. the last row with text is to be found
16151 in the desired matrix. */
16153 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16154 w
->window_end_bytepos
16155 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16157 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16158 xassert (w
->window_end_bytepos
>= 0);
16160 else if (first_unchanged_at_end_row
== NULL
16161 && last_text_row
== NULL
16162 && last_text_row_at_end
== NULL
)
16164 /* Displayed to end of window, but no line containing text was
16165 displayed. Lines were deleted at the end of the window. */
16166 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16167 int vpos
= XFASTINT (w
->window_end_vpos
);
16168 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16169 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16172 row
== NULL
&& vpos
>= first_vpos
;
16173 --vpos
, --current_row
, --desired_row
)
16175 if (desired_row
->enabled_p
)
16177 if (desired_row
->displays_text_p
)
16180 else if (current_row
->displays_text_p
)
16184 xassert (row
!= NULL
);
16185 w
->window_end_vpos
= make_number (vpos
+ 1);
16186 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16187 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16188 xassert (w
->window_end_bytepos
>= 0);
16189 IF_DEBUG (debug_method_add (w
, "C"));
16194 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16195 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16197 /* Record that display has not been completed. */
16198 w
->window_end_valid
= Qnil
;
16199 w
->desired_matrix
->no_scrolling_p
= 1;
16207 /***********************************************************************
16208 More debugging support
16209 ***********************************************************************/
16213 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16214 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16215 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16218 /* Dump the contents of glyph matrix MATRIX on stderr.
16220 GLYPHS 0 means don't show glyph contents.
16221 GLYPHS 1 means show glyphs in short form
16222 GLYPHS > 1 means show glyphs in long form. */
16225 dump_glyph_matrix (matrix
, glyphs
)
16226 struct glyph_matrix
*matrix
;
16230 for (i
= 0; i
< matrix
->nrows
; ++i
)
16231 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16235 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16236 the glyph row and area where the glyph comes from. */
16239 dump_glyph (row
, glyph
, area
)
16240 struct glyph_row
*row
;
16241 struct glyph
*glyph
;
16244 if (glyph
->type
== CHAR_GLYPH
)
16247 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16248 glyph
- row
->glyphs
[TEXT_AREA
],
16251 (BUFFERP (glyph
->object
)
16253 : (STRINGP (glyph
->object
)
16256 glyph
->pixel_width
,
16258 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16262 glyph
->left_box_line_p
,
16263 glyph
->right_box_line_p
);
16265 else if (glyph
->type
== STRETCH_GLYPH
)
16268 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16269 glyph
- row
->glyphs
[TEXT_AREA
],
16272 (BUFFERP (glyph
->object
)
16274 : (STRINGP (glyph
->object
)
16277 glyph
->pixel_width
,
16281 glyph
->left_box_line_p
,
16282 glyph
->right_box_line_p
);
16284 else if (glyph
->type
== IMAGE_GLYPH
)
16287 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16288 glyph
- row
->glyphs
[TEXT_AREA
],
16291 (BUFFERP (glyph
->object
)
16293 : (STRINGP (glyph
->object
)
16296 glyph
->pixel_width
,
16300 glyph
->left_box_line_p
,
16301 glyph
->right_box_line_p
);
16303 else if (glyph
->type
== COMPOSITE_GLYPH
)
16306 " %5d %4c %6d %c %3d 0x%05x",
16307 glyph
- row
->glyphs
[TEXT_AREA
],
16310 (BUFFERP (glyph
->object
)
16312 : (STRINGP (glyph
->object
)
16315 glyph
->pixel_width
,
16317 if (glyph
->u
.cmp
.automatic
)
16320 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16321 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16323 glyph
->left_box_line_p
,
16324 glyph
->right_box_line_p
);
16329 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16330 GLYPHS 0 means don't show glyph contents.
16331 GLYPHS 1 means show glyphs in short form
16332 GLYPHS > 1 means show glyphs in long form. */
16335 dump_glyph_row (row
, vpos
, glyphs
)
16336 struct glyph_row
*row
;
16341 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16342 fprintf (stderr
, "======================================================================\n");
16344 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16345 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16347 MATRIX_ROW_START_CHARPOS (row
),
16348 MATRIX_ROW_END_CHARPOS (row
),
16349 row
->used
[TEXT_AREA
],
16350 row
->contains_overlapping_glyphs_p
,
16352 row
->truncated_on_left_p
,
16353 row
->truncated_on_right_p
,
16355 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16356 row
->displays_text_p
,
16359 row
->ends_in_middle_of_char_p
,
16360 row
->starts_in_middle_of_char_p
,
16366 row
->visible_height
,
16369 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16370 row
->end
.overlay_string_index
,
16371 row
->continuation_lines_width
);
16372 fprintf (stderr
, "%9d %5d\n",
16373 CHARPOS (row
->start
.string_pos
),
16374 CHARPOS (row
->end
.string_pos
));
16375 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16376 row
->end
.dpvec_index
);
16383 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16385 struct glyph
*glyph
= row
->glyphs
[area
];
16386 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16388 /* Glyph for a line end in text. */
16389 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16392 if (glyph
< glyph_end
)
16393 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16395 for (; glyph
< glyph_end
; ++glyph
)
16396 dump_glyph (row
, glyph
, area
);
16399 else if (glyphs
== 1)
16403 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16405 char *s
= (char *) alloca (row
->used
[area
] + 1);
16408 for (i
= 0; i
< row
->used
[area
]; ++i
)
16410 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16411 if (glyph
->type
== CHAR_GLYPH
16412 && glyph
->u
.ch
< 0x80
16413 && glyph
->u
.ch
>= ' ')
16414 s
[i
] = glyph
->u
.ch
;
16420 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16426 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16427 Sdump_glyph_matrix
, 0, 1, "p",
16428 doc
: /* Dump the current matrix of the selected window to stderr.
16429 Shows contents of glyph row structures. With non-nil
16430 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16431 glyphs in short form, otherwise show glyphs in long form. */)
16433 Lisp_Object glyphs
;
16435 struct window
*w
= XWINDOW (selected_window
);
16436 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16438 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16439 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16440 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16441 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16442 fprintf (stderr
, "=============================================\n");
16443 dump_glyph_matrix (w
->current_matrix
,
16444 NILP (glyphs
) ? 0 : XINT (glyphs
));
16449 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16450 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16453 struct frame
*f
= XFRAME (selected_frame
);
16454 dump_glyph_matrix (f
->current_matrix
, 1);
16459 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16460 doc
: /* Dump glyph row ROW to stderr.
16461 GLYPH 0 means don't dump glyphs.
16462 GLYPH 1 means dump glyphs in short form.
16463 GLYPH > 1 or omitted means dump glyphs in long form. */)
16465 Lisp_Object row
, glyphs
;
16467 struct glyph_matrix
*matrix
;
16470 CHECK_NUMBER (row
);
16471 matrix
= XWINDOW (selected_window
)->current_matrix
;
16473 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16474 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16476 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16481 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16482 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16483 GLYPH 0 means don't dump glyphs.
16484 GLYPH 1 means dump glyphs in short form.
16485 GLYPH > 1 or omitted means dump glyphs in long form. */)
16487 Lisp_Object row
, glyphs
;
16489 struct frame
*sf
= SELECTED_FRAME ();
16490 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16493 CHECK_NUMBER (row
);
16495 if (vpos
>= 0 && vpos
< m
->nrows
)
16496 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16497 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16502 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16503 doc
: /* Toggle tracing of redisplay.
16504 With ARG, turn tracing on if and only if ARG is positive. */)
16509 trace_redisplay_p
= !trace_redisplay_p
;
16512 arg
= Fprefix_numeric_value (arg
);
16513 trace_redisplay_p
= XINT (arg
) > 0;
16520 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16521 doc
: /* Like `format', but print result to stderr.
16522 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16527 Lisp_Object s
= Fformat (nargs
, args
);
16528 fprintf (stderr
, "%s", SDATA (s
));
16532 #endif /* GLYPH_DEBUG */
16536 /***********************************************************************
16537 Building Desired Matrix Rows
16538 ***********************************************************************/
16540 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16541 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16543 static struct glyph_row
*
16544 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16546 Lisp_Object overlay_arrow_string
;
16548 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16549 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16550 struct buffer
*old
= current_buffer
;
16551 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16552 int arrow_len
= SCHARS (overlay_arrow_string
);
16553 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16554 const unsigned char *p
;
16557 int n_glyphs_before
;
16559 set_buffer_temp (buffer
);
16560 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16561 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16562 SET_TEXT_POS (it
.position
, 0, 0);
16564 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16566 while (p
< arrow_end
)
16568 Lisp_Object face
, ilisp
;
16570 /* Get the next character. */
16572 it
.c
= string_char_and_length (p
, &it
.len
);
16574 it
.c
= *p
, it
.len
= 1;
16577 /* Get its face. */
16578 ilisp
= make_number (p
- arrow_string
);
16579 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16580 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16582 /* Compute its width, get its glyphs. */
16583 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16584 SET_TEXT_POS (it
.position
, -1, -1);
16585 PRODUCE_GLYPHS (&it
);
16587 /* If this character doesn't fit any more in the line, we have
16588 to remove some glyphs. */
16589 if (it
.current_x
> it
.last_visible_x
)
16591 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16596 set_buffer_temp (old
);
16597 return it
.glyph_row
;
16601 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16602 glyphs are only inserted for terminal frames since we can't really
16603 win with truncation glyphs when partially visible glyphs are
16604 involved. Which glyphs to insert is determined by
16605 produce_special_glyphs. */
16608 insert_left_trunc_glyphs (it
)
16611 struct it truncate_it
;
16612 struct glyph
*from
, *end
, *to
, *toend
;
16614 xassert (!FRAME_WINDOW_P (it
->f
));
16616 /* Get the truncation glyphs. */
16618 truncate_it
.current_x
= 0;
16619 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16620 truncate_it
.glyph_row
= &scratch_glyph_row
;
16621 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16622 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16623 truncate_it
.object
= make_number (0);
16624 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16626 /* Overwrite glyphs from IT with truncation glyphs. */
16627 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16628 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16629 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16630 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16635 /* There may be padding glyphs left over. Overwrite them too. */
16636 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16638 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16644 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16648 /* Compute the pixel height and width of IT->glyph_row.
16650 Most of the time, ascent and height of a display line will be equal
16651 to the max_ascent and max_height values of the display iterator
16652 structure. This is not the case if
16654 1. We hit ZV without displaying anything. In this case, max_ascent
16655 and max_height will be zero.
16657 2. We have some glyphs that don't contribute to the line height.
16658 (The glyph row flag contributes_to_line_height_p is for future
16659 pixmap extensions).
16661 The first case is easily covered by using default values because in
16662 these cases, the line height does not really matter, except that it
16663 must not be zero. */
16666 compute_line_metrics (it
)
16669 struct glyph_row
*row
= it
->glyph_row
;
16672 if (FRAME_WINDOW_P (it
->f
))
16674 int i
, min_y
, max_y
;
16676 /* The line may consist of one space only, that was added to
16677 place the cursor on it. If so, the row's height hasn't been
16679 if (row
->height
== 0)
16681 if (it
->max_ascent
+ it
->max_descent
== 0)
16682 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16683 row
->ascent
= it
->max_ascent
;
16684 row
->height
= it
->max_ascent
+ it
->max_descent
;
16685 row
->phys_ascent
= it
->max_phys_ascent
;
16686 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16687 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16690 /* Compute the width of this line. */
16691 row
->pixel_width
= row
->x
;
16692 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16693 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16695 xassert (row
->pixel_width
>= 0);
16696 xassert (row
->ascent
>= 0 && row
->height
> 0);
16698 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16699 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16701 /* If first line's physical ascent is larger than its logical
16702 ascent, use the physical ascent, and make the row taller.
16703 This makes accented characters fully visible. */
16704 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16705 && row
->phys_ascent
> row
->ascent
)
16707 row
->height
+= row
->phys_ascent
- row
->ascent
;
16708 row
->ascent
= row
->phys_ascent
;
16711 /* Compute how much of the line is visible. */
16712 row
->visible_height
= row
->height
;
16714 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16715 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16717 if (row
->y
< min_y
)
16718 row
->visible_height
-= min_y
- row
->y
;
16719 if (row
->y
+ row
->height
> max_y
)
16720 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16724 row
->pixel_width
= row
->used
[TEXT_AREA
];
16725 if (row
->continued_p
)
16726 row
->pixel_width
-= it
->continuation_pixel_width
;
16727 else if (row
->truncated_on_right_p
)
16728 row
->pixel_width
-= it
->truncation_pixel_width
;
16729 row
->ascent
= row
->phys_ascent
= 0;
16730 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16731 row
->extra_line_spacing
= 0;
16734 /* Compute a hash code for this row. */
16736 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16737 for (i
= 0; i
< row
->used
[area
]; ++i
)
16738 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16739 + row
->glyphs
[area
][i
].u
.val
16740 + row
->glyphs
[area
][i
].face_id
16741 + row
->glyphs
[area
][i
].padding_p
16742 + (row
->glyphs
[area
][i
].type
<< 2));
16744 it
->max_ascent
= it
->max_descent
= 0;
16745 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16749 /* Append one space to the glyph row of iterator IT if doing a
16750 window-based redisplay. The space has the same face as
16751 IT->face_id. Value is non-zero if a space was added.
16753 This function is called to make sure that there is always one glyph
16754 at the end of a glyph row that the cursor can be set on under
16755 window-systems. (If there weren't such a glyph we would not know
16756 how wide and tall a box cursor should be displayed).
16758 At the same time this space let's a nicely handle clearing to the
16759 end of the line if the row ends in italic text. */
16762 append_space_for_newline (it
, default_face_p
)
16764 int default_face_p
;
16766 if (FRAME_WINDOW_P (it
->f
))
16768 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16770 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16771 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16773 /* Save some values that must not be changed.
16774 Must save IT->c and IT->len because otherwise
16775 ITERATOR_AT_END_P wouldn't work anymore after
16776 append_space_for_newline has been called. */
16777 enum display_element_type saved_what
= it
->what
;
16778 int saved_c
= it
->c
, saved_len
= it
->len
;
16779 int saved_x
= it
->current_x
;
16780 int saved_face_id
= it
->face_id
;
16781 struct text_pos saved_pos
;
16782 Lisp_Object saved_object
;
16785 saved_object
= it
->object
;
16786 saved_pos
= it
->position
;
16788 it
->what
= IT_CHARACTER
;
16789 bzero (&it
->position
, sizeof it
->position
);
16790 it
->object
= make_number (0);
16794 if (default_face_p
)
16795 it
->face_id
= DEFAULT_FACE_ID
;
16796 else if (it
->face_before_selective_p
)
16797 it
->face_id
= it
->saved_face_id
;
16798 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16799 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16801 PRODUCE_GLYPHS (it
);
16803 it
->override_ascent
= -1;
16804 it
->constrain_row_ascent_descent_p
= 0;
16805 it
->current_x
= saved_x
;
16806 it
->object
= saved_object
;
16807 it
->position
= saved_pos
;
16808 it
->what
= saved_what
;
16809 it
->face_id
= saved_face_id
;
16810 it
->len
= saved_len
;
16820 /* Extend the face of the last glyph in the text area of IT->glyph_row
16821 to the end of the display line. Called from display_line.
16822 If the glyph row is empty, add a space glyph to it so that we
16823 know the face to draw. Set the glyph row flag fill_line_p. */
16826 extend_face_to_end_of_line (it
)
16830 struct frame
*f
= it
->f
;
16832 /* If line is already filled, do nothing. */
16833 if (it
->current_x
>= it
->last_visible_x
)
16836 /* Face extension extends the background and box of IT->face_id
16837 to the end of the line. If the background equals the background
16838 of the frame, we don't have to do anything. */
16839 if (it
->face_before_selective_p
)
16840 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16842 face
= FACE_FROM_ID (f
, it
->face_id
);
16844 if (FRAME_WINDOW_P (f
)
16845 && it
->glyph_row
->displays_text_p
16846 && face
->box
== FACE_NO_BOX
16847 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16851 /* Set the glyph row flag indicating that the face of the last glyph
16852 in the text area has to be drawn to the end of the text area. */
16853 it
->glyph_row
->fill_line_p
= 1;
16855 /* If current character of IT is not ASCII, make sure we have the
16856 ASCII face. This will be automatically undone the next time
16857 get_next_display_element returns a multibyte character. Note
16858 that the character will always be single byte in unibyte
16860 if (!ASCII_CHAR_P (it
->c
))
16862 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16865 if (FRAME_WINDOW_P (f
))
16867 /* If the row is empty, add a space with the current face of IT,
16868 so that we know which face to draw. */
16869 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16871 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16872 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16873 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16878 /* Save some values that must not be changed. */
16879 int saved_x
= it
->current_x
;
16880 struct text_pos saved_pos
;
16881 Lisp_Object saved_object
;
16882 enum display_element_type saved_what
= it
->what
;
16883 int saved_face_id
= it
->face_id
;
16885 saved_object
= it
->object
;
16886 saved_pos
= it
->position
;
16888 it
->what
= IT_CHARACTER
;
16889 bzero (&it
->position
, sizeof it
->position
);
16890 it
->object
= make_number (0);
16893 it
->face_id
= face
->id
;
16895 PRODUCE_GLYPHS (it
);
16897 while (it
->current_x
<= it
->last_visible_x
)
16898 PRODUCE_GLYPHS (it
);
16900 /* Don't count these blanks really. It would let us insert a left
16901 truncation glyph below and make us set the cursor on them, maybe. */
16902 it
->current_x
= saved_x
;
16903 it
->object
= saved_object
;
16904 it
->position
= saved_pos
;
16905 it
->what
= saved_what
;
16906 it
->face_id
= saved_face_id
;
16911 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16912 trailing whitespace. */
16915 trailing_whitespace_p (charpos
)
16918 int bytepos
= CHAR_TO_BYTE (charpos
);
16921 while (bytepos
< ZV_BYTE
16922 && (c
= FETCH_CHAR (bytepos
),
16923 c
== ' ' || c
== '\t'))
16926 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16928 if (bytepos
!= PT_BYTE
)
16935 /* Highlight trailing whitespace, if any, in ROW. */
16938 highlight_trailing_whitespace (f
, row
)
16940 struct glyph_row
*row
;
16942 int used
= row
->used
[TEXT_AREA
];
16946 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16947 struct glyph
*glyph
= start
+ used
- 1;
16949 /* Skip over glyphs inserted to display the cursor at the
16950 end of a line, for extending the face of the last glyph
16951 to the end of the line on terminals, and for truncation
16952 and continuation glyphs. */
16953 while (glyph
>= start
16954 && glyph
->type
== CHAR_GLYPH
16955 && INTEGERP (glyph
->object
))
16958 /* If last glyph is a space or stretch, and it's trailing
16959 whitespace, set the face of all trailing whitespace glyphs in
16960 IT->glyph_row to `trailing-whitespace'. */
16962 && BUFFERP (glyph
->object
)
16963 && (glyph
->type
== STRETCH_GLYPH
16964 || (glyph
->type
== CHAR_GLYPH
16965 && glyph
->u
.ch
== ' '))
16966 && trailing_whitespace_p (glyph
->charpos
))
16968 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16972 while (glyph
>= start
16973 && BUFFERP (glyph
->object
)
16974 && (glyph
->type
== STRETCH_GLYPH
16975 || (glyph
->type
== CHAR_GLYPH
16976 && glyph
->u
.ch
== ' ')))
16977 (glyph
--)->face_id
= face_id
;
16983 /* Value is non-zero if glyph row ROW in window W should be
16984 used to hold the cursor. */
16987 cursor_row_p (w
, row
)
16989 struct glyph_row
*row
;
16991 int cursor_row_p
= 1;
16993 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16995 /* Suppose the row ends on a string.
16996 Unless the row is continued, that means it ends on a newline
16997 in the string. If it's anything other than a display string
16998 (e.g. a before-string from an overlay), we don't want the
16999 cursor there. (This heuristic seems to give the optimal
17000 behavior for the various types of multi-line strings.) */
17001 if (CHARPOS (row
->end
.string_pos
) >= 0)
17003 if (row
->continued_p
)
17007 /* Check for `display' property. */
17008 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17009 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17010 struct glyph
*glyph
;
17013 for (glyph
= end
; glyph
>= beg
; --glyph
)
17014 if (STRINGP (glyph
->object
))
17017 = Fget_char_property (make_number (PT
),
17021 && display_prop_string_p (prop
, glyph
->object
));
17026 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17028 /* If the row ends in middle of a real character,
17029 and the line is continued, we want the cursor here.
17030 That's because MATRIX_ROW_END_CHARPOS would equal
17031 PT if PT is before the character. */
17032 if (!row
->ends_in_ellipsis_p
)
17033 cursor_row_p
= row
->continued_p
;
17035 /* If the row ends in an ellipsis, then
17036 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17037 We want that position to be displayed after the ellipsis. */
17040 /* If the row ends at ZV, display the cursor at the end of that
17041 row instead of at the start of the row below. */
17042 else if (row
->ends_at_zv_p
)
17048 return cursor_row_p
;
17053 /* Push the display property PROP so that it will be rendered at the
17054 current position in IT. Return 1 if PROP was successfully pushed,
17058 push_display_prop (struct it
*it
, Lisp_Object prop
)
17062 if (STRINGP (prop
))
17064 if (SCHARS (prop
) == 0)
17071 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17072 it
->current
.overlay_string_index
= -1;
17073 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17074 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17075 it
->method
= GET_FROM_STRING
;
17076 it
->stop_charpos
= 0;
17078 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17080 it
->method
= GET_FROM_STRETCH
;
17083 #ifdef HAVE_WINDOW_SYSTEM
17084 else if (IMAGEP (prop
))
17086 it
->what
= IT_IMAGE
;
17087 it
->image_id
= lookup_image (it
->f
, prop
);
17088 it
->method
= GET_FROM_IMAGE
;
17090 #endif /* HAVE_WINDOW_SYSTEM */
17093 pop_it (it
); /* bogus display property, give up */
17100 /* Return the character-property PROP at the current position in IT. */
17103 get_it_property (it
, prop
)
17107 Lisp_Object position
;
17109 if (STRINGP (it
->object
))
17110 position
= make_number (IT_STRING_CHARPOS (*it
));
17111 else if (BUFFERP (it
->object
))
17112 position
= make_number (IT_CHARPOS (*it
));
17116 return Fget_char_property (position
, prop
, it
->object
);
17119 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17122 handle_line_prefix (struct it
*it
)
17124 Lisp_Object prefix
;
17125 if (it
->continuation_lines_width
> 0)
17127 prefix
= get_it_property (it
, Qwrap_prefix
);
17129 prefix
= Vwrap_prefix
;
17133 prefix
= get_it_property (it
, Qline_prefix
);
17135 prefix
= Vline_prefix
;
17137 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17139 /* If the prefix is wider than the window, and we try to wrap
17140 it, it would acquire its own wrap prefix, and so on till the
17141 iterator stack overflows. So, don't wrap the prefix. */
17142 it
->line_wrap
= TRUNCATE
;
17143 it
->avoid_cursor_p
= 1;
17149 /* Construct the glyph row IT->glyph_row in the desired matrix of
17150 IT->w from text at the current position of IT. See dispextern.h
17151 for an overview of struct it. Value is non-zero if
17152 IT->glyph_row displays text, as opposed to a line displaying ZV
17159 struct glyph_row
*row
= it
->glyph_row
;
17160 Lisp_Object overlay_arrow_string
;
17162 int may_wrap
= 0, wrap_x
;
17163 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17164 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17165 int wrap_row_extra_line_spacing
;
17166 struct display_pos row_end
;
17169 /* We always start displaying at hpos zero even if hscrolled. */
17170 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17172 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17173 >= it
->w
->desired_matrix
->nrows
)
17175 it
->w
->nrows_scale_factor
++;
17176 fonts_changed_p
= 1;
17180 /* Is IT->w showing the region? */
17181 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17183 /* Clear the result glyph row and enable it. */
17184 prepare_desired_row (row
);
17186 row
->y
= it
->current_y
;
17187 row
->start
= it
->start
;
17188 row
->continuation_lines_width
= it
->continuation_lines_width
;
17189 row
->displays_text_p
= 1;
17190 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17191 it
->starts_in_middle_of_char_p
= 0;
17193 /* Arrange the overlays nicely for our purposes. Usually, we call
17194 display_line on only one line at a time, in which case this
17195 can't really hurt too much, or we call it on lines which appear
17196 one after another in the buffer, in which case all calls to
17197 recenter_overlay_lists but the first will be pretty cheap. */
17198 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17200 /* Move over display elements that are not visible because we are
17201 hscrolled. This may stop at an x-position < IT->first_visible_x
17202 if the first glyph is partially visible or if we hit a line end. */
17203 if (it
->current_x
< it
->first_visible_x
)
17205 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17206 MOVE_TO_POS
| MOVE_TO_X
);
17210 /* We only do this when not calling `move_it_in_display_line_to'
17211 above, because move_it_in_display_line_to calls
17212 handle_line_prefix itself. */
17213 handle_line_prefix (it
);
17216 /* Get the initial row height. This is either the height of the
17217 text hscrolled, if there is any, or zero. */
17218 row
->ascent
= it
->max_ascent
;
17219 row
->height
= it
->max_ascent
+ it
->max_descent
;
17220 row
->phys_ascent
= it
->max_phys_ascent
;
17221 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17222 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17224 /* Loop generating characters. The loop is left with IT on the next
17225 character to display. */
17228 int n_glyphs_before
, hpos_before
, x_before
;
17230 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17232 /* Retrieve the next thing to display. Value is zero if end of
17234 if (!get_next_display_element (it
))
17236 /* Maybe add a space at the end of this line that is used to
17237 display the cursor there under X. Set the charpos of the
17238 first glyph of blank lines not corresponding to any text
17240 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17241 row
->exact_window_width_line_p
= 1;
17242 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17243 || row
->used
[TEXT_AREA
] == 0)
17245 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17246 row
->displays_text_p
= 0;
17248 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17249 && (!MINI_WINDOW_P (it
->w
)
17250 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17251 row
->indicate_empty_line_p
= 1;
17254 it
->continuation_lines_width
= 0;
17255 row
->ends_at_zv_p
= 1;
17256 /* A row that displays right-to-left text must always have
17257 its last face extended all the way to the end of line,
17258 even if this row ends in ZV. */
17259 if (row
->reversed_p
)
17260 extend_face_to_end_of_line (it
);
17264 /* Now, get the metrics of what we want to display. This also
17265 generates glyphs in `row' (which is IT->glyph_row). */
17266 n_glyphs_before
= row
->used
[TEXT_AREA
];
17269 /* Remember the line height so far in case the next element doesn't
17270 fit on the line. */
17271 if (it
->line_wrap
!= TRUNCATE
)
17273 ascent
= it
->max_ascent
;
17274 descent
= it
->max_descent
;
17275 phys_ascent
= it
->max_phys_ascent
;
17276 phys_descent
= it
->max_phys_descent
;
17278 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17280 if (IT_DISPLAYING_WHITESPACE (it
))
17286 wrap_row_used
= row
->used
[TEXT_AREA
];
17287 wrap_row_ascent
= row
->ascent
;
17288 wrap_row_height
= row
->height
;
17289 wrap_row_phys_ascent
= row
->phys_ascent
;
17290 wrap_row_phys_height
= row
->phys_height
;
17291 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17297 PRODUCE_GLYPHS (it
);
17299 /* If this display element was in marginal areas, continue with
17301 if (it
->area
!= TEXT_AREA
)
17303 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17304 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17305 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17306 row
->phys_height
= max (row
->phys_height
,
17307 it
->max_phys_ascent
+ it
->max_phys_descent
);
17308 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17309 it
->max_extra_line_spacing
);
17310 set_iterator_to_next (it
, 1);
17314 /* Does the display element fit on the line? If we truncate
17315 lines, we should draw past the right edge of the window. If
17316 we don't truncate, we want to stop so that we can display the
17317 continuation glyph before the right margin. If lines are
17318 continued, there are two possible strategies for characters
17319 resulting in more than 1 glyph (e.g. tabs): Display as many
17320 glyphs as possible in this line and leave the rest for the
17321 continuation line, or display the whole element in the next
17322 line. Original redisplay did the former, so we do it also. */
17323 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17324 hpos_before
= it
->hpos
;
17327 if (/* Not a newline. */
17329 /* Glyphs produced fit entirely in the line. */
17330 && it
->current_x
< it
->last_visible_x
)
17332 it
->hpos
+= nglyphs
;
17333 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17334 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17335 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17336 row
->phys_height
= max (row
->phys_height
,
17337 it
->max_phys_ascent
+ it
->max_phys_descent
);
17338 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17339 it
->max_extra_line_spacing
);
17340 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17341 row
->x
= x
- it
->first_visible_x
;
17346 struct glyph
*glyph
;
17348 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17350 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17351 new_x
= x
+ glyph
->pixel_width
;
17353 if (/* Lines are continued. */
17354 it
->line_wrap
!= TRUNCATE
17355 && (/* Glyph doesn't fit on the line. */
17356 new_x
> it
->last_visible_x
17357 /* Or it fits exactly on a window system frame. */
17358 || (new_x
== it
->last_visible_x
17359 && FRAME_WINDOW_P (it
->f
))))
17361 /* End of a continued line. */
17364 || (new_x
== it
->last_visible_x
17365 && FRAME_WINDOW_P (it
->f
)))
17367 /* Current glyph is the only one on the line or
17368 fits exactly on the line. We must continue
17369 the line because we can't draw the cursor
17370 after the glyph. */
17371 row
->continued_p
= 1;
17372 it
->current_x
= new_x
;
17373 it
->continuation_lines_width
+= new_x
;
17375 if (i
== nglyphs
- 1)
17377 /* If line-wrap is on, check if a previous
17378 wrap point was found. */
17379 if (wrap_row_used
> 0
17380 /* Even if there is a previous wrap
17381 point, continue the line here as
17382 usual, if (i) the previous character
17383 was a space or tab AND (ii) the
17384 current character is not. */
17386 || IT_DISPLAYING_WHITESPACE (it
)))
17389 set_iterator_to_next (it
, 1);
17390 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17392 if (!get_next_display_element (it
))
17394 row
->exact_window_width_line_p
= 1;
17395 it
->continuation_lines_width
= 0;
17396 row
->continued_p
= 0;
17397 row
->ends_at_zv_p
= 1;
17399 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17401 row
->continued_p
= 0;
17402 row
->exact_window_width_line_p
= 1;
17407 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17408 && !FRAME_WINDOW_P (it
->f
))
17410 /* A padding glyph that doesn't fit on this line.
17411 This means the whole character doesn't fit
17413 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17415 /* Fill the rest of the row with continuation
17416 glyphs like in 20.x. */
17417 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17418 < row
->glyphs
[1 + TEXT_AREA
])
17419 produce_special_glyphs (it
, IT_CONTINUATION
);
17421 row
->continued_p
= 1;
17422 it
->current_x
= x_before
;
17423 it
->continuation_lines_width
+= x_before
;
17425 /* Restore the height to what it was before the
17426 element not fitting on the line. */
17427 it
->max_ascent
= ascent
;
17428 it
->max_descent
= descent
;
17429 it
->max_phys_ascent
= phys_ascent
;
17430 it
->max_phys_descent
= phys_descent
;
17432 else if (wrap_row_used
> 0)
17436 it
->continuation_lines_width
+= wrap_x
;
17437 row
->used
[TEXT_AREA
] = wrap_row_used
;
17438 row
->ascent
= wrap_row_ascent
;
17439 row
->height
= wrap_row_height
;
17440 row
->phys_ascent
= wrap_row_phys_ascent
;
17441 row
->phys_height
= wrap_row_phys_height
;
17442 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17443 row
->continued_p
= 1;
17444 row
->ends_at_zv_p
= 0;
17445 row
->exact_window_width_line_p
= 0;
17446 it
->continuation_lines_width
+= x
;
17448 /* Make sure that a non-default face is extended
17449 up to the right margin of the window. */
17450 extend_face_to_end_of_line (it
);
17452 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17454 /* A TAB that extends past the right edge of the
17455 window. This produces a single glyph on
17456 window system frames. We leave the glyph in
17457 this row and let it fill the row, but don't
17458 consume the TAB. */
17459 it
->continuation_lines_width
+= it
->last_visible_x
;
17460 row
->ends_in_middle_of_char_p
= 1;
17461 row
->continued_p
= 1;
17462 glyph
->pixel_width
= it
->last_visible_x
- x
;
17463 it
->starts_in_middle_of_char_p
= 1;
17467 /* Something other than a TAB that draws past
17468 the right edge of the window. Restore
17469 positions to values before the element. */
17470 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17472 /* Display continuation glyphs. */
17473 if (!FRAME_WINDOW_P (it
->f
))
17474 produce_special_glyphs (it
, IT_CONTINUATION
);
17475 row
->continued_p
= 1;
17477 it
->current_x
= x_before
;
17478 it
->continuation_lines_width
+= x
;
17479 extend_face_to_end_of_line (it
);
17481 if (nglyphs
> 1 && i
> 0)
17483 row
->ends_in_middle_of_char_p
= 1;
17484 it
->starts_in_middle_of_char_p
= 1;
17487 /* Restore the height to what it was before the
17488 element not fitting on the line. */
17489 it
->max_ascent
= ascent
;
17490 it
->max_descent
= descent
;
17491 it
->max_phys_ascent
= phys_ascent
;
17492 it
->max_phys_descent
= phys_descent
;
17497 else if (new_x
> it
->first_visible_x
)
17499 /* Increment number of glyphs actually displayed. */
17502 if (x
< it
->first_visible_x
)
17503 /* Glyph is partially visible, i.e. row starts at
17504 negative X position. */
17505 row
->x
= x
- it
->first_visible_x
;
17509 /* Glyph is completely off the left margin of the
17510 window. This should not happen because of the
17511 move_it_in_display_line at the start of this
17512 function, unless the text display area of the
17513 window is empty. */
17514 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17518 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17519 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17520 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17521 row
->phys_height
= max (row
->phys_height
,
17522 it
->max_phys_ascent
+ it
->max_phys_descent
);
17523 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17524 it
->max_extra_line_spacing
);
17526 /* End of this display line if row is continued. */
17527 if (row
->continued_p
|| row
->ends_at_zv_p
)
17532 /* Is this a line end? If yes, we're also done, after making
17533 sure that a non-default face is extended up to the right
17534 margin of the window. */
17535 if (ITERATOR_AT_END_OF_LINE_P (it
))
17537 int used_before
= row
->used
[TEXT_AREA
];
17539 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17541 /* Add a space at the end of the line that is used to
17542 display the cursor there. */
17543 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17544 append_space_for_newline (it
, 0);
17546 /* Extend the face to the end of the line. */
17547 extend_face_to_end_of_line (it
);
17549 /* Make sure we have the position. */
17550 if (used_before
== 0)
17551 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17553 /* Consume the line end. This skips over invisible lines. */
17554 set_iterator_to_next (it
, 1);
17555 it
->continuation_lines_width
= 0;
17559 /* Proceed with next display element. Note that this skips
17560 over lines invisible because of selective display. */
17561 set_iterator_to_next (it
, 1);
17563 /* If we truncate lines, we are done when the last displayed
17564 glyphs reach past the right margin of the window. */
17565 if (it
->line_wrap
== TRUNCATE
17566 && (FRAME_WINDOW_P (it
->f
)
17567 ? (it
->current_x
>= it
->last_visible_x
)
17568 : (it
->current_x
> it
->last_visible_x
)))
17570 /* Maybe add truncation glyphs. */
17571 if (!FRAME_WINDOW_P (it
->f
))
17575 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17576 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17579 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17581 row
->used
[TEXT_AREA
] = i
;
17582 produce_special_glyphs (it
, IT_TRUNCATION
);
17585 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17587 /* Don't truncate if we can overflow newline into fringe. */
17588 if (!get_next_display_element (it
))
17590 it
->continuation_lines_width
= 0;
17591 row
->ends_at_zv_p
= 1;
17592 row
->exact_window_width_line_p
= 1;
17595 if (ITERATOR_AT_END_OF_LINE_P (it
))
17597 row
->exact_window_width_line_p
= 1;
17598 goto at_end_of_line
;
17602 row
->truncated_on_right_p
= 1;
17603 it
->continuation_lines_width
= 0;
17604 reseat_at_next_visible_line_start (it
, 0);
17605 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17606 it
->hpos
= hpos_before
;
17607 it
->current_x
= x_before
;
17612 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17613 at the left window margin. */
17614 if (it
->first_visible_x
17615 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17617 if (!FRAME_WINDOW_P (it
->f
))
17618 insert_left_trunc_glyphs (it
);
17619 row
->truncated_on_left_p
= 1;
17622 /* If the start of this line is the overlay arrow-position, then
17623 mark this glyph row as the one containing the overlay arrow.
17624 This is clearly a mess with variable size fonts. It would be
17625 better to let it be displayed like cursors under X. */
17626 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17627 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17628 !NILP (overlay_arrow_string
)))
17630 /* Overlay arrow in window redisplay is a fringe bitmap. */
17631 if (STRINGP (overlay_arrow_string
))
17633 struct glyph_row
*arrow_row
17634 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17635 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17636 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17637 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17638 struct glyph
*p2
, *end
;
17640 /* Copy the arrow glyphs. */
17641 while (glyph
< arrow_end
)
17644 /* Throw away padding glyphs. */
17646 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17647 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17653 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17658 xassert (INTEGERP (overlay_arrow_string
));
17659 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17661 overlay_arrow_seen
= 1;
17664 /* Compute pixel dimensions of this line. */
17665 compute_line_metrics (it
);
17667 /* Remember the position at which this line ends. */
17668 row
->end
= row_end
= it
->current
;
17671 /* ROW->start and ROW->end must be the smallest and largest
17672 buffer positions in ROW. But if ROW was bidi-reordered,
17673 these two positions can be anywhere in the row, so we must
17674 rescan all of the ROW's glyphs to find them. */
17675 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17676 lines' rows is implemented for bidi-reordered rows. */
17677 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17680 struct text_pos tpos
;
17682 for (g
= row
->glyphs
[TEXT_AREA
];
17683 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17686 if (BUFFERP (g
->object
))
17688 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17689 min_pos
= g
->charpos
;
17690 if (g
->charpos
> max_pos
)
17691 max_pos
= g
->charpos
;
17694 /* Empty lines have a valid buffer position at their first
17695 glyph, but that glyph's OBJECT is zero, as if it didn't come
17696 from a buffer. If we didn't find any valid buffer positions
17697 in this row, maybe we have such an empty line. */
17698 if (min_pos
== ZV
+ 1 && row
->used
[TEXT_AREA
])
17700 for (g
= row
->glyphs
[TEXT_AREA
];
17701 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17704 if (INTEGERP (g
->object
))
17706 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17707 min_pos
= g
->charpos
;
17708 if (g
->charpos
> max_pos
)
17709 max_pos
= g
->charpos
;
17715 if (min_pos
!= row
->start
.pos
.charpos
)
17717 row
->start
.pos
.charpos
= min_pos
;
17718 row
->start
.pos
.bytepos
= CHAR_TO_BYTE (min_pos
);
17723 /* For ROW->end, we need the position that is _after_ max_pos,
17724 in the logical order, unless we are at ZV. */
17725 if (row
->ends_at_zv_p
)
17727 row_end
= row
->end
= it
->current
;
17728 if (!row
->used
[TEXT_AREA
])
17730 row
->start
.pos
.charpos
= row_end
.pos
.charpos
;
17731 row
->start
.pos
.bytepos
= row_end
.pos
.bytepos
;
17734 else if (row
->used
[TEXT_AREA
] && max_pos
)
17736 SET_TEXT_POS (tpos
, max_pos
+ 1, CHAR_TO_BYTE (max_pos
+ 1));
17737 row_end
= it
->current
;
17738 row_end
.pos
= tpos
;
17739 /* If the character at max_pos+1 is a newline, skip that as
17740 well. Note that this may skip some invisible text. */
17741 if (FETCH_CHAR (tpos
.bytepos
) == '\n'
17742 || (FETCH_CHAR (tpos
.bytepos
) == '\r' && it
->selective
))
17746 reseat_1 (it
, tpos
, 0);
17747 set_iterator_to_next (it
, 1);
17748 /* Record the position after the newline of a continued
17749 row. We will need that to set ROW->end of the last
17750 row produced for a continued line. */
17751 if (row
->continued_p
)
17753 save_it
.eol_pos
.charpos
= IT_CHARPOS (*it
);
17754 save_it
.eol_pos
.bytepos
= IT_BYTEPOS (*it
);
17758 row_end
= it
->current
;
17759 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17763 else if (!row
->continued_p
17764 && row
->continuation_lines_width
17765 && it
->eol_pos
.charpos
> 0)
17767 /* Last row of a continued line. Use the position
17768 recorded in ROW->eol_pos, to the effect that the
17769 newline belongs to this row, not to the row which
17770 displays the character with the largest buffer
17772 row_end
.pos
= it
->eol_pos
;
17773 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17775 row
->end
= row_end
;
17779 /* Record whether this row ends inside an ellipsis. */
17780 row
->ends_in_ellipsis_p
17781 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17782 && it
->ellipsis_p
);
17784 /* Save fringe bitmaps in this row. */
17785 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17786 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17787 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17788 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17790 it
->left_user_fringe_bitmap
= 0;
17791 it
->left_user_fringe_face_id
= 0;
17792 it
->right_user_fringe_bitmap
= 0;
17793 it
->right_user_fringe_face_id
= 0;
17795 /* Maybe set the cursor. */
17796 cvpos
= it
->w
->cursor
.vpos
;
17798 /* In bidi-reordered rows, keep checking for proper cursor
17799 position even if one has been found already, because buffer
17800 positions in such rows change non-linearly with ROW->VPOS,
17801 when a line is continued. One exception: when we are at ZV,
17802 display cursor on the first suitable glyph row, since all
17803 the empty rows after that also have their position set to ZV. */
17804 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17805 lines' rows is implemented for bidi-reordered rows. */
17807 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17808 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17809 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17810 && cursor_row_p (it
->w
, row
))
17811 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17813 /* Highlight trailing whitespace. */
17814 if (!NILP (Vshow_trailing_whitespace
))
17815 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17817 /* Prepare for the next line. This line starts horizontally at (X
17818 HPOS) = (0 0). Vertical positions are incremented. As a
17819 convenience for the caller, IT->glyph_row is set to the next
17821 it
->current_x
= it
->hpos
= 0;
17822 it
->current_y
+= row
->height
;
17825 /* The next row should use same value of the reversed_p flag as this
17826 one. set_iterator_to_next decides when it's a new paragraph and
17827 recomputes the value of the flag accordingly. */
17828 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17829 it
->start
= row_end
;
17830 return row
->displays_text_p
;
17835 /***********************************************************************
17837 ***********************************************************************/
17839 /* Redisplay the menu bar in the frame for window W.
17841 The menu bar of X frames that don't have X toolkit support is
17842 displayed in a special window W->frame->menu_bar_window.
17844 The menu bar of terminal frames is treated specially as far as
17845 glyph matrices are concerned. Menu bar lines are not part of
17846 windows, so the update is done directly on the frame matrix rows
17847 for the menu bar. */
17850 display_menu_bar (w
)
17853 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17858 /* Don't do all this for graphical frames. */
17860 if (FRAME_W32_P (f
))
17863 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17869 if (FRAME_NS_P (f
))
17871 #endif /* HAVE_NS */
17873 #ifdef USE_X_TOOLKIT
17874 xassert (!FRAME_WINDOW_P (f
));
17875 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17876 it
.first_visible_x
= 0;
17877 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17878 #else /* not USE_X_TOOLKIT */
17879 if (FRAME_WINDOW_P (f
))
17881 /* Menu bar lines are displayed in the desired matrix of the
17882 dummy window menu_bar_window. */
17883 struct window
*menu_w
;
17884 xassert (WINDOWP (f
->menu_bar_window
));
17885 menu_w
= XWINDOW (f
->menu_bar_window
);
17886 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17888 it
.first_visible_x
= 0;
17889 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17893 /* This is a TTY frame, i.e. character hpos/vpos are used as
17895 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17897 it
.first_visible_x
= 0;
17898 it
.last_visible_x
= FRAME_COLS (f
);
17900 #endif /* not USE_X_TOOLKIT */
17902 if (! mode_line_inverse_video
)
17903 /* Force the menu-bar to be displayed in the default face. */
17904 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17906 /* Clear all rows of the menu bar. */
17907 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17909 struct glyph_row
*row
= it
.glyph_row
+ i
;
17910 clear_glyph_row (row
);
17911 row
->enabled_p
= 1;
17912 row
->full_width_p
= 1;
17915 /* Display all items of the menu bar. */
17916 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17917 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17919 Lisp_Object string
;
17921 /* Stop at nil string. */
17922 string
= AREF (items
, i
+ 1);
17926 /* Remember where item was displayed. */
17927 ASET (items
, i
+ 3, make_number (it
.hpos
));
17929 /* Display the item, pad with one space. */
17930 if (it
.current_x
< it
.last_visible_x
)
17931 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17932 SCHARS (string
) + 1, 0, 0, -1);
17935 /* Fill out the line with spaces. */
17936 if (it
.current_x
< it
.last_visible_x
)
17937 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17939 /* Compute the total height of the lines. */
17940 compute_line_metrics (&it
);
17945 /***********************************************************************
17947 ***********************************************************************/
17949 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17950 FORCE is non-zero, redisplay mode lines unconditionally.
17951 Otherwise, redisplay only mode lines that are garbaged. Value is
17952 the number of windows whose mode lines were redisplayed. */
17955 redisplay_mode_lines (window
, force
)
17956 Lisp_Object window
;
17961 while (!NILP (window
))
17963 struct window
*w
= XWINDOW (window
);
17965 if (WINDOWP (w
->hchild
))
17966 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17967 else if (WINDOWP (w
->vchild
))
17968 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17970 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17971 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17973 struct text_pos lpoint
;
17974 struct buffer
*old
= current_buffer
;
17976 /* Set the window's buffer for the mode line display. */
17977 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17978 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17980 /* Point refers normally to the selected window. For any
17981 other window, set up appropriate value. */
17982 if (!EQ (window
, selected_window
))
17984 struct text_pos pt
;
17986 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17987 if (CHARPOS (pt
) < BEGV
)
17988 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17989 else if (CHARPOS (pt
) > (ZV
- 1))
17990 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17992 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17995 /* Display mode lines. */
17996 clear_glyph_matrix (w
->desired_matrix
);
17997 if (display_mode_lines (w
))
18000 w
->must_be_updated_p
= 1;
18003 /* Restore old settings. */
18004 set_buffer_internal_1 (old
);
18005 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18015 /* Display the mode and/or header line of window W. Value is the
18016 sum number of mode lines and header lines displayed. */
18019 display_mode_lines (w
)
18022 Lisp_Object old_selected_window
, old_selected_frame
;
18025 old_selected_frame
= selected_frame
;
18026 selected_frame
= w
->frame
;
18027 old_selected_window
= selected_window
;
18028 XSETWINDOW (selected_window
, w
);
18030 /* These will be set while the mode line specs are processed. */
18031 line_number_displayed
= 0;
18032 w
->column_number_displayed
= Qnil
;
18034 if (WINDOW_WANTS_MODELINE_P (w
))
18036 struct window
*sel_w
= XWINDOW (old_selected_window
);
18038 /* Select mode line face based on the real selected window. */
18039 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18040 current_buffer
->mode_line_format
);
18044 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18046 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18047 current_buffer
->header_line_format
);
18051 selected_frame
= old_selected_frame
;
18052 selected_window
= old_selected_window
;
18057 /* Display mode or header line of window W. FACE_ID specifies which
18058 line to display; it is either MODE_LINE_FACE_ID or
18059 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18060 display. Value is the pixel height of the mode/header line
18064 display_mode_line (w
, face_id
, format
)
18066 enum face_id face_id
;
18067 Lisp_Object format
;
18071 int count
= SPECPDL_INDEX ();
18073 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18074 /* Don't extend on a previously drawn mode-line.
18075 This may happen if called from pos_visible_p. */
18076 it
.glyph_row
->enabled_p
= 0;
18077 prepare_desired_row (it
.glyph_row
);
18079 it
.glyph_row
->mode_line_p
= 1;
18081 if (! mode_line_inverse_video
)
18082 /* Force the mode-line to be displayed in the default face. */
18083 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18085 record_unwind_protect (unwind_format_mode_line
,
18086 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18088 mode_line_target
= MODE_LINE_DISPLAY
;
18090 /* Temporarily make frame's keyboard the current kboard so that
18091 kboard-local variables in the mode_line_format will get the right
18093 push_kboard (FRAME_KBOARD (it
.f
));
18094 record_unwind_save_match_data ();
18095 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18098 unbind_to (count
, Qnil
);
18100 /* Fill up with spaces. */
18101 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18103 compute_line_metrics (&it
);
18104 it
.glyph_row
->full_width_p
= 1;
18105 it
.glyph_row
->continued_p
= 0;
18106 it
.glyph_row
->truncated_on_left_p
= 0;
18107 it
.glyph_row
->truncated_on_right_p
= 0;
18109 /* Make a 3D mode-line have a shadow at its right end. */
18110 face
= FACE_FROM_ID (it
.f
, face_id
);
18111 extend_face_to_end_of_line (&it
);
18112 if (face
->box
!= FACE_NO_BOX
)
18114 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18115 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18116 last
->right_box_line_p
= 1;
18119 return it
.glyph_row
->height
;
18122 /* Move element ELT in LIST to the front of LIST.
18123 Return the updated list. */
18126 move_elt_to_front (elt
, list
)
18127 Lisp_Object elt
, list
;
18129 register Lisp_Object tail
, prev
;
18130 register Lisp_Object tem
;
18134 while (CONSP (tail
))
18140 /* Splice out the link TAIL. */
18142 list
= XCDR (tail
);
18144 Fsetcdr (prev
, XCDR (tail
));
18146 /* Now make it the first. */
18147 Fsetcdr (tail
, list
);
18152 tail
= XCDR (tail
);
18156 /* Not found--return unchanged LIST. */
18160 /* Contribute ELT to the mode line for window IT->w. How it
18161 translates into text depends on its data type.
18163 IT describes the display environment in which we display, as usual.
18165 DEPTH is the depth in recursion. It is used to prevent
18166 infinite recursion here.
18168 FIELD_WIDTH is the number of characters the display of ELT should
18169 occupy in the mode line, and PRECISION is the maximum number of
18170 characters to display from ELT's representation. See
18171 display_string for details.
18173 Returns the hpos of the end of the text generated by ELT.
18175 PROPS is a property list to add to any string we encounter.
18177 If RISKY is nonzero, remove (disregard) any properties in any string
18178 we encounter, and ignore :eval and :propertize.
18180 The global variable `mode_line_target' determines whether the
18181 output is passed to `store_mode_line_noprop',
18182 `store_mode_line_string', or `display_string'. */
18185 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18188 int field_width
, precision
;
18189 Lisp_Object elt
, props
;
18192 int n
= 0, field
, prec
;
18197 elt
= build_string ("*too-deep*");
18201 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18205 /* A string: output it and check for %-constructs within it. */
18209 if (SCHARS (elt
) > 0
18210 && (!NILP (props
) || risky
))
18212 Lisp_Object oprops
, aelt
;
18213 oprops
= Ftext_properties_at (make_number (0), elt
);
18215 /* If the starting string's properties are not what
18216 we want, translate the string. Also, if the string
18217 is risky, do that anyway. */
18219 if (NILP (Fequal (props
, oprops
)) || risky
)
18221 /* If the starting string has properties,
18222 merge the specified ones onto the existing ones. */
18223 if (! NILP (oprops
) && !risky
)
18227 oprops
= Fcopy_sequence (oprops
);
18229 while (CONSP (tem
))
18231 oprops
= Fplist_put (oprops
, XCAR (tem
),
18232 XCAR (XCDR (tem
)));
18233 tem
= XCDR (XCDR (tem
));
18238 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18239 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18241 /* AELT is what we want. Move it to the front
18242 without consing. */
18244 mode_line_proptrans_alist
18245 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18251 /* If AELT has the wrong props, it is useless.
18252 so get rid of it. */
18254 mode_line_proptrans_alist
18255 = Fdelq (aelt
, mode_line_proptrans_alist
);
18257 elt
= Fcopy_sequence (elt
);
18258 Fset_text_properties (make_number (0), Flength (elt
),
18260 /* Add this item to mode_line_proptrans_alist. */
18261 mode_line_proptrans_alist
18262 = Fcons (Fcons (elt
, props
),
18263 mode_line_proptrans_alist
);
18264 /* Truncate mode_line_proptrans_alist
18265 to at most 50 elements. */
18266 tem
= Fnthcdr (make_number (50),
18267 mode_line_proptrans_alist
);
18269 XSETCDR (tem
, Qnil
);
18278 prec
= precision
- n
;
18279 switch (mode_line_target
)
18281 case MODE_LINE_NOPROP
:
18282 case MODE_LINE_TITLE
:
18283 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18285 case MODE_LINE_STRING
:
18286 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18288 case MODE_LINE_DISPLAY
:
18289 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18290 0, prec
, 0, STRING_MULTIBYTE (elt
));
18297 /* Handle the non-literal case. */
18299 while ((precision
<= 0 || n
< precision
)
18300 && SREF (elt
, offset
) != 0
18301 && (mode_line_target
!= MODE_LINE_DISPLAY
18302 || it
->current_x
< it
->last_visible_x
))
18304 int last_offset
= offset
;
18306 /* Advance to end of string or next format specifier. */
18307 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18310 if (offset
- 1 != last_offset
)
18312 int nchars
, nbytes
;
18314 /* Output to end of string or up to '%'. Field width
18315 is length of string. Don't output more than
18316 PRECISION allows us. */
18319 prec
= c_string_width (SDATA (elt
) + last_offset
,
18320 offset
- last_offset
, precision
- n
,
18323 switch (mode_line_target
)
18325 case MODE_LINE_NOPROP
:
18326 case MODE_LINE_TITLE
:
18327 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18329 case MODE_LINE_STRING
:
18331 int bytepos
= last_offset
;
18332 int charpos
= string_byte_to_char (elt
, bytepos
);
18333 int endpos
= (precision
<= 0
18334 ? string_byte_to_char (elt
, offset
)
18335 : charpos
+ nchars
);
18337 n
+= store_mode_line_string (NULL
,
18338 Fsubstring (elt
, make_number (charpos
),
18339 make_number (endpos
)),
18343 case MODE_LINE_DISPLAY
:
18345 int bytepos
= last_offset
;
18346 int charpos
= string_byte_to_char (elt
, bytepos
);
18348 if (precision
<= 0)
18349 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18350 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18352 STRING_MULTIBYTE (elt
));
18357 else /* c == '%' */
18359 int percent_position
= offset
;
18361 /* Get the specified minimum width. Zero means
18364 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18365 field
= field
* 10 + c
- '0';
18367 /* Don't pad beyond the total padding allowed. */
18368 if (field_width
- n
> 0 && field
> field_width
- n
)
18369 field
= field_width
- n
;
18371 /* Note that either PRECISION <= 0 or N < PRECISION. */
18372 prec
= precision
- n
;
18375 n
+= display_mode_element (it
, depth
, field
, prec
,
18376 Vglobal_mode_string
, props
,
18381 int bytepos
, charpos
;
18382 unsigned char *spec
;
18383 Lisp_Object string
;
18385 bytepos
= percent_position
;
18386 charpos
= (STRING_MULTIBYTE (elt
)
18387 ? string_byte_to_char (elt
, bytepos
)
18389 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18390 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18392 switch (mode_line_target
)
18394 case MODE_LINE_NOPROP
:
18395 case MODE_LINE_TITLE
:
18396 n
+= store_mode_line_noprop (spec
, field
, prec
);
18398 case MODE_LINE_STRING
:
18400 int len
= strlen (spec
);
18401 Lisp_Object tem
= make_string (spec
, len
);
18402 props
= Ftext_properties_at (make_number (charpos
), elt
);
18403 /* Should only keep face property in props */
18404 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18407 case MODE_LINE_DISPLAY
:
18409 int nglyphs_before
, nwritten
;
18411 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18412 nwritten
= display_string (spec
, string
, elt
,
18417 /* Assign to the glyphs written above the
18418 string where the `%x' came from, position
18422 struct glyph
*glyph
18423 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18427 for (i
= 0; i
< nwritten
; ++i
)
18429 glyph
[i
].object
= elt
;
18430 glyph
[i
].charpos
= charpos
;
18447 /* A symbol: process the value of the symbol recursively
18448 as if it appeared here directly. Avoid error if symbol void.
18449 Special case: if value of symbol is a string, output the string
18452 register Lisp_Object tem
;
18454 /* If the variable is not marked as risky to set
18455 then its contents are risky to use. */
18456 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18459 tem
= Fboundp (elt
);
18462 tem
= Fsymbol_value (elt
);
18463 /* If value is a string, output that string literally:
18464 don't check for % within it. */
18468 if (!EQ (tem
, elt
))
18470 /* Give up right away for nil or t. */
18480 register Lisp_Object car
, tem
;
18482 /* A cons cell: five distinct cases.
18483 If first element is :eval or :propertize, do something special.
18484 If first element is a string or a cons, process all the elements
18485 and effectively concatenate them.
18486 If first element is a negative number, truncate displaying cdr to
18487 at most that many characters. If positive, pad (with spaces)
18488 to at least that many characters.
18489 If first element is a symbol, process the cadr or caddr recursively
18490 according to whether the symbol's value is non-nil or nil. */
18492 if (EQ (car
, QCeval
))
18494 /* An element of the form (:eval FORM) means evaluate FORM
18495 and use the result as mode line elements. */
18500 if (CONSP (XCDR (elt
)))
18503 spec
= safe_eval (XCAR (XCDR (elt
)));
18504 n
+= display_mode_element (it
, depth
, field_width
- n
,
18505 precision
- n
, spec
, props
,
18509 else if (EQ (car
, QCpropertize
))
18511 /* An element of the form (:propertize ELT PROPS...)
18512 means display ELT but applying properties PROPS. */
18517 if (CONSP (XCDR (elt
)))
18518 n
+= display_mode_element (it
, depth
, field_width
- n
,
18519 precision
- n
, XCAR (XCDR (elt
)),
18520 XCDR (XCDR (elt
)), risky
);
18522 else if (SYMBOLP (car
))
18524 tem
= Fboundp (car
);
18528 /* elt is now the cdr, and we know it is a cons cell.
18529 Use its car if CAR has a non-nil value. */
18532 tem
= Fsymbol_value (car
);
18539 /* Symbol's value is nil (or symbol is unbound)
18540 Get the cddr of the original list
18541 and if possible find the caddr and use that. */
18545 else if (!CONSP (elt
))
18550 else if (INTEGERP (car
))
18552 register int lim
= XINT (car
);
18556 /* Negative int means reduce maximum width. */
18557 if (precision
<= 0)
18560 precision
= min (precision
, -lim
);
18564 /* Padding specified. Don't let it be more than
18565 current maximum. */
18567 lim
= min (precision
, lim
);
18569 /* If that's more padding than already wanted, queue it.
18570 But don't reduce padding already specified even if
18571 that is beyond the current truncation point. */
18572 field_width
= max (lim
, field_width
);
18576 else if (STRINGP (car
) || CONSP (car
))
18578 Lisp_Object halftail
= elt
;
18582 && (precision
<= 0 || n
< precision
))
18584 n
+= display_mode_element (it
, depth
,
18585 /* Do padding only after the last
18586 element in the list. */
18587 (! CONSP (XCDR (elt
))
18590 precision
- n
, XCAR (elt
),
18594 if ((len
& 1) == 0)
18595 halftail
= XCDR (halftail
);
18596 /* Check for cycle. */
18597 if (EQ (halftail
, elt
))
18606 elt
= build_string ("*invalid*");
18610 /* Pad to FIELD_WIDTH. */
18611 if (field_width
> 0 && n
< field_width
)
18613 switch (mode_line_target
)
18615 case MODE_LINE_NOPROP
:
18616 case MODE_LINE_TITLE
:
18617 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18619 case MODE_LINE_STRING
:
18620 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18622 case MODE_LINE_DISPLAY
:
18623 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18632 /* Store a mode-line string element in mode_line_string_list.
18634 If STRING is non-null, display that C string. Otherwise, the Lisp
18635 string LISP_STRING is displayed.
18637 FIELD_WIDTH is the minimum number of output glyphs to produce.
18638 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18639 with spaces. FIELD_WIDTH <= 0 means don't pad.
18641 PRECISION is the maximum number of characters to output from
18642 STRING. PRECISION <= 0 means don't truncate the string.
18644 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18645 properties to the string.
18647 PROPS are the properties to add to the string.
18648 The mode_line_string_face face property is always added to the string.
18652 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18654 Lisp_Object lisp_string
;
18663 if (string
!= NULL
)
18665 len
= strlen (string
);
18666 if (precision
> 0 && len
> precision
)
18668 lisp_string
= make_string (string
, len
);
18670 props
= mode_line_string_face_prop
;
18671 else if (!NILP (mode_line_string_face
))
18673 Lisp_Object face
= Fplist_get (props
, Qface
);
18674 props
= Fcopy_sequence (props
);
18676 face
= mode_line_string_face
;
18678 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18679 props
= Fplist_put (props
, Qface
, face
);
18681 Fadd_text_properties (make_number (0), make_number (len
),
18682 props
, lisp_string
);
18686 len
= XFASTINT (Flength (lisp_string
));
18687 if (precision
> 0 && len
> precision
)
18690 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18693 if (!NILP (mode_line_string_face
))
18697 props
= Ftext_properties_at (make_number (0), lisp_string
);
18698 face
= Fplist_get (props
, Qface
);
18700 face
= mode_line_string_face
;
18702 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18703 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18705 lisp_string
= Fcopy_sequence (lisp_string
);
18708 Fadd_text_properties (make_number (0), make_number (len
),
18709 props
, lisp_string
);
18714 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18718 if (field_width
> len
)
18720 field_width
-= len
;
18721 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18723 Fadd_text_properties (make_number (0), make_number (field_width
),
18724 props
, lisp_string
);
18725 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18733 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18735 doc
: /* Format a string out of a mode line format specification.
18736 First arg FORMAT specifies the mode line format (see `mode-line-format'
18737 for details) to use.
18739 Optional second arg FACE specifies the face property to put
18740 on all characters for which no face is specified.
18741 The value t means whatever face the window's mode line currently uses
18742 \(either `mode-line' or `mode-line-inactive', depending).
18743 A value of nil means the default is no face property.
18744 If FACE is an integer, the value string has no text properties.
18746 Optional third and fourth args WINDOW and BUFFER specify the window
18747 and buffer to use as the context for the formatting (defaults
18748 are the selected window and the window's buffer). */)
18749 (format
, face
, window
, buffer
)
18750 Lisp_Object format
, face
, window
, buffer
;
18755 struct buffer
*old_buffer
= NULL
;
18757 int no_props
= INTEGERP (face
);
18758 int count
= SPECPDL_INDEX ();
18760 int string_start
= 0;
18763 window
= selected_window
;
18764 CHECK_WINDOW (window
);
18765 w
= XWINDOW (window
);
18768 buffer
= w
->buffer
;
18769 CHECK_BUFFER (buffer
);
18771 /* Make formatting the modeline a non-op when noninteractive, otherwise
18772 there will be problems later caused by a partially initialized frame. */
18773 if (NILP (format
) || noninteractive
)
18774 return empty_unibyte_string
;
18782 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18783 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18787 face_id
= DEFAULT_FACE_ID
;
18789 if (XBUFFER (buffer
) != current_buffer
)
18790 old_buffer
= current_buffer
;
18792 /* Save things including mode_line_proptrans_alist,
18793 and set that to nil so that we don't alter the outer value. */
18794 record_unwind_protect (unwind_format_mode_line
,
18795 format_mode_line_unwind_data
18796 (old_buffer
, selected_window
, 1));
18797 mode_line_proptrans_alist
= Qnil
;
18799 Fselect_window (window
, Qt
);
18801 set_buffer_internal_1 (XBUFFER (buffer
));
18803 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18807 mode_line_target
= MODE_LINE_NOPROP
;
18808 mode_line_string_face_prop
= Qnil
;
18809 mode_line_string_list
= Qnil
;
18810 string_start
= MODE_LINE_NOPROP_LEN (0);
18814 mode_line_target
= MODE_LINE_STRING
;
18815 mode_line_string_list
= Qnil
;
18816 mode_line_string_face
= face
;
18817 mode_line_string_face_prop
18818 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18821 push_kboard (FRAME_KBOARD (it
.f
));
18822 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18827 len
= MODE_LINE_NOPROP_LEN (string_start
);
18828 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18832 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18833 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18834 empty_unibyte_string
);
18837 unbind_to (count
, Qnil
);
18841 /* Write a null-terminated, right justified decimal representation of
18842 the positive integer D to BUF using a minimal field width WIDTH. */
18845 pint2str (buf
, width
, d
)
18846 register char *buf
;
18847 register int width
;
18850 register char *p
= buf
;
18858 *p
++ = d
% 10 + '0';
18863 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18874 /* Write a null-terminated, right justified decimal and "human
18875 readable" representation of the nonnegative integer D to BUF using
18876 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18878 static const char power_letter
[] =
18892 pint2hrstr (buf
, width
, d
)
18897 /* We aim to represent the nonnegative integer D as
18898 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18901 /* -1 means: do not use TENTHS. */
18905 /* Length of QUOTIENT.TENTHS as a string. */
18911 if (1000 <= quotient
)
18913 /* Scale to the appropriate EXPONENT. */
18916 remainder
= quotient
% 1000;
18920 while (1000 <= quotient
);
18922 /* Round to nearest and decide whether to use TENTHS or not. */
18925 tenths
= remainder
/ 100;
18926 if (50 <= remainder
% 100)
18933 if (quotient
== 10)
18941 if (500 <= remainder
)
18943 if (quotient
< 999)
18954 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18955 if (tenths
== -1 && quotient
<= 99)
18962 p
= psuffix
= buf
+ max (width
, length
);
18964 /* Print EXPONENT. */
18966 *psuffix
++ = power_letter
[exponent
];
18969 /* Print TENTHS. */
18972 *--p
= '0' + tenths
;
18976 /* Print QUOTIENT. */
18979 int digit
= quotient
% 10;
18980 *--p
= '0' + digit
;
18982 while ((quotient
/= 10) != 0);
18984 /* Print leading spaces. */
18989 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18990 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18991 type of CODING_SYSTEM. Return updated pointer into BUF. */
18993 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18996 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18997 Lisp_Object coding_system
;
18998 register char *buf
;
19002 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19003 const unsigned char *eol_str
;
19005 /* The EOL conversion we are using. */
19006 Lisp_Object eoltype
;
19008 val
= CODING_SYSTEM_SPEC (coding_system
);
19011 if (!VECTORP (val
)) /* Not yet decided. */
19016 eoltype
= eol_mnemonic_undecided
;
19017 /* Don't mention EOL conversion if it isn't decided. */
19022 Lisp_Object eolvalue
;
19024 attrs
= AREF (val
, 0);
19025 eolvalue
= AREF (val
, 2);
19028 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19032 /* The EOL conversion that is normal on this system. */
19034 if (NILP (eolvalue
)) /* Not yet decided. */
19035 eoltype
= eol_mnemonic_undecided
;
19036 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19037 eoltype
= eol_mnemonic_undecided
;
19038 else /* eolvalue is Qunix, Qdos, or Qmac. */
19039 eoltype
= (EQ (eolvalue
, Qunix
)
19040 ? eol_mnemonic_unix
19041 : (EQ (eolvalue
, Qdos
) == 1
19042 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19048 /* Mention the EOL conversion if it is not the usual one. */
19049 if (STRINGP (eoltype
))
19051 eol_str
= SDATA (eoltype
);
19052 eol_str_len
= SBYTES (eoltype
);
19054 else if (CHARACTERP (eoltype
))
19056 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19057 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19062 eol_str
= invalid_eol_type
;
19063 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19065 bcopy (eol_str
, buf
, eol_str_len
);
19066 buf
+= eol_str_len
;
19072 /* Return a string for the output of a mode line %-spec for window W,
19073 generated by character C. PRECISION >= 0 means don't return a
19074 string longer than that value. FIELD_WIDTH > 0 means pad the
19075 string returned with spaces to that value. Return a Lisp string in
19076 *STRING if the resulting string is taken from that Lisp string.
19078 Note we operate on the current buffer for most purposes,
19079 the exception being w->base_line_pos. */
19081 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19084 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19087 int field_width
, precision
;
19088 Lisp_Object
*string
;
19091 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19092 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19093 struct buffer
*b
= current_buffer
;
19101 if (!NILP (b
->read_only
))
19103 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19108 /* This differs from %* only for a modified read-only buffer. */
19109 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19111 if (!NILP (b
->read_only
))
19116 /* This differs from %* in ignoring read-only-ness. */
19117 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19129 if (command_loop_level
> 5)
19131 p
= decode_mode_spec_buf
;
19132 for (i
= 0; i
< command_loop_level
; i
++)
19135 return decode_mode_spec_buf
;
19143 if (command_loop_level
> 5)
19145 p
= decode_mode_spec_buf
;
19146 for (i
= 0; i
< command_loop_level
; i
++)
19149 return decode_mode_spec_buf
;
19156 /* Let lots_of_dashes be a string of infinite length. */
19157 if (mode_line_target
== MODE_LINE_NOPROP
||
19158 mode_line_target
== MODE_LINE_STRING
)
19160 if (field_width
<= 0
19161 || field_width
> sizeof (lots_of_dashes
))
19163 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19164 decode_mode_spec_buf
[i
] = '-';
19165 decode_mode_spec_buf
[i
] = '\0';
19166 return decode_mode_spec_buf
;
19169 return lots_of_dashes
;
19177 /* %c and %l are ignored in `frame-title-format'.
19178 (In redisplay_internal, the frame title is drawn _before_ the
19179 windows are updated, so the stuff which depends on actual
19180 window contents (such as %l) may fail to render properly, or
19181 even crash emacs.) */
19182 if (mode_line_target
== MODE_LINE_TITLE
)
19186 int col
= (int) current_column (); /* iftc */
19187 w
->column_number_displayed
= make_number (col
);
19188 pint2str (decode_mode_spec_buf
, field_width
, col
);
19189 return decode_mode_spec_buf
;
19193 #ifndef SYSTEM_MALLOC
19195 if (NILP (Vmemory_full
))
19198 return "!MEM FULL! ";
19205 /* %F displays the frame name. */
19206 if (!NILP (f
->title
))
19207 return (char *) SDATA (f
->title
);
19208 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19209 return (char *) SDATA (f
->name
);
19218 int size
= ZV
- BEGV
;
19219 pint2str (decode_mode_spec_buf
, field_width
, size
);
19220 return decode_mode_spec_buf
;
19225 int size
= ZV
- BEGV
;
19226 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19227 return decode_mode_spec_buf
;
19232 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19233 int topline
, nlines
, junk
, height
;
19235 /* %c and %l are ignored in `frame-title-format'. */
19236 if (mode_line_target
== MODE_LINE_TITLE
)
19239 startpos
= XMARKER (w
->start
)->charpos
;
19240 startpos_byte
= marker_byte_position (w
->start
);
19241 height
= WINDOW_TOTAL_LINES (w
);
19243 /* If we decided that this buffer isn't suitable for line numbers,
19244 don't forget that too fast. */
19245 if (EQ (w
->base_line_pos
, w
->buffer
))
19247 /* But do forget it, if the window shows a different buffer now. */
19248 else if (BUFFERP (w
->base_line_pos
))
19249 w
->base_line_pos
= Qnil
;
19251 /* If the buffer is very big, don't waste time. */
19252 if (INTEGERP (Vline_number_display_limit
)
19253 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19255 w
->base_line_pos
= Qnil
;
19256 w
->base_line_number
= Qnil
;
19260 if (INTEGERP (w
->base_line_number
)
19261 && INTEGERP (w
->base_line_pos
)
19262 && XFASTINT (w
->base_line_pos
) <= startpos
)
19264 line
= XFASTINT (w
->base_line_number
);
19265 linepos
= XFASTINT (w
->base_line_pos
);
19266 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19271 linepos
= BUF_BEGV (b
);
19272 linepos_byte
= BUF_BEGV_BYTE (b
);
19275 /* Count lines from base line to window start position. */
19276 nlines
= display_count_lines (linepos
, linepos_byte
,
19280 topline
= nlines
+ line
;
19282 /* Determine a new base line, if the old one is too close
19283 or too far away, or if we did not have one.
19284 "Too close" means it's plausible a scroll-down would
19285 go back past it. */
19286 if (startpos
== BUF_BEGV (b
))
19288 w
->base_line_number
= make_number (topline
);
19289 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19291 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19292 || linepos
== BUF_BEGV (b
))
19294 int limit
= BUF_BEGV (b
);
19295 int limit_byte
= BUF_BEGV_BYTE (b
);
19297 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19299 if (startpos
- distance
> limit
)
19301 limit
= startpos
- distance
;
19302 limit_byte
= CHAR_TO_BYTE (limit
);
19305 nlines
= display_count_lines (startpos
, startpos_byte
,
19307 - (height
* 2 + 30),
19309 /* If we couldn't find the lines we wanted within
19310 line_number_display_limit_width chars per line,
19311 give up on line numbers for this window. */
19312 if (position
== limit_byte
&& limit
== startpos
- distance
)
19314 w
->base_line_pos
= w
->buffer
;
19315 w
->base_line_number
= Qnil
;
19319 w
->base_line_number
= make_number (topline
- nlines
);
19320 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19323 /* Now count lines from the start pos to point. */
19324 nlines
= display_count_lines (startpos
, startpos_byte
,
19325 PT_BYTE
, PT
, &junk
);
19327 /* Record that we did display the line number. */
19328 line_number_displayed
= 1;
19330 /* Make the string to show. */
19331 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19332 return decode_mode_spec_buf
;
19335 char* p
= decode_mode_spec_buf
;
19336 int pad
= field_width
- 2;
19342 return decode_mode_spec_buf
;
19348 obj
= b
->mode_name
;
19352 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19358 int pos
= marker_position (w
->start
);
19359 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19361 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19363 if (pos
<= BUF_BEGV (b
))
19368 else if (pos
<= BUF_BEGV (b
))
19372 if (total
> 1000000)
19373 /* Do it differently for a large value, to avoid overflow. */
19374 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19376 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19377 /* We can't normally display a 3-digit number,
19378 so get us a 2-digit number that is close. */
19381 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19382 return decode_mode_spec_buf
;
19386 /* Display percentage of size above the bottom of the screen. */
19389 int toppos
= marker_position (w
->start
);
19390 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19391 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19393 if (botpos
>= BUF_ZV (b
))
19395 if (toppos
<= BUF_BEGV (b
))
19402 if (total
> 1000000)
19403 /* Do it differently for a large value, to avoid overflow. */
19404 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19406 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19407 /* We can't normally display a 3-digit number,
19408 so get us a 2-digit number that is close. */
19411 if (toppos
<= BUF_BEGV (b
))
19412 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19414 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19415 return decode_mode_spec_buf
;
19420 /* status of process */
19421 obj
= Fget_buffer_process (Fcurrent_buffer ());
19423 return "no process";
19424 #ifdef subprocesses
19425 obj
= Fsymbol_name (Fprocess_status (obj
));
19431 int count
= inhibit_garbage_collection ();
19432 Lisp_Object val
= call1 (intern ("file-remote-p"),
19433 current_buffer
->directory
);
19434 unbind_to (count
, Qnil
);
19442 case 't': /* indicate TEXT or BINARY */
19443 #ifdef MODE_LINE_BINARY_TEXT
19444 return MODE_LINE_BINARY_TEXT (b
);
19450 /* coding-system (not including end-of-line format) */
19452 /* coding-system (including end-of-line type) */
19454 int eol_flag
= (c
== 'Z');
19455 char *p
= decode_mode_spec_buf
;
19457 if (! FRAME_WINDOW_P (f
))
19459 /* No need to mention EOL here--the terminal never needs
19460 to do EOL conversion. */
19461 p
= decode_mode_spec_coding (CODING_ID_NAME
19462 (FRAME_KEYBOARD_CODING (f
)->id
),
19464 p
= decode_mode_spec_coding (CODING_ID_NAME
19465 (FRAME_TERMINAL_CODING (f
)->id
),
19468 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19471 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19472 #ifdef subprocesses
19473 obj
= Fget_buffer_process (Fcurrent_buffer ());
19474 if (PROCESSP (obj
))
19476 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19478 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19481 #endif /* subprocesses */
19484 return decode_mode_spec_buf
;
19491 return (char *) SDATA (obj
);
19498 /* Count up to COUNT lines starting from START / START_BYTE.
19499 But don't go beyond LIMIT_BYTE.
19500 Return the number of lines thus found (always nonnegative).
19502 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19505 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19506 int start
, start_byte
, limit_byte
, count
;
19509 register unsigned char *cursor
;
19510 unsigned char *base
;
19512 register int ceiling
;
19513 register unsigned char *ceiling_addr
;
19514 int orig_count
= count
;
19516 /* If we are not in selective display mode,
19517 check only for newlines. */
19518 int selective_display
= (!NILP (current_buffer
->selective_display
)
19519 && !INTEGERP (current_buffer
->selective_display
));
19523 while (start_byte
< limit_byte
)
19525 ceiling
= BUFFER_CEILING_OF (start_byte
);
19526 ceiling
= min (limit_byte
- 1, ceiling
);
19527 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19528 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19531 if (selective_display
)
19532 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19535 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19538 if (cursor
!= ceiling_addr
)
19542 start_byte
+= cursor
- base
+ 1;
19543 *byte_pos_ptr
= start_byte
;
19547 if (++cursor
== ceiling_addr
)
19553 start_byte
+= cursor
- base
;
19558 while (start_byte
> limit_byte
)
19560 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19561 ceiling
= max (limit_byte
, ceiling
);
19562 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19563 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19566 if (selective_display
)
19567 while (--cursor
!= ceiling_addr
19568 && *cursor
!= '\n' && *cursor
!= 015)
19571 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19574 if (cursor
!= ceiling_addr
)
19578 start_byte
+= cursor
- base
+ 1;
19579 *byte_pos_ptr
= start_byte
;
19580 /* When scanning backwards, we should
19581 not count the newline posterior to which we stop. */
19582 return - orig_count
- 1;
19588 /* Here we add 1 to compensate for the last decrement
19589 of CURSOR, which took it past the valid range. */
19590 start_byte
+= cursor
- base
+ 1;
19594 *byte_pos_ptr
= limit_byte
;
19597 return - orig_count
+ count
;
19598 return orig_count
- count
;
19604 /***********************************************************************
19606 ***********************************************************************/
19608 /* Display a NUL-terminated string, starting with index START.
19610 If STRING is non-null, display that C string. Otherwise, the Lisp
19611 string LISP_STRING is displayed. There's a case that STRING is
19612 non-null and LISP_STRING is not nil. It means STRING is a string
19613 data of LISP_STRING. In that case, we display LISP_STRING while
19614 ignoring its text properties.
19616 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19617 FACE_STRING. Display STRING or LISP_STRING with the face at
19618 FACE_STRING_POS in FACE_STRING:
19620 Display the string in the environment given by IT, but use the
19621 standard display table, temporarily.
19623 FIELD_WIDTH is the minimum number of output glyphs to produce.
19624 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19625 with spaces. If STRING has more characters, more than FIELD_WIDTH
19626 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19628 PRECISION is the maximum number of characters to output from
19629 STRING. PRECISION < 0 means don't truncate the string.
19631 This is roughly equivalent to printf format specifiers:
19633 FIELD_WIDTH PRECISION PRINTF
19634 ----------------------------------------
19640 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19641 display them, and < 0 means obey the current buffer's value of
19642 enable_multibyte_characters.
19644 Value is the number of columns displayed. */
19647 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19648 start
, it
, field_width
, precision
, max_x
, multibyte
)
19649 unsigned char *string
;
19650 Lisp_Object lisp_string
;
19651 Lisp_Object face_string
;
19652 EMACS_INT face_string_pos
;
19655 int field_width
, precision
, max_x
;
19658 int hpos_at_start
= it
->hpos
;
19659 int saved_face_id
= it
->face_id
;
19660 struct glyph_row
*row
= it
->glyph_row
;
19662 /* Initialize the iterator IT for iteration over STRING beginning
19663 with index START. */
19664 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19665 precision
, field_width
, multibyte
);
19666 if (string
&& STRINGP (lisp_string
))
19667 /* LISP_STRING is the one returned by decode_mode_spec. We should
19668 ignore its text properties. */
19669 it
->stop_charpos
= -1;
19671 /* If displaying STRING, set up the face of the iterator
19672 from LISP_STRING, if that's given. */
19673 if (STRINGP (face_string
))
19679 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19680 0, it
->region_beg_charpos
,
19681 it
->region_end_charpos
,
19682 &endptr
, it
->base_face_id
, 0);
19683 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19684 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19687 /* Set max_x to the maximum allowed X position. Don't let it go
19688 beyond the right edge of the window. */
19690 max_x
= it
->last_visible_x
;
19692 max_x
= min (max_x
, it
->last_visible_x
);
19694 /* Skip over display elements that are not visible. because IT->w is
19696 if (it
->current_x
< it
->first_visible_x
)
19697 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19698 MOVE_TO_POS
| MOVE_TO_X
);
19700 row
->ascent
= it
->max_ascent
;
19701 row
->height
= it
->max_ascent
+ it
->max_descent
;
19702 row
->phys_ascent
= it
->max_phys_ascent
;
19703 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19704 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19706 /* This condition is for the case that we are called with current_x
19707 past last_visible_x. */
19708 while (it
->current_x
< max_x
)
19710 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19712 /* Get the next display element. */
19713 if (!get_next_display_element (it
))
19716 /* Produce glyphs. */
19717 x_before
= it
->current_x
;
19718 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19719 PRODUCE_GLYPHS (it
);
19721 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19724 while (i
< nglyphs
)
19726 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19728 if (it
->line_wrap
!= TRUNCATE
19729 && x
+ glyph
->pixel_width
> max_x
)
19731 /* End of continued line or max_x reached. */
19732 if (CHAR_GLYPH_PADDING_P (*glyph
))
19734 /* A wide character is unbreakable. */
19735 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19736 it
->current_x
= x_before
;
19740 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19745 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19747 /* Glyph is at least partially visible. */
19749 if (x
< it
->first_visible_x
)
19750 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19754 /* Glyph is off the left margin of the display area.
19755 Should not happen. */
19759 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19760 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19761 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19762 row
->phys_height
= max (row
->phys_height
,
19763 it
->max_phys_ascent
+ it
->max_phys_descent
);
19764 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19765 it
->max_extra_line_spacing
);
19766 x
+= glyph
->pixel_width
;
19770 /* Stop if max_x reached. */
19774 /* Stop at line ends. */
19775 if (ITERATOR_AT_END_OF_LINE_P (it
))
19777 it
->continuation_lines_width
= 0;
19781 set_iterator_to_next (it
, 1);
19783 /* Stop if truncating at the right edge. */
19784 if (it
->line_wrap
== TRUNCATE
19785 && it
->current_x
>= it
->last_visible_x
)
19787 /* Add truncation mark, but don't do it if the line is
19788 truncated at a padding space. */
19789 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19791 if (!FRAME_WINDOW_P (it
->f
))
19795 if (it
->current_x
> it
->last_visible_x
)
19797 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19798 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19800 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19802 row
->used
[TEXT_AREA
] = i
;
19803 produce_special_glyphs (it
, IT_TRUNCATION
);
19806 produce_special_glyphs (it
, IT_TRUNCATION
);
19808 it
->glyph_row
->truncated_on_right_p
= 1;
19814 /* Maybe insert a truncation at the left. */
19815 if (it
->first_visible_x
19816 && IT_CHARPOS (*it
) > 0)
19818 if (!FRAME_WINDOW_P (it
->f
))
19819 insert_left_trunc_glyphs (it
);
19820 it
->glyph_row
->truncated_on_left_p
= 1;
19823 it
->face_id
= saved_face_id
;
19825 /* Value is number of columns displayed. */
19826 return it
->hpos
- hpos_at_start
;
19831 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19832 appears as an element of LIST or as the car of an element of LIST.
19833 If PROPVAL is a list, compare each element against LIST in that
19834 way, and return 1/2 if any element of PROPVAL is found in LIST.
19835 Otherwise return 0. This function cannot quit.
19836 The return value is 2 if the text is invisible but with an ellipsis
19837 and 1 if it's invisible and without an ellipsis. */
19840 invisible_p (propval
, list
)
19841 register Lisp_Object propval
;
19844 register Lisp_Object tail
, proptail
;
19846 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19848 register Lisp_Object tem
;
19850 if (EQ (propval
, tem
))
19852 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19853 return NILP (XCDR (tem
)) ? 1 : 2;
19856 if (CONSP (propval
))
19858 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19860 Lisp_Object propelt
;
19861 propelt
= XCAR (proptail
);
19862 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19864 register Lisp_Object tem
;
19866 if (EQ (propelt
, tem
))
19868 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19869 return NILP (XCDR (tem
)) ? 1 : 2;
19877 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19878 doc
: /* Non-nil if the property makes the text invisible.
19879 POS-OR-PROP can be a marker or number, in which case it is taken to be
19880 a position in the current buffer and the value of the `invisible' property
19881 is checked; or it can be some other value, which is then presumed to be the
19882 value of the `invisible' property of the text of interest.
19883 The non-nil value returned can be t for truly invisible text or something
19884 else if the text is replaced by an ellipsis. */)
19886 Lisp_Object pos_or_prop
;
19889 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19890 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19892 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19893 return (invis
== 0 ? Qnil
19895 : make_number (invis
));
19898 /* Calculate a width or height in pixels from a specification using
19899 the following elements:
19902 NUM - a (fractional) multiple of the default font width/height
19903 (NUM) - specifies exactly NUM pixels
19904 UNIT - a fixed number of pixels, see below.
19905 ELEMENT - size of a display element in pixels, see below.
19906 (NUM . SPEC) - equals NUM * SPEC
19907 (+ SPEC SPEC ...) - add pixel values
19908 (- SPEC SPEC ...) - subtract pixel values
19909 (- SPEC) - negate pixel value
19912 INT or FLOAT - a number constant
19913 SYMBOL - use symbol's (buffer local) variable binding.
19916 in - pixels per inch *)
19917 mm - pixels per 1/1000 meter *)
19918 cm - pixels per 1/100 meter *)
19919 width - width of current font in pixels.
19920 height - height of current font in pixels.
19922 *) using the ratio(s) defined in display-pixels-per-inch.
19926 left-fringe - left fringe width in pixels
19927 right-fringe - right fringe width in pixels
19929 left-margin - left margin width in pixels
19930 right-margin - right margin width in pixels
19932 scroll-bar - scroll-bar area width in pixels
19936 Pixels corresponding to 5 inches:
19939 Total width of non-text areas on left side of window (if scroll-bar is on left):
19940 '(space :width (+ left-fringe left-margin scroll-bar))
19942 Align to first text column (in header line):
19943 '(space :align-to 0)
19945 Align to middle of text area minus half the width of variable `my-image'
19946 containing a loaded image:
19947 '(space :align-to (0.5 . (- text my-image)))
19949 Width of left margin minus width of 1 character in the default font:
19950 '(space :width (- left-margin 1))
19952 Width of left margin minus width of 2 characters in the current font:
19953 '(space :width (- left-margin (2 . width)))
19955 Center 1 character over left-margin (in header line):
19956 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19958 Different ways to express width of left fringe plus left margin minus one pixel:
19959 '(space :width (- (+ left-fringe left-margin) (1)))
19960 '(space :width (+ left-fringe left-margin (- (1))))
19961 '(space :width (+ left-fringe left-margin (-1)))
19965 #define NUMVAL(X) \
19966 ((INTEGERP (X) || FLOATP (X)) \
19971 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19976 int width_p
, *align_to
;
19980 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19981 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19984 return OK_PIXELS (0);
19986 xassert (FRAME_LIVE_P (it
->f
));
19988 if (SYMBOLP (prop
))
19990 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19992 char *unit
= SDATA (SYMBOL_NAME (prop
));
19994 if (unit
[0] == 'i' && unit
[1] == 'n')
19996 else if (unit
[0] == 'm' && unit
[1] == 'm')
19998 else if (unit
[0] == 'c' && unit
[1] == 'm')
20005 #ifdef HAVE_WINDOW_SYSTEM
20006 if (FRAME_WINDOW_P (it
->f
)
20008 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20009 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20011 return OK_PIXELS (ppi
/ pixels
);
20014 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20015 || (CONSP (Vdisplay_pixels_per_inch
)
20017 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20018 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20020 return OK_PIXELS (ppi
/ pixels
);
20026 #ifdef HAVE_WINDOW_SYSTEM
20027 if (EQ (prop
, Qheight
))
20028 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20029 if (EQ (prop
, Qwidth
))
20030 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20032 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20033 return OK_PIXELS (1);
20036 if (EQ (prop
, Qtext
))
20037 return OK_PIXELS (width_p
20038 ? window_box_width (it
->w
, TEXT_AREA
)
20039 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20041 if (align_to
&& *align_to
< 0)
20044 if (EQ (prop
, Qleft
))
20045 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20046 if (EQ (prop
, Qright
))
20047 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20048 if (EQ (prop
, Qcenter
))
20049 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20050 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20051 if (EQ (prop
, Qleft_fringe
))
20052 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20053 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20054 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20055 if (EQ (prop
, Qright_fringe
))
20056 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20057 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20058 : window_box_right_offset (it
->w
, TEXT_AREA
));
20059 if (EQ (prop
, Qleft_margin
))
20060 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20061 if (EQ (prop
, Qright_margin
))
20062 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20063 if (EQ (prop
, Qscroll_bar
))
20064 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20066 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20067 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20068 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20073 if (EQ (prop
, Qleft_fringe
))
20074 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20075 if (EQ (prop
, Qright_fringe
))
20076 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20077 if (EQ (prop
, Qleft_margin
))
20078 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20079 if (EQ (prop
, Qright_margin
))
20080 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20081 if (EQ (prop
, Qscroll_bar
))
20082 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20085 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20088 if (INTEGERP (prop
) || FLOATP (prop
))
20090 int base_unit
= (width_p
20091 ? FRAME_COLUMN_WIDTH (it
->f
)
20092 : FRAME_LINE_HEIGHT (it
->f
));
20093 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20098 Lisp_Object car
= XCAR (prop
);
20099 Lisp_Object cdr
= XCDR (prop
);
20103 #ifdef HAVE_WINDOW_SYSTEM
20104 if (FRAME_WINDOW_P (it
->f
)
20105 && valid_image_p (prop
))
20107 int id
= lookup_image (it
->f
, prop
);
20108 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20110 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20113 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20119 while (CONSP (cdr
))
20121 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20122 font
, width_p
, align_to
))
20125 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20130 if (EQ (car
, Qminus
))
20132 return OK_PIXELS (pixels
);
20135 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20138 if (INTEGERP (car
) || FLOATP (car
))
20141 pixels
= XFLOATINT (car
);
20143 return OK_PIXELS (pixels
);
20144 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20145 font
, width_p
, align_to
))
20146 return OK_PIXELS (pixels
* fact
);
20157 /***********************************************************************
20159 ***********************************************************************/
20161 #ifdef HAVE_WINDOW_SYSTEM
20166 dump_glyph_string (s
)
20167 struct glyph_string
*s
;
20169 fprintf (stderr
, "glyph string\n");
20170 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20171 s
->x
, s
->y
, s
->width
, s
->height
);
20172 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20173 fprintf (stderr
, " hl = %d\n", s
->hl
);
20174 fprintf (stderr
, " left overhang = %d, right = %d\n",
20175 s
->left_overhang
, s
->right_overhang
);
20176 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20177 fprintf (stderr
, " extends to end of line = %d\n",
20178 s
->extends_to_end_of_line_p
);
20179 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20180 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20183 #endif /* GLYPH_DEBUG */
20185 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20186 of XChar2b structures for S; it can't be allocated in
20187 init_glyph_string because it must be allocated via `alloca'. W
20188 is the window on which S is drawn. ROW and AREA are the glyph row
20189 and area within the row from which S is constructed. START is the
20190 index of the first glyph structure covered by S. HL is a
20191 face-override for drawing S. */
20194 #define OPTIONAL_HDC(hdc) hdc,
20195 #define DECLARE_HDC(hdc) HDC hdc;
20196 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20197 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20200 #ifndef OPTIONAL_HDC
20201 #define OPTIONAL_HDC(hdc)
20202 #define DECLARE_HDC(hdc)
20203 #define ALLOCATE_HDC(hdc, f)
20204 #define RELEASE_HDC(hdc, f)
20208 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20209 struct glyph_string
*s
;
20213 struct glyph_row
*row
;
20214 enum glyph_row_area area
;
20216 enum draw_glyphs_face hl
;
20218 bzero (s
, sizeof *s
);
20220 s
->f
= XFRAME (w
->frame
);
20224 s
->display
= FRAME_X_DISPLAY (s
->f
);
20225 s
->window
= FRAME_X_WINDOW (s
->f
);
20226 s
->char2b
= char2b
;
20230 s
->first_glyph
= row
->glyphs
[area
] + start
;
20231 s
->height
= row
->height
;
20232 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20233 s
->ybase
= s
->y
+ row
->ascent
;
20237 /* Append the list of glyph strings with head H and tail T to the list
20238 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20241 append_glyph_string_lists (head
, tail
, h
, t
)
20242 struct glyph_string
**head
, **tail
;
20243 struct glyph_string
*h
, *t
;
20257 /* Prepend the list of glyph strings with head H and tail T to the
20258 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20262 prepend_glyph_string_lists (head
, tail
, h
, t
)
20263 struct glyph_string
**head
, **tail
;
20264 struct glyph_string
*h
, *t
;
20278 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20279 Set *HEAD and *TAIL to the resulting list. */
20282 append_glyph_string (head
, tail
, s
)
20283 struct glyph_string
**head
, **tail
;
20284 struct glyph_string
*s
;
20286 s
->next
= s
->prev
= NULL
;
20287 append_glyph_string_lists (head
, tail
, s
, s
);
20291 /* Get face and two-byte form of character C in face FACE_ID on frame
20292 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20293 means we want to display multibyte text. DISPLAY_P non-zero means
20294 make sure that X resources for the face returned are allocated.
20295 Value is a pointer to a realized face that is ready for display if
20296 DISPLAY_P is non-zero. */
20298 static INLINE
struct face
*
20299 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20303 int multibyte_p
, display_p
;
20305 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20309 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20311 if (code
!= FONT_INVALID_CODE
)
20312 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20314 STORE_XCHAR2B (char2b
, 0, 0);
20317 /* Make sure X resources of the face are allocated. */
20318 #ifdef HAVE_X_WINDOWS
20322 xassert (face
!= NULL
);
20323 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20330 /* Get face and two-byte form of character glyph GLYPH on frame F.
20331 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20332 a pointer to a realized face that is ready for display. */
20334 static INLINE
struct face
*
20335 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20337 struct glyph
*glyph
;
20343 xassert (glyph
->type
== CHAR_GLYPH
);
20344 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20351 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20353 if (code
!= FONT_INVALID_CODE
)
20354 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20356 STORE_XCHAR2B (char2b
, 0, 0);
20359 /* Make sure X resources of the face are allocated. */
20360 xassert (face
!= NULL
);
20361 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20366 /* Fill glyph string S with composition components specified by S->cmp.
20368 BASE_FACE is the base face of the composition.
20369 S->cmp_from is the index of the first component for S.
20371 OVERLAPS non-zero means S should draw the foreground only, and use
20372 its physical height for clipping. See also draw_glyphs.
20374 Value is the index of a component not in S. */
20377 fill_composite_glyph_string (s
, base_face
, overlaps
)
20378 struct glyph_string
*s
;
20379 struct face
*base_face
;
20383 /* For all glyphs of this composition, starting at the offset
20384 S->cmp_from, until we reach the end of the definition or encounter a
20385 glyph that requires the different face, add it to S. */
20390 s
->for_overlaps
= overlaps
;
20393 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20395 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20399 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20402 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20403 s
->char2b
+ i
, 1, 1);
20409 s
->font
= s
->face
->font
;
20411 else if (s
->face
!= face
)
20419 /* All glyph strings for the same composition has the same width,
20420 i.e. the width set for the first component of the composition. */
20421 s
->width
= s
->first_glyph
->pixel_width
;
20423 /* If the specified font could not be loaded, use the frame's
20424 default font, but record the fact that we couldn't load it in
20425 the glyph string so that we can draw rectangles for the
20426 characters of the glyph string. */
20427 if (s
->font
== NULL
)
20429 s
->font_not_found_p
= 1;
20430 s
->font
= FRAME_FONT (s
->f
);
20433 /* Adjust base line for subscript/superscript text. */
20434 s
->ybase
+= s
->first_glyph
->voffset
;
20436 /* This glyph string must always be drawn with 16-bit functions. */
20443 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20444 struct glyph_string
*s
;
20446 int start
, end
, overlaps
;
20448 struct glyph
*glyph
, *last
;
20449 Lisp_Object lgstring
;
20452 s
->for_overlaps
= overlaps
;
20453 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20454 last
= s
->row
->glyphs
[s
->area
] + end
;
20455 s
->cmp_id
= glyph
->u
.cmp
.id
;
20456 s
->cmp_from
= glyph
->u
.cmp
.from
;
20457 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20458 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20459 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20460 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20462 while (glyph
< last
20463 && glyph
->u
.cmp
.automatic
20464 && glyph
->u
.cmp
.id
== s
->cmp_id
20465 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20466 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20468 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20470 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20471 unsigned code
= LGLYPH_CODE (lglyph
);
20473 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20475 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20476 return glyph
- s
->row
->glyphs
[s
->area
];
20480 /* Fill glyph string S from a sequence of character glyphs.
20482 FACE_ID is the face id of the string. START is the index of the
20483 first glyph to consider, END is the index of the last + 1.
20484 OVERLAPS non-zero means S should draw the foreground only, and use
20485 its physical height for clipping. See also draw_glyphs.
20487 Value is the index of the first glyph not in S. */
20490 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20491 struct glyph_string
*s
;
20493 int start
, end
, overlaps
;
20495 struct glyph
*glyph
, *last
;
20497 int glyph_not_available_p
;
20499 xassert (s
->f
== XFRAME (s
->w
->frame
));
20500 xassert (s
->nchars
== 0);
20501 xassert (start
>= 0 && end
> start
);
20503 s
->for_overlaps
= overlaps
;
20504 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20505 last
= s
->row
->glyphs
[s
->area
] + end
;
20506 voffset
= glyph
->voffset
;
20507 s
->padding_p
= glyph
->padding_p
;
20508 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20510 while (glyph
< last
20511 && glyph
->type
== CHAR_GLYPH
20512 && glyph
->voffset
== voffset
20513 /* Same face id implies same font, nowadays. */
20514 && glyph
->face_id
== face_id
20515 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20519 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20520 s
->char2b
+ s
->nchars
,
20522 s
->two_byte_p
= two_byte_p
;
20524 xassert (s
->nchars
<= end
- start
);
20525 s
->width
+= glyph
->pixel_width
;
20526 if (glyph
++->padding_p
!= s
->padding_p
)
20530 s
->font
= s
->face
->font
;
20532 /* If the specified font could not be loaded, use the frame's font,
20533 but record the fact that we couldn't load it in
20534 S->font_not_found_p so that we can draw rectangles for the
20535 characters of the glyph string. */
20536 if (s
->font
== NULL
|| glyph_not_available_p
)
20538 s
->font_not_found_p
= 1;
20539 s
->font
= FRAME_FONT (s
->f
);
20542 /* Adjust base line for subscript/superscript text. */
20543 s
->ybase
+= voffset
;
20545 xassert (s
->face
&& s
->face
->gc
);
20546 return glyph
- s
->row
->glyphs
[s
->area
];
20550 /* Fill glyph string S from image glyph S->first_glyph. */
20553 fill_image_glyph_string (s
)
20554 struct glyph_string
*s
;
20556 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20557 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20559 s
->slice
= s
->first_glyph
->slice
;
20560 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20561 s
->font
= s
->face
->font
;
20562 s
->width
= s
->first_glyph
->pixel_width
;
20564 /* Adjust base line for subscript/superscript text. */
20565 s
->ybase
+= s
->first_glyph
->voffset
;
20569 /* Fill glyph string S from a sequence of stretch glyphs.
20571 ROW is the glyph row in which the glyphs are found, AREA is the
20572 area within the row. START is the index of the first glyph to
20573 consider, END is the index of the last + 1.
20575 Value is the index of the first glyph not in S. */
20578 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20579 struct glyph_string
*s
;
20580 struct glyph_row
*row
;
20581 enum glyph_row_area area
;
20584 struct glyph
*glyph
, *last
;
20585 int voffset
, face_id
;
20587 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20589 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20590 last
= s
->row
->glyphs
[s
->area
] + end
;
20591 face_id
= glyph
->face_id
;
20592 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20593 s
->font
= s
->face
->font
;
20594 s
->width
= glyph
->pixel_width
;
20596 voffset
= glyph
->voffset
;
20600 && glyph
->type
== STRETCH_GLYPH
20601 && glyph
->voffset
== voffset
20602 && glyph
->face_id
== face_id
);
20604 s
->width
+= glyph
->pixel_width
;
20606 /* Adjust base line for subscript/superscript text. */
20607 s
->ybase
+= voffset
;
20609 /* The case that face->gc == 0 is handled when drawing the glyph
20610 string by calling PREPARE_FACE_FOR_DISPLAY. */
20612 return glyph
- s
->row
->glyphs
[s
->area
];
20615 static struct font_metrics
*
20616 get_per_char_metric (f
, font
, char2b
)
20621 static struct font_metrics metrics
;
20622 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20624 if (! font
|| code
== FONT_INVALID_CODE
)
20626 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20631 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20632 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20633 assumed to be zero. */
20636 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20637 struct glyph
*glyph
;
20641 *left
= *right
= 0;
20643 if (glyph
->type
== CHAR_GLYPH
)
20647 struct font_metrics
*pcm
;
20649 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20650 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20652 if (pcm
->rbearing
> pcm
->width
)
20653 *right
= pcm
->rbearing
- pcm
->width
;
20654 if (pcm
->lbearing
< 0)
20655 *left
= -pcm
->lbearing
;
20658 else if (glyph
->type
== COMPOSITE_GLYPH
)
20660 if (! glyph
->u
.cmp
.automatic
)
20662 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20664 if (cmp
->rbearing
> cmp
->pixel_width
)
20665 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20666 if (cmp
->lbearing
< 0)
20667 *left
= - cmp
->lbearing
;
20671 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20672 struct font_metrics metrics
;
20674 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20675 glyph
->u
.cmp
.to
+ 1, &metrics
);
20676 if (metrics
.rbearing
> metrics
.width
)
20677 *right
= metrics
.rbearing
- metrics
.width
;
20678 if (metrics
.lbearing
< 0)
20679 *left
= - metrics
.lbearing
;
20685 /* Return the index of the first glyph preceding glyph string S that
20686 is overwritten by S because of S's left overhang. Value is -1
20687 if no glyphs are overwritten. */
20690 left_overwritten (s
)
20691 struct glyph_string
*s
;
20695 if (s
->left_overhang
)
20698 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20699 int first
= s
->first_glyph
- glyphs
;
20701 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20702 x
-= glyphs
[i
].pixel_width
;
20713 /* Return the index of the first glyph preceding glyph string S that
20714 is overwriting S because of its right overhang. Value is -1 if no
20715 glyph in front of S overwrites S. */
20718 left_overwriting (s
)
20719 struct glyph_string
*s
;
20722 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20723 int first
= s
->first_glyph
- glyphs
;
20727 for (i
= first
- 1; i
>= 0; --i
)
20730 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20733 x
-= glyphs
[i
].pixel_width
;
20740 /* Return the index of the last glyph following glyph string S that is
20741 overwritten by S because of S's right overhang. Value is -1 if
20742 no such glyph is found. */
20745 right_overwritten (s
)
20746 struct glyph_string
*s
;
20750 if (s
->right_overhang
)
20753 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20754 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20755 int end
= s
->row
->used
[s
->area
];
20757 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20758 x
+= glyphs
[i
].pixel_width
;
20767 /* Return the index of the last glyph following glyph string S that
20768 overwrites S because of its left overhang. Value is negative
20769 if no such glyph is found. */
20772 right_overwriting (s
)
20773 struct glyph_string
*s
;
20776 int end
= s
->row
->used
[s
->area
];
20777 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20778 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20782 for (i
= first
; i
< end
; ++i
)
20785 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20788 x
+= glyphs
[i
].pixel_width
;
20795 /* Set background width of glyph string S. START is the index of the
20796 first glyph following S. LAST_X is the right-most x-position + 1
20797 in the drawing area. */
20800 set_glyph_string_background_width (s
, start
, last_x
)
20801 struct glyph_string
*s
;
20805 /* If the face of this glyph string has to be drawn to the end of
20806 the drawing area, set S->extends_to_end_of_line_p. */
20808 if (start
== s
->row
->used
[s
->area
]
20809 && s
->area
== TEXT_AREA
20810 && ((s
->row
->fill_line_p
20811 && (s
->hl
== DRAW_NORMAL_TEXT
20812 || s
->hl
== DRAW_IMAGE_RAISED
20813 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20814 || s
->hl
== DRAW_MOUSE_FACE
))
20815 s
->extends_to_end_of_line_p
= 1;
20817 /* If S extends its face to the end of the line, set its
20818 background_width to the distance to the right edge of the drawing
20820 if (s
->extends_to_end_of_line_p
)
20821 s
->background_width
= last_x
- s
->x
+ 1;
20823 s
->background_width
= s
->width
;
20827 /* Compute overhangs and x-positions for glyph string S and its
20828 predecessors, or successors. X is the starting x-position for S.
20829 BACKWARD_P non-zero means process predecessors. */
20832 compute_overhangs_and_x (s
, x
, backward_p
)
20833 struct glyph_string
*s
;
20841 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20842 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20852 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20853 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20863 /* The following macros are only called from draw_glyphs below.
20864 They reference the following parameters of that function directly:
20865 `w', `row', `area', and `overlap_p'
20866 as well as the following local variables:
20867 `s', `f', and `hdc' (in W32) */
20870 /* On W32, silently add local `hdc' variable to argument list of
20871 init_glyph_string. */
20872 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20873 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20875 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20876 init_glyph_string (s, char2b, w, row, area, start, hl)
20879 /* Add a glyph string for a stretch glyph to the list of strings
20880 between HEAD and TAIL. START is the index of the stretch glyph in
20881 row area AREA of glyph row ROW. END is the index of the last glyph
20882 in that glyph row area. X is the current output position assigned
20883 to the new glyph string constructed. HL overrides that face of the
20884 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20885 is the right-most x-position of the drawing area. */
20887 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20888 and below -- keep them on one line. */
20889 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20892 s = (struct glyph_string *) alloca (sizeof *s); \
20893 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20894 START = fill_stretch_glyph_string (s, row, area, START, END); \
20895 append_glyph_string (&HEAD, &TAIL, s); \
20901 /* Add a glyph string for an image glyph to the list of strings
20902 between HEAD and TAIL. START is the index of the image glyph in
20903 row area AREA of glyph row ROW. END is the index of the last glyph
20904 in that glyph row area. X is the current output position assigned
20905 to the new glyph string constructed. HL overrides that face of the
20906 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20907 is the right-most x-position of the drawing area. */
20909 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20912 s = (struct glyph_string *) alloca (sizeof *s); \
20913 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20914 fill_image_glyph_string (s); \
20915 append_glyph_string (&HEAD, &TAIL, s); \
20922 /* Add a glyph string for a sequence of character glyphs to the list
20923 of strings between HEAD and TAIL. START is the index of the first
20924 glyph in row area AREA of glyph row ROW that is part of the new
20925 glyph string. END is the index of the last glyph in that glyph row
20926 area. X is the current output position assigned to the new glyph
20927 string constructed. HL overrides that face of the glyph; e.g. it
20928 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20929 right-most x-position of the drawing area. */
20931 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20937 face_id = (row)->glyphs[area][START].face_id; \
20939 s = (struct glyph_string *) alloca (sizeof *s); \
20940 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20941 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20942 append_glyph_string (&HEAD, &TAIL, s); \
20944 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20949 /* Add a glyph string for a composite sequence to the list of strings
20950 between HEAD and TAIL. START is the index of the first glyph in
20951 row area AREA of glyph row ROW that is part of the new glyph
20952 string. END is the index of the last glyph in that glyph row area.
20953 X is the current output position assigned to the new glyph string
20954 constructed. HL overrides that face of the glyph; e.g. it is
20955 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20956 x-position of the drawing area. */
20958 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20960 int face_id = (row)->glyphs[area][START].face_id; \
20961 struct face *base_face = FACE_FROM_ID (f, face_id); \
20962 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20963 struct composition *cmp = composition_table[cmp_id]; \
20965 struct glyph_string *first_s; \
20968 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20970 /* Make glyph_strings for each glyph sequence that is drawable by \
20971 the same face, and append them to HEAD/TAIL. */ \
20972 for (n = 0; n < cmp->glyph_len;) \
20974 s = (struct glyph_string *) alloca (sizeof *s); \
20975 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20976 append_glyph_string (&(HEAD), &(TAIL), s); \
20982 n = fill_composite_glyph_string (s, base_face, overlaps); \
20990 /* Add a glyph string for a glyph-string sequence to the list of strings
20991 between HEAD and TAIL. */
20993 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20997 Lisp_Object gstring; \
20999 face_id = (row)->glyphs[area][START].face_id; \
21000 gstring = (composition_gstring_from_id \
21001 ((row)->glyphs[area][START].u.cmp.id)); \
21002 s = (struct glyph_string *) alloca (sizeof *s); \
21003 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21004 * LGSTRING_GLYPH_LEN (gstring)); \
21005 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21006 append_glyph_string (&(HEAD), &(TAIL), s); \
21008 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21012 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21013 of AREA of glyph row ROW on window W between indices START and END.
21014 HL overrides the face for drawing glyph strings, e.g. it is
21015 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21016 x-positions of the drawing area.
21018 This is an ugly monster macro construct because we must use alloca
21019 to allocate glyph strings (because draw_glyphs can be called
21020 asynchronously). */
21022 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21025 HEAD = TAIL = NULL; \
21026 while (START < END) \
21028 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21029 switch (first_glyph->type) \
21032 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21036 case COMPOSITE_GLYPH: \
21037 if (first_glyph->u.cmp.automatic) \
21038 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21041 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21045 case STRETCH_GLYPH: \
21046 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21050 case IMAGE_GLYPH: \
21051 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21061 set_glyph_string_background_width (s, START, LAST_X); \
21068 /* Draw glyphs between START and END in AREA of ROW on window W,
21069 starting at x-position X. X is relative to AREA in W. HL is a
21070 face-override with the following meaning:
21072 DRAW_NORMAL_TEXT draw normally
21073 DRAW_CURSOR draw in cursor face
21074 DRAW_MOUSE_FACE draw in mouse face.
21075 DRAW_INVERSE_VIDEO draw in mode line face
21076 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21077 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21079 If OVERLAPS is non-zero, draw only the foreground of characters and
21080 clip to the physical height of ROW. Non-zero value also defines
21081 the overlapping part to be drawn:
21083 OVERLAPS_PRED overlap with preceding rows
21084 OVERLAPS_SUCC overlap with succeeding rows
21085 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21086 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21088 Value is the x-position reached, relative to AREA of W. */
21091 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21094 struct glyph_row
*row
;
21095 enum glyph_row_area area
;
21096 EMACS_INT start
, end
;
21097 enum draw_glyphs_face hl
;
21100 struct glyph_string
*head
, *tail
;
21101 struct glyph_string
*s
;
21102 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21103 int i
, j
, x_reached
, last_x
, area_left
= 0;
21104 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21107 ALLOCATE_HDC (hdc
, f
);
21109 /* Let's rather be paranoid than getting a SEGV. */
21110 end
= min (end
, row
->used
[area
]);
21111 start
= max (0, start
);
21112 start
= min (end
, start
);
21114 /* Translate X to frame coordinates. Set last_x to the right
21115 end of the drawing area. */
21116 if (row
->full_width_p
)
21118 /* X is relative to the left edge of W, without scroll bars
21120 area_left
= WINDOW_LEFT_EDGE_X (w
);
21121 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21125 area_left
= window_box_left (w
, area
);
21126 last_x
= area_left
+ window_box_width (w
, area
);
21130 /* Build a doubly-linked list of glyph_string structures between
21131 head and tail from what we have to draw. Note that the macro
21132 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21133 the reason we use a separate variable `i'. */
21135 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21137 x_reached
= tail
->x
+ tail
->background_width
;
21141 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21142 the row, redraw some glyphs in front or following the glyph
21143 strings built above. */
21144 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21146 struct glyph_string
*h
, *t
;
21147 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21148 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21151 /* If mouse highlighting is on, we may need to draw adjacent
21152 glyphs using mouse-face highlighting. */
21153 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21155 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21157 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21158 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21160 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21162 check_mouse_face
= 1;
21163 mouse_beg_col
= (row
== mouse_beg_row
)
21164 ? dpyinfo
->mouse_face_beg_col
: 0;
21165 mouse_end_col
= (row
== mouse_end_row
)
21166 ? dpyinfo
->mouse_face_end_col
21167 : row
->used
[TEXT_AREA
];
21171 /* Compute overhangs for all glyph strings. */
21172 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21173 for (s
= head
; s
; s
= s
->next
)
21174 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21176 /* Prepend glyph strings for glyphs in front of the first glyph
21177 string that are overwritten because of the first glyph
21178 string's left overhang. The background of all strings
21179 prepended must be drawn because the first glyph string
21181 i
= left_overwritten (head
);
21184 enum draw_glyphs_face overlap_hl
;
21186 /* If this row contains mouse highlighting, attempt to draw
21187 the overlapped glyphs with the correct highlight. This
21188 code fails if the overlap encompasses more than one glyph
21189 and mouse-highlight spans only some of these glyphs.
21190 However, making it work perfectly involves a lot more
21191 code, and I don't know if the pathological case occurs in
21192 practice, so we'll stick to this for now. --- cyd */
21193 if (check_mouse_face
21194 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21195 overlap_hl
= DRAW_MOUSE_FACE
;
21197 overlap_hl
= DRAW_NORMAL_TEXT
;
21200 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21201 overlap_hl
, dummy_x
, last_x
);
21203 compute_overhangs_and_x (t
, head
->x
, 1);
21204 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21208 /* Prepend glyph strings for glyphs in front of the first glyph
21209 string that overwrite that glyph string because of their
21210 right overhang. For these strings, only the foreground must
21211 be drawn, because it draws over the glyph string at `head'.
21212 The background must not be drawn because this would overwrite
21213 right overhangs of preceding glyphs for which no glyph
21215 i
= left_overwriting (head
);
21218 enum draw_glyphs_face overlap_hl
;
21220 if (check_mouse_face
21221 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21222 overlap_hl
= DRAW_MOUSE_FACE
;
21224 overlap_hl
= DRAW_NORMAL_TEXT
;
21227 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21228 overlap_hl
, dummy_x
, last_x
);
21229 for (s
= h
; s
; s
= s
->next
)
21230 s
->background_filled_p
= 1;
21231 compute_overhangs_and_x (t
, head
->x
, 1);
21232 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21235 /* Append glyphs strings for glyphs following the last glyph
21236 string tail that are overwritten by tail. The background of
21237 these strings has to be drawn because tail's foreground draws
21239 i
= right_overwritten (tail
);
21242 enum draw_glyphs_face overlap_hl
;
21244 if (check_mouse_face
21245 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21246 overlap_hl
= DRAW_MOUSE_FACE
;
21248 overlap_hl
= DRAW_NORMAL_TEXT
;
21250 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21251 overlap_hl
, x
, last_x
);
21252 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21253 we don't have `end = i;' here. */
21254 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21255 append_glyph_string_lists (&head
, &tail
, h
, t
);
21259 /* Append glyph strings for glyphs following the last glyph
21260 string tail that overwrite tail. The foreground of such
21261 glyphs has to be drawn because it writes into the background
21262 of tail. The background must not be drawn because it could
21263 paint over the foreground of following glyphs. */
21264 i
= right_overwriting (tail
);
21267 enum draw_glyphs_face overlap_hl
;
21268 if (check_mouse_face
21269 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21270 overlap_hl
= DRAW_MOUSE_FACE
;
21272 overlap_hl
= DRAW_NORMAL_TEXT
;
21275 i
++; /* We must include the Ith glyph. */
21276 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21277 overlap_hl
, x
, last_x
);
21278 for (s
= h
; s
; s
= s
->next
)
21279 s
->background_filled_p
= 1;
21280 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21281 append_glyph_string_lists (&head
, &tail
, h
, t
);
21283 if (clip_head
|| clip_tail
)
21284 for (s
= head
; s
; s
= s
->next
)
21286 s
->clip_head
= clip_head
;
21287 s
->clip_tail
= clip_tail
;
21291 /* Draw all strings. */
21292 for (s
= head
; s
; s
= s
->next
)
21293 FRAME_RIF (f
)->draw_glyph_string (s
);
21296 /* When focus a sole frame and move horizontally, this sets on_p to 0
21297 causing a failure to erase prev cursor position. */
21298 if (area
== TEXT_AREA
21299 && !row
->full_width_p
21300 /* When drawing overlapping rows, only the glyph strings'
21301 foreground is drawn, which doesn't erase a cursor
21305 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21306 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21307 : (tail
? tail
->x
+ tail
->background_width
: x
));
21311 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21312 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21316 /* Value is the x-position up to which drawn, relative to AREA of W.
21317 This doesn't include parts drawn because of overhangs. */
21318 if (row
->full_width_p
)
21319 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21321 x_reached
-= area_left
;
21323 RELEASE_HDC (hdc
, f
);
21328 /* Expand row matrix if too narrow. Don't expand if area
21331 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21333 if (!fonts_changed_p \
21334 && (it->glyph_row->glyphs[area] \
21335 < it->glyph_row->glyphs[area + 1])) \
21337 it->w->ncols_scale_factor++; \
21338 fonts_changed_p = 1; \
21342 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21343 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21349 struct glyph
*glyph
;
21350 enum glyph_row_area area
= it
->area
;
21352 xassert (it
->glyph_row
);
21353 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21355 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21356 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21358 glyph
->charpos
= CHARPOS (it
->position
);
21359 glyph
->object
= it
->object
;
21360 if (it
->pixel_width
> 0)
21362 glyph
->pixel_width
= it
->pixel_width
;
21363 glyph
->padding_p
= 0;
21367 /* Assure at least 1-pixel width. Otherwise, cursor can't
21368 be displayed correctly. */
21369 glyph
->pixel_width
= 1;
21370 glyph
->padding_p
= 1;
21372 glyph
->ascent
= it
->ascent
;
21373 glyph
->descent
= it
->descent
;
21374 glyph
->voffset
= it
->voffset
;
21375 glyph
->type
= CHAR_GLYPH
;
21376 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21377 glyph
->multibyte_p
= it
->multibyte_p
;
21378 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21379 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21380 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21381 || it
->phys_descent
> it
->descent
);
21382 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21383 glyph
->face_id
= it
->face_id
;
21384 glyph
->u
.ch
= it
->char_to_display
;
21385 glyph
->slice
= null_glyph_slice
;
21386 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21389 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21390 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21392 glyph
->bidi_type
= it
->bidi_it
.type
;
21394 ++it
->glyph_row
->used
[area
];
21397 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21400 /* Store one glyph for the composition IT->cmp_it.id in
21401 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21405 append_composite_glyph (it
)
21408 struct glyph
*glyph
;
21409 enum glyph_row_area area
= it
->area
;
21411 xassert (it
->glyph_row
);
21413 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21414 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21416 glyph
->charpos
= CHARPOS (it
->position
);
21417 glyph
->object
= it
->object
;
21418 glyph
->pixel_width
= it
->pixel_width
;
21419 glyph
->ascent
= it
->ascent
;
21420 glyph
->descent
= it
->descent
;
21421 glyph
->voffset
= it
->voffset
;
21422 glyph
->type
= COMPOSITE_GLYPH
;
21423 if (it
->cmp_it
.ch
< 0)
21425 glyph
->u
.cmp
.automatic
= 0;
21426 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21430 glyph
->u
.cmp
.automatic
= 1;
21431 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21432 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21433 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21435 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21436 glyph
->multibyte_p
= it
->multibyte_p
;
21437 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21438 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21439 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21440 || it
->phys_descent
> it
->descent
);
21441 glyph
->padding_p
= 0;
21442 glyph
->glyph_not_available_p
= 0;
21443 glyph
->face_id
= it
->face_id
;
21444 glyph
->slice
= null_glyph_slice
;
21445 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21448 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21449 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21451 glyph
->bidi_type
= it
->bidi_it
.type
;
21453 ++it
->glyph_row
->used
[area
];
21456 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21460 /* Change IT->ascent and IT->height according to the setting of
21464 take_vertical_position_into_account (it
)
21469 if (it
->voffset
< 0)
21470 /* Increase the ascent so that we can display the text higher
21472 it
->ascent
-= it
->voffset
;
21474 /* Increase the descent so that we can display the text lower
21476 it
->descent
+= it
->voffset
;
21481 /* Produce glyphs/get display metrics for the image IT is loaded with.
21482 See the description of struct display_iterator in dispextern.h for
21483 an overview of struct display_iterator. */
21486 produce_image_glyph (it
)
21491 int glyph_ascent
, crop
;
21492 struct glyph_slice slice
;
21494 xassert (it
->what
== IT_IMAGE
);
21496 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21498 /* Make sure X resources of the face is loaded. */
21499 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21501 if (it
->image_id
< 0)
21503 /* Fringe bitmap. */
21504 it
->ascent
= it
->phys_ascent
= 0;
21505 it
->descent
= it
->phys_descent
= 0;
21506 it
->pixel_width
= 0;
21511 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21513 /* Make sure X resources of the image is loaded. */
21514 prepare_image_for_display (it
->f
, img
);
21516 slice
.x
= slice
.y
= 0;
21517 slice
.width
= img
->width
;
21518 slice
.height
= img
->height
;
21520 if (INTEGERP (it
->slice
.x
))
21521 slice
.x
= XINT (it
->slice
.x
);
21522 else if (FLOATP (it
->slice
.x
))
21523 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21525 if (INTEGERP (it
->slice
.y
))
21526 slice
.y
= XINT (it
->slice
.y
);
21527 else if (FLOATP (it
->slice
.y
))
21528 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21530 if (INTEGERP (it
->slice
.width
))
21531 slice
.width
= XINT (it
->slice
.width
);
21532 else if (FLOATP (it
->slice
.width
))
21533 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21535 if (INTEGERP (it
->slice
.height
))
21536 slice
.height
= XINT (it
->slice
.height
);
21537 else if (FLOATP (it
->slice
.height
))
21538 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21540 if (slice
.x
>= img
->width
)
21541 slice
.x
= img
->width
;
21542 if (slice
.y
>= img
->height
)
21543 slice
.y
= img
->height
;
21544 if (slice
.x
+ slice
.width
>= img
->width
)
21545 slice
.width
= img
->width
- slice
.x
;
21546 if (slice
.y
+ slice
.height
> img
->height
)
21547 slice
.height
= img
->height
- slice
.y
;
21549 if (slice
.width
== 0 || slice
.height
== 0)
21552 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21554 it
->descent
= slice
.height
- glyph_ascent
;
21556 it
->descent
+= img
->vmargin
;
21557 if (slice
.y
+ slice
.height
== img
->height
)
21558 it
->descent
+= img
->vmargin
;
21559 it
->phys_descent
= it
->descent
;
21561 it
->pixel_width
= slice
.width
;
21563 it
->pixel_width
+= img
->hmargin
;
21564 if (slice
.x
+ slice
.width
== img
->width
)
21565 it
->pixel_width
+= img
->hmargin
;
21567 /* It's quite possible for images to have an ascent greater than
21568 their height, so don't get confused in that case. */
21569 if (it
->descent
< 0)
21574 if (face
->box
!= FACE_NO_BOX
)
21576 if (face
->box_line_width
> 0)
21579 it
->ascent
+= face
->box_line_width
;
21580 if (slice
.y
+ slice
.height
== img
->height
)
21581 it
->descent
+= face
->box_line_width
;
21584 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21585 it
->pixel_width
+= eabs (face
->box_line_width
);
21586 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21587 it
->pixel_width
+= eabs (face
->box_line_width
);
21590 take_vertical_position_into_account (it
);
21592 /* Automatically crop wide image glyphs at right edge so we can
21593 draw the cursor on same display row. */
21594 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21595 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21597 it
->pixel_width
-= crop
;
21598 slice
.width
-= crop
;
21603 struct glyph
*glyph
;
21604 enum glyph_row_area area
= it
->area
;
21606 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21607 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21609 glyph
->charpos
= CHARPOS (it
->position
);
21610 glyph
->object
= it
->object
;
21611 glyph
->pixel_width
= it
->pixel_width
;
21612 glyph
->ascent
= glyph_ascent
;
21613 glyph
->descent
= it
->descent
;
21614 glyph
->voffset
= it
->voffset
;
21615 glyph
->type
= IMAGE_GLYPH
;
21616 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21617 glyph
->multibyte_p
= it
->multibyte_p
;
21618 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21619 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21620 glyph
->overlaps_vertically_p
= 0;
21621 glyph
->padding_p
= 0;
21622 glyph
->glyph_not_available_p
= 0;
21623 glyph
->face_id
= it
->face_id
;
21624 glyph
->u
.img_id
= img
->id
;
21625 glyph
->slice
= slice
;
21626 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21629 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21630 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21632 glyph
->bidi_type
= it
->bidi_it
.type
;
21634 ++it
->glyph_row
->used
[area
];
21637 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21642 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21643 of the glyph, WIDTH and HEIGHT are the width and height of the
21644 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21647 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21649 Lisp_Object object
;
21653 struct glyph
*glyph
;
21654 enum glyph_row_area area
= it
->area
;
21656 xassert (ascent
>= 0 && ascent
<= height
);
21658 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21659 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21661 glyph
->charpos
= CHARPOS (it
->position
);
21662 glyph
->object
= object
;
21663 glyph
->pixel_width
= width
;
21664 glyph
->ascent
= ascent
;
21665 glyph
->descent
= height
- ascent
;
21666 glyph
->voffset
= it
->voffset
;
21667 glyph
->type
= STRETCH_GLYPH
;
21668 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21669 glyph
->multibyte_p
= it
->multibyte_p
;
21670 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21671 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21672 glyph
->overlaps_vertically_p
= 0;
21673 glyph
->padding_p
= 0;
21674 glyph
->glyph_not_available_p
= 0;
21675 glyph
->face_id
= it
->face_id
;
21676 glyph
->u
.stretch
.ascent
= ascent
;
21677 glyph
->u
.stretch
.height
= height
;
21678 glyph
->slice
= null_glyph_slice
;
21679 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21682 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21683 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21685 glyph
->bidi_type
= it
->bidi_it
.type
;
21687 ++it
->glyph_row
->used
[area
];
21690 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21694 /* Produce a stretch glyph for iterator IT. IT->object is the value
21695 of the glyph property displayed. The value must be a list
21696 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21699 1. `:width WIDTH' specifies that the space should be WIDTH *
21700 canonical char width wide. WIDTH may be an integer or floating
21703 2. `:relative-width FACTOR' specifies that the width of the stretch
21704 should be computed from the width of the first character having the
21705 `glyph' property, and should be FACTOR times that width.
21707 3. `:align-to HPOS' specifies that the space should be wide enough
21708 to reach HPOS, a value in canonical character units.
21710 Exactly one of the above pairs must be present.
21712 4. `:height HEIGHT' specifies that the height of the stretch produced
21713 should be HEIGHT, measured in canonical character units.
21715 5. `:relative-height FACTOR' specifies that the height of the
21716 stretch should be FACTOR times the height of the characters having
21717 the glyph property.
21719 Either none or exactly one of 4 or 5 must be present.
21721 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21722 of the stretch should be used for the ascent of the stretch.
21723 ASCENT must be in the range 0 <= ASCENT <= 100. */
21726 produce_stretch_glyph (it
)
21729 /* (space :width WIDTH :height HEIGHT ...) */
21730 Lisp_Object prop
, plist
;
21731 int width
= 0, height
= 0, align_to
= -1;
21732 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21735 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21736 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21738 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21740 /* List should start with `space'. */
21741 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21742 plist
= XCDR (it
->object
);
21744 /* Compute the width of the stretch. */
21745 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21746 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21748 /* Absolute width `:width WIDTH' specified and valid. */
21749 zero_width_ok_p
= 1;
21752 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21755 /* Relative width `:relative-width FACTOR' specified and valid.
21756 Compute the width of the characters having the `glyph'
21759 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21762 if (it
->multibyte_p
)
21764 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21765 - IT_BYTEPOS (*it
));
21766 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21769 it2
.c
= *p
, it2
.len
= 1;
21771 it2
.glyph_row
= NULL
;
21772 it2
.what
= IT_CHARACTER
;
21773 x_produce_glyphs (&it2
);
21774 width
= NUMVAL (prop
) * it2
.pixel_width
;
21776 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21777 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21779 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21780 align_to
= (align_to
< 0
21782 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21783 else if (align_to
< 0)
21784 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21785 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21786 zero_width_ok_p
= 1;
21789 /* Nothing specified -> width defaults to canonical char width. */
21790 width
= FRAME_COLUMN_WIDTH (it
->f
);
21792 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21795 /* Compute height. */
21796 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21797 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21800 zero_height_ok_p
= 1;
21802 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21804 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21806 height
= FONT_HEIGHT (font
);
21808 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21811 /* Compute percentage of height used for ascent. If
21812 `:ascent ASCENT' is present and valid, use that. Otherwise,
21813 derive the ascent from the font in use. */
21814 if (prop
= Fplist_get (plist
, QCascent
),
21815 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21816 ascent
= height
* NUMVAL (prop
) / 100.0;
21817 else if (!NILP (prop
)
21818 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21819 ascent
= min (max (0, (int)tem
), height
);
21821 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21823 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21824 && it
->current_x
+ width
> it
->last_visible_x
)
21825 width
= it
->last_visible_x
- it
->current_x
- 1;
21827 if (width
> 0 && height
> 0 && it
->glyph_row
)
21829 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21830 if (!STRINGP (object
))
21831 object
= it
->w
->buffer
;
21832 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21835 it
->pixel_width
= width
;
21836 it
->ascent
= it
->phys_ascent
= ascent
;
21837 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21838 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21840 take_vertical_position_into_account (it
);
21843 /* Calculate line-height and line-spacing properties.
21844 An integer value specifies explicit pixel value.
21845 A float value specifies relative value to current face height.
21846 A cons (float . face-name) specifies relative value to
21847 height of specified face font.
21849 Returns height in pixels, or nil. */
21853 calc_line_height_property (it
, val
, font
, boff
, override
)
21857 int boff
, override
;
21859 Lisp_Object face_name
= Qnil
;
21860 int ascent
, descent
, height
;
21862 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21867 face_name
= XCAR (val
);
21869 if (!NUMBERP (val
))
21870 val
= make_number (1);
21871 if (NILP (face_name
))
21873 height
= it
->ascent
+ it
->descent
;
21878 if (NILP (face_name
))
21880 font
= FRAME_FONT (it
->f
);
21881 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21883 else if (EQ (face_name
, Qt
))
21892 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21894 return make_number (-1);
21896 face
= FACE_FROM_ID (it
->f
, face_id
);
21899 return make_number (-1);
21900 boff
= font
->baseline_offset
;
21901 if (font
->vertical_centering
)
21902 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21905 ascent
= FONT_BASE (font
) + boff
;
21906 descent
= FONT_DESCENT (font
) - boff
;
21910 it
->override_ascent
= ascent
;
21911 it
->override_descent
= descent
;
21912 it
->override_boff
= boff
;
21915 height
= ascent
+ descent
;
21919 height
= (int)(XFLOAT_DATA (val
) * height
);
21920 else if (INTEGERP (val
))
21921 height
*= XINT (val
);
21923 return make_number (height
);
21928 Produce glyphs/get display metrics for the display element IT is
21929 loaded with. See the description of struct it in dispextern.h
21930 for an overview of struct it. */
21933 x_produce_glyphs (it
)
21936 int extra_line_spacing
= it
->extra_line_spacing
;
21938 it
->glyph_not_available_p
= 0;
21940 if (it
->what
== IT_CHARACTER
)
21944 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21945 struct font_metrics
*pcm
;
21946 int font_not_found_p
;
21947 int boff
; /* baseline offset */
21948 /* We may change it->multibyte_p upon unibyte<->multibyte
21949 conversion. So, save the current value now and restore it
21952 Note: It seems that we don't have to record multibyte_p in
21953 struct glyph because the character code itself tells whether
21954 or not the character is multibyte. Thus, in the future, we
21955 must consider eliminating the field `multibyte_p' in the
21957 int saved_multibyte_p
= it
->multibyte_p
;
21959 /* Maybe translate single-byte characters to multibyte, or the
21961 it
->char_to_display
= it
->c
;
21962 if (!ASCII_BYTE_P (it
->c
)
21963 && ! it
->multibyte_p
)
21965 if (SINGLE_BYTE_CHAR_P (it
->c
)
21966 && unibyte_display_via_language_environment
)
21968 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21970 /* get_next_display_element assures that this decoding
21972 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21973 it
->multibyte_p
= 1;
21974 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21976 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21980 /* Get font to use. Encode IT->char_to_display. */
21981 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21982 &char2b
, it
->multibyte_p
, 0);
21985 font_not_found_p
= font
== NULL
;
21986 if (font_not_found_p
)
21988 /* When no suitable font found, display an empty box based
21989 on the metrics of the font of the default face (or what
21991 struct face
*no_font_face
21992 = FACE_FROM_ID (it
->f
,
21993 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21994 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21995 font
= no_font_face
->font
;
21996 boff
= font
->baseline_offset
;
22000 boff
= font
->baseline_offset
;
22001 if (font
->vertical_centering
)
22002 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22005 if (it
->char_to_display
>= ' '
22006 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22008 /* Either unibyte or ASCII. */
22013 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22015 if (it
->override_ascent
>= 0)
22017 it
->ascent
= it
->override_ascent
;
22018 it
->descent
= it
->override_descent
;
22019 boff
= it
->override_boff
;
22023 it
->ascent
= FONT_BASE (font
) + boff
;
22024 it
->descent
= FONT_DESCENT (font
) - boff
;
22029 it
->phys_ascent
= pcm
->ascent
+ boff
;
22030 it
->phys_descent
= pcm
->descent
- boff
;
22031 it
->pixel_width
= pcm
->width
;
22035 it
->glyph_not_available_p
= 1;
22036 it
->phys_ascent
= it
->ascent
;
22037 it
->phys_descent
= it
->descent
;
22038 it
->pixel_width
= FONT_WIDTH (font
);
22041 if (it
->constrain_row_ascent_descent_p
)
22043 if (it
->descent
> it
->max_descent
)
22045 it
->ascent
+= it
->descent
- it
->max_descent
;
22046 it
->descent
= it
->max_descent
;
22048 if (it
->ascent
> it
->max_ascent
)
22050 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22051 it
->ascent
= it
->max_ascent
;
22053 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22054 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22055 extra_line_spacing
= 0;
22058 /* If this is a space inside a region of text with
22059 `space-width' property, change its width. */
22060 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22062 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22064 /* If face has a box, add the box thickness to the character
22065 height. If character has a box line to the left and/or
22066 right, add the box line width to the character's width. */
22067 if (face
->box
!= FACE_NO_BOX
)
22069 int thick
= face
->box_line_width
;
22073 it
->ascent
+= thick
;
22074 it
->descent
+= thick
;
22079 if (it
->start_of_box_run_p
)
22080 it
->pixel_width
+= thick
;
22081 if (it
->end_of_box_run_p
)
22082 it
->pixel_width
+= thick
;
22085 /* If face has an overline, add the height of the overline
22086 (1 pixel) and a 1 pixel margin to the character height. */
22087 if (face
->overline_p
)
22088 it
->ascent
+= overline_margin
;
22090 if (it
->constrain_row_ascent_descent_p
)
22092 if (it
->ascent
> it
->max_ascent
)
22093 it
->ascent
= it
->max_ascent
;
22094 if (it
->descent
> it
->max_descent
)
22095 it
->descent
= it
->max_descent
;
22098 take_vertical_position_into_account (it
);
22100 /* If we have to actually produce glyphs, do it. */
22105 /* Translate a space with a `space-width' property
22106 into a stretch glyph. */
22107 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22108 / FONT_HEIGHT (font
));
22109 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22110 it
->ascent
+ it
->descent
, ascent
);
22115 /* If characters with lbearing or rbearing are displayed
22116 in this line, record that fact in a flag of the
22117 glyph row. This is used to optimize X output code. */
22118 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22119 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22121 if (! stretched_p
&& it
->pixel_width
== 0)
22122 /* We assure that all visible glyphs have at least 1-pixel
22124 it
->pixel_width
= 1;
22126 else if (it
->char_to_display
== '\n')
22128 /* A newline has no width, but we need the height of the
22129 line. But if previous part of the line sets a height,
22130 don't increase that height */
22132 Lisp_Object height
;
22133 Lisp_Object total_height
= Qnil
;
22135 it
->override_ascent
= -1;
22136 it
->pixel_width
= 0;
22139 height
= get_it_property(it
, Qline_height
);
22140 /* Split (line-height total-height) list */
22142 && CONSP (XCDR (height
))
22143 && NILP (XCDR (XCDR (height
))))
22145 total_height
= XCAR (XCDR (height
));
22146 height
= XCAR (height
);
22148 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22150 if (it
->override_ascent
>= 0)
22152 it
->ascent
= it
->override_ascent
;
22153 it
->descent
= it
->override_descent
;
22154 boff
= it
->override_boff
;
22158 it
->ascent
= FONT_BASE (font
) + boff
;
22159 it
->descent
= FONT_DESCENT (font
) - boff
;
22162 if (EQ (height
, Qt
))
22164 if (it
->descent
> it
->max_descent
)
22166 it
->ascent
+= it
->descent
- it
->max_descent
;
22167 it
->descent
= it
->max_descent
;
22169 if (it
->ascent
> it
->max_ascent
)
22171 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22172 it
->ascent
= it
->max_ascent
;
22174 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22175 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22176 it
->constrain_row_ascent_descent_p
= 1;
22177 extra_line_spacing
= 0;
22181 Lisp_Object spacing
;
22183 it
->phys_ascent
= it
->ascent
;
22184 it
->phys_descent
= it
->descent
;
22186 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22187 && face
->box
!= FACE_NO_BOX
22188 && face
->box_line_width
> 0)
22190 it
->ascent
+= face
->box_line_width
;
22191 it
->descent
+= face
->box_line_width
;
22194 && XINT (height
) > it
->ascent
+ it
->descent
)
22195 it
->ascent
= XINT (height
) - it
->descent
;
22197 if (!NILP (total_height
))
22198 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22201 spacing
= get_it_property(it
, Qline_spacing
);
22202 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22204 if (INTEGERP (spacing
))
22206 extra_line_spacing
= XINT (spacing
);
22207 if (!NILP (total_height
))
22208 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22212 else if (it
->char_to_display
== '\t')
22214 if (font
->space_width
> 0)
22216 int tab_width
= it
->tab_width
* font
->space_width
;
22217 int x
= it
->current_x
+ it
->continuation_lines_width
;
22218 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22220 /* If the distance from the current position to the next tab
22221 stop is less than a space character width, use the
22222 tab stop after that. */
22223 if (next_tab_x
- x
< font
->space_width
)
22224 next_tab_x
+= tab_width
;
22226 it
->pixel_width
= next_tab_x
- x
;
22228 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22229 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22233 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22234 it
->ascent
+ it
->descent
, it
->ascent
);
22239 it
->pixel_width
= 0;
22245 /* A multi-byte character. Assume that the display width of the
22246 character is the width of the character multiplied by the
22247 width of the font. */
22249 /* If we found a font, this font should give us the right
22250 metrics. If we didn't find a font, use the frame's
22251 default font and calculate the width of the character by
22252 multiplying the width of font by the width of the
22255 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22257 if (font_not_found_p
|| !pcm
)
22259 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22261 if (char_width
== 0)
22262 /* This is a non spacing character. But, as we are
22263 going to display an empty box, the box must occupy
22264 at least one column. */
22266 it
->glyph_not_available_p
= 1;
22267 it
->pixel_width
= font
->space_width
* char_width
;
22268 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22269 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22273 it
->pixel_width
= pcm
->width
;
22274 it
->phys_ascent
= pcm
->ascent
+ boff
;
22275 it
->phys_descent
= pcm
->descent
- boff
;
22277 && (pcm
->lbearing
< 0
22278 || pcm
->rbearing
> pcm
->width
))
22279 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22282 it
->ascent
= FONT_BASE (font
) + boff
;
22283 it
->descent
= FONT_DESCENT (font
) - boff
;
22284 if (face
->box
!= FACE_NO_BOX
)
22286 int thick
= face
->box_line_width
;
22290 it
->ascent
+= thick
;
22291 it
->descent
+= thick
;
22296 if (it
->start_of_box_run_p
)
22297 it
->pixel_width
+= thick
;
22298 if (it
->end_of_box_run_p
)
22299 it
->pixel_width
+= thick
;
22302 /* If face has an overline, add the height of the overline
22303 (1 pixel) and a 1 pixel margin to the character height. */
22304 if (face
->overline_p
)
22305 it
->ascent
+= overline_margin
;
22307 take_vertical_position_into_account (it
);
22309 if (it
->ascent
< 0)
22311 if (it
->descent
< 0)
22316 if (it
->pixel_width
== 0)
22317 /* We assure that all visible glyphs have at least 1-pixel
22319 it
->pixel_width
= 1;
22321 it
->multibyte_p
= saved_multibyte_p
;
22323 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22325 /* A static composition.
22327 Note: A composition is represented as one glyph in the
22328 glyph matrix. There are no padding glyphs.
22330 Important note: pixel_width, ascent, and descent are the
22331 values of what is drawn by draw_glyphs (i.e. the values of
22332 the overall glyphs composed). */
22333 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22334 int boff
; /* baseline offset */
22335 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22336 int glyph_len
= cmp
->glyph_len
;
22337 struct font
*font
= face
->font
;
22341 /* If we have not yet calculated pixel size data of glyphs of
22342 the composition for the current face font, calculate them
22343 now. Theoretically, we have to check all fonts for the
22344 glyphs, but that requires much time and memory space. So,
22345 here we check only the font of the first glyph. This may
22346 lead to incorrect display, but it's very rare, and C-l
22347 (recenter-top-bottom) can correct the display anyway. */
22348 if (! cmp
->font
|| cmp
->font
!= font
)
22350 /* Ascent and descent of the font of the first character
22351 of this composition (adjusted by baseline offset).
22352 Ascent and descent of overall glyphs should not be less
22353 than these, respectively. */
22354 int font_ascent
, font_descent
, font_height
;
22355 /* Bounding box of the overall glyphs. */
22356 int leftmost
, rightmost
, lowest
, highest
;
22357 int lbearing
, rbearing
;
22358 int i
, width
, ascent
, descent
;
22359 int left_padded
= 0, right_padded
= 0;
22362 struct font_metrics
*pcm
;
22363 int font_not_found_p
;
22366 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22367 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22369 if (glyph_len
< cmp
->glyph_len
)
22371 for (i
= 0; i
< glyph_len
; i
++)
22373 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22375 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22380 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22381 : IT_CHARPOS (*it
));
22382 /* If no suitable font is found, use the default font. */
22383 font_not_found_p
= font
== NULL
;
22384 if (font_not_found_p
)
22386 face
= face
->ascii_face
;
22389 boff
= font
->baseline_offset
;
22390 if (font
->vertical_centering
)
22391 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22392 font_ascent
= FONT_BASE (font
) + boff
;
22393 font_descent
= FONT_DESCENT (font
) - boff
;
22394 font_height
= FONT_HEIGHT (font
);
22396 cmp
->font
= (void *) font
;
22399 if (! font_not_found_p
)
22401 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22402 &char2b
, it
->multibyte_p
, 0);
22403 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22406 /* Initialize the bounding box. */
22409 width
= pcm
->width
;
22410 ascent
= pcm
->ascent
;
22411 descent
= pcm
->descent
;
22412 lbearing
= pcm
->lbearing
;
22413 rbearing
= pcm
->rbearing
;
22417 width
= FONT_WIDTH (font
);
22418 ascent
= FONT_BASE (font
);
22419 descent
= FONT_DESCENT (font
);
22426 lowest
= - descent
+ boff
;
22427 highest
= ascent
+ boff
;
22429 if (! font_not_found_p
22430 && font
->default_ascent
22431 && CHAR_TABLE_P (Vuse_default_ascent
)
22432 && !NILP (Faref (Vuse_default_ascent
,
22433 make_number (it
->char_to_display
))))
22434 highest
= font
->default_ascent
+ boff
;
22436 /* Draw the first glyph at the normal position. It may be
22437 shifted to right later if some other glyphs are drawn
22439 cmp
->offsets
[i
* 2] = 0;
22440 cmp
->offsets
[i
* 2 + 1] = boff
;
22441 cmp
->lbearing
= lbearing
;
22442 cmp
->rbearing
= rbearing
;
22444 /* Set cmp->offsets for the remaining glyphs. */
22445 for (i
++; i
< glyph_len
; i
++)
22447 int left
, right
, btm
, top
;
22448 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22450 struct face
*this_face
;
22455 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22456 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22457 font
= this_face
->font
;
22463 this_boff
= font
->baseline_offset
;
22464 if (font
->vertical_centering
)
22465 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22466 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22467 &char2b
, it
->multibyte_p
, 0);
22468 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22471 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22474 width
= pcm
->width
;
22475 ascent
= pcm
->ascent
;
22476 descent
= pcm
->descent
;
22477 lbearing
= pcm
->lbearing
;
22478 rbearing
= pcm
->rbearing
;
22479 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22481 /* Relative composition with or without
22482 alternate chars. */
22483 left
= (leftmost
+ rightmost
- width
) / 2;
22484 btm
= - descent
+ boff
;
22485 if (font
->relative_compose
22486 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22487 || NILP (Faref (Vignore_relative_composition
,
22488 make_number (ch
)))))
22491 if (- descent
>= font
->relative_compose
)
22492 /* One extra pixel between two glyphs. */
22494 else if (ascent
<= 0)
22495 /* One extra pixel between two glyphs. */
22496 btm
= lowest
- 1 - ascent
- descent
;
22501 /* A composition rule is specified by an integer
22502 value that encodes global and new reference
22503 points (GREF and NREF). GREF and NREF are
22504 specified by numbers as below:
22506 0---1---2 -- ascent
22510 9--10--11 -- center
22512 ---3---4---5--- baseline
22514 6---7---8 -- descent
22516 int rule
= COMPOSITION_RULE (cmp
, i
);
22517 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22519 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22520 grefx
= gref
% 3, nrefx
= nref
% 3;
22521 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22523 xoff
= font_height
* (xoff
- 128) / 256;
22525 yoff
= font_height
* (yoff
- 128) / 256;
22528 + grefx
* (rightmost
- leftmost
) / 2
22529 - nrefx
* width
/ 2
22532 btm
= ((grefy
== 0 ? highest
22534 : grefy
== 2 ? lowest
22535 : (highest
+ lowest
) / 2)
22536 - (nrefy
== 0 ? ascent
+ descent
22537 : nrefy
== 1 ? descent
- boff
22539 : (ascent
+ descent
) / 2)
22543 cmp
->offsets
[i
* 2] = left
;
22544 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22546 /* Update the bounding box of the overall glyphs. */
22549 right
= left
+ width
;
22550 if (left
< leftmost
)
22552 if (right
> rightmost
)
22555 top
= btm
+ descent
+ ascent
;
22561 if (cmp
->lbearing
> left
+ lbearing
)
22562 cmp
->lbearing
= left
+ lbearing
;
22563 if (cmp
->rbearing
< left
+ rbearing
)
22564 cmp
->rbearing
= left
+ rbearing
;
22568 /* If there are glyphs whose x-offsets are negative,
22569 shift all glyphs to the right and make all x-offsets
22573 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22574 cmp
->offsets
[i
* 2] -= leftmost
;
22575 rightmost
-= leftmost
;
22576 cmp
->lbearing
-= leftmost
;
22577 cmp
->rbearing
-= leftmost
;
22580 if (left_padded
&& cmp
->lbearing
< 0)
22582 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22583 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22584 rightmost
-= cmp
->lbearing
;
22585 cmp
->rbearing
-= cmp
->lbearing
;
22588 if (right_padded
&& rightmost
< cmp
->rbearing
)
22590 rightmost
= cmp
->rbearing
;
22593 cmp
->pixel_width
= rightmost
;
22594 cmp
->ascent
= highest
;
22595 cmp
->descent
= - lowest
;
22596 if (cmp
->ascent
< font_ascent
)
22597 cmp
->ascent
= font_ascent
;
22598 if (cmp
->descent
< font_descent
)
22599 cmp
->descent
= font_descent
;
22603 && (cmp
->lbearing
< 0
22604 || cmp
->rbearing
> cmp
->pixel_width
))
22605 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22607 it
->pixel_width
= cmp
->pixel_width
;
22608 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22609 it
->descent
= it
->phys_descent
= cmp
->descent
;
22610 if (face
->box
!= FACE_NO_BOX
)
22612 int thick
= face
->box_line_width
;
22616 it
->ascent
+= thick
;
22617 it
->descent
+= thick
;
22622 if (it
->start_of_box_run_p
)
22623 it
->pixel_width
+= thick
;
22624 if (it
->end_of_box_run_p
)
22625 it
->pixel_width
+= thick
;
22628 /* If face has an overline, add the height of the overline
22629 (1 pixel) and a 1 pixel margin to the character height. */
22630 if (face
->overline_p
)
22631 it
->ascent
+= overline_margin
;
22633 take_vertical_position_into_account (it
);
22634 if (it
->ascent
< 0)
22636 if (it
->descent
< 0)
22640 append_composite_glyph (it
);
22642 else if (it
->what
== IT_COMPOSITION
)
22644 /* A dynamic (automatic) composition. */
22645 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22646 Lisp_Object gstring
;
22647 struct font_metrics metrics
;
22649 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22651 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22654 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22655 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22656 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22657 it
->descent
= it
->phys_descent
= metrics
.descent
;
22658 if (face
->box
!= FACE_NO_BOX
)
22660 int thick
= face
->box_line_width
;
22664 it
->ascent
+= thick
;
22665 it
->descent
+= thick
;
22670 if (it
->start_of_box_run_p
)
22671 it
->pixel_width
+= thick
;
22672 if (it
->end_of_box_run_p
)
22673 it
->pixel_width
+= thick
;
22675 /* If face has an overline, add the height of the overline
22676 (1 pixel) and a 1 pixel margin to the character height. */
22677 if (face
->overline_p
)
22678 it
->ascent
+= overline_margin
;
22679 take_vertical_position_into_account (it
);
22680 if (it
->ascent
< 0)
22682 if (it
->descent
< 0)
22686 append_composite_glyph (it
);
22688 else if (it
->what
== IT_IMAGE
)
22689 produce_image_glyph (it
);
22690 else if (it
->what
== IT_STRETCH
)
22691 produce_stretch_glyph (it
);
22693 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22694 because this isn't true for images with `:ascent 100'. */
22695 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22696 if (it
->area
== TEXT_AREA
)
22697 it
->current_x
+= it
->pixel_width
;
22699 if (extra_line_spacing
> 0)
22701 it
->descent
+= extra_line_spacing
;
22702 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22703 it
->max_extra_line_spacing
= extra_line_spacing
;
22706 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22707 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22708 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22709 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22713 Output LEN glyphs starting at START at the nominal cursor position.
22714 Advance the nominal cursor over the text. The global variable
22715 updated_window contains the window being updated, updated_row is
22716 the glyph row being updated, and updated_area is the area of that
22717 row being updated. */
22720 x_write_glyphs (start
, len
)
22721 struct glyph
*start
;
22726 xassert (updated_window
&& updated_row
);
22729 /* Write glyphs. */
22731 hpos
= start
- updated_row
->glyphs
[updated_area
];
22732 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22733 updated_row
, updated_area
,
22735 DRAW_NORMAL_TEXT
, 0);
22737 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22738 if (updated_area
== TEXT_AREA
22739 && updated_window
->phys_cursor_on_p
22740 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22741 && updated_window
->phys_cursor
.hpos
>= hpos
22742 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22743 updated_window
->phys_cursor_on_p
= 0;
22747 /* Advance the output cursor. */
22748 output_cursor
.hpos
+= len
;
22749 output_cursor
.x
= x
;
22754 Insert LEN glyphs from START at the nominal cursor position. */
22757 x_insert_glyphs (start
, len
)
22758 struct glyph
*start
;
22763 int line_height
, shift_by_width
, shifted_region_width
;
22764 struct glyph_row
*row
;
22765 struct glyph
*glyph
;
22766 int frame_x
, frame_y
;
22769 xassert (updated_window
&& updated_row
);
22771 w
= updated_window
;
22772 f
= XFRAME (WINDOW_FRAME (w
));
22774 /* Get the height of the line we are in. */
22776 line_height
= row
->height
;
22778 /* Get the width of the glyphs to insert. */
22779 shift_by_width
= 0;
22780 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22781 shift_by_width
+= glyph
->pixel_width
;
22783 /* Get the width of the region to shift right. */
22784 shifted_region_width
= (window_box_width (w
, updated_area
)
22789 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22790 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22792 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22793 line_height
, shift_by_width
);
22795 /* Write the glyphs. */
22796 hpos
= start
- row
->glyphs
[updated_area
];
22797 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22799 DRAW_NORMAL_TEXT
, 0);
22801 /* Advance the output cursor. */
22802 output_cursor
.hpos
+= len
;
22803 output_cursor
.x
+= shift_by_width
;
22809 Erase the current text line from the nominal cursor position
22810 (inclusive) to pixel column TO_X (exclusive). The idea is that
22811 everything from TO_X onward is already erased.
22813 TO_X is a pixel position relative to updated_area of
22814 updated_window. TO_X == -1 means clear to the end of this area. */
22817 x_clear_end_of_line (to_x
)
22821 struct window
*w
= updated_window
;
22822 int max_x
, min_y
, max_y
;
22823 int from_x
, from_y
, to_y
;
22825 xassert (updated_window
&& updated_row
);
22826 f
= XFRAME (w
->frame
);
22828 if (updated_row
->full_width_p
)
22829 max_x
= WINDOW_TOTAL_WIDTH (w
);
22831 max_x
= window_box_width (w
, updated_area
);
22832 max_y
= window_text_bottom_y (w
);
22834 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22835 of window. For TO_X > 0, truncate to end of drawing area. */
22841 to_x
= min (to_x
, max_x
);
22843 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22845 /* Notice if the cursor will be cleared by this operation. */
22846 if (!updated_row
->full_width_p
)
22847 notice_overwritten_cursor (w
, updated_area
,
22848 output_cursor
.x
, -1,
22850 MATRIX_ROW_BOTTOM_Y (updated_row
));
22852 from_x
= output_cursor
.x
;
22854 /* Translate to frame coordinates. */
22855 if (updated_row
->full_width_p
)
22857 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22858 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22862 int area_left
= window_box_left (w
, updated_area
);
22863 from_x
+= area_left
;
22867 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22868 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22869 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22871 /* Prevent inadvertently clearing to end of the X window. */
22872 if (to_x
> from_x
&& to_y
> from_y
)
22875 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22876 to_x
- from_x
, to_y
- from_y
);
22881 #endif /* HAVE_WINDOW_SYSTEM */
22885 /***********************************************************************
22887 ***********************************************************************/
22889 /* Value is the internal representation of the specified cursor type
22890 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22891 of the bar cursor. */
22893 static enum text_cursor_kinds
22894 get_specified_cursor_type (arg
, width
)
22898 enum text_cursor_kinds type
;
22903 if (EQ (arg
, Qbox
))
22904 return FILLED_BOX_CURSOR
;
22906 if (EQ (arg
, Qhollow
))
22907 return HOLLOW_BOX_CURSOR
;
22909 if (EQ (arg
, Qbar
))
22916 && EQ (XCAR (arg
), Qbar
)
22917 && INTEGERP (XCDR (arg
))
22918 && XINT (XCDR (arg
)) >= 0)
22920 *width
= XINT (XCDR (arg
));
22924 if (EQ (arg
, Qhbar
))
22927 return HBAR_CURSOR
;
22931 && EQ (XCAR (arg
), Qhbar
)
22932 && INTEGERP (XCDR (arg
))
22933 && XINT (XCDR (arg
)) >= 0)
22935 *width
= XINT (XCDR (arg
));
22936 return HBAR_CURSOR
;
22939 /* Treat anything unknown as "hollow box cursor".
22940 It was bad to signal an error; people have trouble fixing
22941 .Xdefaults with Emacs, when it has something bad in it. */
22942 type
= HOLLOW_BOX_CURSOR
;
22947 /* Set the default cursor types for specified frame. */
22949 set_frame_cursor_types (f
, arg
)
22956 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22957 FRAME_CURSOR_WIDTH (f
) = width
;
22959 /* By default, set up the blink-off state depending on the on-state. */
22961 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22964 FRAME_BLINK_OFF_CURSOR (f
)
22965 = get_specified_cursor_type (XCDR (tem
), &width
);
22966 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22969 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22973 /* Return the cursor we want to be displayed in window W. Return
22974 width of bar/hbar cursor through WIDTH arg. Return with
22975 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22976 (i.e. if the `system caret' should track this cursor).
22978 In a mini-buffer window, we want the cursor only to appear if we
22979 are reading input from this window. For the selected window, we
22980 want the cursor type given by the frame parameter or buffer local
22981 setting of cursor-type. If explicitly marked off, draw no cursor.
22982 In all other cases, we want a hollow box cursor. */
22984 static enum text_cursor_kinds
22985 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22987 struct glyph
*glyph
;
22989 int *active_cursor
;
22991 struct frame
*f
= XFRAME (w
->frame
);
22992 struct buffer
*b
= XBUFFER (w
->buffer
);
22993 int cursor_type
= DEFAULT_CURSOR
;
22994 Lisp_Object alt_cursor
;
22995 int non_selected
= 0;
22997 *active_cursor
= 1;
23000 if (cursor_in_echo_area
23001 && FRAME_HAS_MINIBUF_P (f
)
23002 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23004 if (w
== XWINDOW (echo_area_window
))
23006 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23008 *width
= FRAME_CURSOR_WIDTH (f
);
23009 return FRAME_DESIRED_CURSOR (f
);
23012 return get_specified_cursor_type (b
->cursor_type
, width
);
23015 *active_cursor
= 0;
23019 /* Detect a nonselected window or nonselected frame. */
23020 else if (w
!= XWINDOW (f
->selected_window
)
23021 #ifdef HAVE_WINDOW_SYSTEM
23022 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23026 *active_cursor
= 0;
23028 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23034 /* Never display a cursor in a window in which cursor-type is nil. */
23035 if (NILP (b
->cursor_type
))
23038 /* Get the normal cursor type for this window. */
23039 if (EQ (b
->cursor_type
, Qt
))
23041 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23042 *width
= FRAME_CURSOR_WIDTH (f
);
23045 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23047 /* Use cursor-in-non-selected-windows instead
23048 for non-selected window or frame. */
23051 alt_cursor
= b
->cursor_in_non_selected_windows
;
23052 if (!EQ (Qt
, alt_cursor
))
23053 return get_specified_cursor_type (alt_cursor
, width
);
23054 /* t means modify the normal cursor type. */
23055 if (cursor_type
== FILLED_BOX_CURSOR
)
23056 cursor_type
= HOLLOW_BOX_CURSOR
;
23057 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23059 return cursor_type
;
23062 /* Use normal cursor if not blinked off. */
23063 if (!w
->cursor_off_p
)
23065 #ifdef HAVE_WINDOW_SYSTEM
23066 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23068 if (cursor_type
== FILLED_BOX_CURSOR
)
23070 /* Using a block cursor on large images can be very annoying.
23071 So use a hollow cursor for "large" images.
23072 If image is not transparent (no mask), also use hollow cursor. */
23073 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23074 if (img
!= NULL
&& IMAGEP (img
->spec
))
23076 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23077 where N = size of default frame font size.
23078 This should cover most of the "tiny" icons people may use. */
23080 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23081 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23082 cursor_type
= HOLLOW_BOX_CURSOR
;
23085 else if (cursor_type
!= NO_CURSOR
)
23087 /* Display current only supports BOX and HOLLOW cursors for images.
23088 So for now, unconditionally use a HOLLOW cursor when cursor is
23089 not a solid box cursor. */
23090 cursor_type
= HOLLOW_BOX_CURSOR
;
23094 return cursor_type
;
23097 /* Cursor is blinked off, so determine how to "toggle" it. */
23099 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23100 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23101 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23103 /* Then see if frame has specified a specific blink off cursor type. */
23104 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23106 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23107 return FRAME_BLINK_OFF_CURSOR (f
);
23111 /* Some people liked having a permanently visible blinking cursor,
23112 while others had very strong opinions against it. So it was
23113 decided to remove it. KFS 2003-09-03 */
23115 /* Finally perform built-in cursor blinking:
23116 filled box <-> hollow box
23117 wide [h]bar <-> narrow [h]bar
23118 narrow [h]bar <-> no cursor
23119 other type <-> no cursor */
23121 if (cursor_type
== FILLED_BOX_CURSOR
)
23122 return HOLLOW_BOX_CURSOR
;
23124 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23127 return cursor_type
;
23135 #ifdef HAVE_WINDOW_SYSTEM
23137 /* Notice when the text cursor of window W has been completely
23138 overwritten by a drawing operation that outputs glyphs in AREA
23139 starting at X0 and ending at X1 in the line starting at Y0 and
23140 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23141 the rest of the line after X0 has been written. Y coordinates
23142 are window-relative. */
23145 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23147 enum glyph_row_area area
;
23148 int x0
, y0
, x1
, y1
;
23150 int cx0
, cx1
, cy0
, cy1
;
23151 struct glyph_row
*row
;
23153 if (!w
->phys_cursor_on_p
)
23155 if (area
!= TEXT_AREA
)
23158 if (w
->phys_cursor
.vpos
< 0
23159 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23160 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23161 !(row
->enabled_p
&& row
->displays_text_p
)))
23164 if (row
->cursor_in_fringe_p
)
23166 row
->cursor_in_fringe_p
= 0;
23167 draw_fringe_bitmap (w
, row
, 0);
23168 w
->phys_cursor_on_p
= 0;
23172 cx0
= w
->phys_cursor
.x
;
23173 cx1
= cx0
+ w
->phys_cursor_width
;
23174 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23177 /* The cursor image will be completely removed from the
23178 screen if the output area intersects the cursor area in
23179 y-direction. When we draw in [y0 y1[, and some part of
23180 the cursor is at y < y0, that part must have been drawn
23181 before. When scrolling, the cursor is erased before
23182 actually scrolling, so we don't come here. When not
23183 scrolling, the rows above the old cursor row must have
23184 changed, and in this case these rows must have written
23185 over the cursor image.
23187 Likewise if part of the cursor is below y1, with the
23188 exception of the cursor being in the first blank row at
23189 the buffer and window end because update_text_area
23190 doesn't draw that row. (Except when it does, but
23191 that's handled in update_text_area.) */
23193 cy0
= w
->phys_cursor
.y
;
23194 cy1
= cy0
+ w
->phys_cursor_height
;
23195 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23198 w
->phys_cursor_on_p
= 0;
23201 #endif /* HAVE_WINDOW_SYSTEM */
23204 /************************************************************************
23206 ************************************************************************/
23208 #ifdef HAVE_WINDOW_SYSTEM
23211 Fix the display of area AREA of overlapping row ROW in window W
23212 with respect to the overlapping part OVERLAPS. */
23215 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23217 struct glyph_row
*row
;
23218 enum glyph_row_area area
;
23226 for (i
= 0; i
< row
->used
[area
];)
23228 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23230 int start
= i
, start_x
= x
;
23234 x
+= row
->glyphs
[area
][i
].pixel_width
;
23237 while (i
< row
->used
[area
]
23238 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23240 draw_glyphs (w
, start_x
, row
, area
,
23242 DRAW_NORMAL_TEXT
, overlaps
);
23246 x
+= row
->glyphs
[area
][i
].pixel_width
;
23256 Draw the cursor glyph of window W in glyph row ROW. See the
23257 comment of draw_glyphs for the meaning of HL. */
23260 draw_phys_cursor_glyph (w
, row
, hl
)
23262 struct glyph_row
*row
;
23263 enum draw_glyphs_face hl
;
23265 /* If cursor hpos is out of bounds, don't draw garbage. This can
23266 happen in mini-buffer windows when switching between echo area
23267 glyphs and mini-buffer. */
23268 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
23270 int on_p
= w
->phys_cursor_on_p
;
23272 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23273 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23275 w
->phys_cursor_on_p
= on_p
;
23277 if (hl
== DRAW_CURSOR
)
23278 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23279 /* When we erase the cursor, and ROW is overlapped by other
23280 rows, make sure that these overlapping parts of other rows
23282 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23284 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23286 if (row
> w
->current_matrix
->rows
23287 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23288 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23289 OVERLAPS_ERASED_CURSOR
);
23291 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23292 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23293 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23294 OVERLAPS_ERASED_CURSOR
);
23301 Erase the image of a cursor of window W from the screen. */
23304 erase_phys_cursor (w
)
23307 struct frame
*f
= XFRAME (w
->frame
);
23308 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23309 int hpos
= w
->phys_cursor
.hpos
;
23310 int vpos
= w
->phys_cursor
.vpos
;
23311 int mouse_face_here_p
= 0;
23312 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23313 struct glyph_row
*cursor_row
;
23314 struct glyph
*cursor_glyph
;
23315 enum draw_glyphs_face hl
;
23317 /* No cursor displayed or row invalidated => nothing to do on the
23319 if (w
->phys_cursor_type
== NO_CURSOR
)
23320 goto mark_cursor_off
;
23322 /* VPOS >= active_glyphs->nrows means that window has been resized.
23323 Don't bother to erase the cursor. */
23324 if (vpos
>= active_glyphs
->nrows
)
23325 goto mark_cursor_off
;
23327 /* If row containing cursor is marked invalid, there is nothing we
23329 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23330 if (!cursor_row
->enabled_p
)
23331 goto mark_cursor_off
;
23333 /* If line spacing is > 0, old cursor may only be partially visible in
23334 window after split-window. So adjust visible height. */
23335 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23336 window_text_bottom_y (w
) - cursor_row
->y
);
23338 /* If row is completely invisible, don't attempt to delete a cursor which
23339 isn't there. This can happen if cursor is at top of a window, and
23340 we switch to a buffer with a header line in that window. */
23341 if (cursor_row
->visible_height
<= 0)
23342 goto mark_cursor_off
;
23344 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23345 if (cursor_row
->cursor_in_fringe_p
)
23347 cursor_row
->cursor_in_fringe_p
= 0;
23348 draw_fringe_bitmap (w
, cursor_row
, 0);
23349 goto mark_cursor_off
;
23352 /* This can happen when the new row is shorter than the old one.
23353 In this case, either draw_glyphs or clear_end_of_line
23354 should have cleared the cursor. Note that we wouldn't be
23355 able to erase the cursor in this case because we don't have a
23356 cursor glyph at hand. */
23357 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
23358 goto mark_cursor_off
;
23360 /* If the cursor is in the mouse face area, redisplay that when
23361 we clear the cursor. */
23362 if (! NILP (dpyinfo
->mouse_face_window
)
23363 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23364 && (vpos
> dpyinfo
->mouse_face_beg_row
23365 || (vpos
== dpyinfo
->mouse_face_beg_row
23366 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23367 && (vpos
< dpyinfo
->mouse_face_end_row
23368 || (vpos
== dpyinfo
->mouse_face_end_row
23369 && hpos
< dpyinfo
->mouse_face_end_col
))
23370 /* Don't redraw the cursor's spot in mouse face if it is at the
23371 end of a line (on a newline). The cursor appears there, but
23372 mouse highlighting does not. */
23373 && cursor_row
->used
[TEXT_AREA
] > hpos
)
23374 mouse_face_here_p
= 1;
23376 /* Maybe clear the display under the cursor. */
23377 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23380 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23383 cursor_glyph
= get_phys_cursor_glyph (w
);
23384 if (cursor_glyph
== NULL
)
23385 goto mark_cursor_off
;
23387 width
= cursor_glyph
->pixel_width
;
23388 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23389 x
= w
->phys_cursor
.x
;
23391 width
-= left_x
- x
;
23392 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23393 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23394 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23397 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23400 /* Erase the cursor by redrawing the character underneath it. */
23401 if (mouse_face_here_p
)
23402 hl
= DRAW_MOUSE_FACE
;
23404 hl
= DRAW_NORMAL_TEXT
;
23405 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23408 w
->phys_cursor_on_p
= 0;
23409 w
->phys_cursor_type
= NO_CURSOR
;
23414 Display or clear cursor of window W. If ON is zero, clear the
23415 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23416 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23419 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23421 int on
, hpos
, vpos
, x
, y
;
23423 struct frame
*f
= XFRAME (w
->frame
);
23424 int new_cursor_type
;
23425 int new_cursor_width
;
23427 struct glyph_row
*glyph_row
;
23428 struct glyph
*glyph
;
23430 /* This is pointless on invisible frames, and dangerous on garbaged
23431 windows and frames; in the latter case, the frame or window may
23432 be in the midst of changing its size, and x and y may be off the
23434 if (! FRAME_VISIBLE_P (f
)
23435 || FRAME_GARBAGED_P (f
)
23436 || vpos
>= w
->current_matrix
->nrows
23437 || hpos
>= w
->current_matrix
->matrix_w
)
23440 /* If cursor is off and we want it off, return quickly. */
23441 if (!on
&& !w
->phys_cursor_on_p
)
23444 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23445 /* If cursor row is not enabled, we don't really know where to
23446 display the cursor. */
23447 if (!glyph_row
->enabled_p
)
23449 w
->phys_cursor_on_p
= 0;
23454 if (!glyph_row
->exact_window_width_line_p
23455 || hpos
< glyph_row
->used
[TEXT_AREA
])
23456 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23458 xassert (interrupt_input_blocked
);
23460 /* Set new_cursor_type to the cursor we want to be displayed. */
23461 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23462 &new_cursor_width
, &active_cursor
);
23464 /* If cursor is currently being shown and we don't want it to be or
23465 it is in the wrong place, or the cursor type is not what we want,
23467 if (w
->phys_cursor_on_p
23469 || w
->phys_cursor
.x
!= x
23470 || w
->phys_cursor
.y
!= y
23471 || new_cursor_type
!= w
->phys_cursor_type
23472 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23473 && new_cursor_width
!= w
->phys_cursor_width
)))
23474 erase_phys_cursor (w
);
23476 /* Don't check phys_cursor_on_p here because that flag is only set
23477 to zero in some cases where we know that the cursor has been
23478 completely erased, to avoid the extra work of erasing the cursor
23479 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23480 still not be visible, or it has only been partly erased. */
23483 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23484 w
->phys_cursor_height
= glyph_row
->height
;
23486 /* Set phys_cursor_.* before x_draw_.* is called because some
23487 of them may need the information. */
23488 w
->phys_cursor
.x
= x
;
23489 w
->phys_cursor
.y
= glyph_row
->y
;
23490 w
->phys_cursor
.hpos
= hpos
;
23491 w
->phys_cursor
.vpos
= vpos
;
23494 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23495 new_cursor_type
, new_cursor_width
,
23496 on
, active_cursor
);
23500 /* Switch the display of W's cursor on or off, according to the value
23507 update_window_cursor (w
, on
)
23511 /* Don't update cursor in windows whose frame is in the process
23512 of being deleted. */
23513 if (w
->current_matrix
)
23516 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23517 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23523 /* Call update_window_cursor with parameter ON_P on all leaf windows
23524 in the window tree rooted at W. */
23527 update_cursor_in_window_tree (w
, on_p
)
23533 if (!NILP (w
->hchild
))
23534 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23535 else if (!NILP (w
->vchild
))
23536 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23538 update_window_cursor (w
, on_p
);
23540 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23546 Display the cursor on window W, or clear it, according to ON_P.
23547 Don't change the cursor's position. */
23550 x_update_cursor (f
, on_p
)
23554 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23559 Clear the cursor of window W to background color, and mark the
23560 cursor as not shown. This is used when the text where the cursor
23561 is about to be rewritten. */
23567 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23568 update_window_cursor (w
, 0);
23573 Display the active region described by mouse_face_* according to DRAW. */
23576 show_mouse_face (dpyinfo
, draw
)
23577 Display_Info
*dpyinfo
;
23578 enum draw_glyphs_face draw
;
23580 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23581 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23583 if (/* If window is in the process of being destroyed, don't bother
23585 w
->current_matrix
!= NULL
23586 /* Don't update mouse highlight if hidden */
23587 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23588 /* Recognize when we are called to operate on rows that don't exist
23589 anymore. This can happen when a window is split. */
23590 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23592 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23593 struct glyph_row
*row
, *first
, *last
;
23595 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23596 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23598 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23600 int start_hpos
, end_hpos
, start_x
;
23602 /* For all but the first row, the highlight starts at column 0. */
23605 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23606 start_x
= dpyinfo
->mouse_face_beg_x
;
23615 end_hpos
= dpyinfo
->mouse_face_end_col
;
23618 end_hpos
= row
->used
[TEXT_AREA
];
23619 if (draw
== DRAW_NORMAL_TEXT
)
23620 row
->fill_line_p
= 1; /* Clear to end of line */
23623 if (end_hpos
> start_hpos
)
23625 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23626 start_hpos
, end_hpos
,
23630 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23634 /* When we've written over the cursor, arrange for it to
23635 be displayed again. */
23636 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23639 display_and_set_cursor (w
, 1,
23640 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23641 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23646 /* Change the mouse cursor. */
23647 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23648 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23649 else if (draw
== DRAW_MOUSE_FACE
)
23650 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23652 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23656 Clear out the mouse-highlighted active region.
23657 Redraw it un-highlighted first. Value is non-zero if mouse
23658 face was actually drawn unhighlighted. */
23661 clear_mouse_face (dpyinfo
)
23662 Display_Info
*dpyinfo
;
23666 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23668 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23672 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23673 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23674 dpyinfo
->mouse_face_window
= Qnil
;
23675 dpyinfo
->mouse_face_overlay
= Qnil
;
23681 Non-zero if physical cursor of window W is within mouse face. */
23684 cursor_in_mouse_face_p (w
)
23687 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23688 int in_mouse_face
= 0;
23690 if (WINDOWP (dpyinfo
->mouse_face_window
)
23691 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23693 int hpos
= w
->phys_cursor
.hpos
;
23694 int vpos
= w
->phys_cursor
.vpos
;
23696 if (vpos
>= dpyinfo
->mouse_face_beg_row
23697 && vpos
<= dpyinfo
->mouse_face_end_row
23698 && (vpos
> dpyinfo
->mouse_face_beg_row
23699 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23700 && (vpos
< dpyinfo
->mouse_face_end_row
23701 || hpos
< dpyinfo
->mouse_face_end_col
23702 || dpyinfo
->mouse_face_past_end
))
23706 return in_mouse_face
;
23712 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23713 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23714 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23715 for the overlay or run of text properties specifying the mouse
23716 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23717 before-string and after-string that must also be highlighted.
23718 DISPLAY_STRING, if non-nil, is a display string that may cover some
23719 or all of the highlighted text. */
23722 mouse_face_from_buffer_pos (Lisp_Object window
,
23723 Display_Info
*dpyinfo
,
23724 EMACS_INT mouse_charpos
,
23725 EMACS_INT start_charpos
,
23726 EMACS_INT end_charpos
,
23727 Lisp_Object before_string
,
23728 Lisp_Object after_string
,
23729 Lisp_Object display_string
)
23731 struct window
*w
= XWINDOW (window
);
23732 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23733 struct glyph_row
*row
;
23734 struct glyph
*glyph
, *end
;
23738 xassert (NILP (display_string
) || STRINGP (display_string
));
23739 xassert (NILP (before_string
) || STRINGP (before_string
));
23740 xassert (NILP (after_string
) || STRINGP (after_string
));
23742 /* Find the first highlighted glyph. */
23743 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23745 dpyinfo
->mouse_face_beg_col
= 0;
23746 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23747 dpyinfo
->mouse_face_beg_x
= first
->x
;
23748 dpyinfo
->mouse_face_beg_y
= first
->y
;
23752 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23754 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23756 /* If the before-string or display-string contains newlines,
23757 row_containing_pos skips to its last row. Move back. */
23758 if (!NILP (before_string
) || !NILP (display_string
))
23760 struct glyph_row
*prev
;
23761 while ((prev
= row
- 1, prev
>= first
)
23762 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23763 && prev
->used
[TEXT_AREA
] > 0)
23765 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23766 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23767 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23769 || !(EQ (glyph
->object
, before_string
)
23770 || EQ (glyph
->object
, display_string
)))
23776 glyph
= row
->glyphs
[TEXT_AREA
];
23777 end
= glyph
+ row
->used
[TEXT_AREA
];
23779 dpyinfo
->mouse_face_beg_y
= row
->y
;
23780 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23782 /* Skip truncation glyphs at the start of the glyph row. */
23783 if (row
->displays_text_p
)
23785 && INTEGERP (glyph
->object
)
23786 && glyph
->charpos
< 0;
23788 x
+= glyph
->pixel_width
;
23790 /* Scan the glyph row, stopping before BEFORE_STRING or
23791 DISPLAY_STRING or START_CHARPOS. */
23793 && !INTEGERP (glyph
->object
)
23794 && !EQ (glyph
->object
, before_string
)
23795 && !EQ (glyph
->object
, display_string
)
23796 && !(BUFFERP (glyph
->object
)
23797 && glyph
->charpos
>= start_charpos
);
23799 x
+= glyph
->pixel_width
;
23801 dpyinfo
->mouse_face_beg_x
= x
;
23802 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23805 /* Find the last highlighted glyph. */
23806 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23809 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23810 dpyinfo
->mouse_face_past_end
= 1;
23812 else if (!NILP (after_string
))
23814 /* If the after-string has newlines, advance to its last row. */
23815 struct glyph_row
*next
;
23816 struct glyph_row
*last
23817 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23819 for (next
= row
+ 1;
23821 && next
->used
[TEXT_AREA
] > 0
23822 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23827 glyph
= row
->glyphs
[TEXT_AREA
];
23828 end
= glyph
+ row
->used
[TEXT_AREA
];
23830 dpyinfo
->mouse_face_end_y
= row
->y
;
23831 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23833 /* Skip truncation glyphs at the start of the row. */
23834 if (row
->displays_text_p
)
23836 && INTEGERP (glyph
->object
)
23837 && glyph
->charpos
< 0;
23839 x
+= glyph
->pixel_width
;
23841 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23844 && !INTEGERP (glyph
->object
)
23845 && !EQ (glyph
->object
, after_string
)
23846 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23848 x
+= glyph
->pixel_width
;
23850 /* If we found AFTER_STRING, consume it and stop. */
23851 if (EQ (glyph
->object
, after_string
))
23853 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23854 x
+= glyph
->pixel_width
;
23858 /* If there's no after-string, we must check if we overshot,
23859 which might be the case if we stopped after a string glyph.
23860 That glyph may belong to a before-string or display-string
23861 associated with the end position, which must not be
23863 Lisp_Object prev_object
;
23866 while (glyph
> row
->glyphs
[TEXT_AREA
])
23868 prev_object
= (glyph
- 1)->object
;
23869 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23872 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23873 if (pos
&& pos
< end_charpos
)
23876 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23877 && EQ ((glyph
- 1)->object
, prev_object
);
23879 x
-= (glyph
- 1)->pixel_width
;
23883 dpyinfo
->mouse_face_end_x
= x
;
23884 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23885 dpyinfo
->mouse_face_window
= window
;
23886 dpyinfo
->mouse_face_face_id
23887 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23889 !dpyinfo
->mouse_face_hidden
, -1);
23890 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23894 /* Find the position of the glyph for position POS in OBJECT in
23895 window W's current matrix, and return in *X, *Y the pixel
23896 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23898 RIGHT_P non-zero means return the position of the right edge of the
23899 glyph, RIGHT_P zero means return the left edge position.
23901 If no glyph for POS exists in the matrix, return the position of
23902 the glyph with the next smaller position that is in the matrix, if
23903 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23904 exists in the matrix, return the position of the glyph with the
23905 next larger position in OBJECT.
23907 Value is non-zero if a glyph was found. */
23910 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23913 Lisp_Object object
;
23914 int *hpos
, *vpos
, *x
, *y
;
23917 int yb
= window_text_bottom_y (w
);
23918 struct glyph_row
*r
;
23919 struct glyph
*best_glyph
= NULL
;
23920 struct glyph_row
*best_row
= NULL
;
23923 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23924 r
->enabled_p
&& r
->y
< yb
;
23927 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23928 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23931 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23932 if (EQ (g
->object
, object
))
23934 if (g
->charpos
== pos
)
23941 else if (best_glyph
== NULL
23942 || ((eabs (g
->charpos
- pos
)
23943 < eabs (best_glyph
->charpos
- pos
))
23946 : g
->charpos
> pos
)))
23960 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23964 *x
+= best_glyph
->pixel_width
;
23969 *vpos
= best_row
- w
->current_matrix
->rows
;
23972 return best_glyph
!= NULL
;
23976 /* See if position X, Y is within a hot-spot of an image. */
23979 on_hot_spot_p (hot_spot
, x
, y
)
23980 Lisp_Object hot_spot
;
23983 if (!CONSP (hot_spot
))
23986 if (EQ (XCAR (hot_spot
), Qrect
))
23988 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23989 Lisp_Object rect
= XCDR (hot_spot
);
23993 if (!CONSP (XCAR (rect
)))
23995 if (!CONSP (XCDR (rect
)))
23997 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23999 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24001 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24003 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24007 else if (EQ (XCAR (hot_spot
), Qcircle
))
24009 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24010 Lisp_Object circ
= XCDR (hot_spot
);
24011 Lisp_Object lr
, lx0
, ly0
;
24013 && CONSP (XCAR (circ
))
24014 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24015 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24016 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24018 double r
= XFLOATINT (lr
);
24019 double dx
= XINT (lx0
) - x
;
24020 double dy
= XINT (ly0
) - y
;
24021 return (dx
* dx
+ dy
* dy
<= r
* r
);
24024 else if (EQ (XCAR (hot_spot
), Qpoly
))
24026 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24027 if (VECTORP (XCDR (hot_spot
)))
24029 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24030 Lisp_Object
*poly
= v
->contents
;
24034 Lisp_Object lx
, ly
;
24037 /* Need an even number of coordinates, and at least 3 edges. */
24038 if (n
< 6 || n
& 1)
24041 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24042 If count is odd, we are inside polygon. Pixels on edges
24043 may or may not be included depending on actual geometry of the
24045 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24046 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24048 x0
= XINT (lx
), y0
= XINT (ly
);
24049 for (i
= 0; i
< n
; i
+= 2)
24051 int x1
= x0
, y1
= y0
;
24052 if ((lx
= poly
[i
], !INTEGERP (lx
))
24053 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24055 x0
= XINT (lx
), y0
= XINT (ly
);
24057 /* Does this segment cross the X line? */
24065 if (y
> y0
&& y
> y1
)
24067 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24077 find_hot_spot (map
, x
, y
)
24081 while (CONSP (map
))
24083 if (CONSP (XCAR (map
))
24084 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24092 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24094 doc
: /* Lookup in image map MAP coordinates X and Y.
24095 An image map is an alist where each element has the format (AREA ID PLIST).
24096 An AREA is specified as either a rectangle, a circle, or a polygon:
24097 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24098 pixel coordinates of the upper left and bottom right corners.
24099 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24100 and the radius of the circle; r may be a float or integer.
24101 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24102 vector describes one corner in the polygon.
24103 Returns the alist element for the first matching AREA in MAP. */)
24114 return find_hot_spot (map
, XINT (x
), XINT (y
));
24118 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24120 define_frame_cursor1 (f
, cursor
, pointer
)
24123 Lisp_Object pointer
;
24125 /* Do not change cursor shape while dragging mouse. */
24126 if (!NILP (do_mouse_tracking
))
24129 if (!NILP (pointer
))
24131 if (EQ (pointer
, Qarrow
))
24132 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24133 else if (EQ (pointer
, Qhand
))
24134 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24135 else if (EQ (pointer
, Qtext
))
24136 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24137 else if (EQ (pointer
, intern ("hdrag")))
24138 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24139 #ifdef HAVE_X_WINDOWS
24140 else if (EQ (pointer
, intern ("vdrag")))
24141 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24143 else if (EQ (pointer
, intern ("hourglass")))
24144 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24145 else if (EQ (pointer
, Qmodeline
))
24146 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24148 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24151 if (cursor
!= No_Cursor
)
24152 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24155 /* Take proper action when mouse has moved to the mode or header line
24156 or marginal area AREA of window W, x-position X and y-position Y.
24157 X is relative to the start of the text display area of W, so the
24158 width of bitmap areas and scroll bars must be subtracted to get a
24159 position relative to the start of the mode line. */
24162 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24163 Lisp_Object window
;
24165 enum window_part area
;
24167 struct window
*w
= XWINDOW (window
);
24168 struct frame
*f
= XFRAME (w
->frame
);
24169 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24170 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24171 Lisp_Object pointer
= Qnil
;
24172 int charpos
, dx
, dy
, width
, height
;
24173 Lisp_Object string
, object
= Qnil
;
24174 Lisp_Object pos
, help
;
24176 Lisp_Object mouse_face
;
24177 int original_x_pixel
= x
;
24178 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24179 struct glyph_row
*row
;
24181 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24186 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24187 &object
, &dx
, &dy
, &width
, &height
);
24189 row
= (area
== ON_MODE_LINE
24190 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24191 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24194 if (row
->mode_line_p
&& row
->enabled_p
)
24196 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24197 end
= glyph
+ row
->used
[TEXT_AREA
];
24199 for (x0
= original_x_pixel
;
24200 glyph
< end
&& x0
>= glyph
->pixel_width
;
24202 x0
-= glyph
->pixel_width
;
24210 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24211 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24212 &object
, &dx
, &dy
, &width
, &height
);
24217 if (IMAGEP (object
))
24219 Lisp_Object image_map
, hotspot
;
24220 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24222 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24224 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24226 Lisp_Object area_id
, plist
;
24228 area_id
= XCAR (hotspot
);
24229 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24230 If so, we could look for mouse-enter, mouse-leave
24231 properties in PLIST (and do something...). */
24232 hotspot
= XCDR (hotspot
);
24233 if (CONSP (hotspot
)
24234 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24236 pointer
= Fplist_get (plist
, Qpointer
);
24237 if (NILP (pointer
))
24239 help
= Fplist_get (plist
, Qhelp_echo
);
24242 help_echo_string
= help
;
24243 /* Is this correct? ++kfs */
24244 XSETWINDOW (help_echo_window
, w
);
24245 help_echo_object
= w
->buffer
;
24246 help_echo_pos
= charpos
;
24250 if (NILP (pointer
))
24251 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24254 if (STRINGP (string
))
24256 pos
= make_number (charpos
);
24257 /* If we're on a string with `help-echo' text property, arrange
24258 for the help to be displayed. This is done by setting the
24259 global variable help_echo_string to the help string. */
24262 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24265 help_echo_string
= help
;
24266 XSETWINDOW (help_echo_window
, w
);
24267 help_echo_object
= string
;
24268 help_echo_pos
= charpos
;
24272 if (NILP (pointer
))
24273 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24275 /* Change the mouse pointer according to what is under X/Y. */
24276 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24279 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24280 if (!KEYMAPP (map
))
24281 map
= Fget_text_property (pos
, Qkeymap
, string
);
24282 if (!KEYMAPP (map
))
24283 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24286 /* Change the mouse face according to what is under X/Y. */
24287 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24288 if (!NILP (mouse_face
)
24289 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24294 struct glyph
* tmp_glyph
;
24298 int total_pixel_width
;
24303 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24304 Qmouse_face
, string
, Qnil
);
24306 b
= make_number (0);
24308 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24310 e
= make_number (SCHARS (string
));
24312 /* Calculate the position(glyph position: GPOS) of GLYPH in
24313 displayed string. GPOS is different from CHARPOS.
24315 CHARPOS is the position of glyph in internal string
24316 object. A mode line string format has structures which
24317 is converted to a flatten by emacs lisp interpreter.
24318 The internal string is an element of the structures.
24319 The displayed string is the flatten string. */
24321 if (glyph
> row_start_glyph
)
24323 tmp_glyph
= glyph
- 1;
24324 while (tmp_glyph
>= row_start_glyph
24325 && tmp_glyph
->charpos
>= XINT (b
)
24326 && EQ (tmp_glyph
->object
, glyph
->object
))
24333 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24334 displayed string holding GLYPH.
24336 GSEQ_LENGTH is different from SCHARS (STRING).
24337 SCHARS (STRING) returns the length of the internal string. */
24338 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24339 tmp_glyph
->charpos
< XINT (e
);
24340 tmp_glyph
++, gseq_length
++)
24342 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24346 total_pixel_width
= 0;
24347 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24348 total_pixel_width
+= tmp_glyph
->pixel_width
;
24350 /* Pre calculation of re-rendering position */
24352 hpos
= (area
== ON_MODE_LINE
24353 ? (w
->current_matrix
)->nrows
- 1
24356 /* If the re-rendering position is included in the last
24357 re-rendering area, we should do nothing. */
24358 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24359 && dpyinfo
->mouse_face_beg_col
<= vpos
24360 && vpos
< dpyinfo
->mouse_face_end_col
24361 && dpyinfo
->mouse_face_beg_row
== hpos
)
24364 if (clear_mouse_face (dpyinfo
))
24365 cursor
= No_Cursor
;
24367 dpyinfo
->mouse_face_beg_col
= vpos
;
24368 dpyinfo
->mouse_face_beg_row
= hpos
;
24370 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24371 dpyinfo
->mouse_face_beg_y
= 0;
24373 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24374 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24376 dpyinfo
->mouse_face_end_x
= 0;
24377 dpyinfo
->mouse_face_end_y
= 0;
24379 dpyinfo
->mouse_face_past_end
= 0;
24380 dpyinfo
->mouse_face_window
= window
;
24382 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24385 glyph
->face_id
, 1);
24386 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24388 if (NILP (pointer
))
24391 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24392 clear_mouse_face (dpyinfo
);
24394 define_frame_cursor1 (f
, cursor
, pointer
);
24399 Take proper action when the mouse has moved to position X, Y on
24400 frame F as regards highlighting characters that have mouse-face
24401 properties. Also de-highlighting chars where the mouse was before.
24402 X and Y can be negative or out of range. */
24405 note_mouse_highlight (f
, x
, y
)
24409 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24410 enum window_part part
;
24411 Lisp_Object window
;
24413 Cursor cursor
= No_Cursor
;
24414 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24417 /* When a menu is active, don't highlight because this looks odd. */
24418 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24419 if (popup_activated ())
24423 if (NILP (Vmouse_highlight
)
24424 || !f
->glyphs_initialized_p
)
24427 dpyinfo
->mouse_face_mouse_x
= x
;
24428 dpyinfo
->mouse_face_mouse_y
= y
;
24429 dpyinfo
->mouse_face_mouse_frame
= f
;
24431 if (dpyinfo
->mouse_face_defer
)
24434 if (gc_in_progress
)
24436 dpyinfo
->mouse_face_deferred_gc
= 1;
24440 /* Which window is that in? */
24441 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24443 /* If we were displaying active text in another window, clear that.
24444 Also clear if we move out of text area in same window. */
24445 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24446 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24447 && !NILP (dpyinfo
->mouse_face_window
)))
24448 clear_mouse_face (dpyinfo
);
24450 /* Not on a window -> return. */
24451 if (!WINDOWP (window
))
24454 /* Reset help_echo_string. It will get recomputed below. */
24455 help_echo_string
= Qnil
;
24457 /* Convert to window-relative pixel coordinates. */
24458 w
= XWINDOW (window
);
24459 frame_to_window_pixel_xy (w
, &x
, &y
);
24461 /* Handle tool-bar window differently since it doesn't display a
24463 if (EQ (window
, f
->tool_bar_window
))
24465 note_tool_bar_highlight (f
, x
, y
);
24469 /* Mouse is on the mode, header line or margin? */
24470 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24471 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24473 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24477 if (part
== ON_VERTICAL_BORDER
)
24479 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24480 help_echo_string
= build_string ("drag-mouse-1: resize");
24482 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24483 || part
== ON_SCROLL_BAR
)
24484 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24486 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24488 /* Are we in a window whose display is up to date?
24489 And verify the buffer's text has not changed. */
24490 b
= XBUFFER (w
->buffer
);
24491 if (part
== ON_TEXT
24492 && EQ (w
->window_end_valid
, w
->buffer
)
24493 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24494 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24496 int hpos
, vpos
, i
, dx
, dy
, area
;
24498 struct glyph
*glyph
;
24499 Lisp_Object object
;
24500 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24501 Lisp_Object
*overlay_vec
= NULL
;
24503 struct buffer
*obuf
;
24504 int obegv
, ozv
, same_region
;
24506 /* Find the glyph under X/Y. */
24507 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24509 /* Look for :pointer property on image. */
24510 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24512 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24513 if (img
!= NULL
&& IMAGEP (img
->spec
))
24515 Lisp_Object image_map
, hotspot
;
24516 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24518 && (hotspot
= find_hot_spot (image_map
,
24519 glyph
->slice
.x
+ dx
,
24520 glyph
->slice
.y
+ dy
),
24522 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24524 Lisp_Object area_id
, plist
;
24526 area_id
= XCAR (hotspot
);
24527 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24528 If so, we could look for mouse-enter, mouse-leave
24529 properties in PLIST (and do something...). */
24530 hotspot
= XCDR (hotspot
);
24531 if (CONSP (hotspot
)
24532 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24534 pointer
= Fplist_get (plist
, Qpointer
);
24535 if (NILP (pointer
))
24537 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24538 if (!NILP (help_echo_string
))
24540 help_echo_window
= window
;
24541 help_echo_object
= glyph
->object
;
24542 help_echo_pos
= glyph
->charpos
;
24546 if (NILP (pointer
))
24547 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24551 /* Clear mouse face if X/Y not over text. */
24553 || area
!= TEXT_AREA
24554 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24556 if (clear_mouse_face (dpyinfo
))
24557 cursor
= No_Cursor
;
24558 if (NILP (pointer
))
24560 if (area
!= TEXT_AREA
)
24561 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24563 pointer
= Vvoid_text_area_pointer
;
24568 pos
= glyph
->charpos
;
24569 object
= glyph
->object
;
24570 if (!STRINGP (object
) && !BUFFERP (object
))
24573 /* If we get an out-of-range value, return now; avoid an error. */
24574 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24577 /* Make the window's buffer temporarily current for
24578 overlays_at and compute_char_face. */
24579 obuf
= current_buffer
;
24580 current_buffer
= b
;
24586 /* Is this char mouse-active or does it have help-echo? */
24587 position
= make_number (pos
);
24589 if (BUFFERP (object
))
24591 /* Put all the overlays we want in a vector in overlay_vec. */
24592 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24593 /* Sort overlays into increasing priority order. */
24594 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24599 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24600 && vpos
>= dpyinfo
->mouse_face_beg_row
24601 && vpos
<= dpyinfo
->mouse_face_end_row
24602 && (vpos
> dpyinfo
->mouse_face_beg_row
24603 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24604 && (vpos
< dpyinfo
->mouse_face_end_row
24605 || hpos
< dpyinfo
->mouse_face_end_col
24606 || dpyinfo
->mouse_face_past_end
));
24609 cursor
= No_Cursor
;
24611 /* Check mouse-face highlighting. */
24613 /* If there exists an overlay with mouse-face overlapping
24614 the one we are currently highlighting, we have to
24615 check if we enter the overlapping overlay, and then
24616 highlight only that. */
24617 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24618 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24620 /* Find the highest priority overlay with a mouse-face. */
24622 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24624 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24625 if (!NILP (mouse_face
))
24626 overlay
= overlay_vec
[i
];
24629 /* If we're highlighting the same overlay as before, there's
24630 no need to do that again. */
24631 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24632 goto check_help_echo
;
24633 dpyinfo
->mouse_face_overlay
= overlay
;
24635 /* Clear the display of the old active region, if any. */
24636 if (clear_mouse_face (dpyinfo
))
24637 cursor
= No_Cursor
;
24639 /* If no overlay applies, get a text property. */
24640 if (NILP (overlay
))
24641 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24643 /* Next, compute the bounds of the mouse highlighting and
24645 if (!NILP (mouse_face
) && STRINGP (object
))
24647 /* The mouse-highlighting comes from a display string
24648 with a mouse-face. */
24652 b
= Fprevious_single_property_change
24653 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24654 e
= Fnext_single_property_change
24655 (position
, Qmouse_face
, object
, Qnil
);
24657 b
= make_number (0);
24659 e
= make_number (SCHARS (object
) - 1);
24661 fast_find_string_pos (w
, XINT (b
), object
,
24662 &dpyinfo
->mouse_face_beg_col
,
24663 &dpyinfo
->mouse_face_beg_row
,
24664 &dpyinfo
->mouse_face_beg_x
,
24665 &dpyinfo
->mouse_face_beg_y
, 0);
24666 fast_find_string_pos (w
, XINT (e
), object
,
24667 &dpyinfo
->mouse_face_end_col
,
24668 &dpyinfo
->mouse_face_end_row
,
24669 &dpyinfo
->mouse_face_end_x
,
24670 &dpyinfo
->mouse_face_end_y
, 1);
24671 dpyinfo
->mouse_face_past_end
= 0;
24672 dpyinfo
->mouse_face_window
= window
;
24673 dpyinfo
->mouse_face_face_id
24674 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24675 glyph
->face_id
, 1);
24676 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24677 cursor
= No_Cursor
;
24681 /* The mouse-highlighting, if any, comes from an overlay
24682 or text property in the buffer. */
24683 Lisp_Object buffer
, display_string
;
24685 if (STRINGP (object
))
24687 /* If we are on a display string with no mouse-face,
24688 check if the text under it has one. */
24689 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24690 int start
= MATRIX_ROW_START_CHARPOS (r
);
24691 pos
= string_buffer_position (w
, object
, start
);
24694 mouse_face
= get_char_property_and_overlay
24695 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24696 buffer
= w
->buffer
;
24697 display_string
= object
;
24703 display_string
= Qnil
;
24706 if (!NILP (mouse_face
))
24708 Lisp_Object before
, after
;
24709 Lisp_Object before_string
, after_string
;
24711 if (NILP (overlay
))
24713 /* Handle the text property case. */
24714 before
= Fprevious_single_property_change
24715 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24716 Fmarker_position (w
->start
));
24717 after
= Fnext_single_property_change
24718 (make_number (pos
), Qmouse_face
, buffer
,
24719 make_number (BUF_Z (XBUFFER (buffer
))
24720 - XFASTINT (w
->window_end_pos
)));
24721 before_string
= after_string
= Qnil
;
24725 /* Handle the overlay case. */
24726 before
= Foverlay_start (overlay
);
24727 after
= Foverlay_end (overlay
);
24728 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24729 after_string
= Foverlay_get (overlay
, Qafter_string
);
24731 if (!STRINGP (before_string
)) before_string
= Qnil
;
24732 if (!STRINGP (after_string
)) after_string
= Qnil
;
24735 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24738 before_string
, after_string
,
24740 cursor
= No_Cursor
;
24747 /* Look for a `help-echo' property. */
24748 if (NILP (help_echo_string
)) {
24749 Lisp_Object help
, overlay
;
24751 /* Check overlays first. */
24752 help
= overlay
= Qnil
;
24753 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24755 overlay
= overlay_vec
[i
];
24756 help
= Foverlay_get (overlay
, Qhelp_echo
);
24761 help_echo_string
= help
;
24762 help_echo_window
= window
;
24763 help_echo_object
= overlay
;
24764 help_echo_pos
= pos
;
24768 Lisp_Object object
= glyph
->object
;
24769 int charpos
= glyph
->charpos
;
24771 /* Try text properties. */
24772 if (STRINGP (object
)
24774 && charpos
< SCHARS (object
))
24776 help
= Fget_text_property (make_number (charpos
),
24777 Qhelp_echo
, object
);
24780 /* If the string itself doesn't specify a help-echo,
24781 see if the buffer text ``under'' it does. */
24782 struct glyph_row
*r
24783 = MATRIX_ROW (w
->current_matrix
, vpos
);
24784 int start
= MATRIX_ROW_START_CHARPOS (r
);
24785 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24788 help
= Fget_char_property (make_number (pos
),
24789 Qhelp_echo
, w
->buffer
);
24793 object
= w
->buffer
;
24798 else if (BUFFERP (object
)
24801 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24806 help_echo_string
= help
;
24807 help_echo_window
= window
;
24808 help_echo_object
= object
;
24809 help_echo_pos
= charpos
;
24814 /* Look for a `pointer' property. */
24815 if (NILP (pointer
))
24817 /* Check overlays first. */
24818 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24819 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24821 if (NILP (pointer
))
24823 Lisp_Object object
= glyph
->object
;
24824 int charpos
= glyph
->charpos
;
24826 /* Try text properties. */
24827 if (STRINGP (object
)
24829 && charpos
< SCHARS (object
))
24831 pointer
= Fget_text_property (make_number (charpos
),
24833 if (NILP (pointer
))
24835 /* If the string itself doesn't specify a pointer,
24836 see if the buffer text ``under'' it does. */
24837 struct glyph_row
*r
24838 = MATRIX_ROW (w
->current_matrix
, vpos
);
24839 int start
= MATRIX_ROW_START_CHARPOS (r
);
24840 EMACS_INT pos
= string_buffer_position (w
, object
,
24843 pointer
= Fget_char_property (make_number (pos
),
24844 Qpointer
, w
->buffer
);
24847 else if (BUFFERP (object
)
24850 pointer
= Fget_text_property (make_number (charpos
),
24857 current_buffer
= obuf
;
24862 define_frame_cursor1 (f
, cursor
, pointer
);
24867 Clear any mouse-face on window W. This function is part of the
24868 redisplay interface, and is called from try_window_id and similar
24869 functions to ensure the mouse-highlight is off. */
24872 x_clear_window_mouse_face (w
)
24875 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24876 Lisp_Object window
;
24879 XSETWINDOW (window
, w
);
24880 if (EQ (window
, dpyinfo
->mouse_face_window
))
24881 clear_mouse_face (dpyinfo
);
24887 Just discard the mouse face information for frame F, if any.
24888 This is used when the size of F is changed. */
24891 cancel_mouse_face (f
)
24894 Lisp_Object window
;
24895 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24897 window
= dpyinfo
->mouse_face_window
;
24898 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24900 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24901 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24902 dpyinfo
->mouse_face_window
= Qnil
;
24907 #endif /* HAVE_WINDOW_SYSTEM */
24910 /***********************************************************************
24912 ***********************************************************************/
24914 #ifdef HAVE_WINDOW_SYSTEM
24916 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24917 which intersects rectangle R. R is in window-relative coordinates. */
24920 expose_area (w
, row
, r
, area
)
24922 struct glyph_row
*row
;
24924 enum glyph_row_area area
;
24926 struct glyph
*first
= row
->glyphs
[area
];
24927 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24928 struct glyph
*last
;
24929 int first_x
, start_x
, x
;
24931 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24932 /* If row extends face to end of line write the whole line. */
24933 draw_glyphs (w
, 0, row
, area
,
24934 0, row
->used
[area
],
24935 DRAW_NORMAL_TEXT
, 0);
24938 /* Set START_X to the window-relative start position for drawing glyphs of
24939 AREA. The first glyph of the text area can be partially visible.
24940 The first glyphs of other areas cannot. */
24941 start_x
= window_box_left_offset (w
, area
);
24943 if (area
== TEXT_AREA
)
24946 /* Find the first glyph that must be redrawn. */
24948 && x
+ first
->pixel_width
< r
->x
)
24950 x
+= first
->pixel_width
;
24954 /* Find the last one. */
24958 && x
< r
->x
+ r
->width
)
24960 x
+= last
->pixel_width
;
24966 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24967 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24968 DRAW_NORMAL_TEXT
, 0);
24973 /* Redraw the parts of the glyph row ROW on window W intersecting
24974 rectangle R. R is in window-relative coordinates. Value is
24975 non-zero if mouse-face was overwritten. */
24978 expose_line (w
, row
, r
)
24980 struct glyph_row
*row
;
24983 xassert (row
->enabled_p
);
24985 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24986 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24987 0, row
->used
[TEXT_AREA
],
24988 DRAW_NORMAL_TEXT
, 0);
24991 if (row
->used
[LEFT_MARGIN_AREA
])
24992 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24993 if (row
->used
[TEXT_AREA
])
24994 expose_area (w
, row
, r
, TEXT_AREA
);
24995 if (row
->used
[RIGHT_MARGIN_AREA
])
24996 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24997 draw_row_fringe_bitmaps (w
, row
);
25000 return row
->mouse_face_p
;
25004 /* Redraw those parts of glyphs rows during expose event handling that
25005 overlap other rows. Redrawing of an exposed line writes over parts
25006 of lines overlapping that exposed line; this function fixes that.
25008 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25009 row in W's current matrix that is exposed and overlaps other rows.
25010 LAST_OVERLAPPING_ROW is the last such row. */
25013 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25015 struct glyph_row
*first_overlapping_row
;
25016 struct glyph_row
*last_overlapping_row
;
25019 struct glyph_row
*row
;
25021 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25022 if (row
->overlapping_p
)
25024 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25027 if (row
->used
[LEFT_MARGIN_AREA
])
25028 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25030 if (row
->used
[TEXT_AREA
])
25031 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25033 if (row
->used
[RIGHT_MARGIN_AREA
])
25034 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25040 /* Return non-zero if W's cursor intersects rectangle R. */
25043 phys_cursor_in_rect_p (w
, r
)
25047 XRectangle cr
, result
;
25048 struct glyph
*cursor_glyph
;
25049 struct glyph_row
*row
;
25051 if (w
->phys_cursor
.vpos
>= 0
25052 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25053 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25055 && row
->cursor_in_fringe_p
)
25057 /* Cursor is in the fringe. */
25058 cr
.x
= window_box_right_offset (w
,
25059 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25060 ? RIGHT_MARGIN_AREA
25063 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25064 cr
.height
= row
->height
;
25065 return x_intersect_rectangles (&cr
, r
, &result
);
25068 cursor_glyph
= get_phys_cursor_glyph (w
);
25071 /* r is relative to W's box, but w->phys_cursor.x is relative
25072 to left edge of W's TEXT area. Adjust it. */
25073 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25074 cr
.y
= w
->phys_cursor
.y
;
25075 cr
.width
= cursor_glyph
->pixel_width
;
25076 cr
.height
= w
->phys_cursor_height
;
25077 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25078 I assume the effect is the same -- and this is portable. */
25079 return x_intersect_rectangles (&cr
, r
, &result
);
25081 /* If we don't understand the format, pretend we're not in the hot-spot. */
25087 Draw a vertical window border to the right of window W if W doesn't
25088 have vertical scroll bars. */
25091 x_draw_vertical_border (w
)
25094 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25096 /* We could do better, if we knew what type of scroll-bar the adjacent
25097 windows (on either side) have... But we don't :-(
25098 However, I think this works ok. ++KFS 2003-04-25 */
25100 /* Redraw borders between horizontally adjacent windows. Don't
25101 do it for frames with vertical scroll bars because either the
25102 right scroll bar of a window, or the left scroll bar of its
25103 neighbor will suffice as a border. */
25104 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25107 if (!WINDOW_RIGHTMOST_P (w
)
25108 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25110 int x0
, x1
, y0
, y1
;
25112 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25115 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25118 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25120 else if (!WINDOW_LEFTMOST_P (w
)
25121 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25123 int x0
, x1
, y0
, y1
;
25125 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25128 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25131 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25136 /* Redraw the part of window W intersection rectangle FR. Pixel
25137 coordinates in FR are frame-relative. Call this function with
25138 input blocked. Value is non-zero if the exposure overwrites
25142 expose_window (w
, fr
)
25146 struct frame
*f
= XFRAME (w
->frame
);
25148 int mouse_face_overwritten_p
= 0;
25150 /* If window is not yet fully initialized, do nothing. This can
25151 happen when toolkit scroll bars are used and a window is split.
25152 Reconfiguring the scroll bar will generate an expose for a newly
25154 if (w
->current_matrix
== NULL
)
25157 /* When we're currently updating the window, display and current
25158 matrix usually don't agree. Arrange for a thorough display
25160 if (w
== updated_window
)
25162 SET_FRAME_GARBAGED (f
);
25166 /* Frame-relative pixel rectangle of W. */
25167 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25168 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25169 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25170 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25172 if (x_intersect_rectangles (fr
, &wr
, &r
))
25174 int yb
= window_text_bottom_y (w
);
25175 struct glyph_row
*row
;
25176 int cursor_cleared_p
;
25177 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25179 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25180 r
.x
, r
.y
, r
.width
, r
.height
));
25182 /* Convert to window coordinates. */
25183 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25184 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25186 /* Turn off the cursor. */
25187 if (!w
->pseudo_window_p
25188 && phys_cursor_in_rect_p (w
, &r
))
25190 x_clear_cursor (w
);
25191 cursor_cleared_p
= 1;
25194 cursor_cleared_p
= 0;
25196 /* Update lines intersecting rectangle R. */
25197 first_overlapping_row
= last_overlapping_row
= NULL
;
25198 for (row
= w
->current_matrix
->rows
;
25203 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25205 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25206 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25207 || (r
.y
>= y0
&& r
.y
< y1
)
25208 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25210 /* A header line may be overlapping, but there is no need
25211 to fix overlapping areas for them. KFS 2005-02-12 */
25212 if (row
->overlapping_p
&& !row
->mode_line_p
)
25214 if (first_overlapping_row
== NULL
)
25215 first_overlapping_row
= row
;
25216 last_overlapping_row
= row
;
25220 if (expose_line (w
, row
, &r
))
25221 mouse_face_overwritten_p
= 1;
25224 else if (row
->overlapping_p
)
25226 /* We must redraw a row overlapping the exposed area. */
25228 ? y0
+ row
->phys_height
> r
.y
25229 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25231 if (first_overlapping_row
== NULL
)
25232 first_overlapping_row
= row
;
25233 last_overlapping_row
= row
;
25241 /* Display the mode line if there is one. */
25242 if (WINDOW_WANTS_MODELINE_P (w
)
25243 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25245 && row
->y
< r
.y
+ r
.height
)
25247 if (expose_line (w
, row
, &r
))
25248 mouse_face_overwritten_p
= 1;
25251 if (!w
->pseudo_window_p
)
25253 /* Fix the display of overlapping rows. */
25254 if (first_overlapping_row
)
25255 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25258 /* Draw border between windows. */
25259 x_draw_vertical_border (w
);
25261 /* Turn the cursor on again. */
25262 if (cursor_cleared_p
)
25263 update_window_cursor (w
, 1);
25267 return mouse_face_overwritten_p
;
25272 /* Redraw (parts) of all windows in the window tree rooted at W that
25273 intersect R. R contains frame pixel coordinates. Value is
25274 non-zero if the exposure overwrites mouse-face. */
25277 expose_window_tree (w
, r
)
25281 struct frame
*f
= XFRAME (w
->frame
);
25282 int mouse_face_overwritten_p
= 0;
25284 while (w
&& !FRAME_GARBAGED_P (f
))
25286 if (!NILP (w
->hchild
))
25287 mouse_face_overwritten_p
25288 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25289 else if (!NILP (w
->vchild
))
25290 mouse_face_overwritten_p
25291 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25293 mouse_face_overwritten_p
|= expose_window (w
, r
);
25295 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25298 return mouse_face_overwritten_p
;
25303 Redisplay an exposed area of frame F. X and Y are the upper-left
25304 corner of the exposed rectangle. W and H are width and height of
25305 the exposed area. All are pixel values. W or H zero means redraw
25306 the entire frame. */
25309 expose_frame (f
, x
, y
, w
, h
)
25314 int mouse_face_overwritten_p
= 0;
25316 TRACE ((stderr
, "expose_frame "));
25318 /* No need to redraw if frame will be redrawn soon. */
25319 if (FRAME_GARBAGED_P (f
))
25321 TRACE ((stderr
, " garbaged\n"));
25325 /* If basic faces haven't been realized yet, there is no point in
25326 trying to redraw anything. This can happen when we get an expose
25327 event while Emacs is starting, e.g. by moving another window. */
25328 if (FRAME_FACE_CACHE (f
) == NULL
25329 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25331 TRACE ((stderr
, " no faces\n"));
25335 if (w
== 0 || h
== 0)
25338 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25339 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25349 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25350 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25352 if (WINDOWP (f
->tool_bar_window
))
25353 mouse_face_overwritten_p
25354 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25356 #ifdef HAVE_X_WINDOWS
25358 #ifndef USE_X_TOOLKIT
25359 if (WINDOWP (f
->menu_bar_window
))
25360 mouse_face_overwritten_p
25361 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25362 #endif /* not USE_X_TOOLKIT */
25366 /* Some window managers support a focus-follows-mouse style with
25367 delayed raising of frames. Imagine a partially obscured frame,
25368 and moving the mouse into partially obscured mouse-face on that
25369 frame. The visible part of the mouse-face will be highlighted,
25370 then the WM raises the obscured frame. With at least one WM, KDE
25371 2.1, Emacs is not getting any event for the raising of the frame
25372 (even tried with SubstructureRedirectMask), only Expose events.
25373 These expose events will draw text normally, i.e. not
25374 highlighted. Which means we must redo the highlight here.
25375 Subsume it under ``we love X''. --gerd 2001-08-15 */
25376 /* Included in Windows version because Windows most likely does not
25377 do the right thing if any third party tool offers
25378 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25379 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25381 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25382 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25384 int x
= dpyinfo
->mouse_face_mouse_x
;
25385 int y
= dpyinfo
->mouse_face_mouse_y
;
25386 clear_mouse_face (dpyinfo
);
25387 note_mouse_highlight (f
, x
, y
);
25394 Determine the intersection of two rectangles R1 and R2. Return
25395 the intersection in *RESULT. Value is non-zero if RESULT is not
25399 x_intersect_rectangles (r1
, r2
, result
)
25400 XRectangle
*r1
, *r2
, *result
;
25402 XRectangle
*left
, *right
;
25403 XRectangle
*upper
, *lower
;
25404 int intersection_p
= 0;
25406 /* Rearrange so that R1 is the left-most rectangle. */
25408 left
= r1
, right
= r2
;
25410 left
= r2
, right
= r1
;
25412 /* X0 of the intersection is right.x0, if this is inside R1,
25413 otherwise there is no intersection. */
25414 if (right
->x
<= left
->x
+ left
->width
)
25416 result
->x
= right
->x
;
25418 /* The right end of the intersection is the minimum of the
25419 the right ends of left and right. */
25420 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25423 /* Same game for Y. */
25425 upper
= r1
, lower
= r2
;
25427 upper
= r2
, lower
= r1
;
25429 /* The upper end of the intersection is lower.y0, if this is inside
25430 of upper. Otherwise, there is no intersection. */
25431 if (lower
->y
<= upper
->y
+ upper
->height
)
25433 result
->y
= lower
->y
;
25435 /* The lower end of the intersection is the minimum of the lower
25436 ends of upper and lower. */
25437 result
->height
= (min (lower
->y
+ lower
->height
,
25438 upper
->y
+ upper
->height
)
25440 intersection_p
= 1;
25444 return intersection_p
;
25447 #endif /* HAVE_WINDOW_SYSTEM */
25450 /***********************************************************************
25452 ***********************************************************************/
25457 Vwith_echo_area_save_vector
= Qnil
;
25458 staticpro (&Vwith_echo_area_save_vector
);
25460 Vmessage_stack
= Qnil
;
25461 staticpro (&Vmessage_stack
);
25463 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25464 staticpro (&Qinhibit_redisplay
);
25466 message_dolog_marker1
= Fmake_marker ();
25467 staticpro (&message_dolog_marker1
);
25468 message_dolog_marker2
= Fmake_marker ();
25469 staticpro (&message_dolog_marker2
);
25470 message_dolog_marker3
= Fmake_marker ();
25471 staticpro (&message_dolog_marker3
);
25474 defsubr (&Sdump_frame_glyph_matrix
);
25475 defsubr (&Sdump_glyph_matrix
);
25476 defsubr (&Sdump_glyph_row
);
25477 defsubr (&Sdump_tool_bar_row
);
25478 defsubr (&Strace_redisplay
);
25479 defsubr (&Strace_to_stderr
);
25481 #ifdef HAVE_WINDOW_SYSTEM
25482 defsubr (&Stool_bar_lines_needed
);
25483 defsubr (&Slookup_image_map
);
25485 defsubr (&Sformat_mode_line
);
25486 defsubr (&Sinvisible_p
);
25488 staticpro (&Qmenu_bar_update_hook
);
25489 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25491 staticpro (&Qoverriding_terminal_local_map
);
25492 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25494 staticpro (&Qoverriding_local_map
);
25495 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25497 staticpro (&Qwindow_scroll_functions
);
25498 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25500 staticpro (&Qwindow_text_change_functions
);
25501 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25503 staticpro (&Qredisplay_end_trigger_functions
);
25504 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25506 staticpro (&Qinhibit_point_motion_hooks
);
25507 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25509 Qeval
= intern_c_string ("eval");
25510 staticpro (&Qeval
);
25512 QCdata
= intern_c_string (":data");
25513 staticpro (&QCdata
);
25514 Qdisplay
= intern_c_string ("display");
25515 staticpro (&Qdisplay
);
25516 Qspace_width
= intern_c_string ("space-width");
25517 staticpro (&Qspace_width
);
25518 Qraise
= intern_c_string ("raise");
25519 staticpro (&Qraise
);
25520 Qslice
= intern_c_string ("slice");
25521 staticpro (&Qslice
);
25522 Qspace
= intern_c_string ("space");
25523 staticpro (&Qspace
);
25524 Qmargin
= intern_c_string ("margin");
25525 staticpro (&Qmargin
);
25526 Qpointer
= intern_c_string ("pointer");
25527 staticpro (&Qpointer
);
25528 Qleft_margin
= intern_c_string ("left-margin");
25529 staticpro (&Qleft_margin
);
25530 Qright_margin
= intern_c_string ("right-margin");
25531 staticpro (&Qright_margin
);
25532 Qcenter
= intern_c_string ("center");
25533 staticpro (&Qcenter
);
25534 Qline_height
= intern_c_string ("line-height");
25535 staticpro (&Qline_height
);
25536 QCalign_to
= intern_c_string (":align-to");
25537 staticpro (&QCalign_to
);
25538 QCrelative_width
= intern_c_string (":relative-width");
25539 staticpro (&QCrelative_width
);
25540 QCrelative_height
= intern_c_string (":relative-height");
25541 staticpro (&QCrelative_height
);
25542 QCeval
= intern_c_string (":eval");
25543 staticpro (&QCeval
);
25544 QCpropertize
= intern_c_string (":propertize");
25545 staticpro (&QCpropertize
);
25546 QCfile
= intern_c_string (":file");
25547 staticpro (&QCfile
);
25548 Qfontified
= intern_c_string ("fontified");
25549 staticpro (&Qfontified
);
25550 Qfontification_functions
= intern_c_string ("fontification-functions");
25551 staticpro (&Qfontification_functions
);
25552 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25553 staticpro (&Qtrailing_whitespace
);
25554 Qescape_glyph
= intern_c_string ("escape-glyph");
25555 staticpro (&Qescape_glyph
);
25556 Qnobreak_space
= intern_c_string ("nobreak-space");
25557 staticpro (&Qnobreak_space
);
25558 Qimage
= intern_c_string ("image");
25559 staticpro (&Qimage
);
25560 QCmap
= intern_c_string (":map");
25561 staticpro (&QCmap
);
25562 QCpointer
= intern_c_string (":pointer");
25563 staticpro (&QCpointer
);
25564 Qrect
= intern_c_string ("rect");
25565 staticpro (&Qrect
);
25566 Qcircle
= intern_c_string ("circle");
25567 staticpro (&Qcircle
);
25568 Qpoly
= intern_c_string ("poly");
25569 staticpro (&Qpoly
);
25570 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25571 staticpro (&Qmessage_truncate_lines
);
25572 Qgrow_only
= intern_c_string ("grow-only");
25573 staticpro (&Qgrow_only
);
25574 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25575 staticpro (&Qinhibit_menubar_update
);
25576 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25577 staticpro (&Qinhibit_eval_during_redisplay
);
25578 Qposition
= intern_c_string ("position");
25579 staticpro (&Qposition
);
25580 Qbuffer_position
= intern_c_string ("buffer-position");
25581 staticpro (&Qbuffer_position
);
25582 Qobject
= intern_c_string ("object");
25583 staticpro (&Qobject
);
25584 Qbar
= intern_c_string ("bar");
25586 Qhbar
= intern_c_string ("hbar");
25587 staticpro (&Qhbar
);
25588 Qbox
= intern_c_string ("box");
25590 Qhollow
= intern_c_string ("hollow");
25591 staticpro (&Qhollow
);
25592 Qhand
= intern_c_string ("hand");
25593 staticpro (&Qhand
);
25594 Qarrow
= intern_c_string ("arrow");
25595 staticpro (&Qarrow
);
25596 Qtext
= intern_c_string ("text");
25597 staticpro (&Qtext
);
25598 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25599 staticpro (&Qrisky_local_variable
);
25600 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25601 staticpro (&Qinhibit_free_realized_faces
);
25603 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25604 Fcons (intern_c_string ("void-variable"), Qnil
)),
25606 staticpro (&list_of_error
);
25608 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25609 staticpro (&Qlast_arrow_position
);
25610 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25611 staticpro (&Qlast_arrow_string
);
25613 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25614 staticpro (&Qoverlay_arrow_string
);
25615 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25616 staticpro (&Qoverlay_arrow_bitmap
);
25618 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25619 staticpro (&echo_buffer
[0]);
25620 staticpro (&echo_buffer
[1]);
25622 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25623 staticpro (&echo_area_buffer
[0]);
25624 staticpro (&echo_area_buffer
[1]);
25626 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25627 staticpro (&Vmessages_buffer_name
);
25629 mode_line_proptrans_alist
= Qnil
;
25630 staticpro (&mode_line_proptrans_alist
);
25631 mode_line_string_list
= Qnil
;
25632 staticpro (&mode_line_string_list
);
25633 mode_line_string_face
= Qnil
;
25634 staticpro (&mode_line_string_face
);
25635 mode_line_string_face_prop
= Qnil
;
25636 staticpro (&mode_line_string_face_prop
);
25637 Vmode_line_unwind_vector
= Qnil
;
25638 staticpro (&Vmode_line_unwind_vector
);
25640 help_echo_string
= Qnil
;
25641 staticpro (&help_echo_string
);
25642 help_echo_object
= Qnil
;
25643 staticpro (&help_echo_object
);
25644 help_echo_window
= Qnil
;
25645 staticpro (&help_echo_window
);
25646 previous_help_echo_string
= Qnil
;
25647 staticpro (&previous_help_echo_string
);
25648 help_echo_pos
= -1;
25650 Qright_to_left
= intern ("right-to-left");
25651 staticpro (&Qright_to_left
);
25652 Qleft_to_right
= intern ("left-to-right");
25653 staticpro (&Qleft_to_right
);
25655 #ifdef HAVE_WINDOW_SYSTEM
25656 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25657 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25658 For example, if a block cursor is over a tab, it will be drawn as
25659 wide as that tab on the display. */);
25660 x_stretch_cursor_p
= 0;
25663 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25664 doc
: /* *Non-nil means highlight trailing whitespace.
25665 The face used for trailing whitespace is `trailing-whitespace'. */);
25666 Vshow_trailing_whitespace
= Qnil
;
25668 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25669 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25670 A value of t means highlight the character itself (for nobreak space,
25671 use face `nobreak-space').
25672 A value of nil means no highlighting.
25673 Other values mean display the escape glyph followed by an ordinary
25674 space or ordinary hyphen. */);
25675 Vnobreak_char_display
= Qt
;
25677 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25678 doc
: /* *The pointer shape to show in void text areas.
25679 A value of nil means to show the text pointer. Other options are `arrow',
25680 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25681 Vvoid_text_area_pointer
= Qarrow
;
25683 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25684 doc
: /* Non-nil means don't actually do any redisplay.
25685 This is used for internal purposes. */);
25686 Vinhibit_redisplay
= Qnil
;
25688 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25689 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25690 Vglobal_mode_string
= Qnil
;
25692 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25693 doc
: /* Marker for where to display an arrow on top of the buffer text.
25694 This must be the beginning of a line in order to work.
25695 See also `overlay-arrow-string'. */);
25696 Voverlay_arrow_position
= Qnil
;
25698 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25699 doc
: /* String to display as an arrow in non-window frames.
25700 See also `overlay-arrow-position'. */);
25701 Voverlay_arrow_string
= make_pure_c_string ("=>");
25703 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25704 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25705 The symbols on this list are examined during redisplay to determine
25706 where to display overlay arrows. */);
25707 Voverlay_arrow_variable_list
25708 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25710 DEFVAR_INT ("scroll-step", &scroll_step
,
25711 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25712 If that fails to bring point back on frame, point is centered instead.
25713 If this is zero, point is always centered after it moves off frame.
25714 If you want scrolling to always be a line at a time, you should set
25715 `scroll-conservatively' to a large value rather than set this to 1. */);
25717 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25718 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25719 If point moves off-screen, redisplay will scroll by up to
25720 `scroll-conservatively' lines in order to bring point just barely
25721 onto the screen again. If that cannot be done, then redisplay
25722 recenters point as usual.
25724 A value of zero means always recenter point if it moves off screen. */);
25725 scroll_conservatively
= 0;
25727 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25728 doc
: /* *Number of lines of margin at the top and bottom of a window.
25729 Recenter the window whenever point gets within this many lines
25730 of the top or bottom of the window. */);
25733 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25734 doc
: /* Pixels per inch value for non-window system displays.
25735 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25736 Vdisplay_pixels_per_inch
= make_float (72.0);
25739 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25742 DEFVAR_LISP ("truncate-partial-width-windows",
25743 &Vtruncate_partial_width_windows
,
25744 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25745 For an integer value, truncate lines in each window narrower than the
25746 full frame width, provided the window width is less than that integer;
25747 otherwise, respect the value of `truncate-lines'.
25749 For any other non-nil value, truncate lines in all windows that do
25750 not span the full frame width.
25752 A value of nil means to respect the value of `truncate-lines'.
25754 If `word-wrap' is enabled, you might want to reduce this. */);
25755 Vtruncate_partial_width_windows
= make_number (50);
25757 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25758 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25759 Any other value means to use the appropriate face, `mode-line',
25760 `header-line', or `menu' respectively. */);
25761 mode_line_inverse_video
= 1;
25763 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25764 doc
: /* *Maximum buffer size for which line number should be displayed.
25765 If the buffer is bigger than this, the line number does not appear
25766 in the mode line. A value of nil means no limit. */);
25767 Vline_number_display_limit
= Qnil
;
25769 DEFVAR_INT ("line-number-display-limit-width",
25770 &line_number_display_limit_width
,
25771 doc
: /* *Maximum line width (in characters) for line number display.
25772 If the average length of the lines near point is bigger than this, then the
25773 line number may be omitted from the mode line. */);
25774 line_number_display_limit_width
= 200;
25776 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25777 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25778 highlight_nonselected_windows
= 0;
25780 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25781 doc
: /* Non-nil if more than one frame is visible on this display.
25782 Minibuffer-only frames don't count, but iconified frames do.
25783 This variable is not guaranteed to be accurate except while processing
25784 `frame-title-format' and `icon-title-format'. */);
25786 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25787 doc
: /* Template for displaying the title bar of visible frames.
25788 \(Assuming the window manager supports this feature.)
25790 This variable has the same structure as `mode-line-format', except that
25791 the %c and %l constructs are ignored. It is used only on frames for
25792 which no explicit name has been set \(see `modify-frame-parameters'). */);
25794 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25795 doc
: /* Template for displaying the title bar of an iconified frame.
25796 \(Assuming the window manager supports this feature.)
25797 This variable has the same structure as `mode-line-format' (which see),
25798 and is used only on frames for which no explicit name has been set
25799 \(see `modify-frame-parameters'). */);
25801 = Vframe_title_format
25802 = pure_cons (intern_c_string ("multiple-frames"),
25803 pure_cons (make_pure_c_string ("%b"),
25804 pure_cons (pure_cons (empty_unibyte_string
,
25805 pure_cons (intern_c_string ("invocation-name"),
25806 pure_cons (make_pure_c_string ("@"),
25807 pure_cons (intern_c_string ("system-name"),
25811 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25812 doc
: /* Maximum number of lines to keep in the message log buffer.
25813 If nil, disable message logging. If t, log messages but don't truncate
25814 the buffer when it becomes large. */);
25815 Vmessage_log_max
= make_number (100);
25817 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25818 doc
: /* Functions called before redisplay, if window sizes have changed.
25819 The value should be a list of functions that take one argument.
25820 Just before redisplay, for each frame, if any of its windows have changed
25821 size since the last redisplay, or have been split or deleted,
25822 all the functions in the list are called, with the frame as argument. */);
25823 Vwindow_size_change_functions
= Qnil
;
25825 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25826 doc
: /* List of functions to call before redisplaying a window with scrolling.
25827 Each function is called with two arguments, the window and its new
25828 display-start position. Note that these functions are also called by
25829 `set-window-buffer'. Also note that the value of `window-end' is not
25830 valid when these functions are called. */);
25831 Vwindow_scroll_functions
= Qnil
;
25833 DEFVAR_LISP ("window-text-change-functions",
25834 &Vwindow_text_change_functions
,
25835 doc
: /* Functions to call in redisplay when text in the window might change. */);
25836 Vwindow_text_change_functions
= Qnil
;
25838 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25839 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25840 Each function is called with two arguments, the window and the end trigger value.
25841 See `set-window-redisplay-end-trigger'. */);
25842 Vredisplay_end_trigger_functions
= Qnil
;
25844 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25845 doc
: /* *Non-nil means autoselect window with mouse pointer.
25846 If nil, do not autoselect windows.
25847 A positive number means delay autoselection by that many seconds: a
25848 window is autoselected only after the mouse has remained in that
25849 window for the duration of the delay.
25850 A negative number has a similar effect, but causes windows to be
25851 autoselected only after the mouse has stopped moving. \(Because of
25852 the way Emacs compares mouse events, you will occasionally wait twice
25853 that time before the window gets selected.\)
25854 Any other value means to autoselect window instantaneously when the
25855 mouse pointer enters it.
25857 Autoselection selects the minibuffer only if it is active, and never
25858 unselects the minibuffer if it is active.
25860 When customizing this variable make sure that the actual value of
25861 `focus-follows-mouse' matches the behavior of your window manager. */);
25862 Vmouse_autoselect_window
= Qnil
;
25864 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25865 doc
: /* *Non-nil means automatically resize tool-bars.
25866 This dynamically changes the tool-bar's height to the minimum height
25867 that is needed to make all tool-bar items visible.
25868 If value is `grow-only', the tool-bar's height is only increased
25869 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25870 Vauto_resize_tool_bars
= Qt
;
25872 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25873 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25874 auto_raise_tool_bar_buttons_p
= 1;
25876 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25877 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25878 make_cursor_line_fully_visible_p
= 1;
25880 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25881 doc
: /* *Border below tool-bar in pixels.
25882 If an integer, use it as the height of the border.
25883 If it is one of `internal-border-width' or `border-width', use the
25884 value of the corresponding frame parameter.
25885 Otherwise, no border is added below the tool-bar. */);
25886 Vtool_bar_border
= Qinternal_border_width
;
25888 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25889 doc
: /* *Margin around tool-bar buttons in pixels.
25890 If an integer, use that for both horizontal and vertical margins.
25891 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25892 HORZ specifying the horizontal margin, and VERT specifying the
25893 vertical margin. */);
25894 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25896 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25897 doc
: /* *Relief thickness of tool-bar buttons. */);
25898 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25900 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25901 doc
: /* List of functions to call to fontify regions of text.
25902 Each function is called with one argument POS. Functions must
25903 fontify a region starting at POS in the current buffer, and give
25904 fontified regions the property `fontified'. */);
25905 Vfontification_functions
= Qnil
;
25906 Fmake_variable_buffer_local (Qfontification_functions
);
25908 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25909 &unibyte_display_via_language_environment
,
25910 doc
: /* *Non-nil means display unibyte text according to language environment.
25911 Specifically, this means that raw bytes in the range 160-255 decimal
25912 are displayed by converting them to the equivalent multibyte characters
25913 according to the current language environment. As a result, they are
25914 displayed according to the current fontset.
25916 Note that this variable affects only how these bytes are displayed,
25917 but does not change the fact they are interpreted as raw bytes. */);
25918 unibyte_display_via_language_environment
= 0;
25920 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25921 doc
: /* *Maximum height for resizing mini-windows.
25922 If a float, it specifies a fraction of the mini-window frame's height.
25923 If an integer, it specifies a number of lines. */);
25924 Vmax_mini_window_height
= make_float (0.25);
25926 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25927 doc
: /* *How to resize mini-windows.
25928 A value of nil means don't automatically resize mini-windows.
25929 A value of t means resize them to fit the text displayed in them.
25930 A value of `grow-only', the default, means let mini-windows grow
25931 only, until their display becomes empty, at which point the windows
25932 go back to their normal size. */);
25933 Vresize_mini_windows
= Qgrow_only
;
25935 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25936 doc
: /* Alist specifying how to blink the cursor off.
25937 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25938 `cursor-type' frame-parameter or variable equals ON-STATE,
25939 comparing using `equal', Emacs uses OFF-STATE to specify
25940 how to blink it off. ON-STATE and OFF-STATE are values for
25941 the `cursor-type' frame parameter.
25943 If a frame's ON-STATE has no entry in this list,
25944 the frame's other specifications determine how to blink the cursor off. */);
25945 Vblink_cursor_alist
= Qnil
;
25947 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25948 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25949 automatic_hscrolling_p
= 1;
25950 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25951 staticpro (&Qauto_hscroll_mode
);
25953 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25954 doc
: /* *How many columns away from the window edge point is allowed to get
25955 before automatic hscrolling will horizontally scroll the window. */);
25956 hscroll_margin
= 5;
25958 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25959 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25960 When point is less than `hscroll-margin' columns from the window
25961 edge, automatic hscrolling will scroll the window by the amount of columns
25962 determined by this variable. If its value is a positive integer, scroll that
25963 many columns. If it's a positive floating-point number, it specifies the
25964 fraction of the window's width to scroll. If it's nil or zero, point will be
25965 centered horizontally after the scroll. Any other value, including negative
25966 numbers, are treated as if the value were zero.
25968 Automatic hscrolling always moves point outside the scroll margin, so if
25969 point was more than scroll step columns inside the margin, the window will
25970 scroll more than the value given by the scroll step.
25972 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25973 and `scroll-right' overrides this variable's effect. */);
25974 Vhscroll_step
= make_number (0);
25976 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25977 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25978 Bind this around calls to `message' to let it take effect. */);
25979 message_truncate_lines
= 0;
25981 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25982 doc
: /* Normal hook run to update the menu bar definitions.
25983 Redisplay runs this hook before it redisplays the menu bar.
25984 This is used to update submenus such as Buffers,
25985 whose contents depend on various data. */);
25986 Vmenu_bar_update_hook
= Qnil
;
25988 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25989 doc
: /* Frame for which we are updating a menu.
25990 The enable predicate for a menu binding should check this variable. */);
25991 Vmenu_updating_frame
= Qnil
;
25993 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25994 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25995 inhibit_menubar_update
= 0;
25997 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25998 doc
: /* Prefix prepended to all continuation lines at display time.
25999 The value may be a string, an image, or a stretch-glyph; it is
26000 interpreted in the same way as the value of a `display' text property.
26002 This variable is overridden by any `wrap-prefix' text or overlay
26005 To add a prefix to non-continuation lines, use `line-prefix'. */);
26006 Vwrap_prefix
= Qnil
;
26007 staticpro (&Qwrap_prefix
);
26008 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26009 Fmake_variable_buffer_local (Qwrap_prefix
);
26011 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26012 doc
: /* Prefix prepended to all non-continuation lines at display time.
26013 The value may be a string, an image, or a stretch-glyph; it is
26014 interpreted in the same way as the value of a `display' text property.
26016 This variable is overridden by any `line-prefix' text or overlay
26019 To add a prefix to continuation lines, use `wrap-prefix'. */);
26020 Vline_prefix
= Qnil
;
26021 staticpro (&Qline_prefix
);
26022 Qline_prefix
= intern_c_string ("line-prefix");
26023 Fmake_variable_buffer_local (Qline_prefix
);
26025 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26026 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26027 inhibit_eval_during_redisplay
= 0;
26029 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26030 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26031 inhibit_free_realized_faces
= 0;
26034 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26035 doc
: /* Inhibit try_window_id display optimization. */);
26036 inhibit_try_window_id
= 0;
26038 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26039 doc
: /* Inhibit try_window_reusing display optimization. */);
26040 inhibit_try_window_reusing
= 0;
26042 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26043 doc
: /* Inhibit try_cursor_movement display optimization. */);
26044 inhibit_try_cursor_movement
= 0;
26045 #endif /* GLYPH_DEBUG */
26047 DEFVAR_INT ("overline-margin", &overline_margin
,
26048 doc
: /* *Space between overline and text, in pixels.
26049 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26050 margin to the caracter height. */);
26051 overline_margin
= 2;
26053 DEFVAR_INT ("underline-minimum-offset",
26054 &underline_minimum_offset
,
26055 doc
: /* Minimum distance between baseline and underline.
26056 This can improve legibility of underlined text at small font sizes,
26057 particularly when using variable `x-use-underline-position-properties'
26058 with fonts that specify an UNDERLINE_POSITION relatively close to the
26059 baseline. The default value is 1. */);
26060 underline_minimum_offset
= 1;
26062 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26063 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26064 display_hourglass_p
= 1;
26066 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26067 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26068 Value must be an integer or float. */);
26069 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26071 hourglass_atimer
= NULL
;
26072 hourglass_shown_p
= 0;
26076 /* Initialize this module when Emacs starts. */
26081 Lisp_Object root_window
;
26082 struct window
*mini_w
;
26084 current_header_line_height
= current_mode_line_height
= -1;
26086 CHARPOS (this_line_start_pos
) = 0;
26088 mini_w
= XWINDOW (minibuf_window
);
26089 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26091 if (!noninteractive
)
26093 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26096 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26097 set_window_height (root_window
,
26098 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26100 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26101 set_window_height (minibuf_window
, 1, 0);
26103 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26104 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26106 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26107 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26108 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26110 /* The default ellipsis glyphs `...'. */
26111 for (i
= 0; i
< 3; ++i
)
26112 default_invis_vector
[i
] = make_number ('.');
26116 /* Allocate the buffer for frame titles.
26117 Also used for `format-mode-line'. */
26119 mode_line_noprop_buf
= (char *) xmalloc (size
);
26120 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26121 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26122 mode_line_target
= MODE_LINE_DISPLAY
;
26125 help_echo_showing_p
= 0;
26128 /* Since w32 does not support atimers, it defines its own implementation of
26129 the following three functions in w32fns.c. */
26132 /* Platform-independent portion of hourglass implementation. */
26134 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26136 hourglass_started ()
26138 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26141 /* Cancel a currently active hourglass timer, and start a new one. */
26145 #if defined (HAVE_WINDOW_SYSTEM)
26147 int secs
, usecs
= 0;
26149 cancel_hourglass ();
26151 if (INTEGERP (Vhourglass_delay
)
26152 && XINT (Vhourglass_delay
) > 0)
26153 secs
= XFASTINT (Vhourglass_delay
);
26154 else if (FLOATP (Vhourglass_delay
)
26155 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26158 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26159 secs
= XFASTINT (tem
);
26160 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26163 secs
= DEFAULT_HOURGLASS_DELAY
;
26165 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26166 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26167 show_hourglass
, NULL
);
26172 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26175 cancel_hourglass ()
26177 #if defined (HAVE_WINDOW_SYSTEM)
26178 if (hourglass_atimer
)
26180 cancel_atimer (hourglass_atimer
);
26181 hourglass_atimer
= NULL
;
26184 if (hourglass_shown_p
)
26188 #endif /* ! WINDOWSNT */
26190 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26191 (do not change this comment) */