a7913768d8ac01972f6dec4528a64747f773e7cc
[bpt/emacs.git] / src / xdisp.c
1 /* Display generation from window structure and buffer text.
2
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
21
22 Redisplay.
23
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
27 the display.
28
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
34
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
44
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
48 ^ | |
49 +----------------------------------+ |
50 Don't use this path when called |
51 asynchronously! |
52 |
53 expose_window (asynchronous) |
54 |
55 X expose events -----+
56
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
61
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
70 terminology.
71
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
77
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
82 following functions:
83
84 . try_cursor_movement
85
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
89
90 . try_window_reusing_current_matrix
91
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
94 scrolling).
95
96 . try_window_id
97
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
101
102 . try_window
103
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
109
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
114
115 Desired matrices.
116
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
123
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
129 argument.
130
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
140
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
146 see in dispextern.h.
147
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
159
160 Frame matrices.
161
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
168
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
180
181 Bidirectional display.
182
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
195
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
204
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
223
224 Bidirectional display and character compositions
225
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
229 category.
230
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
250
251 Moving an iterator in bidirectional text
252 without producing glyphs
253
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
272
273 #include <config.h>
274 #include <stdio.h>
275 #include <limits.h>
276 #include <setjmp.h>
277
278 #include "lisp.h"
279 #include "keyboard.h"
280 #include "frame.h"
281 #include "window.h"
282 #include "termchar.h"
283 #include "dispextern.h"
284 #include "character.h"
285 #include "buffer.h"
286 #include "charset.h"
287 #include "indent.h"
288 #include "commands.h"
289 #include "keymap.h"
290 #include "macros.h"
291 #include "disptab.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
295 #include "coding.h"
296 #include "process.h"
297 #include "region-cache.h"
298 #include "font.h"
299 #include "fontset.h"
300 #include "blockinput.h"
301
302 #ifdef HAVE_X_WINDOWS
303 #include "xterm.h"
304 #endif
305 #ifdef WINDOWSNT
306 #include "w32term.h"
307 #endif
308 #ifdef HAVE_NS
309 #include "nsterm.h"
310 #endif
311 #ifdef USE_GTK
312 #include "gtkutil.h"
313 #endif
314
315 #include "font.h"
316
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
319 #endif
320
321 #define INFINITY 10000000
322
323 Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
324 Lisp_Object Qwindow_scroll_functions;
325 static Lisp_Object Qwindow_text_change_functions;
326 static Lisp_Object Qredisplay_end_trigger_functions;
327 Lisp_Object Qinhibit_point_motion_hooks;
328 static Lisp_Object QCeval, QCpropertize;
329 Lisp_Object QCfile, QCdata;
330 static Lisp_Object Qfontified;
331 static Lisp_Object Qgrow_only;
332 static Lisp_Object Qinhibit_eval_during_redisplay;
333 static Lisp_Object Qbuffer_position, Qposition, Qobject;
334 static Lisp_Object Qright_to_left, Qleft_to_right;
335
336 /* Cursor shapes */
337 Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
338
339 /* Pointer shapes */
340 static Lisp_Object Qarrow, Qhand;
341 Lisp_Object Qtext;
342
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error;
345
346 static Lisp_Object Qfontification_functions;
347
348 static Lisp_Object Qwrap_prefix;
349 static Lisp_Object Qline_prefix;
350
351 /* Non-nil means don't actually do any redisplay. */
352
353 Lisp_Object Qinhibit_redisplay;
354
355 /* Names of text properties relevant for redisplay. */
356
357 Lisp_Object Qdisplay;
358
359 Lisp_Object Qspace, QCalign_to;
360 static Lisp_Object QCrelative_width, QCrelative_height;
361 Lisp_Object Qleft_margin, Qright_margin;
362 static Lisp_Object Qspace_width, Qraise;
363 static Lisp_Object Qslice;
364 Lisp_Object Qcenter;
365 static Lisp_Object Qmargin, Qpointer;
366 static Lisp_Object Qline_height;
367 static Lisp_Object Qinhibit_debug_on_message;
368
369 /* These setters are used only in this file, so they can be private. */
370 static inline void
371 wset_base_line_number (struct window *w, Lisp_Object val)
372 {
373 w->base_line_number = val;
374 }
375 static inline void
376 wset_base_line_pos (struct window *w, Lisp_Object val)
377 {
378 w->base_line_pos = val;
379 }
380 static inline void
381 wset_column_number_displayed (struct window *w, Lisp_Object val)
382 {
383 w->column_number_displayed = val;
384 }
385 static inline void
386 wset_region_showing (struct window *w, Lisp_Object val)
387 {
388 w->region_showing = val;
389 }
390
391 #ifdef HAVE_WINDOW_SYSTEM
392
393 /* Test if overflow newline into fringe. Called with iterator IT
394 at or past right window margin, and with IT->current_x set. */
395
396 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
397 (!NILP (Voverflow_newline_into_fringe) \
398 && FRAME_WINDOW_P ((IT)->f) \
399 && ((IT)->bidi_it.paragraph_dir == R2L \
400 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
401 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
402 && (IT)->current_x == (IT)->last_visible_x \
403 && (IT)->line_wrap != WORD_WRAP)
404
405 #else /* !HAVE_WINDOW_SYSTEM */
406 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
407 #endif /* HAVE_WINDOW_SYSTEM */
408
409 /* Test if the display element loaded in IT, or the underlying buffer
410 or string character, is a space or a TAB character. This is used
411 to determine where word wrapping can occur. */
412
413 #define IT_DISPLAYING_WHITESPACE(it) \
414 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
415 || ((STRINGP (it->string) \
416 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
417 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
418 || (it->s \
419 && (it->s[IT_BYTEPOS (*it)] == ' ' \
420 || it->s[IT_BYTEPOS (*it)] == '\t')) \
421 || (IT_BYTEPOS (*it) < ZV_BYTE \
422 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
423 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
424
425 /* Name of the face used to highlight trailing whitespace. */
426
427 static Lisp_Object Qtrailing_whitespace;
428
429 /* Name and number of the face used to highlight escape glyphs. */
430
431 static Lisp_Object Qescape_glyph;
432
433 /* Name and number of the face used to highlight non-breaking spaces. */
434
435 static Lisp_Object Qnobreak_space;
436
437 /* The symbol `image' which is the car of the lists used to represent
438 images in Lisp. Also a tool bar style. */
439
440 Lisp_Object Qimage;
441
442 /* The image map types. */
443 Lisp_Object QCmap;
444 static Lisp_Object QCpointer;
445 static Lisp_Object Qrect, Qcircle, Qpoly;
446
447 /* Tool bar styles */
448 Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
449
450 /* Non-zero means print newline to stdout before next mini-buffer
451 message. */
452
453 int noninteractive_need_newline;
454
455 /* Non-zero means print newline to message log before next message. */
456
457 static int message_log_need_newline;
458
459 /* Three markers that message_dolog uses.
460 It could allocate them itself, but that causes trouble
461 in handling memory-full errors. */
462 static Lisp_Object message_dolog_marker1;
463 static Lisp_Object message_dolog_marker2;
464 static Lisp_Object message_dolog_marker3;
465 \f
466 /* The buffer position of the first character appearing entirely or
467 partially on the line of the selected window which contains the
468 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
469 redisplay optimization in redisplay_internal. */
470
471 static struct text_pos this_line_start_pos;
472
473 /* Number of characters past the end of the line above, including the
474 terminating newline. */
475
476 static struct text_pos this_line_end_pos;
477
478 /* The vertical positions and the height of this line. */
479
480 static int this_line_vpos;
481 static int this_line_y;
482 static int this_line_pixel_height;
483
484 /* X position at which this display line starts. Usually zero;
485 negative if first character is partially visible. */
486
487 static int this_line_start_x;
488
489 /* The smallest character position seen by move_it_* functions as they
490 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
491 hscrolled lines, see display_line. */
492
493 static struct text_pos this_line_min_pos;
494
495 /* Buffer that this_line_.* variables are referring to. */
496
497 static struct buffer *this_line_buffer;
498
499
500 /* Values of those variables at last redisplay are stored as
501 properties on `overlay-arrow-position' symbol. However, if
502 Voverlay_arrow_position is a marker, last-arrow-position is its
503 numerical position. */
504
505 static Lisp_Object Qlast_arrow_position, Qlast_arrow_string;
506
507 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
508 properties on a symbol in overlay-arrow-variable-list. */
509
510 static Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
511
512 Lisp_Object Qmenu_bar_update_hook;
513
514 /* Nonzero if an overlay arrow has been displayed in this window. */
515
516 static int overlay_arrow_seen;
517
518 /* Number of windows showing the buffer of the selected window (or
519 another buffer with the same base buffer). keyboard.c refers to
520 this. */
521
522 int buffer_shared;
523
524 /* Vector containing glyphs for an ellipsis `...'. */
525
526 static Lisp_Object default_invis_vector[3];
527
528 /* This is the window where the echo area message was displayed. It
529 is always a mini-buffer window, but it may not be the same window
530 currently active as a mini-buffer. */
531
532 Lisp_Object echo_area_window;
533
534 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
535 pushes the current message and the value of
536 message_enable_multibyte on the stack, the function restore_message
537 pops the stack and displays MESSAGE again. */
538
539 static Lisp_Object Vmessage_stack;
540
541 /* Nonzero means multibyte characters were enabled when the echo area
542 message was specified. */
543
544 static int message_enable_multibyte;
545
546 /* Nonzero if we should redraw the mode lines on the next redisplay. */
547
548 int update_mode_lines;
549
550 /* Nonzero if window sizes or contents have changed since last
551 redisplay that finished. */
552
553 int windows_or_buffers_changed;
554
555 /* Nonzero means a frame's cursor type has been changed. */
556
557 int cursor_type_changed;
558
559 /* Nonzero after display_mode_line if %l was used and it displayed a
560 line number. */
561
562 static int line_number_displayed;
563
564 /* The name of the *Messages* buffer, a string. */
565
566 static Lisp_Object Vmessages_buffer_name;
567
568 /* Current, index 0, and last displayed echo area message. Either
569 buffers from echo_buffers, or nil to indicate no message. */
570
571 Lisp_Object echo_area_buffer[2];
572
573 /* The buffers referenced from echo_area_buffer. */
574
575 static Lisp_Object echo_buffer[2];
576
577 /* A vector saved used in with_area_buffer to reduce consing. */
578
579 static Lisp_Object Vwith_echo_area_save_vector;
580
581 /* Non-zero means display_echo_area should display the last echo area
582 message again. Set by redisplay_preserve_echo_area. */
583
584 static int display_last_displayed_message_p;
585
586 /* Nonzero if echo area is being used by print; zero if being used by
587 message. */
588
589 static int message_buf_print;
590
591 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
592
593 static Lisp_Object Qinhibit_menubar_update;
594 static Lisp_Object Qmessage_truncate_lines;
595
596 /* Set to 1 in clear_message to make redisplay_internal aware
597 of an emptied echo area. */
598
599 static int message_cleared_p;
600
601 /* A scratch glyph row with contents used for generating truncation
602 glyphs. Also used in direct_output_for_insert. */
603
604 #define MAX_SCRATCH_GLYPHS 100
605 static struct glyph_row scratch_glyph_row;
606 static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
607
608 /* Ascent and height of the last line processed by move_it_to. */
609
610 static int last_max_ascent, last_height;
611
612 /* Non-zero if there's a help-echo in the echo area. */
613
614 int help_echo_showing_p;
615
616 /* If >= 0, computed, exact values of mode-line and header-line height
617 to use in the macros CURRENT_MODE_LINE_HEIGHT and
618 CURRENT_HEADER_LINE_HEIGHT. */
619
620 int current_mode_line_height, current_header_line_height;
621
622 /* The maximum distance to look ahead for text properties. Values
623 that are too small let us call compute_char_face and similar
624 functions too often which is expensive. Values that are too large
625 let us call compute_char_face and alike too often because we
626 might not be interested in text properties that far away. */
627
628 #define TEXT_PROP_DISTANCE_LIMIT 100
629
630 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
631 iterator state and later restore it. This is needed because the
632 bidi iterator on bidi.c keeps a stacked cache of its states, which
633 is really a singleton. When we use scratch iterator objects to
634 move around the buffer, we can cause the bidi cache to be pushed or
635 popped, and therefore we need to restore the cache state when we
636 return to the original iterator. */
637 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
638 do { \
639 if (CACHE) \
640 bidi_unshelve_cache (CACHE, 1); \
641 ITCOPY = ITORIG; \
642 CACHE = bidi_shelve_cache (); \
643 } while (0)
644
645 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
646 do { \
647 if (pITORIG != pITCOPY) \
648 *(pITORIG) = *(pITCOPY); \
649 bidi_unshelve_cache (CACHE, 0); \
650 CACHE = NULL; \
651 } while (0)
652
653 #ifdef GLYPH_DEBUG
654
655 /* Non-zero means print traces of redisplay if compiled with
656 GLYPH_DEBUG defined. */
657
658 int trace_redisplay_p;
659
660 #endif /* GLYPH_DEBUG */
661
662 #ifdef DEBUG_TRACE_MOVE
663 /* Non-zero means trace with TRACE_MOVE to stderr. */
664 int trace_move;
665
666 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
667 #else
668 #define TRACE_MOVE(x) (void) 0
669 #endif
670
671 static Lisp_Object Qauto_hscroll_mode;
672
673 /* Buffer being redisplayed -- for redisplay_window_error. */
674
675 static struct buffer *displayed_buffer;
676
677 /* Value returned from text property handlers (see below). */
678
679 enum prop_handled
680 {
681 HANDLED_NORMALLY,
682 HANDLED_RECOMPUTE_PROPS,
683 HANDLED_OVERLAY_STRING_CONSUMED,
684 HANDLED_RETURN
685 };
686
687 /* A description of text properties that redisplay is interested
688 in. */
689
690 struct props
691 {
692 /* The name of the property. */
693 Lisp_Object *name;
694
695 /* A unique index for the property. */
696 enum prop_idx idx;
697
698 /* A handler function called to set up iterator IT from the property
699 at IT's current position. Value is used to steer handle_stop. */
700 enum prop_handled (*handler) (struct it *it);
701 };
702
703 static enum prop_handled handle_face_prop (struct it *);
704 static enum prop_handled handle_invisible_prop (struct it *);
705 static enum prop_handled handle_display_prop (struct it *);
706 static enum prop_handled handle_composition_prop (struct it *);
707 static enum prop_handled handle_overlay_change (struct it *);
708 static enum prop_handled handle_fontified_prop (struct it *);
709
710 /* Properties handled by iterators. */
711
712 static struct props it_props[] =
713 {
714 {&Qfontified, FONTIFIED_PROP_IDX, handle_fontified_prop},
715 /* Handle `face' before `display' because some sub-properties of
716 `display' need to know the face. */
717 {&Qface, FACE_PROP_IDX, handle_face_prop},
718 {&Qdisplay, DISPLAY_PROP_IDX, handle_display_prop},
719 {&Qinvisible, INVISIBLE_PROP_IDX, handle_invisible_prop},
720 {&Qcomposition, COMPOSITION_PROP_IDX, handle_composition_prop},
721 {NULL, 0, NULL}
722 };
723
724 /* Value is the position described by X. If X is a marker, value is
725 the marker_position of X. Otherwise, value is X. */
726
727 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
728
729 /* Enumeration returned by some move_it_.* functions internally. */
730
731 enum move_it_result
732 {
733 /* Not used. Undefined value. */
734 MOVE_UNDEFINED,
735
736 /* Move ended at the requested buffer position or ZV. */
737 MOVE_POS_MATCH_OR_ZV,
738
739 /* Move ended at the requested X pixel position. */
740 MOVE_X_REACHED,
741
742 /* Move within a line ended at the end of a line that must be
743 continued. */
744 MOVE_LINE_CONTINUED,
745
746 /* Move within a line ended at the end of a line that would
747 be displayed truncated. */
748 MOVE_LINE_TRUNCATED,
749
750 /* Move within a line ended at a line end. */
751 MOVE_NEWLINE_OR_CR
752 };
753
754 /* This counter is used to clear the face cache every once in a while
755 in redisplay_internal. It is incremented for each redisplay.
756 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
757 cleared. */
758
759 #define CLEAR_FACE_CACHE_COUNT 500
760 static int clear_face_cache_count;
761
762 /* Similarly for the image cache. */
763
764 #ifdef HAVE_WINDOW_SYSTEM
765 #define CLEAR_IMAGE_CACHE_COUNT 101
766 static int clear_image_cache_count;
767
768 /* Null glyph slice */
769 static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
770 #endif
771
772 /* True while redisplay_internal is in progress. */
773
774 bool redisplaying_p;
775
776 static Lisp_Object Qinhibit_free_realized_faces;
777 static Lisp_Object Qmode_line_default_help_echo;
778
779 /* If a string, XTread_socket generates an event to display that string.
780 (The display is done in read_char.) */
781
782 Lisp_Object help_echo_string;
783 Lisp_Object help_echo_window;
784 Lisp_Object help_echo_object;
785 ptrdiff_t help_echo_pos;
786
787 /* Temporary variable for XTread_socket. */
788
789 Lisp_Object previous_help_echo_string;
790
791 /* Platform-independent portion of hourglass implementation. */
792
793 /* Non-zero means an hourglass cursor is currently shown. */
794 int hourglass_shown_p;
795
796 /* If non-null, an asynchronous timer that, when it expires, displays
797 an hourglass cursor on all frames. */
798 struct atimer *hourglass_atimer;
799
800 /* Name of the face used to display glyphless characters. */
801 Lisp_Object Qglyphless_char;
802
803 /* Symbol for the purpose of Vglyphless_char_display. */
804 static Lisp_Object Qglyphless_char_display;
805
806 /* Method symbols for Vglyphless_char_display. */
807 static Lisp_Object Qhex_code, Qempty_box, Qthin_space, Qzero_width;
808
809 /* Default pixel width of `thin-space' display method. */
810 #define THIN_SPACE_WIDTH 1
811
812 /* Default number of seconds to wait before displaying an hourglass
813 cursor. */
814 #define DEFAULT_HOURGLASS_DELAY 1
815
816 \f
817 /* Function prototypes. */
818
819 static void setup_for_ellipsis (struct it *, int);
820 static void set_iterator_to_next (struct it *, int);
821 static void mark_window_display_accurate_1 (struct window *, int);
822 static int single_display_spec_string_p (Lisp_Object, Lisp_Object);
823 static int display_prop_string_p (Lisp_Object, Lisp_Object);
824 static int cursor_row_p (struct glyph_row *);
825 static int redisplay_mode_lines (Lisp_Object, int);
826 static char *decode_mode_spec_coding (Lisp_Object, char *, int);
827
828 static Lisp_Object get_it_property (struct it *it, Lisp_Object prop);
829
830 static void handle_line_prefix (struct it *);
831
832 static void pint2str (char *, int, ptrdiff_t);
833 static void pint2hrstr (char *, int, ptrdiff_t);
834 static struct text_pos run_window_scroll_functions (Lisp_Object,
835 struct text_pos);
836 static void reconsider_clip_changes (struct window *, struct buffer *);
837 static int text_outside_line_unchanged_p (struct window *,
838 ptrdiff_t, ptrdiff_t);
839 static void store_mode_line_noprop_char (char);
840 static int store_mode_line_noprop (const char *, int, int);
841 static void handle_stop (struct it *);
842 static void handle_stop_backwards (struct it *, ptrdiff_t);
843 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
844 static void ensure_echo_area_buffers (void);
845 static Lisp_Object unwind_with_echo_area_buffer (Lisp_Object);
846 static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
847 static int with_echo_area_buffer (struct window *, int,
848 int (*) (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t),
849 ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
850 static void clear_garbaged_frames (void);
851 static int current_message_1 (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
852 static void pop_message (void);
853 static int truncate_message_1 (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
854 static void set_message (const char *, Lisp_Object, ptrdiff_t, int);
855 static int set_message_1 (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
856 static int display_echo_area (struct window *);
857 static int display_echo_area_1 (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
858 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t);
859 static Lisp_Object unwind_redisplay (Lisp_Object);
860 static int string_char_and_length (const unsigned char *, int *);
861 static struct text_pos display_prop_end (struct it *, Lisp_Object,
862 struct text_pos);
863 static int compute_window_start_on_continuation_line (struct window *);
864 static void insert_left_trunc_glyphs (struct it *);
865 static struct glyph_row *get_overlay_arrow_glyph_row (struct window *,
866 Lisp_Object);
867 static void extend_face_to_end_of_line (struct it *);
868 static int append_space_for_newline (struct it *, int);
869 static int cursor_row_fully_visible_p (struct window *, int, int);
870 static int try_scrolling (Lisp_Object, int, ptrdiff_t, ptrdiff_t, int, int);
871 static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
872 static int trailing_whitespace_p (ptrdiff_t);
873 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
874 static void push_it (struct it *, struct text_pos *);
875 static void iterate_out_of_display_property (struct it *);
876 static void pop_it (struct it *);
877 static void sync_frame_with_window_matrix_rows (struct window *);
878 static void select_frame_for_redisplay (Lisp_Object);
879 static void redisplay_internal (void);
880 static int echo_area_display (int);
881 static void redisplay_windows (Lisp_Object);
882 static void redisplay_window (Lisp_Object, int);
883 static Lisp_Object redisplay_window_error (Lisp_Object);
884 static Lisp_Object redisplay_window_0 (Lisp_Object);
885 static Lisp_Object redisplay_window_1 (Lisp_Object);
886 static int set_cursor_from_row (struct window *, struct glyph_row *,
887 struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
888 int, int);
889 static int update_menu_bar (struct frame *, int, int);
890 static int try_window_reusing_current_matrix (struct window *);
891 static int try_window_id (struct window *);
892 static int display_line (struct it *);
893 static int display_mode_lines (struct window *);
894 static int display_mode_line (struct window *, enum face_id, Lisp_Object);
895 static int display_mode_element (struct it *, int, int, int, Lisp_Object, Lisp_Object, int);
896 static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
897 static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
898 static void display_menu_bar (struct window *);
899 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
900 ptrdiff_t *);
901 static int display_string (const char *, Lisp_Object, Lisp_Object,
902 ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
903 static void compute_line_metrics (struct it *);
904 static void run_redisplay_end_trigger_hook (struct it *);
905 static int get_overlay_strings (struct it *, ptrdiff_t);
906 static int get_overlay_strings_1 (struct it *, ptrdiff_t, int);
907 static void next_overlay_string (struct it *);
908 static void reseat (struct it *, struct text_pos, int);
909 static void reseat_1 (struct it *, struct text_pos, int);
910 static void back_to_previous_visible_line_start (struct it *);
911 void reseat_at_previous_visible_line_start (struct it *);
912 static void reseat_at_next_visible_line_start (struct it *, int);
913 static int next_element_from_ellipsis (struct it *);
914 static int next_element_from_display_vector (struct it *);
915 static int next_element_from_string (struct it *);
916 static int next_element_from_c_string (struct it *);
917 static int next_element_from_buffer (struct it *);
918 static int next_element_from_composition (struct it *);
919 static int next_element_from_image (struct it *);
920 static int next_element_from_stretch (struct it *);
921 static void load_overlay_strings (struct it *, ptrdiff_t);
922 static int init_from_display_pos (struct it *, struct window *,
923 struct display_pos *);
924 static void reseat_to_string (struct it *, const char *,
925 Lisp_Object, ptrdiff_t, ptrdiff_t, int, int);
926 static int get_next_display_element (struct it *);
927 static enum move_it_result
928 move_it_in_display_line_to (struct it *, ptrdiff_t, int,
929 enum move_operation_enum);
930 void move_it_vertically_backward (struct it *, int);
931 static void init_to_row_start (struct it *, struct window *,
932 struct glyph_row *);
933 static int init_to_row_end (struct it *, struct window *,
934 struct glyph_row *);
935 static void back_to_previous_line_start (struct it *);
936 static int forward_to_next_line_start (struct it *, int *, struct bidi_it *);
937 static struct text_pos string_pos_nchars_ahead (struct text_pos,
938 Lisp_Object, ptrdiff_t);
939 static struct text_pos string_pos (ptrdiff_t, Lisp_Object);
940 static struct text_pos c_string_pos (ptrdiff_t, const char *, int);
941 static ptrdiff_t number_of_chars (const char *, int);
942 static void compute_stop_pos (struct it *);
943 static void compute_string_pos (struct text_pos *, struct text_pos,
944 Lisp_Object);
945 static int face_before_or_after_it_pos (struct it *, int);
946 static ptrdiff_t next_overlay_change (ptrdiff_t);
947 static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
948 Lisp_Object, struct text_pos *, ptrdiff_t, int);
949 static int handle_single_display_spec (struct it *, Lisp_Object,
950 Lisp_Object, Lisp_Object,
951 struct text_pos *, ptrdiff_t, int, int);
952 static int underlying_face_id (struct it *);
953 static int in_ellipses_for_invisible_text_p (struct display_pos *,
954 struct window *);
955
956 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
957 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
958
959 #ifdef HAVE_WINDOW_SYSTEM
960
961 static void x_consider_frame_title (Lisp_Object);
962 static int tool_bar_lines_needed (struct frame *, int *);
963 static void update_tool_bar (struct frame *, int);
964 static void build_desired_tool_bar_string (struct frame *f);
965 static int redisplay_tool_bar (struct frame *);
966 static void display_tool_bar_line (struct it *, int);
967 static void notice_overwritten_cursor (struct window *,
968 enum glyph_row_area,
969 int, int, int, int);
970 static void append_stretch_glyph (struct it *, Lisp_Object,
971 int, int, int);
972
973
974 #endif /* HAVE_WINDOW_SYSTEM */
975
976 static void produce_special_glyphs (struct it *, enum display_element_type);
977 static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
978 static int coords_in_mouse_face_p (struct window *, int, int);
979
980
981 \f
982 /***********************************************************************
983 Window display dimensions
984 ***********************************************************************/
985
986 /* Return the bottom boundary y-position for text lines in window W.
987 This is the first y position at which a line cannot start.
988 It is relative to the top of the window.
989
990 This is the height of W minus the height of a mode line, if any. */
991
992 int
993 window_text_bottom_y (struct window *w)
994 {
995 int height = WINDOW_TOTAL_HEIGHT (w);
996
997 if (WINDOW_WANTS_MODELINE_P (w))
998 height -= CURRENT_MODE_LINE_HEIGHT (w);
999 return height;
1000 }
1001
1002 /* Return the pixel width of display area AREA of window W. AREA < 0
1003 means return the total width of W, not including fringes to
1004 the left and right of the window. */
1005
1006 int
1007 window_box_width (struct window *w, int area)
1008 {
1009 int cols = XFASTINT (w->total_cols);
1010 int pixels = 0;
1011
1012 if (!w->pseudo_window_p)
1013 {
1014 cols -= WINDOW_SCROLL_BAR_COLS (w);
1015
1016 if (area == TEXT_AREA)
1017 {
1018 if (INTEGERP (w->left_margin_cols))
1019 cols -= XFASTINT (w->left_margin_cols);
1020 if (INTEGERP (w->right_margin_cols))
1021 cols -= XFASTINT (w->right_margin_cols);
1022 pixels = -WINDOW_TOTAL_FRINGE_WIDTH (w);
1023 }
1024 else if (area == LEFT_MARGIN_AREA)
1025 {
1026 cols = (INTEGERP (w->left_margin_cols)
1027 ? XFASTINT (w->left_margin_cols) : 0);
1028 pixels = 0;
1029 }
1030 else if (area == RIGHT_MARGIN_AREA)
1031 {
1032 cols = (INTEGERP (w->right_margin_cols)
1033 ? XFASTINT (w->right_margin_cols) : 0);
1034 pixels = 0;
1035 }
1036 }
1037
1038 return cols * WINDOW_FRAME_COLUMN_WIDTH (w) + pixels;
1039 }
1040
1041
1042 /* Return the pixel height of the display area of window W, not
1043 including mode lines of W, if any. */
1044
1045 int
1046 window_box_height (struct window *w)
1047 {
1048 struct frame *f = XFRAME (w->frame);
1049 int height = WINDOW_TOTAL_HEIGHT (w);
1050
1051 eassert (height >= 0);
1052
1053 /* Note: the code below that determines the mode-line/header-line
1054 height is essentially the same as that contained in the macro
1055 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1056 the appropriate glyph row has its `mode_line_p' flag set,
1057 and if it doesn't, uses estimate_mode_line_height instead. */
1058
1059 if (WINDOW_WANTS_MODELINE_P (w))
1060 {
1061 struct glyph_row *ml_row
1062 = (w->current_matrix && w->current_matrix->rows
1063 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
1064 : 0);
1065 if (ml_row && ml_row->mode_line_p)
1066 height -= ml_row->height;
1067 else
1068 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
1069 }
1070
1071 if (WINDOW_WANTS_HEADER_LINE_P (w))
1072 {
1073 struct glyph_row *hl_row
1074 = (w->current_matrix && w->current_matrix->rows
1075 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
1076 : 0);
1077 if (hl_row && hl_row->mode_line_p)
1078 height -= hl_row->height;
1079 else
1080 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
1081 }
1082
1083 /* With a very small font and a mode-line that's taller than
1084 default, we might end up with a negative height. */
1085 return max (0, height);
1086 }
1087
1088 /* Return the window-relative coordinate of the left edge of display
1089 area AREA of window W. AREA < 0 means return the left edge of the
1090 whole window, to the right of the left fringe of W. */
1091
1092 int
1093 window_box_left_offset (struct window *w, int area)
1094 {
1095 int x;
1096
1097 if (w->pseudo_window_p)
1098 return 0;
1099
1100 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
1101
1102 if (area == TEXT_AREA)
1103 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1104 + window_box_width (w, LEFT_MARGIN_AREA));
1105 else if (area == RIGHT_MARGIN_AREA)
1106 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1107 + window_box_width (w, LEFT_MARGIN_AREA)
1108 + window_box_width (w, TEXT_AREA)
1109 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1110 ? 0
1111 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
1112 else if (area == LEFT_MARGIN_AREA
1113 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1114 x += WINDOW_LEFT_FRINGE_WIDTH (w);
1115
1116 return x;
1117 }
1118
1119
1120 /* Return the window-relative coordinate of the right edge of display
1121 area AREA of window W. AREA < 0 means return the right edge of the
1122 whole window, to the left of the right fringe of W. */
1123
1124 int
1125 window_box_right_offset (struct window *w, int area)
1126 {
1127 return window_box_left_offset (w, area) + window_box_width (w, area);
1128 }
1129
1130 /* Return the frame-relative coordinate of the left edge of display
1131 area AREA of window W. AREA < 0 means return the left edge of the
1132 whole window, to the right of the left fringe of W. */
1133
1134 int
1135 window_box_left (struct window *w, int area)
1136 {
1137 struct frame *f = XFRAME (w->frame);
1138 int x;
1139
1140 if (w->pseudo_window_p)
1141 return FRAME_INTERNAL_BORDER_WIDTH (f);
1142
1143 x = (WINDOW_LEFT_EDGE_X (w)
1144 + window_box_left_offset (w, area));
1145
1146 return x;
1147 }
1148
1149
1150 /* Return the frame-relative coordinate of the right edge of display
1151 area AREA of window W. AREA < 0 means return the right edge of the
1152 whole window, to the left of the right fringe of W. */
1153
1154 int
1155 window_box_right (struct window *w, int area)
1156 {
1157 return window_box_left (w, area) + window_box_width (w, area);
1158 }
1159
1160 /* Get the bounding box of the display area AREA of window W, without
1161 mode lines, in frame-relative coordinates. AREA < 0 means the
1162 whole window, not including the left and right fringes of
1163 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1164 coordinates of the upper-left corner of the box. Return in
1165 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1166
1167 void
1168 window_box (struct window *w, int area, int *box_x, int *box_y,
1169 int *box_width, int *box_height)
1170 {
1171 if (box_width)
1172 *box_width = window_box_width (w, area);
1173 if (box_height)
1174 *box_height = window_box_height (w);
1175 if (box_x)
1176 *box_x = window_box_left (w, area);
1177 if (box_y)
1178 {
1179 *box_y = WINDOW_TOP_EDGE_Y (w);
1180 if (WINDOW_WANTS_HEADER_LINE_P (w))
1181 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1182 }
1183 }
1184
1185
1186 /* Get the bounding box of the display area AREA of window W, without
1187 mode lines. AREA < 0 means the whole window, not including the
1188 left and right fringe of the window. Return in *TOP_LEFT_X
1189 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1190 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1191 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1192 box. */
1193
1194 static inline void
1195 window_box_edges (struct window *w, int area, int *top_left_x, int *top_left_y,
1196 int *bottom_right_x, int *bottom_right_y)
1197 {
1198 window_box (w, area, top_left_x, top_left_y, bottom_right_x,
1199 bottom_right_y);
1200 *bottom_right_x += *top_left_x;
1201 *bottom_right_y += *top_left_y;
1202 }
1203
1204
1205 \f
1206 /***********************************************************************
1207 Utilities
1208 ***********************************************************************/
1209
1210 /* Return the bottom y-position of the line the iterator IT is in.
1211 This can modify IT's settings. */
1212
1213 int
1214 line_bottom_y (struct it *it)
1215 {
1216 int line_height = it->max_ascent + it->max_descent;
1217 int line_top_y = it->current_y;
1218
1219 if (line_height == 0)
1220 {
1221 if (last_height)
1222 line_height = last_height;
1223 else if (IT_CHARPOS (*it) < ZV)
1224 {
1225 move_it_by_lines (it, 1);
1226 line_height = (it->max_ascent || it->max_descent
1227 ? it->max_ascent + it->max_descent
1228 : last_height);
1229 }
1230 else
1231 {
1232 struct glyph_row *row = it->glyph_row;
1233
1234 /* Use the default character height. */
1235 it->glyph_row = NULL;
1236 it->what = IT_CHARACTER;
1237 it->c = ' ';
1238 it->len = 1;
1239 PRODUCE_GLYPHS (it);
1240 line_height = it->ascent + it->descent;
1241 it->glyph_row = row;
1242 }
1243 }
1244
1245 return line_top_y + line_height;
1246 }
1247
1248 /* Subroutine of pos_visible_p below. Extracts a display string, if
1249 any, from the display spec given as its argument. */
1250 static Lisp_Object
1251 string_from_display_spec (Lisp_Object spec)
1252 {
1253 if (CONSP (spec))
1254 {
1255 while (CONSP (spec))
1256 {
1257 if (STRINGP (XCAR (spec)))
1258 return XCAR (spec);
1259 spec = XCDR (spec);
1260 }
1261 }
1262 else if (VECTORP (spec))
1263 {
1264 ptrdiff_t i;
1265
1266 for (i = 0; i < ASIZE (spec); i++)
1267 {
1268 if (STRINGP (AREF (spec, i)))
1269 return AREF (spec, i);
1270 }
1271 return Qnil;
1272 }
1273
1274 return spec;
1275 }
1276
1277
1278 /* Limit insanely large values of W->hscroll on frame F to the largest
1279 value that will still prevent first_visible_x and last_visible_x of
1280 'struct it' from overflowing an int. */
1281 static inline int
1282 window_hscroll_limited (struct window *w, struct frame *f)
1283 {
1284 ptrdiff_t window_hscroll = w->hscroll;
1285 int window_text_width = window_box_width (w, TEXT_AREA);
1286 int colwidth = FRAME_COLUMN_WIDTH (f);
1287
1288 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1289 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1290
1291 return window_hscroll;
1292 }
1293
1294 /* Return 1 if position CHARPOS is visible in window W.
1295 CHARPOS < 0 means return info about WINDOW_END position.
1296 If visible, set *X and *Y to pixel coordinates of top left corner.
1297 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1298 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1299
1300 int
1301 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1302 int *rtop, int *rbot, int *rowh, int *vpos)
1303 {
1304 struct it it;
1305 void *itdata = bidi_shelve_cache ();
1306 struct text_pos top;
1307 int visible_p = 0;
1308 struct buffer *old_buffer = NULL;
1309
1310 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1311 return visible_p;
1312
1313 if (XBUFFER (w->buffer) != current_buffer)
1314 {
1315 old_buffer = current_buffer;
1316 set_buffer_internal_1 (XBUFFER (w->buffer));
1317 }
1318
1319 SET_TEXT_POS_FROM_MARKER (top, w->start);
1320 /* Scrolling a minibuffer window via scroll bar when the echo area
1321 shows long text sometimes resets the minibuffer contents behind
1322 our backs. */
1323 if (CHARPOS (top) > ZV)
1324 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1325
1326 /* Compute exact mode line heights. */
1327 if (WINDOW_WANTS_MODELINE_P (w))
1328 current_mode_line_height
1329 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1330 BVAR (current_buffer, mode_line_format));
1331
1332 if (WINDOW_WANTS_HEADER_LINE_P (w))
1333 current_header_line_height
1334 = display_mode_line (w, HEADER_LINE_FACE_ID,
1335 BVAR (current_buffer, header_line_format));
1336
1337 start_display (&it, w, top);
1338 move_it_to (&it, charpos, -1, it.last_visible_y-1, -1,
1339 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1340
1341 if (charpos >= 0
1342 && (((!it.bidi_p || it.bidi_it.scan_dir == 1)
1343 && IT_CHARPOS (it) >= charpos)
1344 /* When scanning backwards under bidi iteration, move_it_to
1345 stops at or _before_ CHARPOS, because it stops at or to
1346 the _right_ of the character at CHARPOS. */
1347 || (it.bidi_p && it.bidi_it.scan_dir == -1
1348 && IT_CHARPOS (it) <= charpos)))
1349 {
1350 /* We have reached CHARPOS, or passed it. How the call to
1351 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1352 or covered by a display property, move_it_to stops at the end
1353 of the invisible text, to the right of CHARPOS. (ii) If
1354 CHARPOS is in a display vector, move_it_to stops on its last
1355 glyph. */
1356 int top_x = it.current_x;
1357 int top_y = it.current_y;
1358 /* Calling line_bottom_y may change it.method, it.position, etc. */
1359 enum it_method it_method = it.method;
1360 int bottom_y = (last_height = 0, line_bottom_y (&it));
1361 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1362
1363 if (top_y < window_top_y)
1364 visible_p = bottom_y > window_top_y;
1365 else if (top_y < it.last_visible_y)
1366 visible_p = 1;
1367 if (bottom_y >= it.last_visible_y
1368 && it.bidi_p && it.bidi_it.scan_dir == -1
1369 && IT_CHARPOS (it) < charpos)
1370 {
1371 /* When the last line of the window is scanned backwards
1372 under bidi iteration, we could be duped into thinking
1373 that we have passed CHARPOS, when in fact move_it_to
1374 simply stopped short of CHARPOS because it reached
1375 last_visible_y. To see if that's what happened, we call
1376 move_it_to again with a slightly larger vertical limit,
1377 and see if it actually moved vertically; if it did, we
1378 didn't really reach CHARPOS, which is beyond window end. */
1379 struct it save_it = it;
1380 /* Why 10? because we don't know how many canonical lines
1381 will the height of the next line(s) be. So we guess. */
1382 int ten_more_lines =
1383 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w)));
1384
1385 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1386 MOVE_TO_POS | MOVE_TO_Y);
1387 if (it.current_y > top_y)
1388 visible_p = 0;
1389
1390 it = save_it;
1391 }
1392 if (visible_p)
1393 {
1394 if (it_method == GET_FROM_DISPLAY_VECTOR)
1395 {
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos < 2 || top.charpos >= charpos)
1399 top_x = it.glyph_row->x;
1400 else
1401 {
1402 struct it it2;
1403 start_display (&it2, w, top);
1404 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1405 get_next_display_element (&it2);
1406 PRODUCE_GLYPHS (&it2);
1407 if (ITERATOR_AT_END_OF_LINE_P (&it2)
1408 || it2.current_x > it2.last_visible_x)
1409 top_x = it.glyph_row->x;
1410 else
1411 {
1412 top_x = it2.current_x;
1413 top_y = it2.current_y;
1414 }
1415 }
1416 }
1417 else if (IT_CHARPOS (it) != charpos)
1418 {
1419 Lisp_Object cpos = make_number (charpos);
1420 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1421 Lisp_Object string = string_from_display_spec (spec);
1422 int newline_in_string = 0;
1423
1424 if (STRINGP (string))
1425 {
1426 const char *s = SSDATA (string);
1427 const char *e = s + SBYTES (string);
1428 while (s < e)
1429 {
1430 if (*s++ == '\n')
1431 {
1432 newline_in_string = 1;
1433 break;
1434 }
1435 }
1436 }
1437 /* The tricky code below is needed because there's a
1438 discrepancy between move_it_to and how we set cursor
1439 when the display line ends in a newline from a
1440 display string. move_it_to will stop _after_ such
1441 display strings, whereas set_cursor_from_row
1442 conspires with cursor_row_p to place the cursor on
1443 the first glyph produced from the display string. */
1444
1445 /* We have overshoot PT because it is covered by a
1446 display property whose value is a string. If the
1447 string includes embedded newlines, we are also in the
1448 wrong display line. Backtrack to the correct line,
1449 where the display string begins. */
1450 if (newline_in_string)
1451 {
1452 Lisp_Object startpos, endpos;
1453 EMACS_INT start, end;
1454 struct it it3;
1455 int it3_moved;
1456
1457 /* Find the first and the last buffer positions
1458 covered by the display string. */
1459 endpos =
1460 Fnext_single_char_property_change (cpos, Qdisplay,
1461 Qnil, Qnil);
1462 startpos =
1463 Fprevious_single_char_property_change (endpos, Qdisplay,
1464 Qnil, Qnil);
1465 start = XFASTINT (startpos);
1466 end = XFASTINT (endpos);
1467 /* Move to the last buffer position before the
1468 display property. */
1469 start_display (&it3, w, top);
1470 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1471 /* Move forward one more line if the position before
1472 the display string is a newline or if it is the
1473 rightmost character on a line that is
1474 continued or word-wrapped. */
1475 if (it3.method == GET_FROM_BUFFER
1476 && it3.c == '\n')
1477 move_it_by_lines (&it3, 1);
1478 else if (move_it_in_display_line_to (&it3, -1,
1479 it3.current_x
1480 + it3.pixel_width,
1481 MOVE_TO_X)
1482 == MOVE_LINE_CONTINUED)
1483 {
1484 move_it_by_lines (&it3, 1);
1485 /* When we are under word-wrap, the #$@%!
1486 move_it_by_lines moves 2 lines, so we need to
1487 fix that up. */
1488 if (it3.line_wrap == WORD_WRAP)
1489 move_it_by_lines (&it3, -1);
1490 }
1491
1492 /* Record the vertical coordinate of the display
1493 line where we wound up. */
1494 top_y = it3.current_y;
1495 if (it3.bidi_p)
1496 {
1497 /* When characters are reordered for display,
1498 the character displayed to the left of the
1499 display string could be _after_ the display
1500 property in the logical order. Use the
1501 smallest vertical position of these two. */
1502 start_display (&it3, w, top);
1503 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1504 if (it3.current_y < top_y)
1505 top_y = it3.current_y;
1506 }
1507 /* Move from the top of the window to the beginning
1508 of the display line where the display string
1509 begins. */
1510 start_display (&it3, w, top);
1511 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1512 /* If it3_moved stays zero after the 'while' loop
1513 below, that means we already were at a newline
1514 before the loop (e.g., the display string begins
1515 with a newline), so we don't need to (and cannot)
1516 inspect the glyphs of it3.glyph_row, because
1517 PRODUCE_GLYPHS will not produce anything for a
1518 newline, and thus it3.glyph_row stays at its
1519 stale content it got at top of the window. */
1520 it3_moved = 0;
1521 /* Finally, advance the iterator until we hit the
1522 first display element whose character position is
1523 CHARPOS, or until the first newline from the
1524 display string, which signals the end of the
1525 display line. */
1526 while (get_next_display_element (&it3))
1527 {
1528 PRODUCE_GLYPHS (&it3);
1529 if (IT_CHARPOS (it3) == charpos
1530 || ITERATOR_AT_END_OF_LINE_P (&it3))
1531 break;
1532 it3_moved = 1;
1533 set_iterator_to_next (&it3, 0);
1534 }
1535 top_x = it3.current_x - it3.pixel_width;
1536 /* Normally, we would exit the above loop because we
1537 found the display element whose character
1538 position is CHARPOS. For the contingency that we
1539 didn't, and stopped at the first newline from the
1540 display string, move back over the glyphs
1541 produced from the string, until we find the
1542 rightmost glyph not from the string. */
1543 if (it3_moved
1544 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1545 {
1546 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1547 + it3.glyph_row->used[TEXT_AREA];
1548
1549 while (EQ ((g - 1)->object, string))
1550 {
1551 --g;
1552 top_x -= g->pixel_width;
1553 }
1554 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1555 + it3.glyph_row->used[TEXT_AREA]);
1556 }
1557 }
1558 }
1559
1560 *x = top_x;
1561 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1562 *rtop = max (0, window_top_y - top_y);
1563 *rbot = max (0, bottom_y - it.last_visible_y);
1564 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1565 - max (top_y, window_top_y)));
1566 *vpos = it.vpos;
1567 }
1568 }
1569 else
1570 {
1571 /* We were asked to provide info about WINDOW_END. */
1572 struct it it2;
1573 void *it2data = NULL;
1574
1575 SAVE_IT (it2, it, it2data);
1576 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1577 move_it_by_lines (&it, 1);
1578 if (charpos < IT_CHARPOS (it)
1579 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1580 {
1581 visible_p = 1;
1582 RESTORE_IT (&it2, &it2, it2data);
1583 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1584 *x = it2.current_x;
1585 *y = it2.current_y + it2.max_ascent - it2.ascent;
1586 *rtop = max (0, -it2.current_y);
1587 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1588 - it.last_visible_y));
1589 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1590 it.last_visible_y)
1591 - max (it2.current_y,
1592 WINDOW_HEADER_LINE_HEIGHT (w))));
1593 *vpos = it2.vpos;
1594 }
1595 else
1596 bidi_unshelve_cache (it2data, 1);
1597 }
1598 bidi_unshelve_cache (itdata, 0);
1599
1600 if (old_buffer)
1601 set_buffer_internal_1 (old_buffer);
1602
1603 current_header_line_height = current_mode_line_height = -1;
1604
1605 if (visible_p && w->hscroll > 0)
1606 *x -=
1607 window_hscroll_limited (w, WINDOW_XFRAME (w))
1608 * WINDOW_FRAME_COLUMN_WIDTH (w);
1609
1610 #if 0
1611 /* Debugging code. */
1612 if (visible_p)
1613 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1614 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1615 else
1616 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1617 #endif
1618
1619 return visible_p;
1620 }
1621
1622
1623 /* Return the next character from STR. Return in *LEN the length of
1624 the character. This is like STRING_CHAR_AND_LENGTH but never
1625 returns an invalid character. If we find one, we return a `?', but
1626 with the length of the invalid character. */
1627
1628 static inline int
1629 string_char_and_length (const unsigned char *str, int *len)
1630 {
1631 int c;
1632
1633 c = STRING_CHAR_AND_LENGTH (str, *len);
1634 if (!CHAR_VALID_P (c))
1635 /* We may not change the length here because other places in Emacs
1636 don't use this function, i.e. they silently accept invalid
1637 characters. */
1638 c = '?';
1639
1640 return c;
1641 }
1642
1643
1644
1645 /* Given a position POS containing a valid character and byte position
1646 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1647
1648 static struct text_pos
1649 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1650 {
1651 eassert (STRINGP (string) && nchars >= 0);
1652
1653 if (STRING_MULTIBYTE (string))
1654 {
1655 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1656 int len;
1657
1658 while (nchars--)
1659 {
1660 string_char_and_length (p, &len);
1661 p += len;
1662 CHARPOS (pos) += 1;
1663 BYTEPOS (pos) += len;
1664 }
1665 }
1666 else
1667 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1668
1669 return pos;
1670 }
1671
1672
1673 /* Value is the text position, i.e. character and byte position,
1674 for character position CHARPOS in STRING. */
1675
1676 static inline struct text_pos
1677 string_pos (ptrdiff_t charpos, Lisp_Object string)
1678 {
1679 struct text_pos pos;
1680 eassert (STRINGP (string));
1681 eassert (charpos >= 0);
1682 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1683 return pos;
1684 }
1685
1686
1687 /* Value is a text position, i.e. character and byte position, for
1688 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1689 means recognize multibyte characters. */
1690
1691 static struct text_pos
1692 c_string_pos (ptrdiff_t charpos, const char *s, int multibyte_p)
1693 {
1694 struct text_pos pos;
1695
1696 eassert (s != NULL);
1697 eassert (charpos >= 0);
1698
1699 if (multibyte_p)
1700 {
1701 int len;
1702
1703 SET_TEXT_POS (pos, 0, 0);
1704 while (charpos--)
1705 {
1706 string_char_and_length ((const unsigned char *) s, &len);
1707 s += len;
1708 CHARPOS (pos) += 1;
1709 BYTEPOS (pos) += len;
1710 }
1711 }
1712 else
1713 SET_TEXT_POS (pos, charpos, charpos);
1714
1715 return pos;
1716 }
1717
1718
1719 /* Value is the number of characters in C string S. MULTIBYTE_P
1720 non-zero means recognize multibyte characters. */
1721
1722 static ptrdiff_t
1723 number_of_chars (const char *s, int multibyte_p)
1724 {
1725 ptrdiff_t nchars;
1726
1727 if (multibyte_p)
1728 {
1729 ptrdiff_t rest = strlen (s);
1730 int len;
1731 const unsigned char *p = (const unsigned char *) s;
1732
1733 for (nchars = 0; rest > 0; ++nchars)
1734 {
1735 string_char_and_length (p, &len);
1736 rest -= len, p += len;
1737 }
1738 }
1739 else
1740 nchars = strlen (s);
1741
1742 return nchars;
1743 }
1744
1745
1746 /* Compute byte position NEWPOS->bytepos corresponding to
1747 NEWPOS->charpos. POS is a known position in string STRING.
1748 NEWPOS->charpos must be >= POS.charpos. */
1749
1750 static void
1751 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1752 {
1753 eassert (STRINGP (string));
1754 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1755
1756 if (STRING_MULTIBYTE (string))
1757 *newpos = string_pos_nchars_ahead (pos, string,
1758 CHARPOS (*newpos) - CHARPOS (pos));
1759 else
1760 BYTEPOS (*newpos) = CHARPOS (*newpos);
1761 }
1762
1763 /* EXPORT:
1764 Return an estimation of the pixel height of mode or header lines on
1765 frame F. FACE_ID specifies what line's height to estimate. */
1766
1767 int
1768 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1769 {
1770 #ifdef HAVE_WINDOW_SYSTEM
1771 if (FRAME_WINDOW_P (f))
1772 {
1773 int height = FONT_HEIGHT (FRAME_FONT (f));
1774
1775 /* This function is called so early when Emacs starts that the face
1776 cache and mode line face are not yet initialized. */
1777 if (FRAME_FACE_CACHE (f))
1778 {
1779 struct face *face = FACE_FROM_ID (f, face_id);
1780 if (face)
1781 {
1782 if (face->font)
1783 height = FONT_HEIGHT (face->font);
1784 if (face->box_line_width > 0)
1785 height += 2 * face->box_line_width;
1786 }
1787 }
1788
1789 return height;
1790 }
1791 #endif
1792
1793 return 1;
1794 }
1795
1796 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1797 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1798 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1799 not force the value into range. */
1800
1801 void
1802 pixel_to_glyph_coords (FRAME_PTR f, register int pix_x, register int pix_y,
1803 int *x, int *y, NativeRectangle *bounds, int noclip)
1804 {
1805
1806 #ifdef HAVE_WINDOW_SYSTEM
1807 if (FRAME_WINDOW_P (f))
1808 {
1809 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1810 even for negative values. */
1811 if (pix_x < 0)
1812 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1813 if (pix_y < 0)
1814 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1815
1816 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1817 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1818
1819 if (bounds)
1820 STORE_NATIVE_RECT (*bounds,
1821 FRAME_COL_TO_PIXEL_X (f, pix_x),
1822 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1823 FRAME_COLUMN_WIDTH (f) - 1,
1824 FRAME_LINE_HEIGHT (f) - 1);
1825
1826 if (!noclip)
1827 {
1828 if (pix_x < 0)
1829 pix_x = 0;
1830 else if (pix_x > FRAME_TOTAL_COLS (f))
1831 pix_x = FRAME_TOTAL_COLS (f);
1832
1833 if (pix_y < 0)
1834 pix_y = 0;
1835 else if (pix_y > FRAME_LINES (f))
1836 pix_y = FRAME_LINES (f);
1837 }
1838 }
1839 #endif
1840
1841 *x = pix_x;
1842 *y = pix_y;
1843 }
1844
1845
1846 /* Find the glyph under window-relative coordinates X/Y in window W.
1847 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1848 strings. Return in *HPOS and *VPOS the row and column number of
1849 the glyph found. Return in *AREA the glyph area containing X.
1850 Value is a pointer to the glyph found or null if X/Y is not on
1851 text, or we can't tell because W's current matrix is not up to
1852 date. */
1853
1854 static
1855 struct glyph *
1856 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1857 int *dx, int *dy, int *area)
1858 {
1859 struct glyph *glyph, *end;
1860 struct glyph_row *row = NULL;
1861 int x0, i;
1862
1863 /* Find row containing Y. Give up if some row is not enabled. */
1864 for (i = 0; i < w->current_matrix->nrows; ++i)
1865 {
1866 row = MATRIX_ROW (w->current_matrix, i);
1867 if (!row->enabled_p)
1868 return NULL;
1869 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1870 break;
1871 }
1872
1873 *vpos = i;
1874 *hpos = 0;
1875
1876 /* Give up if Y is not in the window. */
1877 if (i == w->current_matrix->nrows)
1878 return NULL;
1879
1880 /* Get the glyph area containing X. */
1881 if (w->pseudo_window_p)
1882 {
1883 *area = TEXT_AREA;
1884 x0 = 0;
1885 }
1886 else
1887 {
1888 if (x < window_box_left_offset (w, TEXT_AREA))
1889 {
1890 *area = LEFT_MARGIN_AREA;
1891 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
1892 }
1893 else if (x < window_box_right_offset (w, TEXT_AREA))
1894 {
1895 *area = TEXT_AREA;
1896 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
1897 }
1898 else
1899 {
1900 *area = RIGHT_MARGIN_AREA;
1901 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
1902 }
1903 }
1904
1905 /* Find glyph containing X. */
1906 glyph = row->glyphs[*area];
1907 end = glyph + row->used[*area];
1908 x -= x0;
1909 while (glyph < end && x >= glyph->pixel_width)
1910 {
1911 x -= glyph->pixel_width;
1912 ++glyph;
1913 }
1914
1915 if (glyph == end)
1916 return NULL;
1917
1918 if (dx)
1919 {
1920 *dx = x;
1921 *dy = y - (row->y + row->ascent - glyph->ascent);
1922 }
1923
1924 *hpos = glyph - row->glyphs[*area];
1925 return glyph;
1926 }
1927
1928 /* Convert frame-relative x/y to coordinates relative to window W.
1929 Takes pseudo-windows into account. */
1930
1931 static void
1932 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
1933 {
1934 if (w->pseudo_window_p)
1935 {
1936 /* A pseudo-window is always full-width, and starts at the
1937 left edge of the frame, plus a frame border. */
1938 struct frame *f = XFRAME (w->frame);
1939 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
1940 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1941 }
1942 else
1943 {
1944 *x -= WINDOW_LEFT_EDGE_X (w);
1945 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1946 }
1947 }
1948
1949 #ifdef HAVE_WINDOW_SYSTEM
1950
1951 /* EXPORT:
1952 Return in RECTS[] at most N clipping rectangles for glyph string S.
1953 Return the number of stored rectangles. */
1954
1955 int
1956 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
1957 {
1958 XRectangle r;
1959
1960 if (n <= 0)
1961 return 0;
1962
1963 if (s->row->full_width_p)
1964 {
1965 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1966 r.x = WINDOW_LEFT_EDGE_X (s->w);
1967 r.width = WINDOW_TOTAL_WIDTH (s->w);
1968
1969 /* Unless displaying a mode or menu bar line, which are always
1970 fully visible, clip to the visible part of the row. */
1971 if (s->w->pseudo_window_p)
1972 r.height = s->row->visible_height;
1973 else
1974 r.height = s->height;
1975 }
1976 else
1977 {
1978 /* This is a text line that may be partially visible. */
1979 r.x = window_box_left (s->w, s->area);
1980 r.width = window_box_width (s->w, s->area);
1981 r.height = s->row->visible_height;
1982 }
1983
1984 if (s->clip_head)
1985 if (r.x < s->clip_head->x)
1986 {
1987 if (r.width >= s->clip_head->x - r.x)
1988 r.width -= s->clip_head->x - r.x;
1989 else
1990 r.width = 0;
1991 r.x = s->clip_head->x;
1992 }
1993 if (s->clip_tail)
1994 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
1995 {
1996 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
1997 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
1998 else
1999 r.width = 0;
2000 }
2001
2002 /* If S draws overlapping rows, it's sufficient to use the top and
2003 bottom of the window for clipping because this glyph string
2004 intentionally draws over other lines. */
2005 if (s->for_overlaps)
2006 {
2007 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2008 r.height = window_text_bottom_y (s->w) - r.y;
2009
2010 /* Alas, the above simple strategy does not work for the
2011 environments with anti-aliased text: if the same text is
2012 drawn onto the same place multiple times, it gets thicker.
2013 If the overlap we are processing is for the erased cursor, we
2014 take the intersection with the rectangle of the cursor. */
2015 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2016 {
2017 XRectangle rc, r_save = r;
2018
2019 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2020 rc.y = s->w->phys_cursor.y;
2021 rc.width = s->w->phys_cursor_width;
2022 rc.height = s->w->phys_cursor_height;
2023
2024 x_intersect_rectangles (&r_save, &rc, &r);
2025 }
2026 }
2027 else
2028 {
2029 /* Don't use S->y for clipping because it doesn't take partially
2030 visible lines into account. For example, it can be negative for
2031 partially visible lines at the top of a window. */
2032 if (!s->row->full_width_p
2033 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2034 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2035 else
2036 r.y = max (0, s->row->y);
2037 }
2038
2039 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2040
2041 /* If drawing the cursor, don't let glyph draw outside its
2042 advertised boundaries. Cleartype does this under some circumstances. */
2043 if (s->hl == DRAW_CURSOR)
2044 {
2045 struct glyph *glyph = s->first_glyph;
2046 int height, max_y;
2047
2048 if (s->x > r.x)
2049 {
2050 r.width -= s->x - r.x;
2051 r.x = s->x;
2052 }
2053 r.width = min (r.width, glyph->pixel_width);
2054
2055 /* If r.y is below window bottom, ensure that we still see a cursor. */
2056 height = min (glyph->ascent + glyph->descent,
2057 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2058 max_y = window_text_bottom_y (s->w) - height;
2059 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2060 if (s->ybase - glyph->ascent > max_y)
2061 {
2062 r.y = max_y;
2063 r.height = height;
2064 }
2065 else
2066 {
2067 /* Don't draw cursor glyph taller than our actual glyph. */
2068 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2069 if (height < r.height)
2070 {
2071 max_y = r.y + r.height;
2072 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2073 r.height = min (max_y - r.y, height);
2074 }
2075 }
2076 }
2077
2078 if (s->row->clip)
2079 {
2080 XRectangle r_save = r;
2081
2082 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2083 r.width = 0;
2084 }
2085
2086 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2087 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2088 {
2089 #ifdef CONVERT_FROM_XRECT
2090 CONVERT_FROM_XRECT (r, *rects);
2091 #else
2092 *rects = r;
2093 #endif
2094 return 1;
2095 }
2096 else
2097 {
2098 /* If we are processing overlapping and allowed to return
2099 multiple clipping rectangles, we exclude the row of the glyph
2100 string from the clipping rectangle. This is to avoid drawing
2101 the same text on the environment with anti-aliasing. */
2102 #ifdef CONVERT_FROM_XRECT
2103 XRectangle rs[2];
2104 #else
2105 XRectangle *rs = rects;
2106 #endif
2107 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2108
2109 if (s->for_overlaps & OVERLAPS_PRED)
2110 {
2111 rs[i] = r;
2112 if (r.y + r.height > row_y)
2113 {
2114 if (r.y < row_y)
2115 rs[i].height = row_y - r.y;
2116 else
2117 rs[i].height = 0;
2118 }
2119 i++;
2120 }
2121 if (s->for_overlaps & OVERLAPS_SUCC)
2122 {
2123 rs[i] = r;
2124 if (r.y < row_y + s->row->visible_height)
2125 {
2126 if (r.y + r.height > row_y + s->row->visible_height)
2127 {
2128 rs[i].y = row_y + s->row->visible_height;
2129 rs[i].height = r.y + r.height - rs[i].y;
2130 }
2131 else
2132 rs[i].height = 0;
2133 }
2134 i++;
2135 }
2136
2137 n = i;
2138 #ifdef CONVERT_FROM_XRECT
2139 for (i = 0; i < n; i++)
2140 CONVERT_FROM_XRECT (rs[i], rects[i]);
2141 #endif
2142 return n;
2143 }
2144 }
2145
2146 /* EXPORT:
2147 Return in *NR the clipping rectangle for glyph string S. */
2148
2149 void
2150 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2151 {
2152 get_glyph_string_clip_rects (s, nr, 1);
2153 }
2154
2155
2156 /* EXPORT:
2157 Return the position and height of the phys cursor in window W.
2158 Set w->phys_cursor_width to width of phys cursor.
2159 */
2160
2161 void
2162 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2163 struct glyph *glyph, int *xp, int *yp, int *heightp)
2164 {
2165 struct frame *f = XFRAME (WINDOW_FRAME (w));
2166 int x, y, wd, h, h0, y0;
2167
2168 /* Compute the width of the rectangle to draw. If on a stretch
2169 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2170 rectangle as wide as the glyph, but use a canonical character
2171 width instead. */
2172 wd = glyph->pixel_width - 1;
2173 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2174 wd++; /* Why? */
2175 #endif
2176
2177 x = w->phys_cursor.x;
2178 if (x < 0)
2179 {
2180 wd += x;
2181 x = 0;
2182 }
2183
2184 if (glyph->type == STRETCH_GLYPH
2185 && !x_stretch_cursor_p)
2186 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2187 w->phys_cursor_width = wd;
2188
2189 y = w->phys_cursor.y + row->ascent - glyph->ascent;
2190
2191 /* If y is below window bottom, ensure that we still see a cursor. */
2192 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2193
2194 h = max (h0, glyph->ascent + glyph->descent);
2195 h0 = min (h0, glyph->ascent + glyph->descent);
2196
2197 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2198 if (y < y0)
2199 {
2200 h = max (h - (y0 - y) + 1, h0);
2201 y = y0 - 1;
2202 }
2203 else
2204 {
2205 y0 = window_text_bottom_y (w) - h0;
2206 if (y > y0)
2207 {
2208 h += y - y0;
2209 y = y0;
2210 }
2211 }
2212
2213 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2214 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2215 *heightp = h;
2216 }
2217
2218 /*
2219 * Remember which glyph the mouse is over.
2220 */
2221
2222 void
2223 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2224 {
2225 Lisp_Object window;
2226 struct window *w;
2227 struct glyph_row *r, *gr, *end_row;
2228 enum window_part part;
2229 enum glyph_row_area area;
2230 int x, y, width, height;
2231
2232 /* Try to determine frame pixel position and size of the glyph under
2233 frame pixel coordinates X/Y on frame F. */
2234
2235 if (!f->glyphs_initialized_p
2236 || (window = window_from_coordinates (f, gx, gy, &part, 0),
2237 NILP (window)))
2238 {
2239 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2240 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2241 goto virtual_glyph;
2242 }
2243
2244 w = XWINDOW (window);
2245 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2246 height = WINDOW_FRAME_LINE_HEIGHT (w);
2247
2248 x = window_relative_x_coord (w, part, gx);
2249 y = gy - WINDOW_TOP_EDGE_Y (w);
2250
2251 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2252 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2253
2254 if (w->pseudo_window_p)
2255 {
2256 area = TEXT_AREA;
2257 part = ON_MODE_LINE; /* Don't adjust margin. */
2258 goto text_glyph;
2259 }
2260
2261 switch (part)
2262 {
2263 case ON_LEFT_MARGIN:
2264 area = LEFT_MARGIN_AREA;
2265 goto text_glyph;
2266
2267 case ON_RIGHT_MARGIN:
2268 area = RIGHT_MARGIN_AREA;
2269 goto text_glyph;
2270
2271 case ON_HEADER_LINE:
2272 case ON_MODE_LINE:
2273 gr = (part == ON_HEADER_LINE
2274 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2275 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2276 gy = gr->y;
2277 area = TEXT_AREA;
2278 goto text_glyph_row_found;
2279
2280 case ON_TEXT:
2281 area = TEXT_AREA;
2282
2283 text_glyph:
2284 gr = 0; gy = 0;
2285 for (; r <= end_row && r->enabled_p; ++r)
2286 if (r->y + r->height > y)
2287 {
2288 gr = r; gy = r->y;
2289 break;
2290 }
2291
2292 text_glyph_row_found:
2293 if (gr && gy <= y)
2294 {
2295 struct glyph *g = gr->glyphs[area];
2296 struct glyph *end = g + gr->used[area];
2297
2298 height = gr->height;
2299 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2300 if (gx + g->pixel_width > x)
2301 break;
2302
2303 if (g < end)
2304 {
2305 if (g->type == IMAGE_GLYPH)
2306 {
2307 /* Don't remember when mouse is over image, as
2308 image may have hot-spots. */
2309 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2310 return;
2311 }
2312 width = g->pixel_width;
2313 }
2314 else
2315 {
2316 /* Use nominal char spacing at end of line. */
2317 x -= gx;
2318 gx += (x / width) * width;
2319 }
2320
2321 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2322 gx += window_box_left_offset (w, area);
2323 }
2324 else
2325 {
2326 /* Use nominal line height at end of window. */
2327 gx = (x / width) * width;
2328 y -= gy;
2329 gy += (y / height) * height;
2330 }
2331 break;
2332
2333 case ON_LEFT_FRINGE:
2334 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2335 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2336 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2337 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2338 goto row_glyph;
2339
2340 case ON_RIGHT_FRINGE:
2341 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2342 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2343 : window_box_right_offset (w, TEXT_AREA));
2344 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2345 goto row_glyph;
2346
2347 case ON_SCROLL_BAR:
2348 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2349 ? 0
2350 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2351 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2352 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2353 : 0)));
2354 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2355
2356 row_glyph:
2357 gr = 0, gy = 0;
2358 for (; r <= end_row && r->enabled_p; ++r)
2359 if (r->y + r->height > y)
2360 {
2361 gr = r; gy = r->y;
2362 break;
2363 }
2364
2365 if (gr && gy <= y)
2366 height = gr->height;
2367 else
2368 {
2369 /* Use nominal line height at end of window. */
2370 y -= gy;
2371 gy += (y / height) * height;
2372 }
2373 break;
2374
2375 default:
2376 ;
2377 virtual_glyph:
2378 /* If there is no glyph under the mouse, then we divide the screen
2379 into a grid of the smallest glyph in the frame, and use that
2380 as our "glyph". */
2381
2382 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2383 round down even for negative values. */
2384 if (gx < 0)
2385 gx -= width - 1;
2386 if (gy < 0)
2387 gy -= height - 1;
2388
2389 gx = (gx / width) * width;
2390 gy = (gy / height) * height;
2391
2392 goto store_rect;
2393 }
2394
2395 gx += WINDOW_LEFT_EDGE_X (w);
2396 gy += WINDOW_TOP_EDGE_Y (w);
2397
2398 store_rect:
2399 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2400
2401 /* Visible feedback for debugging. */
2402 #if 0
2403 #if HAVE_X_WINDOWS
2404 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2405 f->output_data.x->normal_gc,
2406 gx, gy, width, height);
2407 #endif
2408 #endif
2409 }
2410
2411
2412 #endif /* HAVE_WINDOW_SYSTEM */
2413
2414 \f
2415 /***********************************************************************
2416 Lisp form evaluation
2417 ***********************************************************************/
2418
2419 /* Error handler for safe_eval and safe_call. */
2420
2421 static Lisp_Object
2422 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2423 {
2424 add_to_log ("Error during redisplay: %S signaled %S",
2425 Flist (nargs, args), arg);
2426 return Qnil;
2427 }
2428
2429 /* Call function FUNC with the rest of NARGS - 1 arguments
2430 following. Return the result, or nil if something went
2431 wrong. Prevent redisplay during the evaluation. */
2432
2433 Lisp_Object
2434 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2435 {
2436 Lisp_Object val;
2437
2438 if (inhibit_eval_during_redisplay)
2439 val = Qnil;
2440 else
2441 {
2442 va_list ap;
2443 ptrdiff_t i;
2444 ptrdiff_t count = SPECPDL_INDEX ();
2445 struct gcpro gcpro1;
2446 Lisp_Object *args = alloca (nargs * word_size);
2447
2448 args[0] = func;
2449 va_start (ap, func);
2450 for (i = 1; i < nargs; i++)
2451 args[i] = va_arg (ap, Lisp_Object);
2452 va_end (ap);
2453
2454 GCPRO1 (args[0]);
2455 gcpro1.nvars = nargs;
2456 specbind (Qinhibit_redisplay, Qt);
2457 /* Use Qt to ensure debugger does not run,
2458 so there is no possibility of wanting to redisplay. */
2459 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2460 safe_eval_handler);
2461 UNGCPRO;
2462 val = unbind_to (count, val);
2463 }
2464
2465 return val;
2466 }
2467
2468
2469 /* Call function FN with one argument ARG.
2470 Return the result, or nil if something went wrong. */
2471
2472 Lisp_Object
2473 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2474 {
2475 return safe_call (2, fn, arg);
2476 }
2477
2478 static Lisp_Object Qeval;
2479
2480 Lisp_Object
2481 safe_eval (Lisp_Object sexpr)
2482 {
2483 return safe_call1 (Qeval, sexpr);
2484 }
2485
2486 /* Call function FN with two arguments ARG1 and ARG2.
2487 Return the result, or nil if something went wrong. */
2488
2489 Lisp_Object
2490 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2491 {
2492 return safe_call (3, fn, arg1, arg2);
2493 }
2494
2495
2496 \f
2497 /***********************************************************************
2498 Debugging
2499 ***********************************************************************/
2500
2501 #if 0
2502
2503 /* Define CHECK_IT to perform sanity checks on iterators.
2504 This is for debugging. It is too slow to do unconditionally. */
2505
2506 static void
2507 check_it (struct it *it)
2508 {
2509 if (it->method == GET_FROM_STRING)
2510 {
2511 eassert (STRINGP (it->string));
2512 eassert (IT_STRING_CHARPOS (*it) >= 0);
2513 }
2514 else
2515 {
2516 eassert (IT_STRING_CHARPOS (*it) < 0);
2517 if (it->method == GET_FROM_BUFFER)
2518 {
2519 /* Check that character and byte positions agree. */
2520 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2521 }
2522 }
2523
2524 if (it->dpvec)
2525 eassert (it->current.dpvec_index >= 0);
2526 else
2527 eassert (it->current.dpvec_index < 0);
2528 }
2529
2530 #define CHECK_IT(IT) check_it ((IT))
2531
2532 #else /* not 0 */
2533
2534 #define CHECK_IT(IT) (void) 0
2535
2536 #endif /* not 0 */
2537
2538
2539 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2540
2541 /* Check that the window end of window W is what we expect it
2542 to be---the last row in the current matrix displaying text. */
2543
2544 static void
2545 check_window_end (struct window *w)
2546 {
2547 if (!MINI_WINDOW_P (w)
2548 && !NILP (w->window_end_valid))
2549 {
2550 struct glyph_row *row;
2551 eassert ((row = MATRIX_ROW (w->current_matrix,
2552 XFASTINT (w->window_end_vpos)),
2553 !row->enabled_p
2554 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2555 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2556 }
2557 }
2558
2559 #define CHECK_WINDOW_END(W) check_window_end ((W))
2560
2561 #else
2562
2563 #define CHECK_WINDOW_END(W) (void) 0
2564
2565 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2566
2567
2568 \f
2569 /***********************************************************************
2570 Iterator initialization
2571 ***********************************************************************/
2572
2573 /* Initialize IT for displaying current_buffer in window W, starting
2574 at character position CHARPOS. CHARPOS < 0 means that no buffer
2575 position is specified which is useful when the iterator is assigned
2576 a position later. BYTEPOS is the byte position corresponding to
2577 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2578
2579 If ROW is not null, calls to produce_glyphs with IT as parameter
2580 will produce glyphs in that row.
2581
2582 BASE_FACE_ID is the id of a base face to use. It must be one of
2583 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2584 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2585 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2586
2587 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2588 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2589 will be initialized to use the corresponding mode line glyph row of
2590 the desired matrix of W. */
2591
2592 void
2593 init_iterator (struct it *it, struct window *w,
2594 ptrdiff_t charpos, ptrdiff_t bytepos,
2595 struct glyph_row *row, enum face_id base_face_id)
2596 {
2597 int highlight_region_p;
2598 enum face_id remapped_base_face_id = base_face_id;
2599
2600 /* Some precondition checks. */
2601 eassert (w != NULL && it != NULL);
2602 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2603 && charpos <= ZV));
2604
2605 /* If face attributes have been changed since the last redisplay,
2606 free realized faces now because they depend on face definitions
2607 that might have changed. Don't free faces while there might be
2608 desired matrices pending which reference these faces. */
2609 if (face_change_count && !inhibit_free_realized_faces)
2610 {
2611 face_change_count = 0;
2612 free_all_realized_faces (Qnil);
2613 }
2614
2615 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2616 if (! NILP (Vface_remapping_alist))
2617 remapped_base_face_id
2618 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2619
2620 /* Use one of the mode line rows of W's desired matrix if
2621 appropriate. */
2622 if (row == NULL)
2623 {
2624 if (base_face_id == MODE_LINE_FACE_ID
2625 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2626 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2627 else if (base_face_id == HEADER_LINE_FACE_ID)
2628 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2629 }
2630
2631 /* Clear IT. */
2632 memset (it, 0, sizeof *it);
2633 it->current.overlay_string_index = -1;
2634 it->current.dpvec_index = -1;
2635 it->base_face_id = remapped_base_face_id;
2636 it->string = Qnil;
2637 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2638 it->paragraph_embedding = L2R;
2639 it->bidi_it.string.lstring = Qnil;
2640 it->bidi_it.string.s = NULL;
2641 it->bidi_it.string.bufpos = 0;
2642
2643 /* The window in which we iterate over current_buffer: */
2644 XSETWINDOW (it->window, w);
2645 it->w = w;
2646 it->f = XFRAME (w->frame);
2647
2648 it->cmp_it.id = -1;
2649
2650 /* Extra space between lines (on window systems only). */
2651 if (base_face_id == DEFAULT_FACE_ID
2652 && FRAME_WINDOW_P (it->f))
2653 {
2654 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2655 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2656 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2657 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2658 * FRAME_LINE_HEIGHT (it->f));
2659 else if (it->f->extra_line_spacing > 0)
2660 it->extra_line_spacing = it->f->extra_line_spacing;
2661 it->max_extra_line_spacing = 0;
2662 }
2663
2664 /* If realized faces have been removed, e.g. because of face
2665 attribute changes of named faces, recompute them. When running
2666 in batch mode, the face cache of the initial frame is null. If
2667 we happen to get called, make a dummy face cache. */
2668 if (FRAME_FACE_CACHE (it->f) == NULL)
2669 init_frame_faces (it->f);
2670 if (FRAME_FACE_CACHE (it->f)->used == 0)
2671 recompute_basic_faces (it->f);
2672
2673 /* Current value of the `slice', `space-width', and 'height' properties. */
2674 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
2675 it->space_width = Qnil;
2676 it->font_height = Qnil;
2677 it->override_ascent = -1;
2678
2679 /* Are control characters displayed as `^C'? */
2680 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2681
2682 /* -1 means everything between a CR and the following line end
2683 is invisible. >0 means lines indented more than this value are
2684 invisible. */
2685 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2686 ? (clip_to_bounds
2687 (-1, XINT (BVAR (current_buffer, selective_display)),
2688 PTRDIFF_MAX))
2689 : (!NILP (BVAR (current_buffer, selective_display))
2690 ? -1 : 0));
2691 it->selective_display_ellipsis_p
2692 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2693
2694 /* Display table to use. */
2695 it->dp = window_display_table (w);
2696
2697 /* Are multibyte characters enabled in current_buffer? */
2698 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2699
2700 /* Non-zero if we should highlight the region. */
2701 highlight_region_p
2702 = (!NILP (Vtransient_mark_mode)
2703 && !NILP (BVAR (current_buffer, mark_active))
2704 && XMARKER (BVAR (current_buffer, mark))->buffer != 0);
2705
2706 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2707 start and end of a visible region in window IT->w. Set both to
2708 -1 to indicate no region. */
2709 if (highlight_region_p
2710 /* Maybe highlight only in selected window. */
2711 && (/* Either show region everywhere. */
2712 highlight_nonselected_windows
2713 /* Or show region in the selected window. */
2714 || w == XWINDOW (selected_window)
2715 /* Or show the region if we are in the mini-buffer and W is
2716 the window the mini-buffer refers to. */
2717 || (MINI_WINDOW_P (XWINDOW (selected_window))
2718 && WINDOWP (minibuf_selected_window)
2719 && w == XWINDOW (minibuf_selected_window))))
2720 {
2721 ptrdiff_t markpos = marker_position (BVAR (current_buffer, mark));
2722 it->region_beg_charpos = min (PT, markpos);
2723 it->region_end_charpos = max (PT, markpos);
2724 }
2725 else
2726 it->region_beg_charpos = it->region_end_charpos = -1;
2727
2728 /* Get the position at which the redisplay_end_trigger hook should
2729 be run, if it is to be run at all. */
2730 if (MARKERP (w->redisplay_end_trigger)
2731 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2732 it->redisplay_end_trigger_charpos
2733 = marker_position (w->redisplay_end_trigger);
2734 else if (INTEGERP (w->redisplay_end_trigger))
2735 it->redisplay_end_trigger_charpos =
2736 clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger), PTRDIFF_MAX);
2737
2738 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2739
2740 /* Are lines in the display truncated? */
2741 if (base_face_id != DEFAULT_FACE_ID
2742 || it->w->hscroll
2743 || (! WINDOW_FULL_WIDTH_P (it->w)
2744 && ((!NILP (Vtruncate_partial_width_windows)
2745 && !INTEGERP (Vtruncate_partial_width_windows))
2746 || (INTEGERP (Vtruncate_partial_width_windows)
2747 && (WINDOW_TOTAL_COLS (it->w)
2748 < XINT (Vtruncate_partial_width_windows))))))
2749 it->line_wrap = TRUNCATE;
2750 else if (NILP (BVAR (current_buffer, truncate_lines)))
2751 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2752 ? WINDOW_WRAP : WORD_WRAP;
2753 else
2754 it->line_wrap = TRUNCATE;
2755
2756 /* Get dimensions of truncation and continuation glyphs. These are
2757 displayed as fringe bitmaps under X, but we need them for such
2758 frames when the fringes are turned off. But leave the dimensions
2759 zero for tooltip frames, as these glyphs look ugly there and also
2760 sabotage calculations of tooltip dimensions in x-show-tip. */
2761 #ifdef HAVE_WINDOW_SYSTEM
2762 if (!(FRAME_WINDOW_P (it->f)
2763 && FRAMEP (tip_frame)
2764 && it->f == XFRAME (tip_frame)))
2765 #endif
2766 {
2767 if (it->line_wrap == TRUNCATE)
2768 {
2769 /* We will need the truncation glyph. */
2770 eassert (it->glyph_row == NULL);
2771 produce_special_glyphs (it, IT_TRUNCATION);
2772 it->truncation_pixel_width = it->pixel_width;
2773 }
2774 else
2775 {
2776 /* We will need the continuation glyph. */
2777 eassert (it->glyph_row == NULL);
2778 produce_special_glyphs (it, IT_CONTINUATION);
2779 it->continuation_pixel_width = it->pixel_width;
2780 }
2781 }
2782
2783 /* Reset these values to zero because the produce_special_glyphs
2784 above has changed them. */
2785 it->pixel_width = it->ascent = it->descent = 0;
2786 it->phys_ascent = it->phys_descent = 0;
2787
2788 /* Set this after getting the dimensions of truncation and
2789 continuation glyphs, so that we don't produce glyphs when calling
2790 produce_special_glyphs, above. */
2791 it->glyph_row = row;
2792 it->area = TEXT_AREA;
2793
2794 /* Forget any previous info about this row being reversed. */
2795 if (it->glyph_row)
2796 it->glyph_row->reversed_p = 0;
2797
2798 /* Get the dimensions of the display area. The display area
2799 consists of the visible window area plus a horizontally scrolled
2800 part to the left of the window. All x-values are relative to the
2801 start of this total display area. */
2802 if (base_face_id != DEFAULT_FACE_ID)
2803 {
2804 /* Mode lines, menu bar in terminal frames. */
2805 it->first_visible_x = 0;
2806 it->last_visible_x = WINDOW_TOTAL_WIDTH (w);
2807 }
2808 else
2809 {
2810 it->first_visible_x =
2811 window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2812 it->last_visible_x = (it->first_visible_x
2813 + window_box_width (w, TEXT_AREA));
2814
2815 /* If we truncate lines, leave room for the truncation glyph(s) at
2816 the right margin. Otherwise, leave room for the continuation
2817 glyph(s). Done only if the window has no fringes. Since we
2818 don't know at this point whether there will be any R2L lines in
2819 the window, we reserve space for truncation/continuation glyphs
2820 even if only one of the fringes is absent. */
2821 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
2822 || (it->bidi_p && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
2823 {
2824 if (it->line_wrap == TRUNCATE)
2825 it->last_visible_x -= it->truncation_pixel_width;
2826 else
2827 it->last_visible_x -= it->continuation_pixel_width;
2828 }
2829
2830 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
2831 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
2832 }
2833
2834 /* Leave room for a border glyph. */
2835 if (!FRAME_WINDOW_P (it->f)
2836 && !WINDOW_RIGHTMOST_P (it->w))
2837 it->last_visible_x -= 1;
2838
2839 it->last_visible_y = window_text_bottom_y (w);
2840
2841 /* For mode lines and alike, arrange for the first glyph having a
2842 left box line if the face specifies a box. */
2843 if (base_face_id != DEFAULT_FACE_ID)
2844 {
2845 struct face *face;
2846
2847 it->face_id = remapped_base_face_id;
2848
2849 /* If we have a boxed mode line, make the first character appear
2850 with a left box line. */
2851 face = FACE_FROM_ID (it->f, remapped_base_face_id);
2852 if (face->box != FACE_NO_BOX)
2853 it->start_of_box_run_p = 1;
2854 }
2855
2856 /* If a buffer position was specified, set the iterator there,
2857 getting overlays and face properties from that position. */
2858 if (charpos >= BUF_BEG (current_buffer))
2859 {
2860 it->end_charpos = ZV;
2861 IT_CHARPOS (*it) = charpos;
2862
2863 /* We will rely on `reseat' to set this up properly, via
2864 handle_face_prop. */
2865 it->face_id = it->base_face_id;
2866
2867 /* Compute byte position if not specified. */
2868 if (bytepos < charpos)
2869 IT_BYTEPOS (*it) = CHAR_TO_BYTE (charpos);
2870 else
2871 IT_BYTEPOS (*it) = bytepos;
2872
2873 it->start = it->current;
2874 /* Do we need to reorder bidirectional text? Not if this is a
2875 unibyte buffer: by definition, none of the single-byte
2876 characters are strong R2L, so no reordering is needed. And
2877 bidi.c doesn't support unibyte buffers anyway. Also, don't
2878 reorder while we are loading loadup.el, since the tables of
2879 character properties needed for reordering are not yet
2880 available. */
2881 it->bidi_p =
2882 NILP (Vpurify_flag)
2883 && !NILP (BVAR (current_buffer, bidi_display_reordering))
2884 && it->multibyte_p;
2885
2886 /* If we are to reorder bidirectional text, init the bidi
2887 iterator. */
2888 if (it->bidi_p)
2889 {
2890 /* Note the paragraph direction that this buffer wants to
2891 use. */
2892 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2893 Qleft_to_right))
2894 it->paragraph_embedding = L2R;
2895 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2896 Qright_to_left))
2897 it->paragraph_embedding = R2L;
2898 else
2899 it->paragraph_embedding = NEUTRAL_DIR;
2900 bidi_unshelve_cache (NULL, 0);
2901 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
2902 &it->bidi_it);
2903 }
2904
2905 /* Compute faces etc. */
2906 reseat (it, it->current.pos, 1);
2907 }
2908
2909 CHECK_IT (it);
2910 }
2911
2912
2913 /* Initialize IT for the display of window W with window start POS. */
2914
2915 void
2916 start_display (struct it *it, struct window *w, struct text_pos pos)
2917 {
2918 struct glyph_row *row;
2919 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
2920
2921 row = w->desired_matrix->rows + first_vpos;
2922 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
2923 it->first_vpos = first_vpos;
2924
2925 /* Don't reseat to previous visible line start if current start
2926 position is in a string or image. */
2927 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
2928 {
2929 int start_at_line_beg_p;
2930 int first_y = it->current_y;
2931
2932 /* If window start is not at a line start, skip forward to POS to
2933 get the correct continuation lines width. */
2934 start_at_line_beg_p = (CHARPOS (pos) == BEGV
2935 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
2936 if (!start_at_line_beg_p)
2937 {
2938 int new_x;
2939
2940 reseat_at_previous_visible_line_start (it);
2941 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
2942
2943 new_x = it->current_x + it->pixel_width;
2944
2945 /* If lines are continued, this line may end in the middle
2946 of a multi-glyph character (e.g. a control character
2947 displayed as \003, or in the middle of an overlay
2948 string). In this case move_it_to above will not have
2949 taken us to the start of the continuation line but to the
2950 end of the continued line. */
2951 if (it->current_x > 0
2952 && it->line_wrap != TRUNCATE /* Lines are continued. */
2953 && (/* And glyph doesn't fit on the line. */
2954 new_x > it->last_visible_x
2955 /* Or it fits exactly and we're on a window
2956 system frame. */
2957 || (new_x == it->last_visible_x
2958 && FRAME_WINDOW_P (it->f)
2959 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
2960 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
2961 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
2962 {
2963 if ((it->current.dpvec_index >= 0
2964 || it->current.overlay_string_index >= 0)
2965 /* If we are on a newline from a display vector or
2966 overlay string, then we are already at the end of
2967 a screen line; no need to go to the next line in
2968 that case, as this line is not really continued.
2969 (If we do go to the next line, C-e will not DTRT.) */
2970 && it->c != '\n')
2971 {
2972 set_iterator_to_next (it, 1);
2973 move_it_in_display_line_to (it, -1, -1, 0);
2974 }
2975
2976 it->continuation_lines_width += it->current_x;
2977 }
2978 /* If the character at POS is displayed via a display
2979 vector, move_it_to above stops at the final glyph of
2980 IT->dpvec. To make the caller redisplay that character
2981 again (a.k.a. start at POS), we need to reset the
2982 dpvec_index to the beginning of IT->dpvec. */
2983 else if (it->current.dpvec_index >= 0)
2984 it->current.dpvec_index = 0;
2985
2986 /* We're starting a new display line, not affected by the
2987 height of the continued line, so clear the appropriate
2988 fields in the iterator structure. */
2989 it->max_ascent = it->max_descent = 0;
2990 it->max_phys_ascent = it->max_phys_descent = 0;
2991
2992 it->current_y = first_y;
2993 it->vpos = 0;
2994 it->current_x = it->hpos = 0;
2995 }
2996 }
2997 }
2998
2999
3000 /* Return 1 if POS is a position in ellipses displayed for invisible
3001 text. W is the window we display, for text property lookup. */
3002
3003 static int
3004 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3005 {
3006 Lisp_Object prop, window;
3007 int ellipses_p = 0;
3008 ptrdiff_t charpos = CHARPOS (pos->pos);
3009
3010 /* If POS specifies a position in a display vector, this might
3011 be for an ellipsis displayed for invisible text. We won't
3012 get the iterator set up for delivering that ellipsis unless
3013 we make sure that it gets aware of the invisible text. */
3014 if (pos->dpvec_index >= 0
3015 && pos->overlay_string_index < 0
3016 && CHARPOS (pos->string_pos) < 0
3017 && charpos > BEGV
3018 && (XSETWINDOW (window, w),
3019 prop = Fget_char_property (make_number (charpos),
3020 Qinvisible, window),
3021 !TEXT_PROP_MEANS_INVISIBLE (prop)))
3022 {
3023 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3024 window);
3025 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3026 }
3027
3028 return ellipses_p;
3029 }
3030
3031
3032 /* Initialize IT for stepping through current_buffer in window W,
3033 starting at position POS that includes overlay string and display
3034 vector/ control character translation position information. Value
3035 is zero if there are overlay strings with newlines at POS. */
3036
3037 static int
3038 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3039 {
3040 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3041 int i, overlay_strings_with_newlines = 0;
3042
3043 /* If POS specifies a position in a display vector, this might
3044 be for an ellipsis displayed for invisible text. We won't
3045 get the iterator set up for delivering that ellipsis unless
3046 we make sure that it gets aware of the invisible text. */
3047 if (in_ellipses_for_invisible_text_p (pos, w))
3048 {
3049 --charpos;
3050 bytepos = 0;
3051 }
3052
3053 /* Keep in mind: the call to reseat in init_iterator skips invisible
3054 text, so we might end up at a position different from POS. This
3055 is only a problem when POS is a row start after a newline and an
3056 overlay starts there with an after-string, and the overlay has an
3057 invisible property. Since we don't skip invisible text in
3058 display_line and elsewhere immediately after consuming the
3059 newline before the row start, such a POS will not be in a string,
3060 but the call to init_iterator below will move us to the
3061 after-string. */
3062 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3063
3064 /* This only scans the current chunk -- it should scan all chunks.
3065 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3066 to 16 in 22.1 to make this a lesser problem. */
3067 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3068 {
3069 const char *s = SSDATA (it->overlay_strings[i]);
3070 const char *e = s + SBYTES (it->overlay_strings[i]);
3071
3072 while (s < e && *s != '\n')
3073 ++s;
3074
3075 if (s < e)
3076 {
3077 overlay_strings_with_newlines = 1;
3078 break;
3079 }
3080 }
3081
3082 /* If position is within an overlay string, set up IT to the right
3083 overlay string. */
3084 if (pos->overlay_string_index >= 0)
3085 {
3086 int relative_index;
3087
3088 /* If the first overlay string happens to have a `display'
3089 property for an image, the iterator will be set up for that
3090 image, and we have to undo that setup first before we can
3091 correct the overlay string index. */
3092 if (it->method == GET_FROM_IMAGE)
3093 pop_it (it);
3094
3095 /* We already have the first chunk of overlay strings in
3096 IT->overlay_strings. Load more until the one for
3097 pos->overlay_string_index is in IT->overlay_strings. */
3098 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3099 {
3100 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3101 it->current.overlay_string_index = 0;
3102 while (n--)
3103 {
3104 load_overlay_strings (it, 0);
3105 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3106 }
3107 }
3108
3109 it->current.overlay_string_index = pos->overlay_string_index;
3110 relative_index = (it->current.overlay_string_index
3111 % OVERLAY_STRING_CHUNK_SIZE);
3112 it->string = it->overlay_strings[relative_index];
3113 eassert (STRINGP (it->string));
3114 it->current.string_pos = pos->string_pos;
3115 it->method = GET_FROM_STRING;
3116 }
3117
3118 if (CHARPOS (pos->string_pos) >= 0)
3119 {
3120 /* Recorded position is not in an overlay string, but in another
3121 string. This can only be a string from a `display' property.
3122 IT should already be filled with that string. */
3123 it->current.string_pos = pos->string_pos;
3124 eassert (STRINGP (it->string));
3125 }
3126
3127 /* Restore position in display vector translations, control
3128 character translations or ellipses. */
3129 if (pos->dpvec_index >= 0)
3130 {
3131 if (it->dpvec == NULL)
3132 get_next_display_element (it);
3133 eassert (it->dpvec && it->current.dpvec_index == 0);
3134 it->current.dpvec_index = pos->dpvec_index;
3135 }
3136
3137 CHECK_IT (it);
3138 return !overlay_strings_with_newlines;
3139 }
3140
3141
3142 /* Initialize IT for stepping through current_buffer in window W
3143 starting at ROW->start. */
3144
3145 static void
3146 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3147 {
3148 init_from_display_pos (it, w, &row->start);
3149 it->start = row->start;
3150 it->continuation_lines_width = row->continuation_lines_width;
3151 CHECK_IT (it);
3152 }
3153
3154
3155 /* Initialize IT for stepping through current_buffer in window W
3156 starting in the line following ROW, i.e. starting at ROW->end.
3157 Value is zero if there are overlay strings with newlines at ROW's
3158 end position. */
3159
3160 static int
3161 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3162 {
3163 int success = 0;
3164
3165 if (init_from_display_pos (it, w, &row->end))
3166 {
3167 if (row->continued_p)
3168 it->continuation_lines_width
3169 = row->continuation_lines_width + row->pixel_width;
3170 CHECK_IT (it);
3171 success = 1;
3172 }
3173
3174 return success;
3175 }
3176
3177
3178
3179 \f
3180 /***********************************************************************
3181 Text properties
3182 ***********************************************************************/
3183
3184 /* Called when IT reaches IT->stop_charpos. Handle text property and
3185 overlay changes. Set IT->stop_charpos to the next position where
3186 to stop. */
3187
3188 static void
3189 handle_stop (struct it *it)
3190 {
3191 enum prop_handled handled;
3192 int handle_overlay_change_p;
3193 struct props *p;
3194
3195 it->dpvec = NULL;
3196 it->current.dpvec_index = -1;
3197 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3198 it->ignore_overlay_strings_at_pos_p = 0;
3199 it->ellipsis_p = 0;
3200
3201 /* Use face of preceding text for ellipsis (if invisible) */
3202 if (it->selective_display_ellipsis_p)
3203 it->saved_face_id = it->face_id;
3204
3205 do
3206 {
3207 handled = HANDLED_NORMALLY;
3208
3209 /* Call text property handlers. */
3210 for (p = it_props; p->handler; ++p)
3211 {
3212 handled = p->handler (it);
3213
3214 if (handled == HANDLED_RECOMPUTE_PROPS)
3215 break;
3216 else if (handled == HANDLED_RETURN)
3217 {
3218 /* We still want to show before and after strings from
3219 overlays even if the actual buffer text is replaced. */
3220 if (!handle_overlay_change_p
3221 || it->sp > 1
3222 /* Don't call get_overlay_strings_1 if we already
3223 have overlay strings loaded, because doing so
3224 will load them again and push the iterator state
3225 onto the stack one more time, which is not
3226 expected by the rest of the code that processes
3227 overlay strings. */
3228 || (it->current.overlay_string_index < 0
3229 ? !get_overlay_strings_1 (it, 0, 0)
3230 : 0))
3231 {
3232 if (it->ellipsis_p)
3233 setup_for_ellipsis (it, 0);
3234 /* When handling a display spec, we might load an
3235 empty string. In that case, discard it here. We
3236 used to discard it in handle_single_display_spec,
3237 but that causes get_overlay_strings_1, above, to
3238 ignore overlay strings that we must check. */
3239 if (STRINGP (it->string) && !SCHARS (it->string))
3240 pop_it (it);
3241 return;
3242 }
3243 else if (STRINGP (it->string) && !SCHARS (it->string))
3244 pop_it (it);
3245 else
3246 {
3247 it->ignore_overlay_strings_at_pos_p = 1;
3248 it->string_from_display_prop_p = 0;
3249 it->from_disp_prop_p = 0;
3250 handle_overlay_change_p = 0;
3251 }
3252 handled = HANDLED_RECOMPUTE_PROPS;
3253 break;
3254 }
3255 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3256 handle_overlay_change_p = 0;
3257 }
3258
3259 if (handled != HANDLED_RECOMPUTE_PROPS)
3260 {
3261 /* Don't check for overlay strings below when set to deliver
3262 characters from a display vector. */
3263 if (it->method == GET_FROM_DISPLAY_VECTOR)
3264 handle_overlay_change_p = 0;
3265
3266 /* Handle overlay changes.
3267 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3268 if it finds overlays. */
3269 if (handle_overlay_change_p)
3270 handled = handle_overlay_change (it);
3271 }
3272
3273 if (it->ellipsis_p)
3274 {
3275 setup_for_ellipsis (it, 0);
3276 break;
3277 }
3278 }
3279 while (handled == HANDLED_RECOMPUTE_PROPS);
3280
3281 /* Determine where to stop next. */
3282 if (handled == HANDLED_NORMALLY)
3283 compute_stop_pos (it);
3284 }
3285
3286
3287 /* Compute IT->stop_charpos from text property and overlay change
3288 information for IT's current position. */
3289
3290 static void
3291 compute_stop_pos (struct it *it)
3292 {
3293 register INTERVAL iv, next_iv;
3294 Lisp_Object object, limit, position;
3295 ptrdiff_t charpos, bytepos;
3296
3297 if (STRINGP (it->string))
3298 {
3299 /* Strings are usually short, so don't limit the search for
3300 properties. */
3301 it->stop_charpos = it->end_charpos;
3302 object = it->string;
3303 limit = Qnil;
3304 charpos = IT_STRING_CHARPOS (*it);
3305 bytepos = IT_STRING_BYTEPOS (*it);
3306 }
3307 else
3308 {
3309 ptrdiff_t pos;
3310
3311 /* If end_charpos is out of range for some reason, such as a
3312 misbehaving display function, rationalize it (Bug#5984). */
3313 if (it->end_charpos > ZV)
3314 it->end_charpos = ZV;
3315 it->stop_charpos = it->end_charpos;
3316
3317 /* If next overlay change is in front of the current stop pos
3318 (which is IT->end_charpos), stop there. Note: value of
3319 next_overlay_change is point-max if no overlay change
3320 follows. */
3321 charpos = IT_CHARPOS (*it);
3322 bytepos = IT_BYTEPOS (*it);
3323 pos = next_overlay_change (charpos);
3324 if (pos < it->stop_charpos)
3325 it->stop_charpos = pos;
3326
3327 /* If showing the region, we have to stop at the region
3328 start or end because the face might change there. */
3329 if (it->region_beg_charpos > 0)
3330 {
3331 if (IT_CHARPOS (*it) < it->region_beg_charpos)
3332 it->stop_charpos = min (it->stop_charpos, it->region_beg_charpos);
3333 else if (IT_CHARPOS (*it) < it->region_end_charpos)
3334 it->stop_charpos = min (it->stop_charpos, it->region_end_charpos);
3335 }
3336
3337 /* Set up variables for computing the stop position from text
3338 property changes. */
3339 XSETBUFFER (object, current_buffer);
3340 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3341 }
3342
3343 /* Get the interval containing IT's position. Value is a null
3344 interval if there isn't such an interval. */
3345 position = make_number (charpos);
3346 iv = validate_interval_range (object, &position, &position, 0);
3347 if (iv)
3348 {
3349 Lisp_Object values_here[LAST_PROP_IDX];
3350 struct props *p;
3351
3352 /* Get properties here. */
3353 for (p = it_props; p->handler; ++p)
3354 values_here[p->idx] = textget (iv->plist, *p->name);
3355
3356 /* Look for an interval following iv that has different
3357 properties. */
3358 for (next_iv = next_interval (iv);
3359 (next_iv
3360 && (NILP (limit)
3361 || XFASTINT (limit) > next_iv->position));
3362 next_iv = next_interval (next_iv))
3363 {
3364 for (p = it_props; p->handler; ++p)
3365 {
3366 Lisp_Object new_value;
3367
3368 new_value = textget (next_iv->plist, *p->name);
3369 if (!EQ (values_here[p->idx], new_value))
3370 break;
3371 }
3372
3373 if (p->handler)
3374 break;
3375 }
3376
3377 if (next_iv)
3378 {
3379 if (INTEGERP (limit)
3380 && next_iv->position >= XFASTINT (limit))
3381 /* No text property change up to limit. */
3382 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3383 else
3384 /* Text properties change in next_iv. */
3385 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3386 }
3387 }
3388
3389 if (it->cmp_it.id < 0)
3390 {
3391 ptrdiff_t stoppos = it->end_charpos;
3392
3393 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3394 stoppos = -1;
3395 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3396 stoppos, it->string);
3397 }
3398
3399 eassert (STRINGP (it->string)
3400 || (it->stop_charpos >= BEGV
3401 && it->stop_charpos >= IT_CHARPOS (*it)));
3402 }
3403
3404
3405 /* Return the position of the next overlay change after POS in
3406 current_buffer. Value is point-max if no overlay change
3407 follows. This is like `next-overlay-change' but doesn't use
3408 xmalloc. */
3409
3410 static ptrdiff_t
3411 next_overlay_change (ptrdiff_t pos)
3412 {
3413 ptrdiff_t i, noverlays;
3414 ptrdiff_t endpos;
3415 Lisp_Object *overlays;
3416
3417 /* Get all overlays at the given position. */
3418 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, 1);
3419
3420 /* If any of these overlays ends before endpos,
3421 use its ending point instead. */
3422 for (i = 0; i < noverlays; ++i)
3423 {
3424 Lisp_Object oend;
3425 ptrdiff_t oendpos;
3426
3427 oend = OVERLAY_END (overlays[i]);
3428 oendpos = OVERLAY_POSITION (oend);
3429 endpos = min (endpos, oendpos);
3430 }
3431
3432 return endpos;
3433 }
3434
3435 /* How many characters forward to search for a display property or
3436 display string. Searching too far forward makes the bidi display
3437 sluggish, especially in small windows. */
3438 #define MAX_DISP_SCAN 250
3439
3440 /* Return the character position of a display string at or after
3441 position specified by POSITION. If no display string exists at or
3442 after POSITION, return ZV. A display string is either an overlay
3443 with `display' property whose value is a string, or a `display'
3444 text property whose value is a string. STRING is data about the
3445 string to iterate; if STRING->lstring is nil, we are iterating a
3446 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3447 on a GUI frame. DISP_PROP is set to zero if we searched
3448 MAX_DISP_SCAN characters forward without finding any display
3449 strings, non-zero otherwise. It is set to 2 if the display string
3450 uses any kind of `(space ...)' spec that will produce a stretch of
3451 white space in the text area. */
3452 ptrdiff_t
3453 compute_display_string_pos (struct text_pos *position,
3454 struct bidi_string_data *string,
3455 int frame_window_p, int *disp_prop)
3456 {
3457 /* OBJECT = nil means current buffer. */
3458 Lisp_Object object =
3459 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3460 Lisp_Object pos, spec, limpos;
3461 int string_p = (string && (STRINGP (string->lstring) || string->s));
3462 ptrdiff_t eob = string_p ? string->schars : ZV;
3463 ptrdiff_t begb = string_p ? 0 : BEGV;
3464 ptrdiff_t bufpos, charpos = CHARPOS (*position);
3465 ptrdiff_t lim =
3466 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3467 struct text_pos tpos;
3468 int rv = 0;
3469
3470 *disp_prop = 1;
3471
3472 if (charpos >= eob
3473 /* We don't support display properties whose values are strings
3474 that have display string properties. */
3475 || string->from_disp_str
3476 /* C strings cannot have display properties. */
3477 || (string->s && !STRINGP (object)))
3478 {
3479 *disp_prop = 0;
3480 return eob;
3481 }
3482
3483 /* If the character at CHARPOS is where the display string begins,
3484 return CHARPOS. */
3485 pos = make_number (charpos);
3486 if (STRINGP (object))
3487 bufpos = string->bufpos;
3488 else
3489 bufpos = charpos;
3490 tpos = *position;
3491 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3492 && (charpos <= begb
3493 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3494 object),
3495 spec))
3496 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3497 frame_window_p)))
3498 {
3499 if (rv == 2)
3500 *disp_prop = 2;
3501 return charpos;
3502 }
3503
3504 /* Look forward for the first character with a `display' property
3505 that will replace the underlying text when displayed. */
3506 limpos = make_number (lim);
3507 do {
3508 pos = Fnext_single_char_property_change (pos, Qdisplay, object, limpos);
3509 CHARPOS (tpos) = XFASTINT (pos);
3510 if (CHARPOS (tpos) >= lim)
3511 {
3512 *disp_prop = 0;
3513 break;
3514 }
3515 if (STRINGP (object))
3516 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3517 else
3518 BYTEPOS (tpos) = CHAR_TO_BYTE (CHARPOS (tpos));
3519 spec = Fget_char_property (pos, Qdisplay, object);
3520 if (!STRINGP (object))
3521 bufpos = CHARPOS (tpos);
3522 } while (NILP (spec)
3523 || !(rv = handle_display_spec (NULL, spec, object, Qnil, &tpos,
3524 bufpos, frame_window_p)));
3525 if (rv == 2)
3526 *disp_prop = 2;
3527
3528 return CHARPOS (tpos);
3529 }
3530
3531 /* Return the character position of the end of the display string that
3532 started at CHARPOS. If there's no display string at CHARPOS,
3533 return -1. A display string is either an overlay with `display'
3534 property whose value is a string or a `display' text property whose
3535 value is a string. */
3536 ptrdiff_t
3537 compute_display_string_end (ptrdiff_t charpos, struct bidi_string_data *string)
3538 {
3539 /* OBJECT = nil means current buffer. */
3540 Lisp_Object object =
3541 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3542 Lisp_Object pos = make_number (charpos);
3543 ptrdiff_t eob =
3544 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3545
3546 if (charpos >= eob || (string->s && !STRINGP (object)))
3547 return eob;
3548
3549 /* It could happen that the display property or overlay was removed
3550 since we found it in compute_display_string_pos above. One way
3551 this can happen is if JIT font-lock was called (through
3552 handle_fontified_prop), and jit-lock-functions remove text
3553 properties or overlays from the portion of buffer that includes
3554 CHARPOS. Muse mode is known to do that, for example. In this
3555 case, we return -1 to the caller, to signal that no display
3556 string is actually present at CHARPOS. See bidi_fetch_char for
3557 how this is handled.
3558
3559 An alternative would be to never look for display properties past
3560 it->stop_charpos. But neither compute_display_string_pos nor
3561 bidi_fetch_char that calls it know or care where the next
3562 stop_charpos is. */
3563 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3564 return -1;
3565
3566 /* Look forward for the first character where the `display' property
3567 changes. */
3568 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3569
3570 return XFASTINT (pos);
3571 }
3572
3573
3574 \f
3575 /***********************************************************************
3576 Fontification
3577 ***********************************************************************/
3578
3579 /* Handle changes in the `fontified' property of the current buffer by
3580 calling hook functions from Qfontification_functions to fontify
3581 regions of text. */
3582
3583 static enum prop_handled
3584 handle_fontified_prop (struct it *it)
3585 {
3586 Lisp_Object prop, pos;
3587 enum prop_handled handled = HANDLED_NORMALLY;
3588
3589 if (!NILP (Vmemory_full))
3590 return handled;
3591
3592 /* Get the value of the `fontified' property at IT's current buffer
3593 position. (The `fontified' property doesn't have a special
3594 meaning in strings.) If the value is nil, call functions from
3595 Qfontification_functions. */
3596 if (!STRINGP (it->string)
3597 && it->s == NULL
3598 && !NILP (Vfontification_functions)
3599 && !NILP (Vrun_hooks)
3600 && (pos = make_number (IT_CHARPOS (*it)),
3601 prop = Fget_char_property (pos, Qfontified, Qnil),
3602 /* Ignore the special cased nil value always present at EOB since
3603 no amount of fontifying will be able to change it. */
3604 NILP (prop) && IT_CHARPOS (*it) < Z))
3605 {
3606 ptrdiff_t count = SPECPDL_INDEX ();
3607 Lisp_Object val;
3608 struct buffer *obuf = current_buffer;
3609 int begv = BEGV, zv = ZV;
3610 int old_clip_changed = current_buffer->clip_changed;
3611
3612 val = Vfontification_functions;
3613 specbind (Qfontification_functions, Qnil);
3614
3615 eassert (it->end_charpos == ZV);
3616
3617 if (!CONSP (val) || EQ (XCAR (val), Qlambda))
3618 safe_call1 (val, pos);
3619 else
3620 {
3621 Lisp_Object fns, fn;
3622 struct gcpro gcpro1, gcpro2;
3623
3624 fns = Qnil;
3625 GCPRO2 (val, fns);
3626
3627 for (; CONSP (val); val = XCDR (val))
3628 {
3629 fn = XCAR (val);
3630
3631 if (EQ (fn, Qt))
3632 {
3633 /* A value of t indicates this hook has a local
3634 binding; it means to run the global binding too.
3635 In a global value, t should not occur. If it
3636 does, we must ignore it to avoid an endless
3637 loop. */
3638 for (fns = Fdefault_value (Qfontification_functions);
3639 CONSP (fns);
3640 fns = XCDR (fns))
3641 {
3642 fn = XCAR (fns);
3643 if (!EQ (fn, Qt))
3644 safe_call1 (fn, pos);
3645 }
3646 }
3647 else
3648 safe_call1 (fn, pos);
3649 }
3650
3651 UNGCPRO;
3652 }
3653
3654 unbind_to (count, Qnil);
3655
3656 /* Fontification functions routinely call `save-restriction'.
3657 Normally, this tags clip_changed, which can confuse redisplay
3658 (see discussion in Bug#6671). Since we don't perform any
3659 special handling of fontification changes in the case where
3660 `save-restriction' isn't called, there's no point doing so in
3661 this case either. So, if the buffer's restrictions are
3662 actually left unchanged, reset clip_changed. */
3663 if (obuf == current_buffer)
3664 {
3665 if (begv == BEGV && zv == ZV)
3666 current_buffer->clip_changed = old_clip_changed;
3667 }
3668 /* There isn't much we can reasonably do to protect against
3669 misbehaving fontification, but here's a fig leaf. */
3670 else if (!NILP (BVAR (obuf, name)))
3671 set_buffer_internal_1 (obuf);
3672
3673 /* The fontification code may have added/removed text.
3674 It could do even a lot worse, but let's at least protect against
3675 the most obvious case where only the text past `pos' gets changed',
3676 as is/was done in grep.el where some escapes sequences are turned
3677 into face properties (bug#7876). */
3678 it->end_charpos = ZV;
3679
3680 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3681 something. This avoids an endless loop if they failed to
3682 fontify the text for which reason ever. */
3683 if (!NILP (Fget_char_property (pos, Qfontified, Qnil)))
3684 handled = HANDLED_RECOMPUTE_PROPS;
3685 }
3686
3687 return handled;
3688 }
3689
3690
3691 \f
3692 /***********************************************************************
3693 Faces
3694 ***********************************************************************/
3695
3696 /* Set up iterator IT from face properties at its current position.
3697 Called from handle_stop. */
3698
3699 static enum prop_handled
3700 handle_face_prop (struct it *it)
3701 {
3702 int new_face_id;
3703 ptrdiff_t next_stop;
3704
3705 if (!STRINGP (it->string))
3706 {
3707 new_face_id
3708 = face_at_buffer_position (it->w,
3709 IT_CHARPOS (*it),
3710 it->region_beg_charpos,
3711 it->region_end_charpos,
3712 &next_stop,
3713 (IT_CHARPOS (*it)
3714 + TEXT_PROP_DISTANCE_LIMIT),
3715 0, it->base_face_id);
3716
3717 /* Is this a start of a run of characters with box face?
3718 Caveat: this can be called for a freshly initialized
3719 iterator; face_id is -1 in this case. We know that the new
3720 face will not change until limit, i.e. if the new face has a
3721 box, all characters up to limit will have one. But, as
3722 usual, we don't know whether limit is really the end. */
3723 if (new_face_id != it->face_id)
3724 {
3725 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3726
3727 /* If new face has a box but old face has not, this is
3728 the start of a run of characters with box, i.e. it has
3729 a shadow on the left side. The value of face_id of the
3730 iterator will be -1 if this is the initial call that gets
3731 the face. In this case, we have to look in front of IT's
3732 position and see whether there is a face != new_face_id. */
3733 it->start_of_box_run_p
3734 = (new_face->box != FACE_NO_BOX
3735 && (it->face_id >= 0
3736 || IT_CHARPOS (*it) == BEG
3737 || new_face_id != face_before_it_pos (it)));
3738 it->face_box_p = new_face->box != FACE_NO_BOX;
3739 }
3740 }
3741 else
3742 {
3743 int base_face_id;
3744 ptrdiff_t bufpos;
3745 int i;
3746 Lisp_Object from_overlay
3747 = (it->current.overlay_string_index >= 0
3748 ? it->string_overlays[it->current.overlay_string_index
3749 % OVERLAY_STRING_CHUNK_SIZE]
3750 : Qnil);
3751
3752 /* See if we got to this string directly or indirectly from
3753 an overlay property. That includes the before-string or
3754 after-string of an overlay, strings in display properties
3755 provided by an overlay, their text properties, etc.
3756
3757 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3758 if (! NILP (from_overlay))
3759 for (i = it->sp - 1; i >= 0; i--)
3760 {
3761 if (it->stack[i].current.overlay_string_index >= 0)
3762 from_overlay
3763 = it->string_overlays[it->stack[i].current.overlay_string_index
3764 % OVERLAY_STRING_CHUNK_SIZE];
3765 else if (! NILP (it->stack[i].from_overlay))
3766 from_overlay = it->stack[i].from_overlay;
3767
3768 if (!NILP (from_overlay))
3769 break;
3770 }
3771
3772 if (! NILP (from_overlay))
3773 {
3774 bufpos = IT_CHARPOS (*it);
3775 /* For a string from an overlay, the base face depends
3776 only on text properties and ignores overlays. */
3777 base_face_id
3778 = face_for_overlay_string (it->w,
3779 IT_CHARPOS (*it),
3780 it->region_beg_charpos,
3781 it->region_end_charpos,
3782 &next_stop,
3783 (IT_CHARPOS (*it)
3784 + TEXT_PROP_DISTANCE_LIMIT),
3785 0,
3786 from_overlay);
3787 }
3788 else
3789 {
3790 bufpos = 0;
3791
3792 /* For strings from a `display' property, use the face at
3793 IT's current buffer position as the base face to merge
3794 with, so that overlay strings appear in the same face as
3795 surrounding text, unless they specify their own
3796 faces. */
3797 base_face_id = it->string_from_prefix_prop_p
3798 ? DEFAULT_FACE_ID
3799 : underlying_face_id (it);
3800 }
3801
3802 new_face_id = face_at_string_position (it->w,
3803 it->string,
3804 IT_STRING_CHARPOS (*it),
3805 bufpos,
3806 it->region_beg_charpos,
3807 it->region_end_charpos,
3808 &next_stop,
3809 base_face_id, 0);
3810
3811 /* Is this a start of a run of characters with box? Caveat:
3812 this can be called for a freshly allocated iterator; face_id
3813 is -1 is this case. We know that the new face will not
3814 change until the next check pos, i.e. if the new face has a
3815 box, all characters up to that position will have a
3816 box. But, as usual, we don't know whether that position
3817 is really the end. */
3818 if (new_face_id != it->face_id)
3819 {
3820 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3821 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
3822
3823 /* If new face has a box but old face hasn't, this is the
3824 start of a run of characters with box, i.e. it has a
3825 shadow on the left side. */
3826 it->start_of_box_run_p
3827 = new_face->box && (old_face == NULL || !old_face->box);
3828 it->face_box_p = new_face->box != FACE_NO_BOX;
3829 }
3830 }
3831
3832 it->face_id = new_face_id;
3833 return HANDLED_NORMALLY;
3834 }
3835
3836
3837 /* Return the ID of the face ``underlying'' IT's current position,
3838 which is in a string. If the iterator is associated with a
3839 buffer, return the face at IT's current buffer position.
3840 Otherwise, use the iterator's base_face_id. */
3841
3842 static int
3843 underlying_face_id (struct it *it)
3844 {
3845 int face_id = it->base_face_id, i;
3846
3847 eassert (STRINGP (it->string));
3848
3849 for (i = it->sp - 1; i >= 0; --i)
3850 if (NILP (it->stack[i].string))
3851 face_id = it->stack[i].face_id;
3852
3853 return face_id;
3854 }
3855
3856
3857 /* Compute the face one character before or after the current position
3858 of IT, in the visual order. BEFORE_P non-zero means get the face
3859 in front (to the left in L2R paragraphs, to the right in R2L
3860 paragraphs) of IT's screen position. Value is the ID of the face. */
3861
3862 static int
3863 face_before_or_after_it_pos (struct it *it, int before_p)
3864 {
3865 int face_id, limit;
3866 ptrdiff_t next_check_charpos;
3867 struct it it_copy;
3868 void *it_copy_data = NULL;
3869
3870 eassert (it->s == NULL);
3871
3872 if (STRINGP (it->string))
3873 {
3874 ptrdiff_t bufpos, charpos;
3875 int base_face_id;
3876
3877 /* No face change past the end of the string (for the case
3878 we are padding with spaces). No face change before the
3879 string start. */
3880 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
3881 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
3882 return it->face_id;
3883
3884 if (!it->bidi_p)
3885 {
3886 /* Set charpos to the position before or after IT's current
3887 position, in the logical order, which in the non-bidi
3888 case is the same as the visual order. */
3889 if (before_p)
3890 charpos = IT_STRING_CHARPOS (*it) - 1;
3891 else if (it->what == IT_COMPOSITION)
3892 /* For composition, we must check the character after the
3893 composition. */
3894 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
3895 else
3896 charpos = IT_STRING_CHARPOS (*it) + 1;
3897 }
3898 else
3899 {
3900 if (before_p)
3901 {
3902 /* With bidi iteration, the character before the current
3903 in the visual order cannot be found by simple
3904 iteration, because "reverse" reordering is not
3905 supported. Instead, we need to use the move_it_*
3906 family of functions. */
3907 /* Ignore face changes before the first visible
3908 character on this display line. */
3909 if (it->current_x <= it->first_visible_x)
3910 return it->face_id;
3911 SAVE_IT (it_copy, *it, it_copy_data);
3912 /* Implementation note: Since move_it_in_display_line
3913 works in the iterator geometry, and thinks the first
3914 character is always the leftmost, even in R2L lines,
3915 we don't need to distinguish between the R2L and L2R
3916 cases here. */
3917 move_it_in_display_line (&it_copy, SCHARS (it_copy.string),
3918 it_copy.current_x - 1, MOVE_TO_X);
3919 charpos = IT_STRING_CHARPOS (it_copy);
3920 RESTORE_IT (it, it, it_copy_data);
3921 }
3922 else
3923 {
3924 /* Set charpos to the string position of the character
3925 that comes after IT's current position in the visual
3926 order. */
3927 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
3928
3929 it_copy = *it;
3930 while (n--)
3931 bidi_move_to_visually_next (&it_copy.bidi_it);
3932
3933 charpos = it_copy.bidi_it.charpos;
3934 }
3935 }
3936 eassert (0 <= charpos && charpos <= SCHARS (it->string));
3937
3938 if (it->current.overlay_string_index >= 0)
3939 bufpos = IT_CHARPOS (*it);
3940 else
3941 bufpos = 0;
3942
3943 base_face_id = underlying_face_id (it);
3944
3945 /* Get the face for ASCII, or unibyte. */
3946 face_id = face_at_string_position (it->w,
3947 it->string,
3948 charpos,
3949 bufpos,
3950 it->region_beg_charpos,
3951 it->region_end_charpos,
3952 &next_check_charpos,
3953 base_face_id, 0);
3954
3955 /* Correct the face for charsets different from ASCII. Do it
3956 for the multibyte case only. The face returned above is
3957 suitable for unibyte text if IT->string is unibyte. */
3958 if (STRING_MULTIBYTE (it->string))
3959 {
3960 struct text_pos pos1 = string_pos (charpos, it->string);
3961 const unsigned char *p = SDATA (it->string) + BYTEPOS (pos1);
3962 int c, len;
3963 struct face *face = FACE_FROM_ID (it->f, face_id);
3964
3965 c = string_char_and_length (p, &len);
3966 face_id = FACE_FOR_CHAR (it->f, face, c, charpos, it->string);
3967 }
3968 }
3969 else
3970 {
3971 struct text_pos pos;
3972
3973 if ((IT_CHARPOS (*it) >= ZV && !before_p)
3974 || (IT_CHARPOS (*it) <= BEGV && before_p))
3975 return it->face_id;
3976
3977 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
3978 pos = it->current.pos;
3979
3980 if (!it->bidi_p)
3981 {
3982 if (before_p)
3983 DEC_TEXT_POS (pos, it->multibyte_p);
3984 else
3985 {
3986 if (it->what == IT_COMPOSITION)
3987 {
3988 /* For composition, we must check the position after
3989 the composition. */
3990 pos.charpos += it->cmp_it.nchars;
3991 pos.bytepos += it->len;
3992 }
3993 else
3994 INC_TEXT_POS (pos, it->multibyte_p);
3995 }
3996 }
3997 else
3998 {
3999 if (before_p)
4000 {
4001 /* With bidi iteration, the character before the current
4002 in the visual order cannot be found by simple
4003 iteration, because "reverse" reordering is not
4004 supported. Instead, we need to use the move_it_*
4005 family of functions. */
4006 /* Ignore face changes before the first visible
4007 character on this display line. */
4008 if (it->current_x <= it->first_visible_x)
4009 return it->face_id;
4010 SAVE_IT (it_copy, *it, it_copy_data);
4011 /* Implementation note: Since move_it_in_display_line
4012 works in the iterator geometry, and thinks the first
4013 character is always the leftmost, even in R2L lines,
4014 we don't need to distinguish between the R2L and L2R
4015 cases here. */
4016 move_it_in_display_line (&it_copy, ZV,
4017 it_copy.current_x - 1, MOVE_TO_X);
4018 pos = it_copy.current.pos;
4019 RESTORE_IT (it, it, it_copy_data);
4020 }
4021 else
4022 {
4023 /* Set charpos to the buffer position of the character
4024 that comes after IT's current position in the visual
4025 order. */
4026 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4027
4028 it_copy = *it;
4029 while (n--)
4030 bidi_move_to_visually_next (&it_copy.bidi_it);
4031
4032 SET_TEXT_POS (pos,
4033 it_copy.bidi_it.charpos, it_copy.bidi_it.bytepos);
4034 }
4035 }
4036 eassert (BEGV <= CHARPOS (pos) && CHARPOS (pos) <= ZV);
4037
4038 /* Determine face for CHARSET_ASCII, or unibyte. */
4039 face_id = face_at_buffer_position (it->w,
4040 CHARPOS (pos),
4041 it->region_beg_charpos,
4042 it->region_end_charpos,
4043 &next_check_charpos,
4044 limit, 0, -1);
4045
4046 /* Correct the face for charsets different from ASCII. Do it
4047 for the multibyte case only. The face returned above is
4048 suitable for unibyte text if current_buffer is unibyte. */
4049 if (it->multibyte_p)
4050 {
4051 int c = FETCH_MULTIBYTE_CHAR (BYTEPOS (pos));
4052 struct face *face = FACE_FROM_ID (it->f, face_id);
4053 face_id = FACE_FOR_CHAR (it->f, face, c, CHARPOS (pos), Qnil);
4054 }
4055 }
4056
4057 return face_id;
4058 }
4059
4060
4061 \f
4062 /***********************************************************************
4063 Invisible text
4064 ***********************************************************************/
4065
4066 /* Set up iterator IT from invisible properties at its current
4067 position. Called from handle_stop. */
4068
4069 static enum prop_handled
4070 handle_invisible_prop (struct it *it)
4071 {
4072 enum prop_handled handled = HANDLED_NORMALLY;
4073 int invis_p;
4074 Lisp_Object prop;
4075
4076 if (STRINGP (it->string))
4077 {
4078 Lisp_Object end_charpos, limit, charpos;
4079
4080 /* Get the value of the invisible text property at the
4081 current position. Value will be nil if there is no such
4082 property. */
4083 charpos = make_number (IT_STRING_CHARPOS (*it));
4084 prop = Fget_text_property (charpos, Qinvisible, it->string);
4085 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4086
4087 if (invis_p && IT_STRING_CHARPOS (*it) < it->end_charpos)
4088 {
4089 /* Record whether we have to display an ellipsis for the
4090 invisible text. */
4091 int display_ellipsis_p = (invis_p == 2);
4092 ptrdiff_t len, endpos;
4093
4094 handled = HANDLED_RECOMPUTE_PROPS;
4095
4096 /* Get the position at which the next visible text can be
4097 found in IT->string, if any. */
4098 endpos = len = SCHARS (it->string);
4099 XSETINT (limit, len);
4100 do
4101 {
4102 end_charpos = Fnext_single_property_change (charpos, Qinvisible,
4103 it->string, limit);
4104 if (INTEGERP (end_charpos))
4105 {
4106 endpos = XFASTINT (end_charpos);
4107 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4108 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4109 if (invis_p == 2)
4110 display_ellipsis_p = 1;
4111 }
4112 }
4113 while (invis_p && endpos < len);
4114
4115 if (display_ellipsis_p)
4116 it->ellipsis_p = 1;
4117
4118 if (endpos < len)
4119 {
4120 /* Text at END_CHARPOS is visible. Move IT there. */
4121 struct text_pos old;
4122 ptrdiff_t oldpos;
4123
4124 old = it->current.string_pos;
4125 oldpos = CHARPOS (old);
4126 if (it->bidi_p)
4127 {
4128 if (it->bidi_it.first_elt
4129 && it->bidi_it.charpos < SCHARS (it->string))
4130 bidi_paragraph_init (it->paragraph_embedding,
4131 &it->bidi_it, 1);
4132 /* Bidi-iterate out of the invisible text. */
4133 do
4134 {
4135 bidi_move_to_visually_next (&it->bidi_it);
4136 }
4137 while (oldpos <= it->bidi_it.charpos
4138 && it->bidi_it.charpos < endpos);
4139
4140 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4141 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4142 if (IT_CHARPOS (*it) >= endpos)
4143 it->prev_stop = endpos;
4144 }
4145 else
4146 {
4147 IT_STRING_CHARPOS (*it) = XFASTINT (end_charpos);
4148 compute_string_pos (&it->current.string_pos, old, it->string);
4149 }
4150 }
4151 else
4152 {
4153 /* The rest of the string is invisible. If this is an
4154 overlay string, proceed with the next overlay string
4155 or whatever comes and return a character from there. */
4156 if (it->current.overlay_string_index >= 0
4157 && !display_ellipsis_p)
4158 {
4159 next_overlay_string (it);
4160 /* Don't check for overlay strings when we just
4161 finished processing them. */
4162 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4163 }
4164 else
4165 {
4166 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4167 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4168 }
4169 }
4170 }
4171 }
4172 else
4173 {
4174 ptrdiff_t newpos, next_stop, start_charpos, tem;
4175 Lisp_Object pos, overlay;
4176
4177 /* First of all, is there invisible text at this position? */
4178 tem = start_charpos = IT_CHARPOS (*it);
4179 pos = make_number (tem);
4180 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4181 &overlay);
4182 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4183
4184 /* If we are on invisible text, skip over it. */
4185 if (invis_p && start_charpos < it->end_charpos)
4186 {
4187 /* Record whether we have to display an ellipsis for the
4188 invisible text. */
4189 int display_ellipsis_p = invis_p == 2;
4190
4191 handled = HANDLED_RECOMPUTE_PROPS;
4192
4193 /* Loop skipping over invisible text. The loop is left at
4194 ZV or with IT on the first char being visible again. */
4195 do
4196 {
4197 /* Try to skip some invisible text. Return value is the
4198 position reached which can be equal to where we start
4199 if there is nothing invisible there. This skips both
4200 over invisible text properties and overlays with
4201 invisible property. */
4202 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4203
4204 /* If we skipped nothing at all we weren't at invisible
4205 text in the first place. If everything to the end of
4206 the buffer was skipped, end the loop. */
4207 if (newpos == tem || newpos >= ZV)
4208 invis_p = 0;
4209 else
4210 {
4211 /* We skipped some characters but not necessarily
4212 all there are. Check if we ended up on visible
4213 text. Fget_char_property returns the property of
4214 the char before the given position, i.e. if we
4215 get invis_p = 0, this means that the char at
4216 newpos is visible. */
4217 pos = make_number (newpos);
4218 prop = Fget_char_property (pos, Qinvisible, it->window);
4219 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4220 }
4221
4222 /* If we ended up on invisible text, proceed to
4223 skip starting with next_stop. */
4224 if (invis_p)
4225 tem = next_stop;
4226
4227 /* If there are adjacent invisible texts, don't lose the
4228 second one's ellipsis. */
4229 if (invis_p == 2)
4230 display_ellipsis_p = 1;
4231 }
4232 while (invis_p);
4233
4234 /* The position newpos is now either ZV or on visible text. */
4235 if (it->bidi_p)
4236 {
4237 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4238 int on_newline =
4239 bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4240 int after_newline =
4241 newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4242
4243 /* If the invisible text ends on a newline or on a
4244 character after a newline, we can avoid the costly,
4245 character by character, bidi iteration to NEWPOS, and
4246 instead simply reseat the iterator there. That's
4247 because all bidi reordering information is tossed at
4248 the newline. This is a big win for modes that hide
4249 complete lines, like Outline, Org, etc. */
4250 if (on_newline || after_newline)
4251 {
4252 struct text_pos tpos;
4253 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4254
4255 SET_TEXT_POS (tpos, newpos, bpos);
4256 reseat_1 (it, tpos, 0);
4257 /* If we reseat on a newline/ZV, we need to prep the
4258 bidi iterator for advancing to the next character
4259 after the newline/EOB, keeping the current paragraph
4260 direction (so that PRODUCE_GLYPHS does TRT wrt
4261 prepending/appending glyphs to a glyph row). */
4262 if (on_newline)
4263 {
4264 it->bidi_it.first_elt = 0;
4265 it->bidi_it.paragraph_dir = pdir;
4266 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4267 it->bidi_it.nchars = 1;
4268 it->bidi_it.ch_len = 1;
4269 }
4270 }
4271 else /* Must use the slow method. */
4272 {
4273 /* With bidi iteration, the region of invisible text
4274 could start and/or end in the middle of a
4275 non-base embedding level. Therefore, we need to
4276 skip invisible text using the bidi iterator,
4277 starting at IT's current position, until we find
4278 ourselves outside of the invisible text.
4279 Skipping invisible text _after_ bidi iteration
4280 avoids affecting the visual order of the
4281 displayed text when invisible properties are
4282 added or removed. */
4283 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4284 {
4285 /* If we were `reseat'ed to a new paragraph,
4286 determine the paragraph base direction. We
4287 need to do it now because
4288 next_element_from_buffer may not have a
4289 chance to do it, if we are going to skip any
4290 text at the beginning, which resets the
4291 FIRST_ELT flag. */
4292 bidi_paragraph_init (it->paragraph_embedding,
4293 &it->bidi_it, 1);
4294 }
4295 do
4296 {
4297 bidi_move_to_visually_next (&it->bidi_it);
4298 }
4299 while (it->stop_charpos <= it->bidi_it.charpos
4300 && it->bidi_it.charpos < newpos);
4301 IT_CHARPOS (*it) = it->bidi_it.charpos;
4302 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4303 /* If we overstepped NEWPOS, record its position in
4304 the iterator, so that we skip invisible text if
4305 later the bidi iteration lands us in the
4306 invisible region again. */
4307 if (IT_CHARPOS (*it) >= newpos)
4308 it->prev_stop = newpos;
4309 }
4310 }
4311 else
4312 {
4313 IT_CHARPOS (*it) = newpos;
4314 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
4315 }
4316
4317 /* If there are before-strings at the start of invisible
4318 text, and the text is invisible because of a text
4319 property, arrange to show before-strings because 20.x did
4320 it that way. (If the text is invisible because of an
4321 overlay property instead of a text property, this is
4322 already handled in the overlay code.) */
4323 if (NILP (overlay)
4324 && get_overlay_strings (it, it->stop_charpos))
4325 {
4326 handled = HANDLED_RECOMPUTE_PROPS;
4327 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4328 }
4329 else if (display_ellipsis_p)
4330 {
4331 /* Make sure that the glyphs of the ellipsis will get
4332 correct `charpos' values. If we would not update
4333 it->position here, the glyphs would belong to the
4334 last visible character _before_ the invisible
4335 text, which confuses `set_cursor_from_row'.
4336
4337 We use the last invisible position instead of the
4338 first because this way the cursor is always drawn on
4339 the first "." of the ellipsis, whenever PT is inside
4340 the invisible text. Otherwise the cursor would be
4341 placed _after_ the ellipsis when the point is after the
4342 first invisible character. */
4343 if (!STRINGP (it->object))
4344 {
4345 it->position.charpos = newpos - 1;
4346 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
4347 }
4348 it->ellipsis_p = 1;
4349 /* Let the ellipsis display before
4350 considering any properties of the following char.
4351 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4352 handled = HANDLED_RETURN;
4353 }
4354 }
4355 }
4356
4357 return handled;
4358 }
4359
4360
4361 /* Make iterator IT return `...' next.
4362 Replaces LEN characters from buffer. */
4363
4364 static void
4365 setup_for_ellipsis (struct it *it, int len)
4366 {
4367 /* Use the display table definition for `...'. Invalid glyphs
4368 will be handled by the method returning elements from dpvec. */
4369 if (it->dp && VECTORP (DISP_INVIS_VECTOR (it->dp)))
4370 {
4371 struct Lisp_Vector *v = XVECTOR (DISP_INVIS_VECTOR (it->dp));
4372 it->dpvec = v->contents;
4373 it->dpend = v->contents + v->header.size;
4374 }
4375 else
4376 {
4377 /* Default `...'. */
4378 it->dpvec = default_invis_vector;
4379 it->dpend = default_invis_vector + 3;
4380 }
4381
4382 it->dpvec_char_len = len;
4383 it->current.dpvec_index = 0;
4384 it->dpvec_face_id = -1;
4385
4386 /* Remember the current face id in case glyphs specify faces.
4387 IT's face is restored in set_iterator_to_next.
4388 saved_face_id was set to preceding char's face in handle_stop. */
4389 if (it->saved_face_id < 0 || it->saved_face_id != it->face_id)
4390 it->saved_face_id = it->face_id = DEFAULT_FACE_ID;
4391
4392 it->method = GET_FROM_DISPLAY_VECTOR;
4393 it->ellipsis_p = 1;
4394 }
4395
4396
4397 \f
4398 /***********************************************************************
4399 'display' property
4400 ***********************************************************************/
4401
4402 /* Set up iterator IT from `display' property at its current position.
4403 Called from handle_stop.
4404 We return HANDLED_RETURN if some part of the display property
4405 overrides the display of the buffer text itself.
4406 Otherwise we return HANDLED_NORMALLY. */
4407
4408 static enum prop_handled
4409 handle_display_prop (struct it *it)
4410 {
4411 Lisp_Object propval, object, overlay;
4412 struct text_pos *position;
4413 ptrdiff_t bufpos;
4414 /* Nonzero if some property replaces the display of the text itself. */
4415 int display_replaced_p = 0;
4416
4417 if (STRINGP (it->string))
4418 {
4419 object = it->string;
4420 position = &it->current.string_pos;
4421 bufpos = CHARPOS (it->current.pos);
4422 }
4423 else
4424 {
4425 XSETWINDOW (object, it->w);
4426 position = &it->current.pos;
4427 bufpos = CHARPOS (*position);
4428 }
4429
4430 /* Reset those iterator values set from display property values. */
4431 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4432 it->space_width = Qnil;
4433 it->font_height = Qnil;
4434 it->voffset = 0;
4435
4436 /* We don't support recursive `display' properties, i.e. string
4437 values that have a string `display' property, that have a string
4438 `display' property etc. */
4439 if (!it->string_from_display_prop_p)
4440 it->area = TEXT_AREA;
4441
4442 propval = get_char_property_and_overlay (make_number (position->charpos),
4443 Qdisplay, object, &overlay);
4444 if (NILP (propval))
4445 return HANDLED_NORMALLY;
4446 /* Now OVERLAY is the overlay that gave us this property, or nil
4447 if it was a text property. */
4448
4449 if (!STRINGP (it->string))
4450 object = it->w->buffer;
4451
4452 display_replaced_p = handle_display_spec (it, propval, object, overlay,
4453 position, bufpos,
4454 FRAME_WINDOW_P (it->f));
4455
4456 return display_replaced_p ? HANDLED_RETURN : HANDLED_NORMALLY;
4457 }
4458
4459 /* Subroutine of handle_display_prop. Returns non-zero if the display
4460 specification in SPEC is a replacing specification, i.e. it would
4461 replace the text covered by `display' property with something else,
4462 such as an image or a display string. If SPEC includes any kind or
4463 `(space ...) specification, the value is 2; this is used by
4464 compute_display_string_pos, which see.
4465
4466 See handle_single_display_spec for documentation of arguments.
4467 frame_window_p is non-zero if the window being redisplayed is on a
4468 GUI frame; this argument is used only if IT is NULL, see below.
4469
4470 IT can be NULL, if this is called by the bidi reordering code
4471 through compute_display_string_pos, which see. In that case, this
4472 function only examines SPEC, but does not otherwise "handle" it, in
4473 the sense that it doesn't set up members of IT from the display
4474 spec. */
4475 static int
4476 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4477 Lisp_Object overlay, struct text_pos *position,
4478 ptrdiff_t bufpos, int frame_window_p)
4479 {
4480 int replacing_p = 0;
4481 int rv;
4482
4483 if (CONSP (spec)
4484 /* Simple specifications. */
4485 && !EQ (XCAR (spec), Qimage)
4486 && !EQ (XCAR (spec), Qspace)
4487 && !EQ (XCAR (spec), Qwhen)
4488 && !EQ (XCAR (spec), Qslice)
4489 && !EQ (XCAR (spec), Qspace_width)
4490 && !EQ (XCAR (spec), Qheight)
4491 && !EQ (XCAR (spec), Qraise)
4492 /* Marginal area specifications. */
4493 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4494 && !EQ (XCAR (spec), Qleft_fringe)
4495 && !EQ (XCAR (spec), Qright_fringe)
4496 && !NILP (XCAR (spec)))
4497 {
4498 for (; CONSP (spec); spec = XCDR (spec))
4499 {
4500 if ((rv = handle_single_display_spec (it, XCAR (spec), object,
4501 overlay, position, bufpos,
4502 replacing_p, frame_window_p)))
4503 {
4504 replacing_p = rv;
4505 /* If some text in a string is replaced, `position' no
4506 longer points to the position of `object'. */
4507 if (!it || STRINGP (object))
4508 break;
4509 }
4510 }
4511 }
4512 else if (VECTORP (spec))
4513 {
4514 ptrdiff_t i;
4515 for (i = 0; i < ASIZE (spec); ++i)
4516 if ((rv = handle_single_display_spec (it, AREF (spec, i), object,
4517 overlay, position, bufpos,
4518 replacing_p, frame_window_p)))
4519 {
4520 replacing_p = rv;
4521 /* If some text in a string is replaced, `position' no
4522 longer points to the position of `object'. */
4523 if (!it || STRINGP (object))
4524 break;
4525 }
4526 }
4527 else
4528 {
4529 if ((rv = handle_single_display_spec (it, spec, object, overlay,
4530 position, bufpos, 0,
4531 frame_window_p)))
4532 replacing_p = rv;
4533 }
4534
4535 return replacing_p;
4536 }
4537
4538 /* Value is the position of the end of the `display' property starting
4539 at START_POS in OBJECT. */
4540
4541 static struct text_pos
4542 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4543 {
4544 Lisp_Object end;
4545 struct text_pos end_pos;
4546
4547 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4548 Qdisplay, object, Qnil);
4549 CHARPOS (end_pos) = XFASTINT (end);
4550 if (STRINGP (object))
4551 compute_string_pos (&end_pos, start_pos, it->string);
4552 else
4553 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4554
4555 return end_pos;
4556 }
4557
4558
4559 /* Set up IT from a single `display' property specification SPEC. OBJECT
4560 is the object in which the `display' property was found. *POSITION
4561 is the position in OBJECT at which the `display' property was found.
4562 BUFPOS is the buffer position of OBJECT (different from POSITION if
4563 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4564 previously saw a display specification which already replaced text
4565 display with something else, for example an image; we ignore such
4566 properties after the first one has been processed.
4567
4568 OVERLAY is the overlay this `display' property came from,
4569 or nil if it was a text property.
4570
4571 If SPEC is a `space' or `image' specification, and in some other
4572 cases too, set *POSITION to the position where the `display'
4573 property ends.
4574
4575 If IT is NULL, only examine the property specification in SPEC, but
4576 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4577 is intended to be displayed in a window on a GUI frame.
4578
4579 Value is non-zero if something was found which replaces the display
4580 of buffer or string text. */
4581
4582 static int
4583 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4584 Lisp_Object overlay, struct text_pos *position,
4585 ptrdiff_t bufpos, int display_replaced_p,
4586 int frame_window_p)
4587 {
4588 Lisp_Object form;
4589 Lisp_Object location, value;
4590 struct text_pos start_pos = *position;
4591 int valid_p;
4592
4593 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4594 If the result is non-nil, use VALUE instead of SPEC. */
4595 form = Qt;
4596 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4597 {
4598 spec = XCDR (spec);
4599 if (!CONSP (spec))
4600 return 0;
4601 form = XCAR (spec);
4602 spec = XCDR (spec);
4603 }
4604
4605 if (!NILP (form) && !EQ (form, Qt))
4606 {
4607 ptrdiff_t count = SPECPDL_INDEX ();
4608 struct gcpro gcpro1;
4609
4610 /* Bind `object' to the object having the `display' property, a
4611 buffer or string. Bind `position' to the position in the
4612 object where the property was found, and `buffer-position'
4613 to the current position in the buffer. */
4614
4615 if (NILP (object))
4616 XSETBUFFER (object, current_buffer);
4617 specbind (Qobject, object);
4618 specbind (Qposition, make_number (CHARPOS (*position)));
4619 specbind (Qbuffer_position, make_number (bufpos));
4620 GCPRO1 (form);
4621 form = safe_eval (form);
4622 UNGCPRO;
4623 unbind_to (count, Qnil);
4624 }
4625
4626 if (NILP (form))
4627 return 0;
4628
4629 /* Handle `(height HEIGHT)' specifications. */
4630 if (CONSP (spec)
4631 && EQ (XCAR (spec), Qheight)
4632 && CONSP (XCDR (spec)))
4633 {
4634 if (it)
4635 {
4636 if (!FRAME_WINDOW_P (it->f))
4637 return 0;
4638
4639 it->font_height = XCAR (XCDR (spec));
4640 if (!NILP (it->font_height))
4641 {
4642 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4643 int new_height = -1;
4644
4645 if (CONSP (it->font_height)
4646 && (EQ (XCAR (it->font_height), Qplus)
4647 || EQ (XCAR (it->font_height), Qminus))
4648 && CONSP (XCDR (it->font_height))
4649 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4650 {
4651 /* `(+ N)' or `(- N)' where N is an integer. */
4652 int steps = XINT (XCAR (XCDR (it->font_height)));
4653 if (EQ (XCAR (it->font_height), Qplus))
4654 steps = - steps;
4655 it->face_id = smaller_face (it->f, it->face_id, steps);
4656 }
4657 else if (FUNCTIONP (it->font_height))
4658 {
4659 /* Call function with current height as argument.
4660 Value is the new height. */
4661 Lisp_Object height;
4662 height = safe_call1 (it->font_height,
4663 face->lface[LFACE_HEIGHT_INDEX]);
4664 if (NUMBERP (height))
4665 new_height = XFLOATINT (height);
4666 }
4667 else if (NUMBERP (it->font_height))
4668 {
4669 /* Value is a multiple of the canonical char height. */
4670 struct face *f;
4671
4672 f = FACE_FROM_ID (it->f,
4673 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4674 new_height = (XFLOATINT (it->font_height)
4675 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4676 }
4677 else
4678 {
4679 /* Evaluate IT->font_height with `height' bound to the
4680 current specified height to get the new height. */
4681 ptrdiff_t count = SPECPDL_INDEX ();
4682
4683 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4684 value = safe_eval (it->font_height);
4685 unbind_to (count, Qnil);
4686
4687 if (NUMBERP (value))
4688 new_height = XFLOATINT (value);
4689 }
4690
4691 if (new_height > 0)
4692 it->face_id = face_with_height (it->f, it->face_id, new_height);
4693 }
4694 }
4695
4696 return 0;
4697 }
4698
4699 /* Handle `(space-width WIDTH)'. */
4700 if (CONSP (spec)
4701 && EQ (XCAR (spec), Qspace_width)
4702 && CONSP (XCDR (spec)))
4703 {
4704 if (it)
4705 {
4706 if (!FRAME_WINDOW_P (it->f))
4707 return 0;
4708
4709 value = XCAR (XCDR (spec));
4710 if (NUMBERP (value) && XFLOATINT (value) > 0)
4711 it->space_width = value;
4712 }
4713
4714 return 0;
4715 }
4716
4717 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4718 if (CONSP (spec)
4719 && EQ (XCAR (spec), Qslice))
4720 {
4721 Lisp_Object tem;
4722
4723 if (it)
4724 {
4725 if (!FRAME_WINDOW_P (it->f))
4726 return 0;
4727
4728 if (tem = XCDR (spec), CONSP (tem))
4729 {
4730 it->slice.x = XCAR (tem);
4731 if (tem = XCDR (tem), CONSP (tem))
4732 {
4733 it->slice.y = XCAR (tem);
4734 if (tem = XCDR (tem), CONSP (tem))
4735 {
4736 it->slice.width = XCAR (tem);
4737 if (tem = XCDR (tem), CONSP (tem))
4738 it->slice.height = XCAR (tem);
4739 }
4740 }
4741 }
4742 }
4743
4744 return 0;
4745 }
4746
4747 /* Handle `(raise FACTOR)'. */
4748 if (CONSP (spec)
4749 && EQ (XCAR (spec), Qraise)
4750 && CONSP (XCDR (spec)))
4751 {
4752 if (it)
4753 {
4754 if (!FRAME_WINDOW_P (it->f))
4755 return 0;
4756
4757 #ifdef HAVE_WINDOW_SYSTEM
4758 value = XCAR (XCDR (spec));
4759 if (NUMBERP (value))
4760 {
4761 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4762 it->voffset = - (XFLOATINT (value)
4763 * (FONT_HEIGHT (face->font)));
4764 }
4765 #endif /* HAVE_WINDOW_SYSTEM */
4766 }
4767
4768 return 0;
4769 }
4770
4771 /* Don't handle the other kinds of display specifications
4772 inside a string that we got from a `display' property. */
4773 if (it && it->string_from_display_prop_p)
4774 return 0;
4775
4776 /* Characters having this form of property are not displayed, so
4777 we have to find the end of the property. */
4778 if (it)
4779 {
4780 start_pos = *position;
4781 *position = display_prop_end (it, object, start_pos);
4782 }
4783 value = Qnil;
4784
4785 /* Stop the scan at that end position--we assume that all
4786 text properties change there. */
4787 if (it)
4788 it->stop_charpos = position->charpos;
4789
4790 /* Handle `(left-fringe BITMAP [FACE])'
4791 and `(right-fringe BITMAP [FACE])'. */
4792 if (CONSP (spec)
4793 && (EQ (XCAR (spec), Qleft_fringe)
4794 || EQ (XCAR (spec), Qright_fringe))
4795 && CONSP (XCDR (spec)))
4796 {
4797 int fringe_bitmap;
4798
4799 if (it)
4800 {
4801 if (!FRAME_WINDOW_P (it->f))
4802 /* If we return here, POSITION has been advanced
4803 across the text with this property. */
4804 {
4805 /* Synchronize the bidi iterator with POSITION. This is
4806 needed because we are not going to push the iterator
4807 on behalf of this display property, so there will be
4808 no pop_it call to do this synchronization for us. */
4809 if (it->bidi_p)
4810 {
4811 it->position = *position;
4812 iterate_out_of_display_property (it);
4813 *position = it->position;
4814 }
4815 return 1;
4816 }
4817 }
4818 else if (!frame_window_p)
4819 return 1;
4820
4821 #ifdef HAVE_WINDOW_SYSTEM
4822 value = XCAR (XCDR (spec));
4823 if (!SYMBOLP (value)
4824 || !(fringe_bitmap = lookup_fringe_bitmap (value)))
4825 /* If we return here, POSITION has been advanced
4826 across the text with this property. */
4827 {
4828 if (it && it->bidi_p)
4829 {
4830 it->position = *position;
4831 iterate_out_of_display_property (it);
4832 *position = it->position;
4833 }
4834 return 1;
4835 }
4836
4837 if (it)
4838 {
4839 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);;
4840
4841 if (CONSP (XCDR (XCDR (spec))))
4842 {
4843 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
4844 int face_id2 = lookup_derived_face (it->f, face_name,
4845 FRINGE_FACE_ID, 0);
4846 if (face_id2 >= 0)
4847 face_id = face_id2;
4848 }
4849
4850 /* Save current settings of IT so that we can restore them
4851 when we are finished with the glyph property value. */
4852 push_it (it, position);
4853
4854 it->area = TEXT_AREA;
4855 it->what = IT_IMAGE;
4856 it->image_id = -1; /* no image */
4857 it->position = start_pos;
4858 it->object = NILP (object) ? it->w->buffer : object;
4859 it->method = GET_FROM_IMAGE;
4860 it->from_overlay = Qnil;
4861 it->face_id = face_id;
4862 it->from_disp_prop_p = 1;
4863
4864 /* Say that we haven't consumed the characters with
4865 `display' property yet. The call to pop_it in
4866 set_iterator_to_next will clean this up. */
4867 *position = start_pos;
4868
4869 if (EQ (XCAR (spec), Qleft_fringe))
4870 {
4871 it->left_user_fringe_bitmap = fringe_bitmap;
4872 it->left_user_fringe_face_id = face_id;
4873 }
4874 else
4875 {
4876 it->right_user_fringe_bitmap = fringe_bitmap;
4877 it->right_user_fringe_face_id = face_id;
4878 }
4879 }
4880 #endif /* HAVE_WINDOW_SYSTEM */
4881 return 1;
4882 }
4883
4884 /* Prepare to handle `((margin left-margin) ...)',
4885 `((margin right-margin) ...)' and `((margin nil) ...)'
4886 prefixes for display specifications. */
4887 location = Qunbound;
4888 if (CONSP (spec) && CONSP (XCAR (spec)))
4889 {
4890 Lisp_Object tem;
4891
4892 value = XCDR (spec);
4893 if (CONSP (value))
4894 value = XCAR (value);
4895
4896 tem = XCAR (spec);
4897 if (EQ (XCAR (tem), Qmargin)
4898 && (tem = XCDR (tem),
4899 tem = CONSP (tem) ? XCAR (tem) : Qnil,
4900 (NILP (tem)
4901 || EQ (tem, Qleft_margin)
4902 || EQ (tem, Qright_margin))))
4903 location = tem;
4904 }
4905
4906 if (EQ (location, Qunbound))
4907 {
4908 location = Qnil;
4909 value = spec;
4910 }
4911
4912 /* After this point, VALUE is the property after any
4913 margin prefix has been stripped. It must be a string,
4914 an image specification, or `(space ...)'.
4915
4916 LOCATION specifies where to display: `left-margin',
4917 `right-margin' or nil. */
4918
4919 valid_p = (STRINGP (value)
4920 #ifdef HAVE_WINDOW_SYSTEM
4921 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
4922 && valid_image_p (value))
4923 #endif /* not HAVE_WINDOW_SYSTEM */
4924 || (CONSP (value) && EQ (XCAR (value), Qspace)));
4925
4926 if (valid_p && !display_replaced_p)
4927 {
4928 int retval = 1;
4929
4930 if (!it)
4931 {
4932 /* Callers need to know whether the display spec is any kind
4933 of `(space ...)' spec that is about to affect text-area
4934 display. */
4935 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
4936 retval = 2;
4937 return retval;
4938 }
4939
4940 /* Save current settings of IT so that we can restore them
4941 when we are finished with the glyph property value. */
4942 push_it (it, position);
4943 it->from_overlay = overlay;
4944 it->from_disp_prop_p = 1;
4945
4946 if (NILP (location))
4947 it->area = TEXT_AREA;
4948 else if (EQ (location, Qleft_margin))
4949 it->area = LEFT_MARGIN_AREA;
4950 else
4951 it->area = RIGHT_MARGIN_AREA;
4952
4953 if (STRINGP (value))
4954 {
4955 it->string = value;
4956 it->multibyte_p = STRING_MULTIBYTE (it->string);
4957 it->current.overlay_string_index = -1;
4958 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
4959 it->end_charpos = it->string_nchars = SCHARS (it->string);
4960 it->method = GET_FROM_STRING;
4961 it->stop_charpos = 0;
4962 it->prev_stop = 0;
4963 it->base_level_stop = 0;
4964 it->string_from_display_prop_p = 1;
4965 /* Say that we haven't consumed the characters with
4966 `display' property yet. The call to pop_it in
4967 set_iterator_to_next will clean this up. */
4968 if (BUFFERP (object))
4969 *position = start_pos;
4970
4971 /* Force paragraph direction to be that of the parent
4972 object. If the parent object's paragraph direction is
4973 not yet determined, default to L2R. */
4974 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
4975 it->paragraph_embedding = it->bidi_it.paragraph_dir;
4976 else
4977 it->paragraph_embedding = L2R;
4978
4979 /* Set up the bidi iterator for this display string. */
4980 if (it->bidi_p)
4981 {
4982 it->bidi_it.string.lstring = it->string;
4983 it->bidi_it.string.s = NULL;
4984 it->bidi_it.string.schars = it->end_charpos;
4985 it->bidi_it.string.bufpos = bufpos;
4986 it->bidi_it.string.from_disp_str = 1;
4987 it->bidi_it.string.unibyte = !it->multibyte_p;
4988 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
4989 }
4990 }
4991 else if (CONSP (value) && EQ (XCAR (value), Qspace))
4992 {
4993 it->method = GET_FROM_STRETCH;
4994 it->object = value;
4995 *position = it->position = start_pos;
4996 retval = 1 + (it->area == TEXT_AREA);
4997 }
4998 #ifdef HAVE_WINDOW_SYSTEM
4999 else
5000 {
5001 it->what = IT_IMAGE;
5002 it->image_id = lookup_image (it->f, value);
5003 it->position = start_pos;
5004 it->object = NILP (object) ? it->w->buffer : object;
5005 it->method = GET_FROM_IMAGE;
5006
5007 /* Say that we haven't consumed the characters with
5008 `display' property yet. The call to pop_it in
5009 set_iterator_to_next will clean this up. */
5010 *position = start_pos;
5011 }
5012 #endif /* HAVE_WINDOW_SYSTEM */
5013
5014 return retval;
5015 }
5016
5017 /* Invalid property or property not supported. Restore
5018 POSITION to what it was before. */
5019 *position = start_pos;
5020 return 0;
5021 }
5022
5023 /* Check if PROP is a display property value whose text should be
5024 treated as intangible. OVERLAY is the overlay from which PROP
5025 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5026 specify the buffer position covered by PROP. */
5027
5028 int
5029 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5030 ptrdiff_t charpos, ptrdiff_t bytepos)
5031 {
5032 int frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5033 struct text_pos position;
5034
5035 SET_TEXT_POS (position, charpos, bytepos);
5036 return handle_display_spec (NULL, prop, Qnil, overlay,
5037 &position, charpos, frame_window_p);
5038 }
5039
5040
5041 /* Return 1 if PROP is a display sub-property value containing STRING.
5042
5043 Implementation note: this and the following function are really
5044 special cases of handle_display_spec and
5045 handle_single_display_spec, and should ideally use the same code.
5046 Until they do, these two pairs must be consistent and must be
5047 modified in sync. */
5048
5049 static int
5050 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5051 {
5052 if (EQ (string, prop))
5053 return 1;
5054
5055 /* Skip over `when FORM'. */
5056 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5057 {
5058 prop = XCDR (prop);
5059 if (!CONSP (prop))
5060 return 0;
5061 /* Actually, the condition following `when' should be eval'ed,
5062 like handle_single_display_spec does, and we should return
5063 zero if it evaluates to nil. However, this function is
5064 called only when the buffer was already displayed and some
5065 glyph in the glyph matrix was found to come from a display
5066 string. Therefore, the condition was already evaluated, and
5067 the result was non-nil, otherwise the display string wouldn't
5068 have been displayed and we would have never been called for
5069 this property. Thus, we can skip the evaluation and assume
5070 its result is non-nil. */
5071 prop = XCDR (prop);
5072 }
5073
5074 if (CONSP (prop))
5075 /* Skip over `margin LOCATION'. */
5076 if (EQ (XCAR (prop), Qmargin))
5077 {
5078 prop = XCDR (prop);
5079 if (!CONSP (prop))
5080 return 0;
5081
5082 prop = XCDR (prop);
5083 if (!CONSP (prop))
5084 return 0;
5085 }
5086
5087 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5088 }
5089
5090
5091 /* Return 1 if STRING appears in the `display' property PROP. */
5092
5093 static int
5094 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5095 {
5096 if (CONSP (prop)
5097 && !EQ (XCAR (prop), Qwhen)
5098 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5099 {
5100 /* A list of sub-properties. */
5101 while (CONSP (prop))
5102 {
5103 if (single_display_spec_string_p (XCAR (prop), string))
5104 return 1;
5105 prop = XCDR (prop);
5106 }
5107 }
5108 else if (VECTORP (prop))
5109 {
5110 /* A vector of sub-properties. */
5111 ptrdiff_t i;
5112 for (i = 0; i < ASIZE (prop); ++i)
5113 if (single_display_spec_string_p (AREF (prop, i), string))
5114 return 1;
5115 }
5116 else
5117 return single_display_spec_string_p (prop, string);
5118
5119 return 0;
5120 }
5121
5122 /* Look for STRING in overlays and text properties in the current
5123 buffer, between character positions FROM and TO (excluding TO).
5124 BACK_P non-zero means look back (in this case, TO is supposed to be
5125 less than FROM).
5126 Value is the first character position where STRING was found, or
5127 zero if it wasn't found before hitting TO.
5128
5129 This function may only use code that doesn't eval because it is
5130 called asynchronously from note_mouse_highlight. */
5131
5132 static ptrdiff_t
5133 string_buffer_position_lim (Lisp_Object string,
5134 ptrdiff_t from, ptrdiff_t to, int back_p)
5135 {
5136 Lisp_Object limit, prop, pos;
5137 int found = 0;
5138
5139 pos = make_number (max (from, BEGV));
5140
5141 if (!back_p) /* looking forward */
5142 {
5143 limit = make_number (min (to, ZV));
5144 while (!found && !EQ (pos, limit))
5145 {
5146 prop = Fget_char_property (pos, Qdisplay, Qnil);
5147 if (!NILP (prop) && display_prop_string_p (prop, string))
5148 found = 1;
5149 else
5150 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5151 limit);
5152 }
5153 }
5154 else /* looking back */
5155 {
5156 limit = make_number (max (to, BEGV));
5157 while (!found && !EQ (pos, limit))
5158 {
5159 prop = Fget_char_property (pos, Qdisplay, Qnil);
5160 if (!NILP (prop) && display_prop_string_p (prop, string))
5161 found = 1;
5162 else
5163 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5164 limit);
5165 }
5166 }
5167
5168 return found ? XINT (pos) : 0;
5169 }
5170
5171 /* Determine which buffer position in current buffer STRING comes from.
5172 AROUND_CHARPOS is an approximate position where it could come from.
5173 Value is the buffer position or 0 if it couldn't be determined.
5174
5175 This function is necessary because we don't record buffer positions
5176 in glyphs generated from strings (to keep struct glyph small).
5177 This function may only use code that doesn't eval because it is
5178 called asynchronously from note_mouse_highlight. */
5179
5180 static ptrdiff_t
5181 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5182 {
5183 const int MAX_DISTANCE = 1000;
5184 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5185 around_charpos + MAX_DISTANCE,
5186 0);
5187
5188 if (!found)
5189 found = string_buffer_position_lim (string, around_charpos,
5190 around_charpos - MAX_DISTANCE, 1);
5191 return found;
5192 }
5193
5194
5195 \f
5196 /***********************************************************************
5197 `composition' property
5198 ***********************************************************************/
5199
5200 /* Set up iterator IT from `composition' property at its current
5201 position. Called from handle_stop. */
5202
5203 static enum prop_handled
5204 handle_composition_prop (struct it *it)
5205 {
5206 Lisp_Object prop, string;
5207 ptrdiff_t pos, pos_byte, start, end;
5208
5209 if (STRINGP (it->string))
5210 {
5211 unsigned char *s;
5212
5213 pos = IT_STRING_CHARPOS (*it);
5214 pos_byte = IT_STRING_BYTEPOS (*it);
5215 string = it->string;
5216 s = SDATA (string) + pos_byte;
5217 it->c = STRING_CHAR (s);
5218 }
5219 else
5220 {
5221 pos = IT_CHARPOS (*it);
5222 pos_byte = IT_BYTEPOS (*it);
5223 string = Qnil;
5224 it->c = FETCH_CHAR (pos_byte);
5225 }
5226
5227 /* If there's a valid composition and point is not inside of the
5228 composition (in the case that the composition is from the current
5229 buffer), draw a glyph composed from the composition components. */
5230 if (find_composition (pos, -1, &start, &end, &prop, string)
5231 && COMPOSITION_VALID_P (start, end, prop)
5232 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5233 {
5234 if (start < pos)
5235 /* As we can't handle this situation (perhaps font-lock added
5236 a new composition), we just return here hoping that next
5237 redisplay will detect this composition much earlier. */
5238 return HANDLED_NORMALLY;
5239 if (start != pos)
5240 {
5241 if (STRINGP (it->string))
5242 pos_byte = string_char_to_byte (it->string, start);
5243 else
5244 pos_byte = CHAR_TO_BYTE (start);
5245 }
5246 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5247 prop, string);
5248
5249 if (it->cmp_it.id >= 0)
5250 {
5251 it->cmp_it.ch = -1;
5252 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5253 it->cmp_it.nglyphs = -1;
5254 }
5255 }
5256
5257 return HANDLED_NORMALLY;
5258 }
5259
5260
5261 \f
5262 /***********************************************************************
5263 Overlay strings
5264 ***********************************************************************/
5265
5266 /* The following structure is used to record overlay strings for
5267 later sorting in load_overlay_strings. */
5268
5269 struct overlay_entry
5270 {
5271 Lisp_Object overlay;
5272 Lisp_Object string;
5273 EMACS_INT priority;
5274 int after_string_p;
5275 };
5276
5277
5278 /* Set up iterator IT from overlay strings at its current position.
5279 Called from handle_stop. */
5280
5281 static enum prop_handled
5282 handle_overlay_change (struct it *it)
5283 {
5284 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5285 return HANDLED_RECOMPUTE_PROPS;
5286 else
5287 return HANDLED_NORMALLY;
5288 }
5289
5290
5291 /* Set up the next overlay string for delivery by IT, if there is an
5292 overlay string to deliver. Called by set_iterator_to_next when the
5293 end of the current overlay string is reached. If there are more
5294 overlay strings to display, IT->string and
5295 IT->current.overlay_string_index are set appropriately here.
5296 Otherwise IT->string is set to nil. */
5297
5298 static void
5299 next_overlay_string (struct it *it)
5300 {
5301 ++it->current.overlay_string_index;
5302 if (it->current.overlay_string_index == it->n_overlay_strings)
5303 {
5304 /* No more overlay strings. Restore IT's settings to what
5305 they were before overlay strings were processed, and
5306 continue to deliver from current_buffer. */
5307
5308 it->ellipsis_p = (it->stack[it->sp - 1].display_ellipsis_p != 0);
5309 pop_it (it);
5310 eassert (it->sp > 0
5311 || (NILP (it->string)
5312 && it->method == GET_FROM_BUFFER
5313 && it->stop_charpos >= BEGV
5314 && it->stop_charpos <= it->end_charpos));
5315 it->current.overlay_string_index = -1;
5316 it->n_overlay_strings = 0;
5317 it->overlay_strings_charpos = -1;
5318 /* If there's an empty display string on the stack, pop the
5319 stack, to resync the bidi iterator with IT's position. Such
5320 empty strings are pushed onto the stack in
5321 get_overlay_strings_1. */
5322 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5323 pop_it (it);
5324
5325 /* If we're at the end of the buffer, record that we have
5326 processed the overlay strings there already, so that
5327 next_element_from_buffer doesn't try it again. */
5328 if (NILP (it->string) && IT_CHARPOS (*it) >= it->end_charpos)
5329 it->overlay_strings_at_end_processed_p = 1;
5330 }
5331 else
5332 {
5333 /* There are more overlay strings to process. If
5334 IT->current.overlay_string_index has advanced to a position
5335 where we must load IT->overlay_strings with more strings, do
5336 it. We must load at the IT->overlay_strings_charpos where
5337 IT->n_overlay_strings was originally computed; when invisible
5338 text is present, this might not be IT_CHARPOS (Bug#7016). */
5339 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5340
5341 if (it->current.overlay_string_index && i == 0)
5342 load_overlay_strings (it, it->overlay_strings_charpos);
5343
5344 /* Initialize IT to deliver display elements from the overlay
5345 string. */
5346 it->string = it->overlay_strings[i];
5347 it->multibyte_p = STRING_MULTIBYTE (it->string);
5348 SET_TEXT_POS (it->current.string_pos, 0, 0);
5349 it->method = GET_FROM_STRING;
5350 it->stop_charpos = 0;
5351 if (it->cmp_it.stop_pos >= 0)
5352 it->cmp_it.stop_pos = 0;
5353 it->prev_stop = 0;
5354 it->base_level_stop = 0;
5355
5356 /* Set up the bidi iterator for this overlay string. */
5357 if (it->bidi_p)
5358 {
5359 it->bidi_it.string.lstring = it->string;
5360 it->bidi_it.string.s = NULL;
5361 it->bidi_it.string.schars = SCHARS (it->string);
5362 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5363 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5364 it->bidi_it.string.unibyte = !it->multibyte_p;
5365 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5366 }
5367 }
5368
5369 CHECK_IT (it);
5370 }
5371
5372
5373 /* Compare two overlay_entry structures E1 and E2. Used as a
5374 comparison function for qsort in load_overlay_strings. Overlay
5375 strings for the same position are sorted so that
5376
5377 1. All after-strings come in front of before-strings, except
5378 when they come from the same overlay.
5379
5380 2. Within after-strings, strings are sorted so that overlay strings
5381 from overlays with higher priorities come first.
5382
5383 2. Within before-strings, strings are sorted so that overlay
5384 strings from overlays with higher priorities come last.
5385
5386 Value is analogous to strcmp. */
5387
5388
5389 static int
5390 compare_overlay_entries (const void *e1, const void *e2)
5391 {
5392 struct overlay_entry *entry1 = (struct overlay_entry *) e1;
5393 struct overlay_entry *entry2 = (struct overlay_entry *) e2;
5394 int result;
5395
5396 if (entry1->after_string_p != entry2->after_string_p)
5397 {
5398 /* Let after-strings appear in front of before-strings if
5399 they come from different overlays. */
5400 if (EQ (entry1->overlay, entry2->overlay))
5401 result = entry1->after_string_p ? 1 : -1;
5402 else
5403 result = entry1->after_string_p ? -1 : 1;
5404 }
5405 else if (entry1->priority != entry2->priority)
5406 {
5407 if (entry1->after_string_p)
5408 /* After-strings sorted in order of decreasing priority. */
5409 result = entry2->priority < entry1->priority ? -1 : 1;
5410 else
5411 /* Before-strings sorted in order of increasing priority. */
5412 result = entry1->priority < entry2->priority ? -1 : 1;
5413 }
5414 else
5415 result = 0;
5416
5417 return result;
5418 }
5419
5420
5421 /* Load the vector IT->overlay_strings with overlay strings from IT's
5422 current buffer position, or from CHARPOS if that is > 0. Set
5423 IT->n_overlays to the total number of overlay strings found.
5424
5425 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5426 a time. On entry into load_overlay_strings,
5427 IT->current.overlay_string_index gives the number of overlay
5428 strings that have already been loaded by previous calls to this
5429 function.
5430
5431 IT->add_overlay_start contains an additional overlay start
5432 position to consider for taking overlay strings from, if non-zero.
5433 This position comes into play when the overlay has an `invisible'
5434 property, and both before and after-strings. When we've skipped to
5435 the end of the overlay, because of its `invisible' property, we
5436 nevertheless want its before-string to appear.
5437 IT->add_overlay_start will contain the overlay start position
5438 in this case.
5439
5440 Overlay strings are sorted so that after-string strings come in
5441 front of before-string strings. Within before and after-strings,
5442 strings are sorted by overlay priority. See also function
5443 compare_overlay_entries. */
5444
5445 static void
5446 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5447 {
5448 Lisp_Object overlay, window, str, invisible;
5449 struct Lisp_Overlay *ov;
5450 ptrdiff_t start, end;
5451 ptrdiff_t size = 20;
5452 ptrdiff_t n = 0, i, j;
5453 int invis_p;
5454 struct overlay_entry *entries = alloca (size * sizeof *entries);
5455 USE_SAFE_ALLOCA;
5456
5457 if (charpos <= 0)
5458 charpos = IT_CHARPOS (*it);
5459
5460 /* Append the overlay string STRING of overlay OVERLAY to vector
5461 `entries' which has size `size' and currently contains `n'
5462 elements. AFTER_P non-zero means STRING is an after-string of
5463 OVERLAY. */
5464 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5465 do \
5466 { \
5467 Lisp_Object priority; \
5468 \
5469 if (n == size) \
5470 { \
5471 struct overlay_entry *old = entries; \
5472 SAFE_NALLOCA (entries, 2, size); \
5473 memcpy (entries, old, size * sizeof *entries); \
5474 size *= 2; \
5475 } \
5476 \
5477 entries[n].string = (STRING); \
5478 entries[n].overlay = (OVERLAY); \
5479 priority = Foverlay_get ((OVERLAY), Qpriority); \
5480 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5481 entries[n].after_string_p = (AFTER_P); \
5482 ++n; \
5483 } \
5484 while (0)
5485
5486 /* Process overlay before the overlay center. */
5487 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5488 {
5489 XSETMISC (overlay, ov);
5490 eassert (OVERLAYP (overlay));
5491 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5492 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5493
5494 if (end < charpos)
5495 break;
5496
5497 /* Skip this overlay if it doesn't start or end at IT's current
5498 position. */
5499 if (end != charpos && start != charpos)
5500 continue;
5501
5502 /* Skip this overlay if it doesn't apply to IT->w. */
5503 window = Foverlay_get (overlay, Qwindow);
5504 if (WINDOWP (window) && XWINDOW (window) != it->w)
5505 continue;
5506
5507 /* If the text ``under'' the overlay is invisible, both before-
5508 and after-strings from this overlay are visible; start and
5509 end position are indistinguishable. */
5510 invisible = Foverlay_get (overlay, Qinvisible);
5511 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5512
5513 /* If overlay has a non-empty before-string, record it. */
5514 if ((start == charpos || (end == charpos && invis_p))
5515 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5516 && SCHARS (str))
5517 RECORD_OVERLAY_STRING (overlay, str, 0);
5518
5519 /* If overlay has a non-empty after-string, record it. */
5520 if ((end == charpos || (start == charpos && invis_p))
5521 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5522 && SCHARS (str))
5523 RECORD_OVERLAY_STRING (overlay, str, 1);
5524 }
5525
5526 /* Process overlays after the overlay center. */
5527 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5528 {
5529 XSETMISC (overlay, ov);
5530 eassert (OVERLAYP (overlay));
5531 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5532 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5533
5534 if (start > charpos)
5535 break;
5536
5537 /* Skip this overlay if it doesn't start or end at IT's current
5538 position. */
5539 if (end != charpos && start != charpos)
5540 continue;
5541
5542 /* Skip this overlay if it doesn't apply to IT->w. */
5543 window = Foverlay_get (overlay, Qwindow);
5544 if (WINDOWP (window) && XWINDOW (window) != it->w)
5545 continue;
5546
5547 /* If the text ``under'' the overlay is invisible, it has a zero
5548 dimension, and both before- and after-strings apply. */
5549 invisible = Foverlay_get (overlay, Qinvisible);
5550 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5551
5552 /* If overlay has a non-empty before-string, record it. */
5553 if ((start == charpos || (end == charpos && invis_p))
5554 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5555 && SCHARS (str))
5556 RECORD_OVERLAY_STRING (overlay, str, 0);
5557
5558 /* If overlay has a non-empty after-string, record it. */
5559 if ((end == charpos || (start == charpos && invis_p))
5560 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5561 && SCHARS (str))
5562 RECORD_OVERLAY_STRING (overlay, str, 1);
5563 }
5564
5565 #undef RECORD_OVERLAY_STRING
5566
5567 /* Sort entries. */
5568 if (n > 1)
5569 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5570
5571 /* Record number of overlay strings, and where we computed it. */
5572 it->n_overlay_strings = n;
5573 it->overlay_strings_charpos = charpos;
5574
5575 /* IT->current.overlay_string_index is the number of overlay strings
5576 that have already been consumed by IT. Copy some of the
5577 remaining overlay strings to IT->overlay_strings. */
5578 i = 0;
5579 j = it->current.overlay_string_index;
5580 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5581 {
5582 it->overlay_strings[i] = entries[j].string;
5583 it->string_overlays[i++] = entries[j++].overlay;
5584 }
5585
5586 CHECK_IT (it);
5587 SAFE_FREE ();
5588 }
5589
5590
5591 /* Get the first chunk of overlay strings at IT's current buffer
5592 position, or at CHARPOS if that is > 0. Value is non-zero if at
5593 least one overlay string was found. */
5594
5595 static int
5596 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, int compute_stop_p)
5597 {
5598 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5599 process. This fills IT->overlay_strings with strings, and sets
5600 IT->n_overlay_strings to the total number of strings to process.
5601 IT->pos.overlay_string_index has to be set temporarily to zero
5602 because load_overlay_strings needs this; it must be set to -1
5603 when no overlay strings are found because a zero value would
5604 indicate a position in the first overlay string. */
5605 it->current.overlay_string_index = 0;
5606 load_overlay_strings (it, charpos);
5607
5608 /* If we found overlay strings, set up IT to deliver display
5609 elements from the first one. Otherwise set up IT to deliver
5610 from current_buffer. */
5611 if (it->n_overlay_strings)
5612 {
5613 /* Make sure we know settings in current_buffer, so that we can
5614 restore meaningful values when we're done with the overlay
5615 strings. */
5616 if (compute_stop_p)
5617 compute_stop_pos (it);
5618 eassert (it->face_id >= 0);
5619
5620 /* Save IT's settings. They are restored after all overlay
5621 strings have been processed. */
5622 eassert (!compute_stop_p || it->sp == 0);
5623
5624 /* When called from handle_stop, there might be an empty display
5625 string loaded. In that case, don't bother saving it. But
5626 don't use this optimization with the bidi iterator, since we
5627 need the corresponding pop_it call to resync the bidi
5628 iterator's position with IT's position, after we are done
5629 with the overlay strings. (The corresponding call to pop_it
5630 in case of an empty display string is in
5631 next_overlay_string.) */
5632 if (!(!it->bidi_p
5633 && STRINGP (it->string) && !SCHARS (it->string)))
5634 push_it (it, NULL);
5635
5636 /* Set up IT to deliver display elements from the first overlay
5637 string. */
5638 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5639 it->string = it->overlay_strings[0];
5640 it->from_overlay = Qnil;
5641 it->stop_charpos = 0;
5642 eassert (STRINGP (it->string));
5643 it->end_charpos = SCHARS (it->string);
5644 it->prev_stop = 0;
5645 it->base_level_stop = 0;
5646 it->multibyte_p = STRING_MULTIBYTE (it->string);
5647 it->method = GET_FROM_STRING;
5648 it->from_disp_prop_p = 0;
5649
5650 /* Force paragraph direction to be that of the parent
5651 buffer. */
5652 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5653 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5654 else
5655 it->paragraph_embedding = L2R;
5656
5657 /* Set up the bidi iterator for this overlay string. */
5658 if (it->bidi_p)
5659 {
5660 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5661
5662 it->bidi_it.string.lstring = it->string;
5663 it->bidi_it.string.s = NULL;
5664 it->bidi_it.string.schars = SCHARS (it->string);
5665 it->bidi_it.string.bufpos = pos;
5666 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5667 it->bidi_it.string.unibyte = !it->multibyte_p;
5668 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5669 }
5670 return 1;
5671 }
5672
5673 it->current.overlay_string_index = -1;
5674 return 0;
5675 }
5676
5677 static int
5678 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5679 {
5680 it->string = Qnil;
5681 it->method = GET_FROM_BUFFER;
5682
5683 (void) get_overlay_strings_1 (it, charpos, 1);
5684
5685 CHECK_IT (it);
5686
5687 /* Value is non-zero if we found at least one overlay string. */
5688 return STRINGP (it->string);
5689 }
5690
5691
5692 \f
5693 /***********************************************************************
5694 Saving and restoring state
5695 ***********************************************************************/
5696
5697 /* Save current settings of IT on IT->stack. Called, for example,
5698 before setting up IT for an overlay string, to be able to restore
5699 IT's settings to what they were after the overlay string has been
5700 processed. If POSITION is non-NULL, it is the position to save on
5701 the stack instead of IT->position. */
5702
5703 static void
5704 push_it (struct it *it, struct text_pos *position)
5705 {
5706 struct iterator_stack_entry *p;
5707
5708 eassert (it->sp < IT_STACK_SIZE);
5709 p = it->stack + it->sp;
5710
5711 p->stop_charpos = it->stop_charpos;
5712 p->prev_stop = it->prev_stop;
5713 p->base_level_stop = it->base_level_stop;
5714 p->cmp_it = it->cmp_it;
5715 eassert (it->face_id >= 0);
5716 p->face_id = it->face_id;
5717 p->string = it->string;
5718 p->method = it->method;
5719 p->from_overlay = it->from_overlay;
5720 switch (p->method)
5721 {
5722 case GET_FROM_IMAGE:
5723 p->u.image.object = it->object;
5724 p->u.image.image_id = it->image_id;
5725 p->u.image.slice = it->slice;
5726 break;
5727 case GET_FROM_STRETCH:
5728 p->u.stretch.object = it->object;
5729 break;
5730 }
5731 p->position = position ? *position : it->position;
5732 p->current = it->current;
5733 p->end_charpos = it->end_charpos;
5734 p->string_nchars = it->string_nchars;
5735 p->area = it->area;
5736 p->multibyte_p = it->multibyte_p;
5737 p->avoid_cursor_p = it->avoid_cursor_p;
5738 p->space_width = it->space_width;
5739 p->font_height = it->font_height;
5740 p->voffset = it->voffset;
5741 p->string_from_display_prop_p = it->string_from_display_prop_p;
5742 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
5743 p->display_ellipsis_p = 0;
5744 p->line_wrap = it->line_wrap;
5745 p->bidi_p = it->bidi_p;
5746 p->paragraph_embedding = it->paragraph_embedding;
5747 p->from_disp_prop_p = it->from_disp_prop_p;
5748 ++it->sp;
5749
5750 /* Save the state of the bidi iterator as well. */
5751 if (it->bidi_p)
5752 bidi_push_it (&it->bidi_it);
5753 }
5754
5755 static void
5756 iterate_out_of_display_property (struct it *it)
5757 {
5758 int buffer_p = !STRINGP (it->string);
5759 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
5760 ptrdiff_t bob = (buffer_p ? BEGV : 0);
5761
5762 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
5763
5764 /* Maybe initialize paragraph direction. If we are at the beginning
5765 of a new paragraph, next_element_from_buffer may not have a
5766 chance to do that. */
5767 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
5768 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
5769 /* prev_stop can be zero, so check against BEGV as well. */
5770 while (it->bidi_it.charpos >= bob
5771 && it->prev_stop <= it->bidi_it.charpos
5772 && it->bidi_it.charpos < CHARPOS (it->position)
5773 && it->bidi_it.charpos < eob)
5774 bidi_move_to_visually_next (&it->bidi_it);
5775 /* Record the stop_pos we just crossed, for when we cross it
5776 back, maybe. */
5777 if (it->bidi_it.charpos > CHARPOS (it->position))
5778 it->prev_stop = CHARPOS (it->position);
5779 /* If we ended up not where pop_it put us, resync IT's
5780 positional members with the bidi iterator. */
5781 if (it->bidi_it.charpos != CHARPOS (it->position))
5782 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
5783 if (buffer_p)
5784 it->current.pos = it->position;
5785 else
5786 it->current.string_pos = it->position;
5787 }
5788
5789 /* Restore IT's settings from IT->stack. Called, for example, when no
5790 more overlay strings must be processed, and we return to delivering
5791 display elements from a buffer, or when the end of a string from a
5792 `display' property is reached and we return to delivering display
5793 elements from an overlay string, or from a buffer. */
5794
5795 static void
5796 pop_it (struct it *it)
5797 {
5798 struct iterator_stack_entry *p;
5799 int from_display_prop = it->from_disp_prop_p;
5800
5801 eassert (it->sp > 0);
5802 --it->sp;
5803 p = it->stack + it->sp;
5804 it->stop_charpos = p->stop_charpos;
5805 it->prev_stop = p->prev_stop;
5806 it->base_level_stop = p->base_level_stop;
5807 it->cmp_it = p->cmp_it;
5808 it->face_id = p->face_id;
5809 it->current = p->current;
5810 it->position = p->position;
5811 it->string = p->string;
5812 it->from_overlay = p->from_overlay;
5813 if (NILP (it->string))
5814 SET_TEXT_POS (it->current.string_pos, -1, -1);
5815 it->method = p->method;
5816 switch (it->method)
5817 {
5818 case GET_FROM_IMAGE:
5819 it->image_id = p->u.image.image_id;
5820 it->object = p->u.image.object;
5821 it->slice = p->u.image.slice;
5822 break;
5823 case GET_FROM_STRETCH:
5824 it->object = p->u.stretch.object;
5825 break;
5826 case GET_FROM_BUFFER:
5827 it->object = it->w->buffer;
5828 break;
5829 case GET_FROM_STRING:
5830 it->object = it->string;
5831 break;
5832 case GET_FROM_DISPLAY_VECTOR:
5833 if (it->s)
5834 it->method = GET_FROM_C_STRING;
5835 else if (STRINGP (it->string))
5836 it->method = GET_FROM_STRING;
5837 else
5838 {
5839 it->method = GET_FROM_BUFFER;
5840 it->object = it->w->buffer;
5841 }
5842 }
5843 it->end_charpos = p->end_charpos;
5844 it->string_nchars = p->string_nchars;
5845 it->area = p->area;
5846 it->multibyte_p = p->multibyte_p;
5847 it->avoid_cursor_p = p->avoid_cursor_p;
5848 it->space_width = p->space_width;
5849 it->font_height = p->font_height;
5850 it->voffset = p->voffset;
5851 it->string_from_display_prop_p = p->string_from_display_prop_p;
5852 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
5853 it->line_wrap = p->line_wrap;
5854 it->bidi_p = p->bidi_p;
5855 it->paragraph_embedding = p->paragraph_embedding;
5856 it->from_disp_prop_p = p->from_disp_prop_p;
5857 if (it->bidi_p)
5858 {
5859 bidi_pop_it (&it->bidi_it);
5860 /* Bidi-iterate until we get out of the portion of text, if any,
5861 covered by a `display' text property or by an overlay with
5862 `display' property. (We cannot just jump there, because the
5863 internal coherency of the bidi iterator state can not be
5864 preserved across such jumps.) We also must determine the
5865 paragraph base direction if the overlay we just processed is
5866 at the beginning of a new paragraph. */
5867 if (from_display_prop
5868 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
5869 iterate_out_of_display_property (it);
5870
5871 eassert ((BUFFERP (it->object)
5872 && IT_CHARPOS (*it) == it->bidi_it.charpos
5873 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
5874 || (STRINGP (it->object)
5875 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
5876 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
5877 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
5878 }
5879 }
5880
5881
5882 \f
5883 /***********************************************************************
5884 Moving over lines
5885 ***********************************************************************/
5886
5887 /* Set IT's current position to the previous line start. */
5888
5889 static void
5890 back_to_previous_line_start (struct it *it)
5891 {
5892 IT_CHARPOS (*it) = find_next_newline_no_quit (IT_CHARPOS (*it) - 1, -1);
5893 IT_BYTEPOS (*it) = CHAR_TO_BYTE (IT_CHARPOS (*it));
5894 }
5895
5896
5897 /* Move IT to the next line start.
5898
5899 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5900 we skipped over part of the text (as opposed to moving the iterator
5901 continuously over the text). Otherwise, don't change the value
5902 of *SKIPPED_P.
5903
5904 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5905 iterator on the newline, if it was found.
5906
5907 Newlines may come from buffer text, overlay strings, or strings
5908 displayed via the `display' property. That's the reason we can't
5909 simply use find_next_newline_no_quit.
5910
5911 Note that this function may not skip over invisible text that is so
5912 because of text properties and immediately follows a newline. If
5913 it would, function reseat_at_next_visible_line_start, when called
5914 from set_iterator_to_next, would effectively make invisible
5915 characters following a newline part of the wrong glyph row, which
5916 leads to wrong cursor motion. */
5917
5918 static int
5919 forward_to_next_line_start (struct it *it, int *skipped_p,
5920 struct bidi_it *bidi_it_prev)
5921 {
5922 ptrdiff_t old_selective;
5923 int newline_found_p, n;
5924 const int MAX_NEWLINE_DISTANCE = 500;
5925
5926 /* If already on a newline, just consume it to avoid unintended
5927 skipping over invisible text below. */
5928 if (it->what == IT_CHARACTER
5929 && it->c == '\n'
5930 && CHARPOS (it->position) == IT_CHARPOS (*it))
5931 {
5932 if (it->bidi_p && bidi_it_prev)
5933 *bidi_it_prev = it->bidi_it;
5934 set_iterator_to_next (it, 0);
5935 it->c = 0;
5936 return 1;
5937 }
5938
5939 /* Don't handle selective display in the following. It's (a)
5940 unnecessary because it's done by the caller, and (b) leads to an
5941 infinite recursion because next_element_from_ellipsis indirectly
5942 calls this function. */
5943 old_selective = it->selective;
5944 it->selective = 0;
5945
5946 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5947 from buffer text. */
5948 for (n = newline_found_p = 0;
5949 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
5950 n += STRINGP (it->string) ? 0 : 1)
5951 {
5952 if (!get_next_display_element (it))
5953 return 0;
5954 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
5955 if (newline_found_p && it->bidi_p && bidi_it_prev)
5956 *bidi_it_prev = it->bidi_it;
5957 set_iterator_to_next (it, 0);
5958 }
5959
5960 /* If we didn't find a newline near enough, see if we can use a
5961 short-cut. */
5962 if (!newline_found_p)
5963 {
5964 ptrdiff_t start = IT_CHARPOS (*it);
5965 ptrdiff_t limit = find_next_newline_no_quit (start, 1);
5966 Lisp_Object pos;
5967
5968 eassert (!STRINGP (it->string));
5969
5970 /* If there isn't any `display' property in sight, and no
5971 overlays, we can just use the position of the newline in
5972 buffer text. */
5973 if (it->stop_charpos >= limit
5974 || ((pos = Fnext_single_property_change (make_number (start),
5975 Qdisplay, Qnil,
5976 make_number (limit)),
5977 NILP (pos))
5978 && next_overlay_change (start) == ZV))
5979 {
5980 if (!it->bidi_p)
5981 {
5982 IT_CHARPOS (*it) = limit;
5983 IT_BYTEPOS (*it) = CHAR_TO_BYTE (limit);
5984 }
5985 else
5986 {
5987 struct bidi_it bprev;
5988
5989 /* Help bidi.c avoid expensive searches for display
5990 properties and overlays, by telling it that there are
5991 none up to `limit'. */
5992 if (it->bidi_it.disp_pos < limit)
5993 {
5994 it->bidi_it.disp_pos = limit;
5995 it->bidi_it.disp_prop = 0;
5996 }
5997 do {
5998 bprev = it->bidi_it;
5999 bidi_move_to_visually_next (&it->bidi_it);
6000 } while (it->bidi_it.charpos != limit);
6001 IT_CHARPOS (*it) = limit;
6002 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6003 if (bidi_it_prev)
6004 *bidi_it_prev = bprev;
6005 }
6006 *skipped_p = newline_found_p = 1;
6007 }
6008 else
6009 {
6010 while (get_next_display_element (it)
6011 && !newline_found_p)
6012 {
6013 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6014 if (newline_found_p && it->bidi_p && bidi_it_prev)
6015 *bidi_it_prev = it->bidi_it;
6016 set_iterator_to_next (it, 0);
6017 }
6018 }
6019 }
6020
6021 it->selective = old_selective;
6022 return newline_found_p;
6023 }
6024
6025
6026 /* Set IT's current position to the previous visible line start. Skip
6027 invisible text that is so either due to text properties or due to
6028 selective display. Caution: this does not change IT->current_x and
6029 IT->hpos. */
6030
6031 static void
6032 back_to_previous_visible_line_start (struct it *it)
6033 {
6034 while (IT_CHARPOS (*it) > BEGV)
6035 {
6036 back_to_previous_line_start (it);
6037
6038 if (IT_CHARPOS (*it) <= BEGV)
6039 break;
6040
6041 /* If selective > 0, then lines indented more than its value are
6042 invisible. */
6043 if (it->selective > 0
6044 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6045 it->selective))
6046 continue;
6047
6048 /* Check the newline before point for invisibility. */
6049 {
6050 Lisp_Object prop;
6051 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6052 Qinvisible, it->window);
6053 if (TEXT_PROP_MEANS_INVISIBLE (prop))
6054 continue;
6055 }
6056
6057 if (IT_CHARPOS (*it) <= BEGV)
6058 break;
6059
6060 {
6061 struct it it2;
6062 void *it2data = NULL;
6063 ptrdiff_t pos;
6064 ptrdiff_t beg, end;
6065 Lisp_Object val, overlay;
6066
6067 SAVE_IT (it2, *it, it2data);
6068
6069 /* If newline is part of a composition, continue from start of composition */
6070 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6071 && beg < IT_CHARPOS (*it))
6072 goto replaced;
6073
6074 /* If newline is replaced by a display property, find start of overlay
6075 or interval and continue search from that point. */
6076 pos = --IT_CHARPOS (it2);
6077 --IT_BYTEPOS (it2);
6078 it2.sp = 0;
6079 bidi_unshelve_cache (NULL, 0);
6080 it2.string_from_display_prop_p = 0;
6081 it2.from_disp_prop_p = 0;
6082 if (handle_display_prop (&it2) == HANDLED_RETURN
6083 && !NILP (val = get_char_property_and_overlay
6084 (make_number (pos), Qdisplay, Qnil, &overlay))
6085 && (OVERLAYP (overlay)
6086 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6087 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6088 {
6089 RESTORE_IT (it, it, it2data);
6090 goto replaced;
6091 }
6092
6093 /* Newline is not replaced by anything -- so we are done. */
6094 RESTORE_IT (it, it, it2data);
6095 break;
6096
6097 replaced:
6098 if (beg < BEGV)
6099 beg = BEGV;
6100 IT_CHARPOS (*it) = beg;
6101 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6102 }
6103 }
6104
6105 it->continuation_lines_width = 0;
6106
6107 eassert (IT_CHARPOS (*it) >= BEGV);
6108 eassert (IT_CHARPOS (*it) == BEGV
6109 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6110 CHECK_IT (it);
6111 }
6112
6113
6114 /* Reseat iterator IT at the previous visible line start. Skip
6115 invisible text that is so either due to text properties or due to
6116 selective display. At the end, update IT's overlay information,
6117 face information etc. */
6118
6119 void
6120 reseat_at_previous_visible_line_start (struct it *it)
6121 {
6122 back_to_previous_visible_line_start (it);
6123 reseat (it, it->current.pos, 1);
6124 CHECK_IT (it);
6125 }
6126
6127
6128 /* Reseat iterator IT on the next visible line start in the current
6129 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6130 preceding the line start. Skip over invisible text that is so
6131 because of selective display. Compute faces, overlays etc at the
6132 new position. Note that this function does not skip over text that
6133 is invisible because of text properties. */
6134
6135 static void
6136 reseat_at_next_visible_line_start (struct it *it, int on_newline_p)
6137 {
6138 int newline_found_p, skipped_p = 0;
6139 struct bidi_it bidi_it_prev;
6140
6141 newline_found_p = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6142
6143 /* Skip over lines that are invisible because they are indented
6144 more than the value of IT->selective. */
6145 if (it->selective > 0)
6146 while (IT_CHARPOS (*it) < ZV
6147 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6148 it->selective))
6149 {
6150 eassert (IT_BYTEPOS (*it) == BEGV
6151 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6152 newline_found_p =
6153 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6154 }
6155
6156 /* Position on the newline if that's what's requested. */
6157 if (on_newline_p && newline_found_p)
6158 {
6159 if (STRINGP (it->string))
6160 {
6161 if (IT_STRING_CHARPOS (*it) > 0)
6162 {
6163 if (!it->bidi_p)
6164 {
6165 --IT_STRING_CHARPOS (*it);
6166 --IT_STRING_BYTEPOS (*it);
6167 }
6168 else
6169 {
6170 /* We need to restore the bidi iterator to the state
6171 it had on the newline, and resync the IT's
6172 position with that. */
6173 it->bidi_it = bidi_it_prev;
6174 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6175 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6176 }
6177 }
6178 }
6179 else if (IT_CHARPOS (*it) > BEGV)
6180 {
6181 if (!it->bidi_p)
6182 {
6183 --IT_CHARPOS (*it);
6184 --IT_BYTEPOS (*it);
6185 }
6186 else
6187 {
6188 /* We need to restore the bidi iterator to the state it
6189 had on the newline and resync IT with that. */
6190 it->bidi_it = bidi_it_prev;
6191 IT_CHARPOS (*it) = it->bidi_it.charpos;
6192 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6193 }
6194 reseat (it, it->current.pos, 0);
6195 }
6196 }
6197 else if (skipped_p)
6198 reseat (it, it->current.pos, 0);
6199
6200 CHECK_IT (it);
6201 }
6202
6203
6204 \f
6205 /***********************************************************************
6206 Changing an iterator's position
6207 ***********************************************************************/
6208
6209 /* Change IT's current position to POS in current_buffer. If FORCE_P
6210 is non-zero, always check for text properties at the new position.
6211 Otherwise, text properties are only looked up if POS >=
6212 IT->check_charpos of a property. */
6213
6214 static void
6215 reseat (struct it *it, struct text_pos pos, int force_p)
6216 {
6217 ptrdiff_t original_pos = IT_CHARPOS (*it);
6218
6219 reseat_1 (it, pos, 0);
6220
6221 /* Determine where to check text properties. Avoid doing it
6222 where possible because text property lookup is very expensive. */
6223 if (force_p
6224 || CHARPOS (pos) > it->stop_charpos
6225 || CHARPOS (pos) < original_pos)
6226 {
6227 if (it->bidi_p)
6228 {
6229 /* For bidi iteration, we need to prime prev_stop and
6230 base_level_stop with our best estimations. */
6231 /* Implementation note: Of course, POS is not necessarily a
6232 stop position, so assigning prev_pos to it is a lie; we
6233 should have called compute_stop_backwards. However, if
6234 the current buffer does not include any R2L characters,
6235 that call would be a waste of cycles, because the
6236 iterator will never move back, and thus never cross this
6237 "fake" stop position. So we delay that backward search
6238 until the time we really need it, in next_element_from_buffer. */
6239 if (CHARPOS (pos) != it->prev_stop)
6240 it->prev_stop = CHARPOS (pos);
6241 if (CHARPOS (pos) < it->base_level_stop)
6242 it->base_level_stop = 0; /* meaning it's unknown */
6243 handle_stop (it);
6244 }
6245 else
6246 {
6247 handle_stop (it);
6248 it->prev_stop = it->base_level_stop = 0;
6249 }
6250
6251 }
6252
6253 CHECK_IT (it);
6254 }
6255
6256
6257 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6258 IT->stop_pos to POS, also. */
6259
6260 static void
6261 reseat_1 (struct it *it, struct text_pos pos, int set_stop_p)
6262 {
6263 /* Don't call this function when scanning a C string. */
6264 eassert (it->s == NULL);
6265
6266 /* POS must be a reasonable value. */
6267 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6268
6269 it->current.pos = it->position = pos;
6270 it->end_charpos = ZV;
6271 it->dpvec = NULL;
6272 it->current.dpvec_index = -1;
6273 it->current.overlay_string_index = -1;
6274 IT_STRING_CHARPOS (*it) = -1;
6275 IT_STRING_BYTEPOS (*it) = -1;
6276 it->string = Qnil;
6277 it->method = GET_FROM_BUFFER;
6278 it->object = it->w->buffer;
6279 it->area = TEXT_AREA;
6280 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6281 it->sp = 0;
6282 it->string_from_display_prop_p = 0;
6283 it->string_from_prefix_prop_p = 0;
6284
6285 it->from_disp_prop_p = 0;
6286 it->face_before_selective_p = 0;
6287 if (it->bidi_p)
6288 {
6289 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6290 &it->bidi_it);
6291 bidi_unshelve_cache (NULL, 0);
6292 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6293 it->bidi_it.string.s = NULL;
6294 it->bidi_it.string.lstring = Qnil;
6295 it->bidi_it.string.bufpos = 0;
6296 it->bidi_it.string.unibyte = 0;
6297 }
6298
6299 if (set_stop_p)
6300 {
6301 it->stop_charpos = CHARPOS (pos);
6302 it->base_level_stop = CHARPOS (pos);
6303 }
6304 }
6305
6306
6307 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6308 If S is non-null, it is a C string to iterate over. Otherwise,
6309 STRING gives a Lisp string to iterate over.
6310
6311 If PRECISION > 0, don't return more then PRECISION number of
6312 characters from the string.
6313
6314 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6315 characters have been returned. FIELD_WIDTH < 0 means an infinite
6316 field width.
6317
6318 MULTIBYTE = 0 means disable processing of multibyte characters,
6319 MULTIBYTE > 0 means enable it,
6320 MULTIBYTE < 0 means use IT->multibyte_p.
6321
6322 IT must be initialized via a prior call to init_iterator before
6323 calling this function. */
6324
6325 static void
6326 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6327 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6328 int multibyte)
6329 {
6330 /* No region in strings. */
6331 it->region_beg_charpos = it->region_end_charpos = -1;
6332
6333 /* No text property checks performed by default, but see below. */
6334 it->stop_charpos = -1;
6335
6336 /* Set iterator position and end position. */
6337 memset (&it->current, 0, sizeof it->current);
6338 it->current.overlay_string_index = -1;
6339 it->current.dpvec_index = -1;
6340 eassert (charpos >= 0);
6341
6342 /* If STRING is specified, use its multibyteness, otherwise use the
6343 setting of MULTIBYTE, if specified. */
6344 if (multibyte >= 0)
6345 it->multibyte_p = multibyte > 0;
6346
6347 /* Bidirectional reordering of strings is controlled by the default
6348 value of bidi-display-reordering. Don't try to reorder while
6349 loading loadup.el, as the necessary character property tables are
6350 not yet available. */
6351 it->bidi_p =
6352 NILP (Vpurify_flag)
6353 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6354
6355 if (s == NULL)
6356 {
6357 eassert (STRINGP (string));
6358 it->string = string;
6359 it->s = NULL;
6360 it->end_charpos = it->string_nchars = SCHARS (string);
6361 it->method = GET_FROM_STRING;
6362 it->current.string_pos = string_pos (charpos, string);
6363
6364 if (it->bidi_p)
6365 {
6366 it->bidi_it.string.lstring = string;
6367 it->bidi_it.string.s = NULL;
6368 it->bidi_it.string.schars = it->end_charpos;
6369 it->bidi_it.string.bufpos = 0;
6370 it->bidi_it.string.from_disp_str = 0;
6371 it->bidi_it.string.unibyte = !it->multibyte_p;
6372 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6373 FRAME_WINDOW_P (it->f), &it->bidi_it);
6374 }
6375 }
6376 else
6377 {
6378 it->s = (const unsigned char *) s;
6379 it->string = Qnil;
6380
6381 /* Note that we use IT->current.pos, not it->current.string_pos,
6382 for displaying C strings. */
6383 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6384 if (it->multibyte_p)
6385 {
6386 it->current.pos = c_string_pos (charpos, s, 1);
6387 it->end_charpos = it->string_nchars = number_of_chars (s, 1);
6388 }
6389 else
6390 {
6391 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6392 it->end_charpos = it->string_nchars = strlen (s);
6393 }
6394
6395 if (it->bidi_p)
6396 {
6397 it->bidi_it.string.lstring = Qnil;
6398 it->bidi_it.string.s = (const unsigned char *) s;
6399 it->bidi_it.string.schars = it->end_charpos;
6400 it->bidi_it.string.bufpos = 0;
6401 it->bidi_it.string.from_disp_str = 0;
6402 it->bidi_it.string.unibyte = !it->multibyte_p;
6403 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6404 &it->bidi_it);
6405 }
6406 it->method = GET_FROM_C_STRING;
6407 }
6408
6409 /* PRECISION > 0 means don't return more than PRECISION characters
6410 from the string. */
6411 if (precision > 0 && it->end_charpos - charpos > precision)
6412 {
6413 it->end_charpos = it->string_nchars = charpos + precision;
6414 if (it->bidi_p)
6415 it->bidi_it.string.schars = it->end_charpos;
6416 }
6417
6418 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6419 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6420 FIELD_WIDTH < 0 means infinite field width. This is useful for
6421 padding with `-' at the end of a mode line. */
6422 if (field_width < 0)
6423 field_width = INFINITY;
6424 /* Implementation note: We deliberately don't enlarge
6425 it->bidi_it.string.schars here to fit it->end_charpos, because
6426 the bidi iterator cannot produce characters out of thin air. */
6427 if (field_width > it->end_charpos - charpos)
6428 it->end_charpos = charpos + field_width;
6429
6430 /* Use the standard display table for displaying strings. */
6431 if (DISP_TABLE_P (Vstandard_display_table))
6432 it->dp = XCHAR_TABLE (Vstandard_display_table);
6433
6434 it->stop_charpos = charpos;
6435 it->prev_stop = charpos;
6436 it->base_level_stop = 0;
6437 if (it->bidi_p)
6438 {
6439 it->bidi_it.first_elt = 1;
6440 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6441 it->bidi_it.disp_pos = -1;
6442 }
6443 if (s == NULL && it->multibyte_p)
6444 {
6445 ptrdiff_t endpos = SCHARS (it->string);
6446 if (endpos > it->end_charpos)
6447 endpos = it->end_charpos;
6448 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6449 it->string);
6450 }
6451 CHECK_IT (it);
6452 }
6453
6454
6455 \f
6456 /***********************************************************************
6457 Iteration
6458 ***********************************************************************/
6459
6460 /* Map enum it_method value to corresponding next_element_from_* function. */
6461
6462 static int (* get_next_element[NUM_IT_METHODS]) (struct it *it) =
6463 {
6464 next_element_from_buffer,
6465 next_element_from_display_vector,
6466 next_element_from_string,
6467 next_element_from_c_string,
6468 next_element_from_image,
6469 next_element_from_stretch
6470 };
6471
6472 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6473
6474
6475 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6476 (possibly with the following characters). */
6477
6478 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6479 ((IT)->cmp_it.id >= 0 \
6480 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6481 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6482 END_CHARPOS, (IT)->w, \
6483 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6484 (IT)->string)))
6485
6486
6487 /* Lookup the char-table Vglyphless_char_display for character C (-1
6488 if we want information for no-font case), and return the display
6489 method symbol. By side-effect, update it->what and
6490 it->glyphless_method. This function is called from
6491 get_next_display_element for each character element, and from
6492 x_produce_glyphs when no suitable font was found. */
6493
6494 Lisp_Object
6495 lookup_glyphless_char_display (int c, struct it *it)
6496 {
6497 Lisp_Object glyphless_method = Qnil;
6498
6499 if (CHAR_TABLE_P (Vglyphless_char_display)
6500 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6501 {
6502 if (c >= 0)
6503 {
6504 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6505 if (CONSP (glyphless_method))
6506 glyphless_method = FRAME_WINDOW_P (it->f)
6507 ? XCAR (glyphless_method)
6508 : XCDR (glyphless_method);
6509 }
6510 else
6511 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6512 }
6513
6514 retry:
6515 if (NILP (glyphless_method))
6516 {
6517 if (c >= 0)
6518 /* The default is to display the character by a proper font. */
6519 return Qnil;
6520 /* The default for the no-font case is to display an empty box. */
6521 glyphless_method = Qempty_box;
6522 }
6523 if (EQ (glyphless_method, Qzero_width))
6524 {
6525 if (c >= 0)
6526 return glyphless_method;
6527 /* This method can't be used for the no-font case. */
6528 glyphless_method = Qempty_box;
6529 }
6530 if (EQ (glyphless_method, Qthin_space))
6531 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6532 else if (EQ (glyphless_method, Qempty_box))
6533 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6534 else if (EQ (glyphless_method, Qhex_code))
6535 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6536 else if (STRINGP (glyphless_method))
6537 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6538 else
6539 {
6540 /* Invalid value. We use the default method. */
6541 glyphless_method = Qnil;
6542 goto retry;
6543 }
6544 it->what = IT_GLYPHLESS;
6545 return glyphless_method;
6546 }
6547
6548 /* Load IT's display element fields with information about the next
6549 display element from the current position of IT. Value is zero if
6550 end of buffer (or C string) is reached. */
6551
6552 static struct frame *last_escape_glyph_frame = NULL;
6553 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6554 static int last_escape_glyph_merged_face_id = 0;
6555
6556 struct frame *last_glyphless_glyph_frame = NULL;
6557 int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6558 int last_glyphless_glyph_merged_face_id = 0;
6559
6560 static int
6561 get_next_display_element (struct it *it)
6562 {
6563 /* Non-zero means that we found a display element. Zero means that
6564 we hit the end of what we iterate over. Performance note: the
6565 function pointer `method' used here turns out to be faster than
6566 using a sequence of if-statements. */
6567 int success_p;
6568
6569 get_next:
6570 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6571
6572 if (it->what == IT_CHARACTER)
6573 {
6574 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6575 and only if (a) the resolved directionality of that character
6576 is R..." */
6577 /* FIXME: Do we need an exception for characters from display
6578 tables? */
6579 if (it->bidi_p && it->bidi_it.type == STRONG_R)
6580 it->c = bidi_mirror_char (it->c);
6581 /* Map via display table or translate control characters.
6582 IT->c, IT->len etc. have been set to the next character by
6583 the function call above. If we have a display table, and it
6584 contains an entry for IT->c, translate it. Don't do this if
6585 IT->c itself comes from a display table, otherwise we could
6586 end up in an infinite recursion. (An alternative could be to
6587 count the recursion depth of this function and signal an
6588 error when a certain maximum depth is reached.) Is it worth
6589 it? */
6590 if (success_p && it->dpvec == NULL)
6591 {
6592 Lisp_Object dv;
6593 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6594 int nonascii_space_p = 0;
6595 int nonascii_hyphen_p = 0;
6596 int c = it->c; /* This is the character to display. */
6597
6598 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6599 {
6600 eassert (SINGLE_BYTE_CHAR_P (c));
6601 if (unibyte_display_via_language_environment)
6602 {
6603 c = DECODE_CHAR (unibyte, c);
6604 if (c < 0)
6605 c = BYTE8_TO_CHAR (it->c);
6606 }
6607 else
6608 c = BYTE8_TO_CHAR (it->c);
6609 }
6610
6611 if (it->dp
6612 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6613 VECTORP (dv)))
6614 {
6615 struct Lisp_Vector *v = XVECTOR (dv);
6616
6617 /* Return the first character from the display table
6618 entry, if not empty. If empty, don't display the
6619 current character. */
6620 if (v->header.size)
6621 {
6622 it->dpvec_char_len = it->len;
6623 it->dpvec = v->contents;
6624 it->dpend = v->contents + v->header.size;
6625 it->current.dpvec_index = 0;
6626 it->dpvec_face_id = -1;
6627 it->saved_face_id = it->face_id;
6628 it->method = GET_FROM_DISPLAY_VECTOR;
6629 it->ellipsis_p = 0;
6630 }
6631 else
6632 {
6633 set_iterator_to_next (it, 0);
6634 }
6635 goto get_next;
6636 }
6637
6638 if (! NILP (lookup_glyphless_char_display (c, it)))
6639 {
6640 if (it->what == IT_GLYPHLESS)
6641 goto done;
6642 /* Don't display this character. */
6643 set_iterator_to_next (it, 0);
6644 goto get_next;
6645 }
6646
6647 /* If `nobreak-char-display' is non-nil, we display
6648 non-ASCII spaces and hyphens specially. */
6649 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
6650 {
6651 if (c == 0xA0)
6652 nonascii_space_p = 1;
6653 else if (c == 0xAD || c == 0x2010 || c == 0x2011)
6654 nonascii_hyphen_p = 1;
6655 }
6656
6657 /* Translate control characters into `\003' or `^C' form.
6658 Control characters coming from a display table entry are
6659 currently not translated because we use IT->dpvec to hold
6660 the translation. This could easily be changed but I
6661 don't believe that it is worth doing.
6662
6663 The characters handled by `nobreak-char-display' must be
6664 translated too.
6665
6666 Non-printable characters and raw-byte characters are also
6667 translated to octal form. */
6668 if (((c < ' ' || c == 127) /* ASCII control chars */
6669 ? (it->area != TEXT_AREA
6670 /* In mode line, treat \n, \t like other crl chars. */
6671 || (c != '\t'
6672 && it->glyph_row
6673 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
6674 || (c != '\n' && c != '\t'))
6675 : (nonascii_space_p
6676 || nonascii_hyphen_p
6677 || CHAR_BYTE8_P (c)
6678 || ! CHAR_PRINTABLE_P (c))))
6679 {
6680 /* C is a control character, non-ASCII space/hyphen,
6681 raw-byte, or a non-printable character which must be
6682 displayed either as '\003' or as `^C' where the '\\'
6683 and '^' can be defined in the display table. Fill
6684 IT->ctl_chars with glyphs for what we have to
6685 display. Then, set IT->dpvec to these glyphs. */
6686 Lisp_Object gc;
6687 int ctl_len;
6688 int face_id;
6689 int lface_id = 0;
6690 int escape_glyph;
6691
6692 /* Handle control characters with ^. */
6693
6694 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
6695 {
6696 int g;
6697
6698 g = '^'; /* default glyph for Control */
6699 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6700 if (it->dp
6701 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6702 {
6703 g = GLYPH_CODE_CHAR (gc);
6704 lface_id = GLYPH_CODE_FACE (gc);
6705 }
6706 if (lface_id)
6707 {
6708 face_id = merge_faces (it->f, Qt, lface_id, it->face_id);
6709 }
6710 else if (it->f == last_escape_glyph_frame
6711 && it->face_id == last_escape_glyph_face_id)
6712 {
6713 face_id = last_escape_glyph_merged_face_id;
6714 }
6715 else
6716 {
6717 /* Merge the escape-glyph face into the current face. */
6718 face_id = merge_faces (it->f, Qescape_glyph, 0,
6719 it->face_id);
6720 last_escape_glyph_frame = it->f;
6721 last_escape_glyph_face_id = it->face_id;
6722 last_escape_glyph_merged_face_id = face_id;
6723 }
6724
6725 XSETINT (it->ctl_chars[0], g);
6726 XSETINT (it->ctl_chars[1], c ^ 0100);
6727 ctl_len = 2;
6728 goto display_control;
6729 }
6730
6731 /* Handle non-ascii space in the mode where it only gets
6732 highlighting. */
6733
6734 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
6735 {
6736 /* Merge `nobreak-space' into the current face. */
6737 face_id = merge_faces (it->f, Qnobreak_space, 0,
6738 it->face_id);
6739 XSETINT (it->ctl_chars[0], ' ');
6740 ctl_len = 1;
6741 goto display_control;
6742 }
6743
6744 /* Handle sequences that start with the "escape glyph". */
6745
6746 /* the default escape glyph is \. */
6747 escape_glyph = '\\';
6748
6749 if (it->dp
6750 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6751 {
6752 escape_glyph = GLYPH_CODE_CHAR (gc);
6753 lface_id = GLYPH_CODE_FACE (gc);
6754 }
6755 if (lface_id)
6756 {
6757 /* The display table specified a face.
6758 Merge it into face_id and also into escape_glyph. */
6759 face_id = merge_faces (it->f, Qt, lface_id,
6760 it->face_id);
6761 }
6762 else if (it->f == last_escape_glyph_frame
6763 && it->face_id == last_escape_glyph_face_id)
6764 {
6765 face_id = last_escape_glyph_merged_face_id;
6766 }
6767 else
6768 {
6769 /* Merge the escape-glyph face into the current face. */
6770 face_id = merge_faces (it->f, Qescape_glyph, 0,
6771 it->face_id);
6772 last_escape_glyph_frame = it->f;
6773 last_escape_glyph_face_id = it->face_id;
6774 last_escape_glyph_merged_face_id = face_id;
6775 }
6776
6777 /* Draw non-ASCII hyphen with just highlighting: */
6778
6779 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
6780 {
6781 XSETINT (it->ctl_chars[0], '-');
6782 ctl_len = 1;
6783 goto display_control;
6784 }
6785
6786 /* Draw non-ASCII space/hyphen with escape glyph: */
6787
6788 if (nonascii_space_p || nonascii_hyphen_p)
6789 {
6790 XSETINT (it->ctl_chars[0], escape_glyph);
6791 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
6792 ctl_len = 2;
6793 goto display_control;
6794 }
6795
6796 {
6797 char str[10];
6798 int len, i;
6799
6800 if (CHAR_BYTE8_P (c))
6801 /* Display \200 instead of \17777600. */
6802 c = CHAR_TO_BYTE8 (c);
6803 len = sprintf (str, "%03o", c);
6804
6805 XSETINT (it->ctl_chars[0], escape_glyph);
6806 for (i = 0; i < len; i++)
6807 XSETINT (it->ctl_chars[i + 1], str[i]);
6808 ctl_len = len + 1;
6809 }
6810
6811 display_control:
6812 /* Set up IT->dpvec and return first character from it. */
6813 it->dpvec_char_len = it->len;
6814 it->dpvec = it->ctl_chars;
6815 it->dpend = it->dpvec + ctl_len;
6816 it->current.dpvec_index = 0;
6817 it->dpvec_face_id = face_id;
6818 it->saved_face_id = it->face_id;
6819 it->method = GET_FROM_DISPLAY_VECTOR;
6820 it->ellipsis_p = 0;
6821 goto get_next;
6822 }
6823 it->char_to_display = c;
6824 }
6825 else if (success_p)
6826 {
6827 it->char_to_display = it->c;
6828 }
6829 }
6830
6831 /* Adjust face id for a multibyte character. There are no multibyte
6832 character in unibyte text. */
6833 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
6834 && it->multibyte_p
6835 && success_p
6836 && FRAME_WINDOW_P (it->f))
6837 {
6838 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6839
6840 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
6841 {
6842 /* Automatic composition with glyph-string. */
6843 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
6844
6845 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
6846 }
6847 else
6848 {
6849 ptrdiff_t pos = (it->s ? -1
6850 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
6851 : IT_CHARPOS (*it));
6852 int c;
6853
6854 if (it->what == IT_CHARACTER)
6855 c = it->char_to_display;
6856 else
6857 {
6858 struct composition *cmp = composition_table[it->cmp_it.id];
6859 int i;
6860
6861 c = ' ';
6862 for (i = 0; i < cmp->glyph_len; i++)
6863 /* TAB in a composition means display glyphs with
6864 padding space on the left or right. */
6865 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
6866 break;
6867 }
6868 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
6869 }
6870 }
6871
6872 done:
6873 /* Is this character the last one of a run of characters with
6874 box? If yes, set IT->end_of_box_run_p to 1. */
6875 if (it->face_box_p
6876 && it->s == NULL)
6877 {
6878 if (it->method == GET_FROM_STRING && it->sp)
6879 {
6880 int face_id = underlying_face_id (it);
6881 struct face *face = FACE_FROM_ID (it->f, face_id);
6882
6883 if (face)
6884 {
6885 if (face->box == FACE_NO_BOX)
6886 {
6887 /* If the box comes from face properties in a
6888 display string, check faces in that string. */
6889 int string_face_id = face_after_it_pos (it);
6890 it->end_of_box_run_p
6891 = (FACE_FROM_ID (it->f, string_face_id)->box
6892 == FACE_NO_BOX);
6893 }
6894 /* Otherwise, the box comes from the underlying face.
6895 If this is the last string character displayed, check
6896 the next buffer location. */
6897 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
6898 && (it->current.overlay_string_index
6899 == it->n_overlay_strings - 1))
6900 {
6901 ptrdiff_t ignore;
6902 int next_face_id;
6903 struct text_pos pos = it->current.pos;
6904 INC_TEXT_POS (pos, it->multibyte_p);
6905
6906 next_face_id = face_at_buffer_position
6907 (it->w, CHARPOS (pos), it->region_beg_charpos,
6908 it->region_end_charpos, &ignore,
6909 (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT), 0,
6910 -1);
6911 it->end_of_box_run_p
6912 = (FACE_FROM_ID (it->f, next_face_id)->box
6913 == FACE_NO_BOX);
6914 }
6915 }
6916 }
6917 else
6918 {
6919 int face_id = face_after_it_pos (it);
6920 it->end_of_box_run_p
6921 = (face_id != it->face_id
6922 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
6923 }
6924 }
6925 /* If we reached the end of the object we've been iterating (e.g., a
6926 display string or an overlay string), and there's something on
6927 IT->stack, proceed with what's on the stack. It doesn't make
6928 sense to return zero if there's unprocessed stuff on the stack,
6929 because otherwise that stuff will never be displayed. */
6930 if (!success_p && it->sp > 0)
6931 {
6932 set_iterator_to_next (it, 0);
6933 success_p = get_next_display_element (it);
6934 }
6935
6936 /* Value is 0 if end of buffer or string reached. */
6937 return success_p;
6938 }
6939
6940
6941 /* Move IT to the next display element.
6942
6943 RESEAT_P non-zero means if called on a newline in buffer text,
6944 skip to the next visible line start.
6945
6946 Functions get_next_display_element and set_iterator_to_next are
6947 separate because I find this arrangement easier to handle than a
6948 get_next_display_element function that also increments IT's
6949 position. The way it is we can first look at an iterator's current
6950 display element, decide whether it fits on a line, and if it does,
6951 increment the iterator position. The other way around we probably
6952 would either need a flag indicating whether the iterator has to be
6953 incremented the next time, or we would have to implement a
6954 decrement position function which would not be easy to write. */
6955
6956 void
6957 set_iterator_to_next (struct it *it, int reseat_p)
6958 {
6959 /* Reset flags indicating start and end of a sequence of characters
6960 with box. Reset them at the start of this function because
6961 moving the iterator to a new position might set them. */
6962 it->start_of_box_run_p = it->end_of_box_run_p = 0;
6963
6964 switch (it->method)
6965 {
6966 case GET_FROM_BUFFER:
6967 /* The current display element of IT is a character from
6968 current_buffer. Advance in the buffer, and maybe skip over
6969 invisible lines that are so because of selective display. */
6970 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
6971 reseat_at_next_visible_line_start (it, 0);
6972 else if (it->cmp_it.id >= 0)
6973 {
6974 /* We are currently getting glyphs from a composition. */
6975 int i;
6976
6977 if (! it->bidi_p)
6978 {
6979 IT_CHARPOS (*it) += it->cmp_it.nchars;
6980 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
6981 if (it->cmp_it.to < it->cmp_it.nglyphs)
6982 {
6983 it->cmp_it.from = it->cmp_it.to;
6984 }
6985 else
6986 {
6987 it->cmp_it.id = -1;
6988 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
6989 IT_BYTEPOS (*it),
6990 it->end_charpos, Qnil);
6991 }
6992 }
6993 else if (! it->cmp_it.reversed_p)
6994 {
6995 /* Composition created while scanning forward. */
6996 /* Update IT's char/byte positions to point to the first
6997 character of the next grapheme cluster, or to the
6998 character visually after the current composition. */
6999 for (i = 0; i < it->cmp_it.nchars; i++)
7000 bidi_move_to_visually_next (&it->bidi_it);
7001 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7002 IT_CHARPOS (*it) = it->bidi_it.charpos;
7003
7004 if (it->cmp_it.to < it->cmp_it.nglyphs)
7005 {
7006 /* Proceed to the next grapheme cluster. */
7007 it->cmp_it.from = it->cmp_it.to;
7008 }
7009 else
7010 {
7011 /* No more grapheme clusters in this composition.
7012 Find the next stop position. */
7013 ptrdiff_t stop = it->end_charpos;
7014 if (it->bidi_it.scan_dir < 0)
7015 /* Now we are scanning backward and don't know
7016 where to stop. */
7017 stop = -1;
7018 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7019 IT_BYTEPOS (*it), stop, Qnil);
7020 }
7021 }
7022 else
7023 {
7024 /* Composition created while scanning backward. */
7025 /* Update IT's char/byte positions to point to the last
7026 character of the previous grapheme cluster, or the
7027 character visually after the current composition. */
7028 for (i = 0; i < it->cmp_it.nchars; i++)
7029 bidi_move_to_visually_next (&it->bidi_it);
7030 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7031 IT_CHARPOS (*it) = it->bidi_it.charpos;
7032 if (it->cmp_it.from > 0)
7033 {
7034 /* Proceed to the previous grapheme cluster. */
7035 it->cmp_it.to = it->cmp_it.from;
7036 }
7037 else
7038 {
7039 /* No more grapheme clusters in this composition.
7040 Find the next stop position. */
7041 ptrdiff_t stop = it->end_charpos;
7042 if (it->bidi_it.scan_dir < 0)
7043 /* Now we are scanning backward and don't know
7044 where to stop. */
7045 stop = -1;
7046 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7047 IT_BYTEPOS (*it), stop, Qnil);
7048 }
7049 }
7050 }
7051 else
7052 {
7053 eassert (it->len != 0);
7054
7055 if (!it->bidi_p)
7056 {
7057 IT_BYTEPOS (*it) += it->len;
7058 IT_CHARPOS (*it) += 1;
7059 }
7060 else
7061 {
7062 int prev_scan_dir = it->bidi_it.scan_dir;
7063 /* If this is a new paragraph, determine its base
7064 direction (a.k.a. its base embedding level). */
7065 if (it->bidi_it.new_paragraph)
7066 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
7067 bidi_move_to_visually_next (&it->bidi_it);
7068 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7069 IT_CHARPOS (*it) = it->bidi_it.charpos;
7070 if (prev_scan_dir != it->bidi_it.scan_dir)
7071 {
7072 /* As the scan direction was changed, we must
7073 re-compute the stop position for composition. */
7074 ptrdiff_t stop = it->end_charpos;
7075 if (it->bidi_it.scan_dir < 0)
7076 stop = -1;
7077 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7078 IT_BYTEPOS (*it), stop, Qnil);
7079 }
7080 }
7081 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7082 }
7083 break;
7084
7085 case GET_FROM_C_STRING:
7086 /* Current display element of IT is from a C string. */
7087 if (!it->bidi_p
7088 /* If the string position is beyond string's end, it means
7089 next_element_from_c_string is padding the string with
7090 blanks, in which case we bypass the bidi iterator,
7091 because it cannot deal with such virtual characters. */
7092 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7093 {
7094 IT_BYTEPOS (*it) += it->len;
7095 IT_CHARPOS (*it) += 1;
7096 }
7097 else
7098 {
7099 bidi_move_to_visually_next (&it->bidi_it);
7100 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7101 IT_CHARPOS (*it) = it->bidi_it.charpos;
7102 }
7103 break;
7104
7105 case GET_FROM_DISPLAY_VECTOR:
7106 /* Current display element of IT is from a display table entry.
7107 Advance in the display table definition. Reset it to null if
7108 end reached, and continue with characters from buffers/
7109 strings. */
7110 ++it->current.dpvec_index;
7111
7112 /* Restore face of the iterator to what they were before the
7113 display vector entry (these entries may contain faces). */
7114 it->face_id = it->saved_face_id;
7115
7116 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7117 {
7118 int recheck_faces = it->ellipsis_p;
7119
7120 if (it->s)
7121 it->method = GET_FROM_C_STRING;
7122 else if (STRINGP (it->string))
7123 it->method = GET_FROM_STRING;
7124 else
7125 {
7126 it->method = GET_FROM_BUFFER;
7127 it->object = it->w->buffer;
7128 }
7129
7130 it->dpvec = NULL;
7131 it->current.dpvec_index = -1;
7132
7133 /* Skip over characters which were displayed via IT->dpvec. */
7134 if (it->dpvec_char_len < 0)
7135 reseat_at_next_visible_line_start (it, 1);
7136 else if (it->dpvec_char_len > 0)
7137 {
7138 if (it->method == GET_FROM_STRING
7139 && it->n_overlay_strings > 0)
7140 it->ignore_overlay_strings_at_pos_p = 1;
7141 it->len = it->dpvec_char_len;
7142 set_iterator_to_next (it, reseat_p);
7143 }
7144
7145 /* Maybe recheck faces after display vector */
7146 if (recheck_faces)
7147 it->stop_charpos = IT_CHARPOS (*it);
7148 }
7149 break;
7150
7151 case GET_FROM_STRING:
7152 /* Current display element is a character from a Lisp string. */
7153 eassert (it->s == NULL && STRINGP (it->string));
7154 /* Don't advance past string end. These conditions are true
7155 when set_iterator_to_next is called at the end of
7156 get_next_display_element, in which case the Lisp string is
7157 already exhausted, and all we want is pop the iterator
7158 stack. */
7159 if (it->current.overlay_string_index >= 0)
7160 {
7161 /* This is an overlay string, so there's no padding with
7162 spaces, and the number of characters in the string is
7163 where the string ends. */
7164 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7165 goto consider_string_end;
7166 }
7167 else
7168 {
7169 /* Not an overlay string. There could be padding, so test
7170 against it->end_charpos . */
7171 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7172 goto consider_string_end;
7173 }
7174 if (it->cmp_it.id >= 0)
7175 {
7176 int i;
7177
7178 if (! it->bidi_p)
7179 {
7180 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7181 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7182 if (it->cmp_it.to < it->cmp_it.nglyphs)
7183 it->cmp_it.from = it->cmp_it.to;
7184 else
7185 {
7186 it->cmp_it.id = -1;
7187 composition_compute_stop_pos (&it->cmp_it,
7188 IT_STRING_CHARPOS (*it),
7189 IT_STRING_BYTEPOS (*it),
7190 it->end_charpos, it->string);
7191 }
7192 }
7193 else if (! it->cmp_it.reversed_p)
7194 {
7195 for (i = 0; i < it->cmp_it.nchars; i++)
7196 bidi_move_to_visually_next (&it->bidi_it);
7197 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7198 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7199
7200 if (it->cmp_it.to < it->cmp_it.nglyphs)
7201 it->cmp_it.from = it->cmp_it.to;
7202 else
7203 {
7204 ptrdiff_t stop = it->end_charpos;
7205 if (it->bidi_it.scan_dir < 0)
7206 stop = -1;
7207 composition_compute_stop_pos (&it->cmp_it,
7208 IT_STRING_CHARPOS (*it),
7209 IT_STRING_BYTEPOS (*it), stop,
7210 it->string);
7211 }
7212 }
7213 else
7214 {
7215 for (i = 0; i < it->cmp_it.nchars; i++)
7216 bidi_move_to_visually_next (&it->bidi_it);
7217 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7218 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7219 if (it->cmp_it.from > 0)
7220 it->cmp_it.to = it->cmp_it.from;
7221 else
7222 {
7223 ptrdiff_t stop = it->end_charpos;
7224 if (it->bidi_it.scan_dir < 0)
7225 stop = -1;
7226 composition_compute_stop_pos (&it->cmp_it,
7227 IT_STRING_CHARPOS (*it),
7228 IT_STRING_BYTEPOS (*it), stop,
7229 it->string);
7230 }
7231 }
7232 }
7233 else
7234 {
7235 if (!it->bidi_p
7236 /* If the string position is beyond string's end, it
7237 means next_element_from_string is padding the string
7238 with blanks, in which case we bypass the bidi
7239 iterator, because it cannot deal with such virtual
7240 characters. */
7241 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7242 {
7243 IT_STRING_BYTEPOS (*it) += it->len;
7244 IT_STRING_CHARPOS (*it) += 1;
7245 }
7246 else
7247 {
7248 int prev_scan_dir = it->bidi_it.scan_dir;
7249
7250 bidi_move_to_visually_next (&it->bidi_it);
7251 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7252 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7253 if (prev_scan_dir != it->bidi_it.scan_dir)
7254 {
7255 ptrdiff_t stop = it->end_charpos;
7256
7257 if (it->bidi_it.scan_dir < 0)
7258 stop = -1;
7259 composition_compute_stop_pos (&it->cmp_it,
7260 IT_STRING_CHARPOS (*it),
7261 IT_STRING_BYTEPOS (*it), stop,
7262 it->string);
7263 }
7264 }
7265 }
7266
7267 consider_string_end:
7268
7269 if (it->current.overlay_string_index >= 0)
7270 {
7271 /* IT->string is an overlay string. Advance to the
7272 next, if there is one. */
7273 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7274 {
7275 it->ellipsis_p = 0;
7276 next_overlay_string (it);
7277 if (it->ellipsis_p)
7278 setup_for_ellipsis (it, 0);
7279 }
7280 }
7281 else
7282 {
7283 /* IT->string is not an overlay string. If we reached
7284 its end, and there is something on IT->stack, proceed
7285 with what is on the stack. This can be either another
7286 string, this time an overlay string, or a buffer. */
7287 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7288 && it->sp > 0)
7289 {
7290 pop_it (it);
7291 if (it->method == GET_FROM_STRING)
7292 goto consider_string_end;
7293 }
7294 }
7295 break;
7296
7297 case GET_FROM_IMAGE:
7298 case GET_FROM_STRETCH:
7299 /* The position etc with which we have to proceed are on
7300 the stack. The position may be at the end of a string,
7301 if the `display' property takes up the whole string. */
7302 eassert (it->sp > 0);
7303 pop_it (it);
7304 if (it->method == GET_FROM_STRING)
7305 goto consider_string_end;
7306 break;
7307
7308 default:
7309 /* There are no other methods defined, so this should be a bug. */
7310 emacs_abort ();
7311 }
7312
7313 eassert (it->method != GET_FROM_STRING
7314 || (STRINGP (it->string)
7315 && IT_STRING_CHARPOS (*it) >= 0));
7316 }
7317
7318 /* Load IT's display element fields with information about the next
7319 display element which comes from a display table entry or from the
7320 result of translating a control character to one of the forms `^C'
7321 or `\003'.
7322
7323 IT->dpvec holds the glyphs to return as characters.
7324 IT->saved_face_id holds the face id before the display vector--it
7325 is restored into IT->face_id in set_iterator_to_next. */
7326
7327 static int
7328 next_element_from_display_vector (struct it *it)
7329 {
7330 Lisp_Object gc;
7331
7332 /* Precondition. */
7333 eassert (it->dpvec && it->current.dpvec_index >= 0);
7334
7335 it->face_id = it->saved_face_id;
7336
7337 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7338 That seemed totally bogus - so I changed it... */
7339 gc = it->dpvec[it->current.dpvec_index];
7340
7341 if (GLYPH_CODE_P (gc))
7342 {
7343 it->c = GLYPH_CODE_CHAR (gc);
7344 it->len = CHAR_BYTES (it->c);
7345
7346 /* The entry may contain a face id to use. Such a face id is
7347 the id of a Lisp face, not a realized face. A face id of
7348 zero means no face is specified. */
7349 if (it->dpvec_face_id >= 0)
7350 it->face_id = it->dpvec_face_id;
7351 else
7352 {
7353 int lface_id = GLYPH_CODE_FACE (gc);
7354 if (lface_id > 0)
7355 it->face_id = merge_faces (it->f, Qt, lface_id,
7356 it->saved_face_id);
7357 }
7358 }
7359 else
7360 /* Display table entry is invalid. Return a space. */
7361 it->c = ' ', it->len = 1;
7362
7363 /* Don't change position and object of the iterator here. They are
7364 still the values of the character that had this display table
7365 entry or was translated, and that's what we want. */
7366 it->what = IT_CHARACTER;
7367 return 1;
7368 }
7369
7370 /* Get the first element of string/buffer in the visual order, after
7371 being reseated to a new position in a string or a buffer. */
7372 static void
7373 get_visually_first_element (struct it *it)
7374 {
7375 int string_p = STRINGP (it->string) || it->s;
7376 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7377 ptrdiff_t bob = (string_p ? 0 : BEGV);
7378
7379 if (STRINGP (it->string))
7380 {
7381 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7382 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7383 }
7384 else
7385 {
7386 it->bidi_it.charpos = IT_CHARPOS (*it);
7387 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7388 }
7389
7390 if (it->bidi_it.charpos == eob)
7391 {
7392 /* Nothing to do, but reset the FIRST_ELT flag, like
7393 bidi_paragraph_init does, because we are not going to
7394 call it. */
7395 it->bidi_it.first_elt = 0;
7396 }
7397 else if (it->bidi_it.charpos == bob
7398 || (!string_p
7399 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7400 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7401 {
7402 /* If we are at the beginning of a line/string, we can produce
7403 the next element right away. */
7404 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7405 bidi_move_to_visually_next (&it->bidi_it);
7406 }
7407 else
7408 {
7409 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7410
7411 /* We need to prime the bidi iterator starting at the line's or
7412 string's beginning, before we will be able to produce the
7413 next element. */
7414 if (string_p)
7415 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7416 else
7417 {
7418 it->bidi_it.charpos = find_next_newline_no_quit (IT_CHARPOS (*it),
7419 -1);
7420 it->bidi_it.bytepos = CHAR_TO_BYTE (it->bidi_it.charpos);
7421 }
7422 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7423 do
7424 {
7425 /* Now return to buffer/string position where we were asked
7426 to get the next display element, and produce that. */
7427 bidi_move_to_visually_next (&it->bidi_it);
7428 }
7429 while (it->bidi_it.bytepos != orig_bytepos
7430 && it->bidi_it.charpos < eob);
7431 }
7432
7433 /* Adjust IT's position information to where we ended up. */
7434 if (STRINGP (it->string))
7435 {
7436 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7437 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7438 }
7439 else
7440 {
7441 IT_CHARPOS (*it) = it->bidi_it.charpos;
7442 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7443 }
7444
7445 if (STRINGP (it->string) || !it->s)
7446 {
7447 ptrdiff_t stop, charpos, bytepos;
7448
7449 if (STRINGP (it->string))
7450 {
7451 eassert (!it->s);
7452 stop = SCHARS (it->string);
7453 if (stop > it->end_charpos)
7454 stop = it->end_charpos;
7455 charpos = IT_STRING_CHARPOS (*it);
7456 bytepos = IT_STRING_BYTEPOS (*it);
7457 }
7458 else
7459 {
7460 stop = it->end_charpos;
7461 charpos = IT_CHARPOS (*it);
7462 bytepos = IT_BYTEPOS (*it);
7463 }
7464 if (it->bidi_it.scan_dir < 0)
7465 stop = -1;
7466 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7467 it->string);
7468 }
7469 }
7470
7471 /* Load IT with the next display element from Lisp string IT->string.
7472 IT->current.string_pos is the current position within the string.
7473 If IT->current.overlay_string_index >= 0, the Lisp string is an
7474 overlay string. */
7475
7476 static int
7477 next_element_from_string (struct it *it)
7478 {
7479 struct text_pos position;
7480
7481 eassert (STRINGP (it->string));
7482 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7483 eassert (IT_STRING_CHARPOS (*it) >= 0);
7484 position = it->current.string_pos;
7485
7486 /* With bidi reordering, the character to display might not be the
7487 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7488 that we were reseat()ed to a new string, whose paragraph
7489 direction is not known. */
7490 if (it->bidi_p && it->bidi_it.first_elt)
7491 {
7492 get_visually_first_element (it);
7493 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7494 }
7495
7496 /* Time to check for invisible text? */
7497 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7498 {
7499 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7500 {
7501 if (!(!it->bidi_p
7502 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7503 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7504 {
7505 /* With bidi non-linear iteration, we could find
7506 ourselves far beyond the last computed stop_charpos,
7507 with several other stop positions in between that we
7508 missed. Scan them all now, in buffer's logical
7509 order, until we find and handle the last stop_charpos
7510 that precedes our current position. */
7511 handle_stop_backwards (it, it->stop_charpos);
7512 return GET_NEXT_DISPLAY_ELEMENT (it);
7513 }
7514 else
7515 {
7516 if (it->bidi_p)
7517 {
7518 /* Take note of the stop position we just moved
7519 across, for when we will move back across it. */
7520 it->prev_stop = it->stop_charpos;
7521 /* If we are at base paragraph embedding level, take
7522 note of the last stop position seen at this
7523 level. */
7524 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7525 it->base_level_stop = it->stop_charpos;
7526 }
7527 handle_stop (it);
7528
7529 /* Since a handler may have changed IT->method, we must
7530 recurse here. */
7531 return GET_NEXT_DISPLAY_ELEMENT (it);
7532 }
7533 }
7534 else if (it->bidi_p
7535 /* If we are before prev_stop, we may have overstepped
7536 on our way backwards a stop_pos, and if so, we need
7537 to handle that stop_pos. */
7538 && IT_STRING_CHARPOS (*it) < it->prev_stop
7539 /* We can sometimes back up for reasons that have nothing
7540 to do with bidi reordering. E.g., compositions. The
7541 code below is only needed when we are above the base
7542 embedding level, so test for that explicitly. */
7543 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7544 {
7545 /* If we lost track of base_level_stop, we have no better
7546 place for handle_stop_backwards to start from than string
7547 beginning. This happens, e.g., when we were reseated to
7548 the previous screenful of text by vertical-motion. */
7549 if (it->base_level_stop <= 0
7550 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7551 it->base_level_stop = 0;
7552 handle_stop_backwards (it, it->base_level_stop);
7553 return GET_NEXT_DISPLAY_ELEMENT (it);
7554 }
7555 }
7556
7557 if (it->current.overlay_string_index >= 0)
7558 {
7559 /* Get the next character from an overlay string. In overlay
7560 strings, there is no field width or padding with spaces to
7561 do. */
7562 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7563 {
7564 it->what = IT_EOB;
7565 return 0;
7566 }
7567 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7568 IT_STRING_BYTEPOS (*it),
7569 it->bidi_it.scan_dir < 0
7570 ? -1
7571 : SCHARS (it->string))
7572 && next_element_from_composition (it))
7573 {
7574 return 1;
7575 }
7576 else if (STRING_MULTIBYTE (it->string))
7577 {
7578 const unsigned char *s = (SDATA (it->string)
7579 + IT_STRING_BYTEPOS (*it));
7580 it->c = string_char_and_length (s, &it->len);
7581 }
7582 else
7583 {
7584 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7585 it->len = 1;
7586 }
7587 }
7588 else
7589 {
7590 /* Get the next character from a Lisp string that is not an
7591 overlay string. Such strings come from the mode line, for
7592 example. We may have to pad with spaces, or truncate the
7593 string. See also next_element_from_c_string. */
7594 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7595 {
7596 it->what = IT_EOB;
7597 return 0;
7598 }
7599 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7600 {
7601 /* Pad with spaces. */
7602 it->c = ' ', it->len = 1;
7603 CHARPOS (position) = BYTEPOS (position) = -1;
7604 }
7605 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7606 IT_STRING_BYTEPOS (*it),
7607 it->bidi_it.scan_dir < 0
7608 ? -1
7609 : it->string_nchars)
7610 && next_element_from_composition (it))
7611 {
7612 return 1;
7613 }
7614 else if (STRING_MULTIBYTE (it->string))
7615 {
7616 const unsigned char *s = (SDATA (it->string)
7617 + IT_STRING_BYTEPOS (*it));
7618 it->c = string_char_and_length (s, &it->len);
7619 }
7620 else
7621 {
7622 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7623 it->len = 1;
7624 }
7625 }
7626
7627 /* Record what we have and where it came from. */
7628 it->what = IT_CHARACTER;
7629 it->object = it->string;
7630 it->position = position;
7631 return 1;
7632 }
7633
7634
7635 /* Load IT with next display element from C string IT->s.
7636 IT->string_nchars is the maximum number of characters to return
7637 from the string. IT->end_charpos may be greater than
7638 IT->string_nchars when this function is called, in which case we
7639 may have to return padding spaces. Value is zero if end of string
7640 reached, including padding spaces. */
7641
7642 static int
7643 next_element_from_c_string (struct it *it)
7644 {
7645 int success_p = 1;
7646
7647 eassert (it->s);
7648 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
7649 it->what = IT_CHARACTER;
7650 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
7651 it->object = Qnil;
7652
7653 /* With bidi reordering, the character to display might not be the
7654 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7655 we were reseated to a new string, whose paragraph direction is
7656 not known. */
7657 if (it->bidi_p && it->bidi_it.first_elt)
7658 get_visually_first_element (it);
7659
7660 /* IT's position can be greater than IT->string_nchars in case a
7661 field width or precision has been specified when the iterator was
7662 initialized. */
7663 if (IT_CHARPOS (*it) >= it->end_charpos)
7664 {
7665 /* End of the game. */
7666 it->what = IT_EOB;
7667 success_p = 0;
7668 }
7669 else if (IT_CHARPOS (*it) >= it->string_nchars)
7670 {
7671 /* Pad with spaces. */
7672 it->c = ' ', it->len = 1;
7673 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
7674 }
7675 else if (it->multibyte_p)
7676 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
7677 else
7678 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
7679
7680 return success_p;
7681 }
7682
7683
7684 /* Set up IT to return characters from an ellipsis, if appropriate.
7685 The definition of the ellipsis glyphs may come from a display table
7686 entry. This function fills IT with the first glyph from the
7687 ellipsis if an ellipsis is to be displayed. */
7688
7689 static int
7690 next_element_from_ellipsis (struct it *it)
7691 {
7692 if (it->selective_display_ellipsis_p)
7693 setup_for_ellipsis (it, it->len);
7694 else
7695 {
7696 /* The face at the current position may be different from the
7697 face we find after the invisible text. Remember what it
7698 was in IT->saved_face_id, and signal that it's there by
7699 setting face_before_selective_p. */
7700 it->saved_face_id = it->face_id;
7701 it->method = GET_FROM_BUFFER;
7702 it->object = it->w->buffer;
7703 reseat_at_next_visible_line_start (it, 1);
7704 it->face_before_selective_p = 1;
7705 }
7706
7707 return GET_NEXT_DISPLAY_ELEMENT (it);
7708 }
7709
7710
7711 /* Deliver an image display element. The iterator IT is already
7712 filled with image information (done in handle_display_prop). Value
7713 is always 1. */
7714
7715
7716 static int
7717 next_element_from_image (struct it *it)
7718 {
7719 it->what = IT_IMAGE;
7720 it->ignore_overlay_strings_at_pos_p = 0;
7721 return 1;
7722 }
7723
7724
7725 /* Fill iterator IT with next display element from a stretch glyph
7726 property. IT->object is the value of the text property. Value is
7727 always 1. */
7728
7729 static int
7730 next_element_from_stretch (struct it *it)
7731 {
7732 it->what = IT_STRETCH;
7733 return 1;
7734 }
7735
7736 /* Scan backwards from IT's current position until we find a stop
7737 position, or until BEGV. This is called when we find ourself
7738 before both the last known prev_stop and base_level_stop while
7739 reordering bidirectional text. */
7740
7741 static void
7742 compute_stop_pos_backwards (struct it *it)
7743 {
7744 const int SCAN_BACK_LIMIT = 1000;
7745 struct text_pos pos;
7746 struct display_pos save_current = it->current;
7747 struct text_pos save_position = it->position;
7748 ptrdiff_t charpos = IT_CHARPOS (*it);
7749 ptrdiff_t where_we_are = charpos;
7750 ptrdiff_t save_stop_pos = it->stop_charpos;
7751 ptrdiff_t save_end_pos = it->end_charpos;
7752
7753 eassert (NILP (it->string) && !it->s);
7754 eassert (it->bidi_p);
7755 it->bidi_p = 0;
7756 do
7757 {
7758 it->end_charpos = min (charpos + 1, ZV);
7759 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
7760 SET_TEXT_POS (pos, charpos, BYTE_TO_CHAR (charpos));
7761 reseat_1 (it, pos, 0);
7762 compute_stop_pos (it);
7763 /* We must advance forward, right? */
7764 if (it->stop_charpos <= charpos)
7765 emacs_abort ();
7766 }
7767 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
7768
7769 if (it->stop_charpos <= where_we_are)
7770 it->prev_stop = it->stop_charpos;
7771 else
7772 it->prev_stop = BEGV;
7773 it->bidi_p = 1;
7774 it->current = save_current;
7775 it->position = save_position;
7776 it->stop_charpos = save_stop_pos;
7777 it->end_charpos = save_end_pos;
7778 }
7779
7780 /* Scan forward from CHARPOS in the current buffer/string, until we
7781 find a stop position > current IT's position. Then handle the stop
7782 position before that. This is called when we bump into a stop
7783 position while reordering bidirectional text. CHARPOS should be
7784 the last previously processed stop_pos (or BEGV/0, if none were
7785 processed yet) whose position is less that IT's current
7786 position. */
7787
7788 static void
7789 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
7790 {
7791 int bufp = !STRINGP (it->string);
7792 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
7793 struct display_pos save_current = it->current;
7794 struct text_pos save_position = it->position;
7795 struct text_pos pos1;
7796 ptrdiff_t next_stop;
7797
7798 /* Scan in strict logical order. */
7799 eassert (it->bidi_p);
7800 it->bidi_p = 0;
7801 do
7802 {
7803 it->prev_stop = charpos;
7804 if (bufp)
7805 {
7806 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
7807 reseat_1 (it, pos1, 0);
7808 }
7809 else
7810 it->current.string_pos = string_pos (charpos, it->string);
7811 compute_stop_pos (it);
7812 /* We must advance forward, right? */
7813 if (it->stop_charpos <= it->prev_stop)
7814 emacs_abort ();
7815 charpos = it->stop_charpos;
7816 }
7817 while (charpos <= where_we_are);
7818
7819 it->bidi_p = 1;
7820 it->current = save_current;
7821 it->position = save_position;
7822 next_stop = it->stop_charpos;
7823 it->stop_charpos = it->prev_stop;
7824 handle_stop (it);
7825 it->stop_charpos = next_stop;
7826 }
7827
7828 /* Load IT with the next display element from current_buffer. Value
7829 is zero if end of buffer reached. IT->stop_charpos is the next
7830 position at which to stop and check for text properties or buffer
7831 end. */
7832
7833 static int
7834 next_element_from_buffer (struct it *it)
7835 {
7836 int success_p = 1;
7837
7838 eassert (IT_CHARPOS (*it) >= BEGV);
7839 eassert (NILP (it->string) && !it->s);
7840 eassert (!it->bidi_p
7841 || (EQ (it->bidi_it.string.lstring, Qnil)
7842 && it->bidi_it.string.s == NULL));
7843
7844 /* With bidi reordering, the character to display might not be the
7845 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7846 we were reseat()ed to a new buffer position, which is potentially
7847 a different paragraph. */
7848 if (it->bidi_p && it->bidi_it.first_elt)
7849 {
7850 get_visually_first_element (it);
7851 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
7852 }
7853
7854 if (IT_CHARPOS (*it) >= it->stop_charpos)
7855 {
7856 if (IT_CHARPOS (*it) >= it->end_charpos)
7857 {
7858 int overlay_strings_follow_p;
7859
7860 /* End of the game, except when overlay strings follow that
7861 haven't been returned yet. */
7862 if (it->overlay_strings_at_end_processed_p)
7863 overlay_strings_follow_p = 0;
7864 else
7865 {
7866 it->overlay_strings_at_end_processed_p = 1;
7867 overlay_strings_follow_p = get_overlay_strings (it, 0);
7868 }
7869
7870 if (overlay_strings_follow_p)
7871 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
7872 else
7873 {
7874 it->what = IT_EOB;
7875 it->position = it->current.pos;
7876 success_p = 0;
7877 }
7878 }
7879 else if (!(!it->bidi_p
7880 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7881 || IT_CHARPOS (*it) == it->stop_charpos))
7882 {
7883 /* With bidi non-linear iteration, we could find ourselves
7884 far beyond the last computed stop_charpos, with several
7885 other stop positions in between that we missed. Scan
7886 them all now, in buffer's logical order, until we find
7887 and handle the last stop_charpos that precedes our
7888 current position. */
7889 handle_stop_backwards (it, it->stop_charpos);
7890 return GET_NEXT_DISPLAY_ELEMENT (it);
7891 }
7892 else
7893 {
7894 if (it->bidi_p)
7895 {
7896 /* Take note of the stop position we just moved across,
7897 for when we will move back across it. */
7898 it->prev_stop = it->stop_charpos;
7899 /* If we are at base paragraph embedding level, take
7900 note of the last stop position seen at this
7901 level. */
7902 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7903 it->base_level_stop = it->stop_charpos;
7904 }
7905 handle_stop (it);
7906 return GET_NEXT_DISPLAY_ELEMENT (it);
7907 }
7908 }
7909 else if (it->bidi_p
7910 /* If we are before prev_stop, we may have overstepped on
7911 our way backwards a stop_pos, and if so, we need to
7912 handle that stop_pos. */
7913 && IT_CHARPOS (*it) < it->prev_stop
7914 /* We can sometimes back up for reasons that have nothing
7915 to do with bidi reordering. E.g., compositions. The
7916 code below is only needed when we are above the base
7917 embedding level, so test for that explicitly. */
7918 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7919 {
7920 if (it->base_level_stop <= 0
7921 || IT_CHARPOS (*it) < it->base_level_stop)
7922 {
7923 /* If we lost track of base_level_stop, we need to find
7924 prev_stop by looking backwards. This happens, e.g., when
7925 we were reseated to the previous screenful of text by
7926 vertical-motion. */
7927 it->base_level_stop = BEGV;
7928 compute_stop_pos_backwards (it);
7929 handle_stop_backwards (it, it->prev_stop);
7930 }
7931 else
7932 handle_stop_backwards (it, it->base_level_stop);
7933 return GET_NEXT_DISPLAY_ELEMENT (it);
7934 }
7935 else
7936 {
7937 /* No face changes, overlays etc. in sight, so just return a
7938 character from current_buffer. */
7939 unsigned char *p;
7940 ptrdiff_t stop;
7941
7942 /* Maybe run the redisplay end trigger hook. Performance note:
7943 This doesn't seem to cost measurable time. */
7944 if (it->redisplay_end_trigger_charpos
7945 && it->glyph_row
7946 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
7947 run_redisplay_end_trigger_hook (it);
7948
7949 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
7950 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
7951 stop)
7952 && next_element_from_composition (it))
7953 {
7954 return 1;
7955 }
7956
7957 /* Get the next character, maybe multibyte. */
7958 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
7959 if (it->multibyte_p && !ASCII_BYTE_P (*p))
7960 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
7961 else
7962 it->c = *p, it->len = 1;
7963
7964 /* Record what we have and where it came from. */
7965 it->what = IT_CHARACTER;
7966 it->object = it->w->buffer;
7967 it->position = it->current.pos;
7968
7969 /* Normally we return the character found above, except when we
7970 really want to return an ellipsis for selective display. */
7971 if (it->selective)
7972 {
7973 if (it->c == '\n')
7974 {
7975 /* A value of selective > 0 means hide lines indented more
7976 than that number of columns. */
7977 if (it->selective > 0
7978 && IT_CHARPOS (*it) + 1 < ZV
7979 && indented_beyond_p (IT_CHARPOS (*it) + 1,
7980 IT_BYTEPOS (*it) + 1,
7981 it->selective))
7982 {
7983 success_p = next_element_from_ellipsis (it);
7984 it->dpvec_char_len = -1;
7985 }
7986 }
7987 else if (it->c == '\r' && it->selective == -1)
7988 {
7989 /* A value of selective == -1 means that everything from the
7990 CR to the end of the line is invisible, with maybe an
7991 ellipsis displayed for it. */
7992 success_p = next_element_from_ellipsis (it);
7993 it->dpvec_char_len = -1;
7994 }
7995 }
7996 }
7997
7998 /* Value is zero if end of buffer reached. */
7999 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8000 return success_p;
8001 }
8002
8003
8004 /* Run the redisplay end trigger hook for IT. */
8005
8006 static void
8007 run_redisplay_end_trigger_hook (struct it *it)
8008 {
8009 Lisp_Object args[3];
8010
8011 /* IT->glyph_row should be non-null, i.e. we should be actually
8012 displaying something, or otherwise we should not run the hook. */
8013 eassert (it->glyph_row);
8014
8015 /* Set up hook arguments. */
8016 args[0] = Qredisplay_end_trigger_functions;
8017 args[1] = it->window;
8018 XSETINT (args[2], it->redisplay_end_trigger_charpos);
8019 it->redisplay_end_trigger_charpos = 0;
8020
8021 /* Since we are *trying* to run these functions, don't try to run
8022 them again, even if they get an error. */
8023 wset_redisplay_end_trigger (it->w, Qnil);
8024 Frun_hook_with_args (3, args);
8025
8026 /* Notice if it changed the face of the character we are on. */
8027 handle_face_prop (it);
8028 }
8029
8030
8031 /* Deliver a composition display element. Unlike the other
8032 next_element_from_XXX, this function is not registered in the array
8033 get_next_element[]. It is called from next_element_from_buffer and
8034 next_element_from_string when necessary. */
8035
8036 static int
8037 next_element_from_composition (struct it *it)
8038 {
8039 it->what = IT_COMPOSITION;
8040 it->len = it->cmp_it.nbytes;
8041 if (STRINGP (it->string))
8042 {
8043 if (it->c < 0)
8044 {
8045 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8046 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8047 return 0;
8048 }
8049 it->position = it->current.string_pos;
8050 it->object = it->string;
8051 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8052 IT_STRING_BYTEPOS (*it), it->string);
8053 }
8054 else
8055 {
8056 if (it->c < 0)
8057 {
8058 IT_CHARPOS (*it) += it->cmp_it.nchars;
8059 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8060 if (it->bidi_p)
8061 {
8062 if (it->bidi_it.new_paragraph)
8063 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
8064 /* Resync the bidi iterator with IT's new position.
8065 FIXME: this doesn't support bidirectional text. */
8066 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8067 bidi_move_to_visually_next (&it->bidi_it);
8068 }
8069 return 0;
8070 }
8071 it->position = it->current.pos;
8072 it->object = it->w->buffer;
8073 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8074 IT_BYTEPOS (*it), Qnil);
8075 }
8076 return 1;
8077 }
8078
8079
8080 \f
8081 /***********************************************************************
8082 Moving an iterator without producing glyphs
8083 ***********************************************************************/
8084
8085 /* Check if iterator is at a position corresponding to a valid buffer
8086 position after some move_it_ call. */
8087
8088 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8089 ((it)->method == GET_FROM_STRING \
8090 ? IT_STRING_CHARPOS (*it) == 0 \
8091 : 1)
8092
8093
8094 /* Move iterator IT to a specified buffer or X position within one
8095 line on the display without producing glyphs.
8096
8097 OP should be a bit mask including some or all of these bits:
8098 MOVE_TO_X: Stop upon reaching x-position TO_X.
8099 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8100 Regardless of OP's value, stop upon reaching the end of the display line.
8101
8102 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8103 This means, in particular, that TO_X includes window's horizontal
8104 scroll amount.
8105
8106 The return value has several possible values that
8107 say what condition caused the scan to stop:
8108
8109 MOVE_POS_MATCH_OR_ZV
8110 - when TO_POS or ZV was reached.
8111
8112 MOVE_X_REACHED
8113 -when TO_X was reached before TO_POS or ZV were reached.
8114
8115 MOVE_LINE_CONTINUED
8116 - when we reached the end of the display area and the line must
8117 be continued.
8118
8119 MOVE_LINE_TRUNCATED
8120 - when we reached the end of the display area and the line is
8121 truncated.
8122
8123 MOVE_NEWLINE_OR_CR
8124 - when we stopped at a line end, i.e. a newline or a CR and selective
8125 display is on. */
8126
8127 static enum move_it_result
8128 move_it_in_display_line_to (struct it *it,
8129 ptrdiff_t to_charpos, int to_x,
8130 enum move_operation_enum op)
8131 {
8132 enum move_it_result result = MOVE_UNDEFINED;
8133 struct glyph_row *saved_glyph_row;
8134 struct it wrap_it, atpos_it, atx_it, ppos_it;
8135 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8136 void *ppos_data = NULL;
8137 int may_wrap = 0;
8138 enum it_method prev_method = it->method;
8139 ptrdiff_t prev_pos = IT_CHARPOS (*it);
8140 int saw_smaller_pos = prev_pos < to_charpos;
8141
8142 /* Don't produce glyphs in produce_glyphs. */
8143 saved_glyph_row = it->glyph_row;
8144 it->glyph_row = NULL;
8145
8146 /* Use wrap_it to save a copy of IT wherever a word wrap could
8147 occur. Use atpos_it to save a copy of IT at the desired buffer
8148 position, if found, so that we can scan ahead and check if the
8149 word later overshoots the window edge. Use atx_it similarly, for
8150 pixel positions. */
8151 wrap_it.sp = -1;
8152 atpos_it.sp = -1;
8153 atx_it.sp = -1;
8154
8155 /* Use ppos_it under bidi reordering to save a copy of IT for the
8156 position > CHARPOS that is the closest to CHARPOS. We restore
8157 that position in IT when we have scanned the entire display line
8158 without finding a match for CHARPOS and all the character
8159 positions are greater than CHARPOS. */
8160 if (it->bidi_p)
8161 {
8162 SAVE_IT (ppos_it, *it, ppos_data);
8163 SET_TEXT_POS (ppos_it.current.pos, ZV, ZV_BYTE);
8164 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8165 SAVE_IT (ppos_it, *it, ppos_data);
8166 }
8167
8168 #define BUFFER_POS_REACHED_P() \
8169 ((op & MOVE_TO_POS) != 0 \
8170 && BUFFERP (it->object) \
8171 && (IT_CHARPOS (*it) == to_charpos \
8172 || ((!it->bidi_p \
8173 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8174 && IT_CHARPOS (*it) > to_charpos) \
8175 || (it->what == IT_COMPOSITION \
8176 && ((IT_CHARPOS (*it) > to_charpos \
8177 && to_charpos >= it->cmp_it.charpos) \
8178 || (IT_CHARPOS (*it) < to_charpos \
8179 && to_charpos <= it->cmp_it.charpos)))) \
8180 && (it->method == GET_FROM_BUFFER \
8181 || (it->method == GET_FROM_DISPLAY_VECTOR \
8182 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8183
8184 /* If there's a line-/wrap-prefix, handle it. */
8185 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8186 && it->current_y < it->last_visible_y)
8187 handle_line_prefix (it);
8188
8189 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8190 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8191
8192 while (1)
8193 {
8194 int x, i, ascent = 0, descent = 0;
8195
8196 /* Utility macro to reset an iterator with x, ascent, and descent. */
8197 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8198 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8199 (IT)->max_descent = descent)
8200
8201 /* Stop if we move beyond TO_CHARPOS (after an image or a
8202 display string or stretch glyph). */
8203 if ((op & MOVE_TO_POS) != 0
8204 && BUFFERP (it->object)
8205 && it->method == GET_FROM_BUFFER
8206 && (((!it->bidi_p
8207 /* When the iterator is at base embedding level, we
8208 are guaranteed that characters are delivered for
8209 display in strictly increasing order of their
8210 buffer positions. */
8211 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8212 && IT_CHARPOS (*it) > to_charpos)
8213 || (it->bidi_p
8214 && (prev_method == GET_FROM_IMAGE
8215 || prev_method == GET_FROM_STRETCH
8216 || prev_method == GET_FROM_STRING)
8217 /* Passed TO_CHARPOS from left to right. */
8218 && ((prev_pos < to_charpos
8219 && IT_CHARPOS (*it) > to_charpos)
8220 /* Passed TO_CHARPOS from right to left. */
8221 || (prev_pos > to_charpos
8222 && IT_CHARPOS (*it) < to_charpos)))))
8223 {
8224 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8225 {
8226 result = MOVE_POS_MATCH_OR_ZV;
8227 break;
8228 }
8229 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8230 /* If wrap_it is valid, the current position might be in a
8231 word that is wrapped. So, save the iterator in
8232 atpos_it and continue to see if wrapping happens. */
8233 SAVE_IT (atpos_it, *it, atpos_data);
8234 }
8235
8236 /* Stop when ZV reached.
8237 We used to stop here when TO_CHARPOS reached as well, but that is
8238 too soon if this glyph does not fit on this line. So we handle it
8239 explicitly below. */
8240 if (!get_next_display_element (it))
8241 {
8242 result = MOVE_POS_MATCH_OR_ZV;
8243 break;
8244 }
8245
8246 if (it->line_wrap == TRUNCATE)
8247 {
8248 if (BUFFER_POS_REACHED_P ())
8249 {
8250 result = MOVE_POS_MATCH_OR_ZV;
8251 break;
8252 }
8253 }
8254 else
8255 {
8256 if (it->line_wrap == WORD_WRAP)
8257 {
8258 if (IT_DISPLAYING_WHITESPACE (it))
8259 may_wrap = 1;
8260 else if (may_wrap)
8261 {
8262 /* We have reached a glyph that follows one or more
8263 whitespace characters. If the position is
8264 already found, we are done. */
8265 if (atpos_it.sp >= 0)
8266 {
8267 RESTORE_IT (it, &atpos_it, atpos_data);
8268 result = MOVE_POS_MATCH_OR_ZV;
8269 goto done;
8270 }
8271 if (atx_it.sp >= 0)
8272 {
8273 RESTORE_IT (it, &atx_it, atx_data);
8274 result = MOVE_X_REACHED;
8275 goto done;
8276 }
8277 /* Otherwise, we can wrap here. */
8278 SAVE_IT (wrap_it, *it, wrap_data);
8279 may_wrap = 0;
8280 }
8281 }
8282 }
8283
8284 /* Remember the line height for the current line, in case
8285 the next element doesn't fit on the line. */
8286 ascent = it->max_ascent;
8287 descent = it->max_descent;
8288
8289 /* The call to produce_glyphs will get the metrics of the
8290 display element IT is loaded with. Record the x-position
8291 before this display element, in case it doesn't fit on the
8292 line. */
8293 x = it->current_x;
8294
8295 PRODUCE_GLYPHS (it);
8296
8297 if (it->area != TEXT_AREA)
8298 {
8299 prev_method = it->method;
8300 if (it->method == GET_FROM_BUFFER)
8301 prev_pos = IT_CHARPOS (*it);
8302 set_iterator_to_next (it, 1);
8303 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8304 SET_TEXT_POS (this_line_min_pos,
8305 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8306 if (it->bidi_p
8307 && (op & MOVE_TO_POS)
8308 && IT_CHARPOS (*it) > to_charpos
8309 && IT_CHARPOS (*it) < IT_CHARPOS (ppos_it))
8310 SAVE_IT (ppos_it, *it, ppos_data);
8311 continue;
8312 }
8313
8314 /* The number of glyphs we get back in IT->nglyphs will normally
8315 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8316 character on a terminal frame, or (iii) a line end. For the
8317 second case, IT->nglyphs - 1 padding glyphs will be present.
8318 (On X frames, there is only one glyph produced for a
8319 composite character.)
8320
8321 The behavior implemented below means, for continuation lines,
8322 that as many spaces of a TAB as fit on the current line are
8323 displayed there. For terminal frames, as many glyphs of a
8324 multi-glyph character are displayed in the current line, too.
8325 This is what the old redisplay code did, and we keep it that
8326 way. Under X, the whole shape of a complex character must
8327 fit on the line or it will be completely displayed in the
8328 next line.
8329
8330 Note that both for tabs and padding glyphs, all glyphs have
8331 the same width. */
8332 if (it->nglyphs)
8333 {
8334 /* More than one glyph or glyph doesn't fit on line. All
8335 glyphs have the same width. */
8336 int single_glyph_width = it->pixel_width / it->nglyphs;
8337 int new_x;
8338 int x_before_this_char = x;
8339 int hpos_before_this_char = it->hpos;
8340
8341 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8342 {
8343 new_x = x + single_glyph_width;
8344
8345 /* We want to leave anything reaching TO_X to the caller. */
8346 if ((op & MOVE_TO_X) && new_x > to_x)
8347 {
8348 if (BUFFER_POS_REACHED_P ())
8349 {
8350 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8351 goto buffer_pos_reached;
8352 if (atpos_it.sp < 0)
8353 {
8354 SAVE_IT (atpos_it, *it, atpos_data);
8355 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8356 }
8357 }
8358 else
8359 {
8360 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8361 {
8362 it->current_x = x;
8363 result = MOVE_X_REACHED;
8364 break;
8365 }
8366 if (atx_it.sp < 0)
8367 {
8368 SAVE_IT (atx_it, *it, atx_data);
8369 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8370 }
8371 }
8372 }
8373
8374 if (/* Lines are continued. */
8375 it->line_wrap != TRUNCATE
8376 && (/* And glyph doesn't fit on the line. */
8377 new_x > it->last_visible_x
8378 /* Or it fits exactly and we're on a window
8379 system frame. */
8380 || (new_x == it->last_visible_x
8381 && FRAME_WINDOW_P (it->f)
8382 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8383 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8384 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8385 {
8386 if (/* IT->hpos == 0 means the very first glyph
8387 doesn't fit on the line, e.g. a wide image. */
8388 it->hpos == 0
8389 || (new_x == it->last_visible_x
8390 && FRAME_WINDOW_P (it->f)))
8391 {
8392 ++it->hpos;
8393 it->current_x = new_x;
8394
8395 /* The character's last glyph just barely fits
8396 in this row. */
8397 if (i == it->nglyphs - 1)
8398 {
8399 /* If this is the destination position,
8400 return a position *before* it in this row,
8401 now that we know it fits in this row. */
8402 if (BUFFER_POS_REACHED_P ())
8403 {
8404 if (it->line_wrap != WORD_WRAP
8405 || wrap_it.sp < 0)
8406 {
8407 it->hpos = hpos_before_this_char;
8408 it->current_x = x_before_this_char;
8409 result = MOVE_POS_MATCH_OR_ZV;
8410 break;
8411 }
8412 if (it->line_wrap == WORD_WRAP
8413 && atpos_it.sp < 0)
8414 {
8415 SAVE_IT (atpos_it, *it, atpos_data);
8416 atpos_it.current_x = x_before_this_char;
8417 atpos_it.hpos = hpos_before_this_char;
8418 }
8419 }
8420
8421 prev_method = it->method;
8422 if (it->method == GET_FROM_BUFFER)
8423 prev_pos = IT_CHARPOS (*it);
8424 set_iterator_to_next (it, 1);
8425 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8426 SET_TEXT_POS (this_line_min_pos,
8427 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8428 /* On graphical terminals, newlines may
8429 "overflow" into the fringe if
8430 overflow-newline-into-fringe is non-nil.
8431 On text terminals, and on graphical
8432 terminals with no right margin, newlines
8433 may overflow into the last glyph on the
8434 display line.*/
8435 if (!FRAME_WINDOW_P (it->f)
8436 || ((it->bidi_p
8437 && it->bidi_it.paragraph_dir == R2L)
8438 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8439 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8440 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8441 {
8442 if (!get_next_display_element (it))
8443 {
8444 result = MOVE_POS_MATCH_OR_ZV;
8445 break;
8446 }
8447 if (BUFFER_POS_REACHED_P ())
8448 {
8449 if (ITERATOR_AT_END_OF_LINE_P (it))
8450 result = MOVE_POS_MATCH_OR_ZV;
8451 else
8452 result = MOVE_LINE_CONTINUED;
8453 break;
8454 }
8455 if (ITERATOR_AT_END_OF_LINE_P (it))
8456 {
8457 result = MOVE_NEWLINE_OR_CR;
8458 break;
8459 }
8460 }
8461 }
8462 }
8463 else
8464 IT_RESET_X_ASCENT_DESCENT (it);
8465
8466 if (wrap_it.sp >= 0)
8467 {
8468 RESTORE_IT (it, &wrap_it, wrap_data);
8469 atpos_it.sp = -1;
8470 atx_it.sp = -1;
8471 }
8472
8473 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8474 IT_CHARPOS (*it)));
8475 result = MOVE_LINE_CONTINUED;
8476 break;
8477 }
8478
8479 if (BUFFER_POS_REACHED_P ())
8480 {
8481 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8482 goto buffer_pos_reached;
8483 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8484 {
8485 SAVE_IT (atpos_it, *it, atpos_data);
8486 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8487 }
8488 }
8489
8490 if (new_x > it->first_visible_x)
8491 {
8492 /* Glyph is visible. Increment number of glyphs that
8493 would be displayed. */
8494 ++it->hpos;
8495 }
8496 }
8497
8498 if (result != MOVE_UNDEFINED)
8499 break;
8500 }
8501 else if (BUFFER_POS_REACHED_P ())
8502 {
8503 buffer_pos_reached:
8504 IT_RESET_X_ASCENT_DESCENT (it);
8505 result = MOVE_POS_MATCH_OR_ZV;
8506 break;
8507 }
8508 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8509 {
8510 /* Stop when TO_X specified and reached. This check is
8511 necessary here because of lines consisting of a line end,
8512 only. The line end will not produce any glyphs and we
8513 would never get MOVE_X_REACHED. */
8514 eassert (it->nglyphs == 0);
8515 result = MOVE_X_REACHED;
8516 break;
8517 }
8518
8519 /* Is this a line end? If yes, we're done. */
8520 if (ITERATOR_AT_END_OF_LINE_P (it))
8521 {
8522 /* If we are past TO_CHARPOS, but never saw any character
8523 positions smaller than TO_CHARPOS, return
8524 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8525 did. */
8526 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8527 {
8528 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8529 {
8530 if (IT_CHARPOS (ppos_it) < ZV)
8531 {
8532 RESTORE_IT (it, &ppos_it, ppos_data);
8533 result = MOVE_POS_MATCH_OR_ZV;
8534 }
8535 else
8536 goto buffer_pos_reached;
8537 }
8538 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8539 && IT_CHARPOS (*it) > to_charpos)
8540 goto buffer_pos_reached;
8541 else
8542 result = MOVE_NEWLINE_OR_CR;
8543 }
8544 else
8545 result = MOVE_NEWLINE_OR_CR;
8546 break;
8547 }
8548
8549 prev_method = it->method;
8550 if (it->method == GET_FROM_BUFFER)
8551 prev_pos = IT_CHARPOS (*it);
8552 /* The current display element has been consumed. Advance
8553 to the next. */
8554 set_iterator_to_next (it, 1);
8555 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8556 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8557 if (IT_CHARPOS (*it) < to_charpos)
8558 saw_smaller_pos = 1;
8559 if (it->bidi_p
8560 && (op & MOVE_TO_POS)
8561 && IT_CHARPOS (*it) >= to_charpos
8562 && IT_CHARPOS (*it) < IT_CHARPOS (ppos_it))
8563 SAVE_IT (ppos_it, *it, ppos_data);
8564
8565 /* Stop if lines are truncated and IT's current x-position is
8566 past the right edge of the window now. */
8567 if (it->line_wrap == TRUNCATE
8568 && it->current_x >= it->last_visible_x)
8569 {
8570 if (!FRAME_WINDOW_P (it->f)
8571 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8572 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8573 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8574 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8575 {
8576 int at_eob_p = 0;
8577
8578 if ((at_eob_p = !get_next_display_element (it))
8579 || BUFFER_POS_REACHED_P ()
8580 /* If we are past TO_CHARPOS, but never saw any
8581 character positions smaller than TO_CHARPOS,
8582 return MOVE_POS_MATCH_OR_ZV, like the
8583 unidirectional display did. */
8584 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8585 && !saw_smaller_pos
8586 && IT_CHARPOS (*it) > to_charpos))
8587 {
8588 if (it->bidi_p
8589 && !at_eob_p && IT_CHARPOS (ppos_it) < ZV)
8590 RESTORE_IT (it, &ppos_it, ppos_data);
8591 result = MOVE_POS_MATCH_OR_ZV;
8592 break;
8593 }
8594 if (ITERATOR_AT_END_OF_LINE_P (it))
8595 {
8596 result = MOVE_NEWLINE_OR_CR;
8597 break;
8598 }
8599 }
8600 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
8601 && !saw_smaller_pos
8602 && IT_CHARPOS (*it) > to_charpos)
8603 {
8604 if (IT_CHARPOS (ppos_it) < ZV)
8605 RESTORE_IT (it, &ppos_it, ppos_data);
8606 result = MOVE_POS_MATCH_OR_ZV;
8607 break;
8608 }
8609 result = MOVE_LINE_TRUNCATED;
8610 break;
8611 }
8612 #undef IT_RESET_X_ASCENT_DESCENT
8613 }
8614
8615 #undef BUFFER_POS_REACHED_P
8616
8617 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8618 restore the saved iterator. */
8619 if (atpos_it.sp >= 0)
8620 RESTORE_IT (it, &atpos_it, atpos_data);
8621 else if (atx_it.sp >= 0)
8622 RESTORE_IT (it, &atx_it, atx_data);
8623
8624 done:
8625
8626 if (atpos_data)
8627 bidi_unshelve_cache (atpos_data, 1);
8628 if (atx_data)
8629 bidi_unshelve_cache (atx_data, 1);
8630 if (wrap_data)
8631 bidi_unshelve_cache (wrap_data, 1);
8632 if (ppos_data)
8633 bidi_unshelve_cache (ppos_data, 1);
8634
8635 /* Restore the iterator settings altered at the beginning of this
8636 function. */
8637 it->glyph_row = saved_glyph_row;
8638 return result;
8639 }
8640
8641 /* For external use. */
8642 void
8643 move_it_in_display_line (struct it *it,
8644 ptrdiff_t to_charpos, int to_x,
8645 enum move_operation_enum op)
8646 {
8647 if (it->line_wrap == WORD_WRAP
8648 && (op & MOVE_TO_X))
8649 {
8650 struct it save_it;
8651 void *save_data = NULL;
8652 int skip;
8653
8654 SAVE_IT (save_it, *it, save_data);
8655 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
8656 /* When word-wrap is on, TO_X may lie past the end
8657 of a wrapped line. Then it->current is the
8658 character on the next line, so backtrack to the
8659 space before the wrap point. */
8660 if (skip == MOVE_LINE_CONTINUED)
8661 {
8662 int prev_x = max (it->current_x - 1, 0);
8663 RESTORE_IT (it, &save_it, save_data);
8664 move_it_in_display_line_to
8665 (it, -1, prev_x, MOVE_TO_X);
8666 }
8667 else
8668 bidi_unshelve_cache (save_data, 1);
8669 }
8670 else
8671 move_it_in_display_line_to (it, to_charpos, to_x, op);
8672 }
8673
8674
8675 /* Move IT forward until it satisfies one or more of the criteria in
8676 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8677
8678 OP is a bit-mask that specifies where to stop, and in particular,
8679 which of those four position arguments makes a difference. See the
8680 description of enum move_operation_enum.
8681
8682 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8683 screen line, this function will set IT to the next position that is
8684 displayed to the right of TO_CHARPOS on the screen. */
8685
8686 void
8687 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
8688 {
8689 enum move_it_result skip, skip2 = MOVE_X_REACHED;
8690 int line_height, line_start_x = 0, reached = 0;
8691 void *backup_data = NULL;
8692
8693 for (;;)
8694 {
8695 if (op & MOVE_TO_VPOS)
8696 {
8697 /* If no TO_CHARPOS and no TO_X specified, stop at the
8698 start of the line TO_VPOS. */
8699 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
8700 {
8701 if (it->vpos == to_vpos)
8702 {
8703 reached = 1;
8704 break;
8705 }
8706 else
8707 skip = move_it_in_display_line_to (it, -1, -1, 0);
8708 }
8709 else
8710 {
8711 /* TO_VPOS >= 0 means stop at TO_X in the line at
8712 TO_VPOS, or at TO_POS, whichever comes first. */
8713 if (it->vpos == to_vpos)
8714 {
8715 reached = 2;
8716 break;
8717 }
8718
8719 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
8720
8721 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
8722 {
8723 reached = 3;
8724 break;
8725 }
8726 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
8727 {
8728 /* We have reached TO_X but not in the line we want. */
8729 skip = move_it_in_display_line_to (it, to_charpos,
8730 -1, MOVE_TO_POS);
8731 if (skip == MOVE_POS_MATCH_OR_ZV)
8732 {
8733 reached = 4;
8734 break;
8735 }
8736 }
8737 }
8738 }
8739 else if (op & MOVE_TO_Y)
8740 {
8741 struct it it_backup;
8742
8743 if (it->line_wrap == WORD_WRAP)
8744 SAVE_IT (it_backup, *it, backup_data);
8745
8746 /* TO_Y specified means stop at TO_X in the line containing
8747 TO_Y---or at TO_CHARPOS if this is reached first. The
8748 problem is that we can't really tell whether the line
8749 contains TO_Y before we have completely scanned it, and
8750 this may skip past TO_X. What we do is to first scan to
8751 TO_X.
8752
8753 If TO_X is not specified, use a TO_X of zero. The reason
8754 is to make the outcome of this function more predictable.
8755 If we didn't use TO_X == 0, we would stop at the end of
8756 the line which is probably not what a caller would expect
8757 to happen. */
8758 skip = move_it_in_display_line_to
8759 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
8760 (MOVE_TO_X | (op & MOVE_TO_POS)));
8761
8762 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8763 if (skip == MOVE_POS_MATCH_OR_ZV)
8764 reached = 5;
8765 else if (skip == MOVE_X_REACHED)
8766 {
8767 /* If TO_X was reached, we want to know whether TO_Y is
8768 in the line. We know this is the case if the already
8769 scanned glyphs make the line tall enough. Otherwise,
8770 we must check by scanning the rest of the line. */
8771 line_height = it->max_ascent + it->max_descent;
8772 if (to_y >= it->current_y
8773 && to_y < it->current_y + line_height)
8774 {
8775 reached = 6;
8776 break;
8777 }
8778 SAVE_IT (it_backup, *it, backup_data);
8779 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
8780 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
8781 op & MOVE_TO_POS);
8782 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
8783 line_height = it->max_ascent + it->max_descent;
8784 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
8785
8786 if (to_y >= it->current_y
8787 && to_y < it->current_y + line_height)
8788 {
8789 /* If TO_Y is in this line and TO_X was reached
8790 above, we scanned too far. We have to restore
8791 IT's settings to the ones before skipping. But
8792 keep the more accurate values of max_ascent and
8793 max_descent we've found while skipping the rest
8794 of the line, for the sake of callers, such as
8795 pos_visible_p, that need to know the line
8796 height. */
8797 int max_ascent = it->max_ascent;
8798 int max_descent = it->max_descent;
8799
8800 RESTORE_IT (it, &it_backup, backup_data);
8801 it->max_ascent = max_ascent;
8802 it->max_descent = max_descent;
8803 reached = 6;
8804 }
8805 else
8806 {
8807 skip = skip2;
8808 if (skip == MOVE_POS_MATCH_OR_ZV)
8809 reached = 7;
8810 }
8811 }
8812 else
8813 {
8814 /* Check whether TO_Y is in this line. */
8815 line_height = it->max_ascent + it->max_descent;
8816 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
8817
8818 if (to_y >= it->current_y
8819 && to_y < it->current_y + line_height)
8820 {
8821 /* When word-wrap is on, TO_X may lie past the end
8822 of a wrapped line. Then it->current is the
8823 character on the next line, so backtrack to the
8824 space before the wrap point. */
8825 if (skip == MOVE_LINE_CONTINUED
8826 && it->line_wrap == WORD_WRAP)
8827 {
8828 int prev_x = max (it->current_x - 1, 0);
8829 RESTORE_IT (it, &it_backup, backup_data);
8830 skip = move_it_in_display_line_to
8831 (it, -1, prev_x, MOVE_TO_X);
8832 }
8833 reached = 6;
8834 }
8835 }
8836
8837 if (reached)
8838 break;
8839 }
8840 else if (BUFFERP (it->object)
8841 && (it->method == GET_FROM_BUFFER
8842 || it->method == GET_FROM_STRETCH)
8843 && IT_CHARPOS (*it) >= to_charpos
8844 /* Under bidi iteration, a call to set_iterator_to_next
8845 can scan far beyond to_charpos if the initial
8846 portion of the next line needs to be reordered. In
8847 that case, give move_it_in_display_line_to another
8848 chance below. */
8849 && !(it->bidi_p
8850 && it->bidi_it.scan_dir == -1))
8851 skip = MOVE_POS_MATCH_OR_ZV;
8852 else
8853 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
8854
8855 switch (skip)
8856 {
8857 case MOVE_POS_MATCH_OR_ZV:
8858 reached = 8;
8859 goto out;
8860
8861 case MOVE_NEWLINE_OR_CR:
8862 set_iterator_to_next (it, 1);
8863 it->continuation_lines_width = 0;
8864 break;
8865
8866 case MOVE_LINE_TRUNCATED:
8867 it->continuation_lines_width = 0;
8868 reseat_at_next_visible_line_start (it, 0);
8869 if ((op & MOVE_TO_POS) != 0
8870 && IT_CHARPOS (*it) > to_charpos)
8871 {
8872 reached = 9;
8873 goto out;
8874 }
8875 break;
8876
8877 case MOVE_LINE_CONTINUED:
8878 /* For continued lines ending in a tab, some of the glyphs
8879 associated with the tab are displayed on the current
8880 line. Since it->current_x does not include these glyphs,
8881 we use it->last_visible_x instead. */
8882 if (it->c == '\t')
8883 {
8884 it->continuation_lines_width += it->last_visible_x;
8885 /* When moving by vpos, ensure that the iterator really
8886 advances to the next line (bug#847, bug#969). Fixme:
8887 do we need to do this in other circumstances? */
8888 if (it->current_x != it->last_visible_x
8889 && (op & MOVE_TO_VPOS)
8890 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
8891 {
8892 line_start_x = it->current_x + it->pixel_width
8893 - it->last_visible_x;
8894 set_iterator_to_next (it, 0);
8895 }
8896 }
8897 else
8898 it->continuation_lines_width += it->current_x;
8899 break;
8900
8901 default:
8902 emacs_abort ();
8903 }
8904
8905 /* Reset/increment for the next run. */
8906 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
8907 it->current_x = line_start_x;
8908 line_start_x = 0;
8909 it->hpos = 0;
8910 it->current_y += it->max_ascent + it->max_descent;
8911 ++it->vpos;
8912 last_height = it->max_ascent + it->max_descent;
8913 last_max_ascent = it->max_ascent;
8914 it->max_ascent = it->max_descent = 0;
8915 }
8916
8917 out:
8918
8919 /* On text terminals, we may stop at the end of a line in the middle
8920 of a multi-character glyph. If the glyph itself is continued,
8921 i.e. it is actually displayed on the next line, don't treat this
8922 stopping point as valid; move to the next line instead (unless
8923 that brings us offscreen). */
8924 if (!FRAME_WINDOW_P (it->f)
8925 && op & MOVE_TO_POS
8926 && IT_CHARPOS (*it) == to_charpos
8927 && it->what == IT_CHARACTER
8928 && it->nglyphs > 1
8929 && it->line_wrap == WINDOW_WRAP
8930 && it->current_x == it->last_visible_x - 1
8931 && it->c != '\n'
8932 && it->c != '\t'
8933 && it->vpos < XFASTINT (it->w->window_end_vpos))
8934 {
8935 it->continuation_lines_width += it->current_x;
8936 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
8937 it->current_y += it->max_ascent + it->max_descent;
8938 ++it->vpos;
8939 last_height = it->max_ascent + it->max_descent;
8940 last_max_ascent = it->max_ascent;
8941 }
8942
8943 if (backup_data)
8944 bidi_unshelve_cache (backup_data, 1);
8945
8946 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
8947 }
8948
8949
8950 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8951
8952 If DY > 0, move IT backward at least that many pixels. DY = 0
8953 means move IT backward to the preceding line start or BEGV. This
8954 function may move over more than DY pixels if IT->current_y - DY
8955 ends up in the middle of a line; in this case IT->current_y will be
8956 set to the top of the line moved to. */
8957
8958 void
8959 move_it_vertically_backward (struct it *it, int dy)
8960 {
8961 int nlines, h;
8962 struct it it2, it3;
8963 void *it2data = NULL, *it3data = NULL;
8964 ptrdiff_t start_pos;
8965
8966 move_further_back:
8967 eassert (dy >= 0);
8968
8969 start_pos = IT_CHARPOS (*it);
8970
8971 /* Estimate how many newlines we must move back. */
8972 nlines = max (1, dy / FRAME_LINE_HEIGHT (it->f));
8973
8974 /* Set the iterator's position that many lines back. */
8975 while (nlines-- && IT_CHARPOS (*it) > BEGV)
8976 back_to_previous_visible_line_start (it);
8977
8978 /* Reseat the iterator here. When moving backward, we don't want
8979 reseat to skip forward over invisible text, set up the iterator
8980 to deliver from overlay strings at the new position etc. So,
8981 use reseat_1 here. */
8982 reseat_1 (it, it->current.pos, 1);
8983
8984 /* We are now surely at a line start. */
8985 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
8986 reordering is in effect. */
8987 it->continuation_lines_width = 0;
8988
8989 /* Move forward and see what y-distance we moved. First move to the
8990 start of the next line so that we get its height. We need this
8991 height to be able to tell whether we reached the specified
8992 y-distance. */
8993 SAVE_IT (it2, *it, it2data);
8994 it2.max_ascent = it2.max_descent = 0;
8995 do
8996 {
8997 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
8998 MOVE_TO_POS | MOVE_TO_VPOS);
8999 }
9000 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9001 /* If we are in a display string which starts at START_POS,
9002 and that display string includes a newline, and we are
9003 right after that newline (i.e. at the beginning of a
9004 display line), exit the loop, because otherwise we will
9005 infloop, since move_it_to will see that it is already at
9006 START_POS and will not move. */
9007 || (it2.method == GET_FROM_STRING
9008 && IT_CHARPOS (it2) == start_pos
9009 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9010 eassert (IT_CHARPOS (*it) >= BEGV);
9011 SAVE_IT (it3, it2, it3data);
9012
9013 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9014 eassert (IT_CHARPOS (*it) >= BEGV);
9015 /* H is the actual vertical distance from the position in *IT
9016 and the starting position. */
9017 h = it2.current_y - it->current_y;
9018 /* NLINES is the distance in number of lines. */
9019 nlines = it2.vpos - it->vpos;
9020
9021 /* Correct IT's y and vpos position
9022 so that they are relative to the starting point. */
9023 it->vpos -= nlines;
9024 it->current_y -= h;
9025
9026 if (dy == 0)
9027 {
9028 /* DY == 0 means move to the start of the screen line. The
9029 value of nlines is > 0 if continuation lines were involved,
9030 or if the original IT position was at start of a line. */
9031 RESTORE_IT (it, it, it2data);
9032 if (nlines > 0)
9033 move_it_by_lines (it, nlines);
9034 /* The above code moves us to some position NLINES down,
9035 usually to its first glyph (leftmost in an L2R line), but
9036 that's not necessarily the start of the line, under bidi
9037 reordering. We want to get to the character position
9038 that is immediately after the newline of the previous
9039 line. */
9040 if (it->bidi_p
9041 && !it->continuation_lines_width
9042 && !STRINGP (it->string)
9043 && IT_CHARPOS (*it) > BEGV
9044 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9045 {
9046 ptrdiff_t nl_pos =
9047 find_next_newline_no_quit (IT_CHARPOS (*it) - 1, -1);
9048
9049 move_it_to (it, nl_pos, -1, -1, -1, MOVE_TO_POS);
9050 }
9051 bidi_unshelve_cache (it3data, 1);
9052 }
9053 else
9054 {
9055 /* The y-position we try to reach, relative to *IT.
9056 Note that H has been subtracted in front of the if-statement. */
9057 int target_y = it->current_y + h - dy;
9058 int y0 = it3.current_y;
9059 int y1;
9060 int line_height;
9061
9062 RESTORE_IT (&it3, &it3, it3data);
9063 y1 = line_bottom_y (&it3);
9064 line_height = y1 - y0;
9065 RESTORE_IT (it, it, it2data);
9066 /* If we did not reach target_y, try to move further backward if
9067 we can. If we moved too far backward, try to move forward. */
9068 if (target_y < it->current_y
9069 /* This is heuristic. In a window that's 3 lines high, with
9070 a line height of 13 pixels each, recentering with point
9071 on the bottom line will try to move -39/2 = 19 pixels
9072 backward. Try to avoid moving into the first line. */
9073 && (it->current_y - target_y
9074 > min (window_box_height (it->w), line_height * 2 / 3))
9075 && IT_CHARPOS (*it) > BEGV)
9076 {
9077 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9078 target_y - it->current_y));
9079 dy = it->current_y - target_y;
9080 goto move_further_back;
9081 }
9082 else if (target_y >= it->current_y + line_height
9083 && IT_CHARPOS (*it) < ZV)
9084 {
9085 /* Should move forward by at least one line, maybe more.
9086
9087 Note: Calling move_it_by_lines can be expensive on
9088 terminal frames, where compute_motion is used (via
9089 vmotion) to do the job, when there are very long lines
9090 and truncate-lines is nil. That's the reason for
9091 treating terminal frames specially here. */
9092
9093 if (!FRAME_WINDOW_P (it->f))
9094 move_it_vertically (it, target_y - (it->current_y + line_height));
9095 else
9096 {
9097 do
9098 {
9099 move_it_by_lines (it, 1);
9100 }
9101 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9102 }
9103 }
9104 }
9105 }
9106
9107
9108 /* Move IT by a specified amount of pixel lines DY. DY negative means
9109 move backwards. DY = 0 means move to start of screen line. At the
9110 end, IT will be on the start of a screen line. */
9111
9112 void
9113 move_it_vertically (struct it *it, int dy)
9114 {
9115 if (dy <= 0)
9116 move_it_vertically_backward (it, -dy);
9117 else
9118 {
9119 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9120 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9121 MOVE_TO_POS | MOVE_TO_Y);
9122 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9123
9124 /* If buffer ends in ZV without a newline, move to the start of
9125 the line to satisfy the post-condition. */
9126 if (IT_CHARPOS (*it) == ZV
9127 && ZV > BEGV
9128 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9129 move_it_by_lines (it, 0);
9130 }
9131 }
9132
9133
9134 /* Move iterator IT past the end of the text line it is in. */
9135
9136 void
9137 move_it_past_eol (struct it *it)
9138 {
9139 enum move_it_result rc;
9140
9141 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9142 if (rc == MOVE_NEWLINE_OR_CR)
9143 set_iterator_to_next (it, 0);
9144 }
9145
9146
9147 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9148 negative means move up. DVPOS == 0 means move to the start of the
9149 screen line.
9150
9151 Optimization idea: If we would know that IT->f doesn't use
9152 a face with proportional font, we could be faster for
9153 truncate-lines nil. */
9154
9155 void
9156 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9157 {
9158
9159 /* The commented-out optimization uses vmotion on terminals. This
9160 gives bad results, because elements like it->what, on which
9161 callers such as pos_visible_p rely, aren't updated. */
9162 /* struct position pos;
9163 if (!FRAME_WINDOW_P (it->f))
9164 {
9165 struct text_pos textpos;
9166
9167 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9168 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9169 reseat (it, textpos, 1);
9170 it->vpos += pos.vpos;
9171 it->current_y += pos.vpos;
9172 }
9173 else */
9174
9175 if (dvpos == 0)
9176 {
9177 /* DVPOS == 0 means move to the start of the screen line. */
9178 move_it_vertically_backward (it, 0);
9179 /* Let next call to line_bottom_y calculate real line height */
9180 last_height = 0;
9181 }
9182 else if (dvpos > 0)
9183 {
9184 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9185 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9186 {
9187 /* Only move to the next buffer position if we ended up in a
9188 string from display property, not in an overlay string
9189 (before-string or after-string). That is because the
9190 latter don't conceal the underlying buffer position, so
9191 we can ask to move the iterator to the exact position we
9192 are interested in. Note that, even if we are already at
9193 IT_CHARPOS (*it), the call below is not a no-op, as it
9194 will detect that we are at the end of the string, pop the
9195 iterator, and compute it->current_x and it->hpos
9196 correctly. */
9197 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9198 -1, -1, -1, MOVE_TO_POS);
9199 }
9200 }
9201 else
9202 {
9203 struct it it2;
9204 void *it2data = NULL;
9205 ptrdiff_t start_charpos, i;
9206
9207 /* Start at the beginning of the screen line containing IT's
9208 position. This may actually move vertically backwards,
9209 in case of overlays, so adjust dvpos accordingly. */
9210 dvpos += it->vpos;
9211 move_it_vertically_backward (it, 0);
9212 dvpos -= it->vpos;
9213
9214 /* Go back -DVPOS visible lines and reseat the iterator there. */
9215 start_charpos = IT_CHARPOS (*it);
9216 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > BEGV; --i)
9217 back_to_previous_visible_line_start (it);
9218 reseat (it, it->current.pos, 1);
9219
9220 /* Move further back if we end up in a string or an image. */
9221 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9222 {
9223 /* First try to move to start of display line. */
9224 dvpos += it->vpos;
9225 move_it_vertically_backward (it, 0);
9226 dvpos -= it->vpos;
9227 if (IT_POS_VALID_AFTER_MOVE_P (it))
9228 break;
9229 /* If start of line is still in string or image,
9230 move further back. */
9231 back_to_previous_visible_line_start (it);
9232 reseat (it, it->current.pos, 1);
9233 dvpos--;
9234 }
9235
9236 it->current_x = it->hpos = 0;
9237
9238 /* Above call may have moved too far if continuation lines
9239 are involved. Scan forward and see if it did. */
9240 SAVE_IT (it2, *it, it2data);
9241 it2.vpos = it2.current_y = 0;
9242 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9243 it->vpos -= it2.vpos;
9244 it->current_y -= it2.current_y;
9245 it->current_x = it->hpos = 0;
9246
9247 /* If we moved too far back, move IT some lines forward. */
9248 if (it2.vpos > -dvpos)
9249 {
9250 int delta = it2.vpos + dvpos;
9251
9252 RESTORE_IT (&it2, &it2, it2data);
9253 SAVE_IT (it2, *it, it2data);
9254 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9255 /* Move back again if we got too far ahead. */
9256 if (IT_CHARPOS (*it) >= start_charpos)
9257 RESTORE_IT (it, &it2, it2data);
9258 else
9259 bidi_unshelve_cache (it2data, 1);
9260 }
9261 else
9262 RESTORE_IT (it, it, it2data);
9263 }
9264 }
9265
9266 /* Return 1 if IT points into the middle of a display vector. */
9267
9268 int
9269 in_display_vector_p (struct it *it)
9270 {
9271 return (it->method == GET_FROM_DISPLAY_VECTOR
9272 && it->current.dpvec_index > 0
9273 && it->dpvec + it->current.dpvec_index != it->dpend);
9274 }
9275
9276 \f
9277 /***********************************************************************
9278 Messages
9279 ***********************************************************************/
9280
9281
9282 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9283 to *Messages*. */
9284
9285 void
9286 add_to_log (const char *format, Lisp_Object arg1, Lisp_Object arg2)
9287 {
9288 Lisp_Object args[3];
9289 Lisp_Object msg, fmt;
9290 char *buffer;
9291 ptrdiff_t len;
9292 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9293 USE_SAFE_ALLOCA;
9294
9295 /* Do nothing if called asynchronously. Inserting text into
9296 a buffer may call after-change-functions and alike and
9297 that would means running Lisp asynchronously. */
9298 if (handling_signal)
9299 return;
9300
9301 fmt = msg = Qnil;
9302 GCPRO4 (fmt, msg, arg1, arg2);
9303
9304 args[0] = fmt = build_string (format);
9305 args[1] = arg1;
9306 args[2] = arg2;
9307 msg = Fformat (3, args);
9308
9309 len = SBYTES (msg) + 1;
9310 buffer = SAFE_ALLOCA (len);
9311 memcpy (buffer, SDATA (msg), len);
9312
9313 message_dolog (buffer, len - 1, 1, 0);
9314 SAFE_FREE ();
9315
9316 UNGCPRO;
9317 }
9318
9319
9320 /* Output a newline in the *Messages* buffer if "needs" one. */
9321
9322 void
9323 message_log_maybe_newline (void)
9324 {
9325 if (message_log_need_newline)
9326 message_dolog ("", 0, 1, 0);
9327 }
9328
9329
9330 /* Add a string M of length NBYTES to the message log, optionally
9331 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9332 nonzero, means interpret the contents of M as multibyte. This
9333 function calls low-level routines in order to bypass text property
9334 hooks, etc. which might not be safe to run.
9335
9336 This may GC (insert may run before/after change hooks),
9337 so the buffer M must NOT point to a Lisp string. */
9338
9339 void
9340 message_dolog (const char *m, ptrdiff_t nbytes, int nlflag, int multibyte)
9341 {
9342 const unsigned char *msg = (const unsigned char *) m;
9343
9344 if (!NILP (Vmemory_full))
9345 return;
9346
9347 if (!NILP (Vmessage_log_max))
9348 {
9349 struct buffer *oldbuf;
9350 Lisp_Object oldpoint, oldbegv, oldzv;
9351 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9352 ptrdiff_t point_at_end = 0;
9353 ptrdiff_t zv_at_end = 0;
9354 Lisp_Object old_deactivate_mark, tem;
9355 struct gcpro gcpro1;
9356
9357 old_deactivate_mark = Vdeactivate_mark;
9358 oldbuf = current_buffer;
9359 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9360 bset_undo_list (current_buffer, Qt);
9361
9362 oldpoint = message_dolog_marker1;
9363 set_marker_restricted (oldpoint, make_number (PT), Qnil);
9364 oldbegv = message_dolog_marker2;
9365 set_marker_restricted (oldbegv, make_number (BEGV), Qnil);
9366 oldzv = message_dolog_marker3;
9367 set_marker_restricted (oldzv, make_number (ZV), Qnil);
9368 GCPRO1 (old_deactivate_mark);
9369
9370 if (PT == Z)
9371 point_at_end = 1;
9372 if (ZV == Z)
9373 zv_at_end = 1;
9374
9375 BEGV = BEG;
9376 BEGV_BYTE = BEG_BYTE;
9377 ZV = Z;
9378 ZV_BYTE = Z_BYTE;
9379 TEMP_SET_PT_BOTH (Z, Z_BYTE);
9380
9381 /* Insert the string--maybe converting multibyte to single byte
9382 or vice versa, so that all the text fits the buffer. */
9383 if (multibyte
9384 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
9385 {
9386 ptrdiff_t i;
9387 int c, char_bytes;
9388 char work[1];
9389
9390 /* Convert a multibyte string to single-byte
9391 for the *Message* buffer. */
9392 for (i = 0; i < nbytes; i += char_bytes)
9393 {
9394 c = string_char_and_length (msg + i, &char_bytes);
9395 work[0] = (ASCII_CHAR_P (c)
9396 ? c
9397 : multibyte_char_to_unibyte (c));
9398 insert_1_both (work, 1, 1, 1, 0, 0);
9399 }
9400 }
9401 else if (! multibyte
9402 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
9403 {
9404 ptrdiff_t i;
9405 int c, char_bytes;
9406 unsigned char str[MAX_MULTIBYTE_LENGTH];
9407 /* Convert a single-byte string to multibyte
9408 for the *Message* buffer. */
9409 for (i = 0; i < nbytes; i++)
9410 {
9411 c = msg[i];
9412 MAKE_CHAR_MULTIBYTE (c);
9413 char_bytes = CHAR_STRING (c, str);
9414 insert_1_both ((char *) str, 1, char_bytes, 1, 0, 0);
9415 }
9416 }
9417 else if (nbytes)
9418 insert_1 (m, nbytes, 1, 0, 0);
9419
9420 if (nlflag)
9421 {
9422 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
9423 printmax_t dups;
9424 insert_1 ("\n", 1, 1, 0, 0);
9425
9426 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, 0);
9427 this_bol = PT;
9428 this_bol_byte = PT_BYTE;
9429
9430 /* See if this line duplicates the previous one.
9431 If so, combine duplicates. */
9432 if (this_bol > BEG)
9433 {
9434 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, 0);
9435 prev_bol = PT;
9436 prev_bol_byte = PT_BYTE;
9437
9438 dups = message_log_check_duplicate (prev_bol_byte,
9439 this_bol_byte);
9440 if (dups)
9441 {
9442 del_range_both (prev_bol, prev_bol_byte,
9443 this_bol, this_bol_byte, 0);
9444 if (dups > 1)
9445 {
9446 char dupstr[sizeof " [ times]"
9447 + INT_STRLEN_BOUND (printmax_t)];
9448
9449 /* If you change this format, don't forget to also
9450 change message_log_check_duplicate. */
9451 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
9452 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
9453 insert_1 (dupstr, duplen, 1, 0, 1);
9454 }
9455 }
9456 }
9457
9458 /* If we have more than the desired maximum number of lines
9459 in the *Messages* buffer now, delete the oldest ones.
9460 This is safe because we don't have undo in this buffer. */
9461
9462 if (NATNUMP (Vmessage_log_max))
9463 {
9464 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
9465 -XFASTINT (Vmessage_log_max) - 1, 0);
9466 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, 0);
9467 }
9468 }
9469 BEGV = XMARKER (oldbegv)->charpos;
9470 BEGV_BYTE = marker_byte_position (oldbegv);
9471
9472 if (zv_at_end)
9473 {
9474 ZV = Z;
9475 ZV_BYTE = Z_BYTE;
9476 }
9477 else
9478 {
9479 ZV = XMARKER (oldzv)->charpos;
9480 ZV_BYTE = marker_byte_position (oldzv);
9481 }
9482
9483 if (point_at_end)
9484 TEMP_SET_PT_BOTH (Z, Z_BYTE);
9485 else
9486 /* We can't do Fgoto_char (oldpoint) because it will run some
9487 Lisp code. */
9488 TEMP_SET_PT_BOTH (XMARKER (oldpoint)->charpos,
9489 XMARKER (oldpoint)->bytepos);
9490
9491 UNGCPRO;
9492 unchain_marker (XMARKER (oldpoint));
9493 unchain_marker (XMARKER (oldbegv));
9494 unchain_marker (XMARKER (oldzv));
9495
9496 tem = Fget_buffer_window (Fcurrent_buffer (), Qt);
9497 set_buffer_internal (oldbuf);
9498 if (NILP (tem))
9499 windows_or_buffers_changed = old_windows_or_buffers_changed;
9500 message_log_need_newline = !nlflag;
9501 Vdeactivate_mark = old_deactivate_mark;
9502 }
9503 }
9504
9505
9506 /* We are at the end of the buffer after just having inserted a newline.
9507 (Note: We depend on the fact we won't be crossing the gap.)
9508 Check to see if the most recent message looks a lot like the previous one.
9509 Return 0 if different, 1 if the new one should just replace it, or a
9510 value N > 1 if we should also append " [N times]". */
9511
9512 static intmax_t
9513 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
9514 {
9515 ptrdiff_t i;
9516 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
9517 int seen_dots = 0;
9518 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
9519 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
9520
9521 for (i = 0; i < len; i++)
9522 {
9523 if (i >= 3 && p1[i-3] == '.' && p1[i-2] == '.' && p1[i-1] == '.')
9524 seen_dots = 1;
9525 if (p1[i] != p2[i])
9526 return seen_dots;
9527 }
9528 p1 += len;
9529 if (*p1 == '\n')
9530 return 2;
9531 if (*p1++ == ' ' && *p1++ == '[')
9532 {
9533 char *pend;
9534 intmax_t n = strtoimax ((char *) p1, &pend, 10);
9535 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
9536 return n+1;
9537 }
9538 return 0;
9539 }
9540 \f
9541
9542 /* Display an echo area message M with a specified length of NBYTES
9543 bytes. The string may include null characters. If M is 0, clear
9544 out any existing message, and let the mini-buffer text show
9545 through.
9546
9547 This may GC, so the buffer M must NOT point to a Lisp string. */
9548
9549 void
9550 message2 (const char *m, ptrdiff_t nbytes, int multibyte)
9551 {
9552 /* First flush out any partial line written with print. */
9553 message_log_maybe_newline ();
9554 if (m)
9555 message_dolog (m, nbytes, 1, multibyte);
9556 message2_nolog (m, nbytes, multibyte);
9557 }
9558
9559
9560 /* The non-logging counterpart of message2. */
9561
9562 void
9563 message2_nolog (const char *m, ptrdiff_t nbytes, int multibyte)
9564 {
9565 struct frame *sf = SELECTED_FRAME ();
9566 message_enable_multibyte = multibyte;
9567
9568 if (FRAME_INITIAL_P (sf))
9569 {
9570 if (noninteractive_need_newline)
9571 putc ('\n', stderr);
9572 noninteractive_need_newline = 0;
9573 if (m)
9574 fwrite (m, nbytes, 1, stderr);
9575 if (cursor_in_echo_area == 0)
9576 fprintf (stderr, "\n");
9577 fflush (stderr);
9578 }
9579 /* A null message buffer means that the frame hasn't really been
9580 initialized yet. Error messages get reported properly by
9581 cmd_error, so this must be just an informative message; toss it. */
9582 else if (INTERACTIVE
9583 && sf->glyphs_initialized_p
9584 && FRAME_MESSAGE_BUF (sf))
9585 {
9586 Lisp_Object mini_window;
9587 struct frame *f;
9588
9589 /* Get the frame containing the mini-buffer
9590 that the selected frame is using. */
9591 mini_window = FRAME_MINIBUF_WINDOW (sf);
9592 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
9593
9594 FRAME_SAMPLE_VISIBILITY (f);
9595 if (FRAME_VISIBLE_P (sf)
9596 && ! FRAME_VISIBLE_P (f))
9597 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window)));
9598
9599 if (m)
9600 {
9601 set_message (m, Qnil, nbytes, multibyte);
9602 if (minibuffer_auto_raise)
9603 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
9604 }
9605 else
9606 clear_message (1, 1);
9607
9608 do_pending_window_change (0);
9609 echo_area_display (1);
9610 do_pending_window_change (0);
9611 if (FRAME_TERMINAL (f)->frame_up_to_date_hook != 0 && ! gc_in_progress)
9612 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
9613 }
9614 }
9615
9616
9617 /* Display an echo area message M with a specified length of NBYTES
9618 bytes. The string may include null characters. If M is not a
9619 string, clear out any existing message, and let the mini-buffer
9620 text show through.
9621
9622 This function cancels echoing. */
9623
9624 void
9625 message3 (Lisp_Object m, ptrdiff_t nbytes, int multibyte)
9626 {
9627 struct gcpro gcpro1;
9628
9629 GCPRO1 (m);
9630 clear_message (1,1);
9631 cancel_echoing ();
9632
9633 /* First flush out any partial line written with print. */
9634 message_log_maybe_newline ();
9635 if (STRINGP (m))
9636 {
9637 USE_SAFE_ALLOCA;
9638 char *buffer = SAFE_ALLOCA (nbytes);
9639 memcpy (buffer, SDATA (m), nbytes);
9640 message_dolog (buffer, nbytes, 1, multibyte);
9641 SAFE_FREE ();
9642 }
9643 message3_nolog (m, nbytes, multibyte);
9644
9645 UNGCPRO;
9646 }
9647
9648
9649 /* The non-logging version of message3.
9650 This does not cancel echoing, because it is used for echoing.
9651 Perhaps we need to make a separate function for echoing
9652 and make this cancel echoing. */
9653
9654 void
9655 message3_nolog (Lisp_Object m, ptrdiff_t nbytes, int multibyte)
9656 {
9657 struct frame *sf = SELECTED_FRAME ();
9658 message_enable_multibyte = multibyte;
9659
9660 if (FRAME_INITIAL_P (sf))
9661 {
9662 if (noninteractive_need_newline)
9663 putc ('\n', stderr);
9664 noninteractive_need_newline = 0;
9665 if (STRINGP (m))
9666 fwrite (SDATA (m), nbytes, 1, stderr);
9667 if (cursor_in_echo_area == 0)
9668 fprintf (stderr, "\n");
9669 fflush (stderr);
9670 }
9671 /* A null message buffer means that the frame hasn't really been
9672 initialized yet. Error messages get reported properly by
9673 cmd_error, so this must be just an informative message; toss it. */
9674 else if (INTERACTIVE
9675 && sf->glyphs_initialized_p
9676 && FRAME_MESSAGE_BUF (sf))
9677 {
9678 Lisp_Object mini_window;
9679 Lisp_Object frame;
9680 struct frame *f;
9681
9682 /* Get the frame containing the mini-buffer
9683 that the selected frame is using. */
9684 mini_window = FRAME_MINIBUF_WINDOW (sf);
9685 frame = XWINDOW (mini_window)->frame;
9686 f = XFRAME (frame);
9687
9688 FRAME_SAMPLE_VISIBILITY (f);
9689 if (FRAME_VISIBLE_P (sf)
9690 && !FRAME_VISIBLE_P (f))
9691 Fmake_frame_visible (frame);
9692
9693 if (STRINGP (m) && SCHARS (m) > 0)
9694 {
9695 set_message (NULL, m, nbytes, multibyte);
9696 if (minibuffer_auto_raise)
9697 Fraise_frame (frame);
9698 /* Assume we are not echoing.
9699 (If we are, echo_now will override this.) */
9700 echo_message_buffer = Qnil;
9701 }
9702 else
9703 clear_message (1, 1);
9704
9705 do_pending_window_change (0);
9706 echo_area_display (1);
9707 do_pending_window_change (0);
9708 if (FRAME_TERMINAL (f)->frame_up_to_date_hook != 0 && ! gc_in_progress)
9709 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
9710 }
9711 }
9712
9713
9714 /* Display a null-terminated echo area message M. If M is 0, clear
9715 out any existing message, and let the mini-buffer text show through.
9716
9717 The buffer M must continue to exist until after the echo area gets
9718 cleared or some other message gets displayed there. Do not pass
9719 text that is stored in a Lisp string. Do not pass text in a buffer
9720 that was alloca'd. */
9721
9722 void
9723 message1 (const char *m)
9724 {
9725 message2 (m, (m ? strlen (m) : 0), 0);
9726 }
9727
9728
9729 /* The non-logging counterpart of message1. */
9730
9731 void
9732 message1_nolog (const char *m)
9733 {
9734 message2_nolog (m, (m ? strlen (m) : 0), 0);
9735 }
9736
9737 /* Display a message M which contains a single %s
9738 which gets replaced with STRING. */
9739
9740 void
9741 message_with_string (const char *m, Lisp_Object string, int log)
9742 {
9743 CHECK_STRING (string);
9744
9745 if (noninteractive)
9746 {
9747 if (m)
9748 {
9749 if (noninteractive_need_newline)
9750 putc ('\n', stderr);
9751 noninteractive_need_newline = 0;
9752 fprintf (stderr, m, SDATA (string));
9753 if (!cursor_in_echo_area)
9754 fprintf (stderr, "\n");
9755 fflush (stderr);
9756 }
9757 }
9758 else if (INTERACTIVE)
9759 {
9760 /* The frame whose minibuffer we're going to display the message on.
9761 It may be larger than the selected frame, so we need
9762 to use its buffer, not the selected frame's buffer. */
9763 Lisp_Object mini_window;
9764 struct frame *f, *sf = SELECTED_FRAME ();
9765
9766 /* Get the frame containing the minibuffer
9767 that the selected frame is using. */
9768 mini_window = FRAME_MINIBUF_WINDOW (sf);
9769 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
9770
9771 /* A null message buffer means that the frame hasn't really been
9772 initialized yet. Error messages get reported properly by
9773 cmd_error, so this must be just an informative message; toss it. */
9774 if (FRAME_MESSAGE_BUF (f))
9775 {
9776 Lisp_Object args[2], msg;
9777 struct gcpro gcpro1, gcpro2;
9778
9779 args[0] = build_string (m);
9780 args[1] = msg = string;
9781 GCPRO2 (args[0], msg);
9782 gcpro1.nvars = 2;
9783
9784 msg = Fformat (2, args);
9785
9786 if (log)
9787 message3 (msg, SBYTES (msg), STRING_MULTIBYTE (msg));
9788 else
9789 message3_nolog (msg, SBYTES (msg), STRING_MULTIBYTE (msg));
9790
9791 UNGCPRO;
9792
9793 /* Print should start at the beginning of the message
9794 buffer next time. */
9795 message_buf_print = 0;
9796 }
9797 }
9798 }
9799
9800
9801 /* Dump an informative message to the minibuf. If M is 0, clear out
9802 any existing message, and let the mini-buffer text show through. */
9803
9804 static void
9805 vmessage (const char *m, va_list ap)
9806 {
9807 if (noninteractive)
9808 {
9809 if (m)
9810 {
9811 if (noninteractive_need_newline)
9812 putc ('\n', stderr);
9813 noninteractive_need_newline = 0;
9814 vfprintf (stderr, m, ap);
9815 if (cursor_in_echo_area == 0)
9816 fprintf (stderr, "\n");
9817 fflush (stderr);
9818 }
9819 }
9820 else if (INTERACTIVE)
9821 {
9822 /* The frame whose mini-buffer we're going to display the message
9823 on. It may be larger than the selected frame, so we need to
9824 use its buffer, not the selected frame's buffer. */
9825 Lisp_Object mini_window;
9826 struct frame *f, *sf = SELECTED_FRAME ();
9827
9828 /* Get the frame containing the mini-buffer
9829 that the selected frame is using. */
9830 mini_window = FRAME_MINIBUF_WINDOW (sf);
9831 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
9832
9833 /* A null message buffer means that the frame hasn't really been
9834 initialized yet. Error messages get reported properly by
9835 cmd_error, so this must be just an informative message; toss
9836 it. */
9837 if (FRAME_MESSAGE_BUF (f))
9838 {
9839 if (m)
9840 {
9841 ptrdiff_t len;
9842
9843 len = doprnt (FRAME_MESSAGE_BUF (f),
9844 FRAME_MESSAGE_BUF_SIZE (f), m, (char *)0, ap);
9845
9846 message2 (FRAME_MESSAGE_BUF (f), len, 1);
9847 }
9848 else
9849 message1 (0);
9850
9851 /* Print should start at the beginning of the message
9852 buffer next time. */
9853 message_buf_print = 0;
9854 }
9855 }
9856 }
9857
9858 void
9859 message (const char *m, ...)
9860 {
9861 va_list ap;
9862 va_start (ap, m);
9863 vmessage (m, ap);
9864 va_end (ap);
9865 }
9866
9867
9868 #if 0
9869 /* The non-logging version of message. */
9870
9871 void
9872 message_nolog (const char *m, ...)
9873 {
9874 Lisp_Object old_log_max;
9875 va_list ap;
9876 va_start (ap, m);
9877 old_log_max = Vmessage_log_max;
9878 Vmessage_log_max = Qnil;
9879 vmessage (m, ap);
9880 Vmessage_log_max = old_log_max;
9881 va_end (ap);
9882 }
9883 #endif
9884
9885
9886 /* Display the current message in the current mini-buffer. This is
9887 only called from error handlers in process.c, and is not time
9888 critical. */
9889
9890 void
9891 update_echo_area (void)
9892 {
9893 if (!NILP (echo_area_buffer[0]))
9894 {
9895 Lisp_Object string;
9896 string = Fcurrent_message ();
9897 message3 (string, SBYTES (string),
9898 !NILP (BVAR (current_buffer, enable_multibyte_characters)));
9899 }
9900 }
9901
9902
9903 /* Make sure echo area buffers in `echo_buffers' are live.
9904 If they aren't, make new ones. */
9905
9906 static void
9907 ensure_echo_area_buffers (void)
9908 {
9909 int i;
9910
9911 for (i = 0; i < 2; ++i)
9912 if (!BUFFERP (echo_buffer[i])
9913 || NILP (BVAR (XBUFFER (echo_buffer[i]), name)))
9914 {
9915 char name[30];
9916 Lisp_Object old_buffer;
9917 int j;
9918
9919 old_buffer = echo_buffer[i];
9920 echo_buffer[i] = Fget_buffer_create
9921 (make_formatted_string (name, " *Echo Area %d*", i));
9922 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
9923 /* to force word wrap in echo area -
9924 it was decided to postpone this*/
9925 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9926
9927 for (j = 0; j < 2; ++j)
9928 if (EQ (old_buffer, echo_area_buffer[j]))
9929 echo_area_buffer[j] = echo_buffer[i];
9930 }
9931 }
9932
9933
9934 /* Call FN with args A1..A4 with either the current or last displayed
9935 echo_area_buffer as current buffer.
9936
9937 WHICH zero means use the current message buffer
9938 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9939 from echo_buffer[] and clear it.
9940
9941 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9942 suitable buffer from echo_buffer[] and clear it.
9943
9944 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9945 that the current message becomes the last displayed one, make
9946 choose a suitable buffer for echo_area_buffer[0], and clear it.
9947
9948 Value is what FN returns. */
9949
9950 static int
9951 with_echo_area_buffer (struct window *w, int which,
9952 int (*fn) (ptrdiff_t, Lisp_Object, ptrdiff_t, ptrdiff_t),
9953 ptrdiff_t a1, Lisp_Object a2, ptrdiff_t a3, ptrdiff_t a4)
9954 {
9955 Lisp_Object buffer;
9956 int this_one, the_other, clear_buffer_p, rc;
9957 ptrdiff_t count = SPECPDL_INDEX ();
9958
9959 /* If buffers aren't live, make new ones. */
9960 ensure_echo_area_buffers ();
9961
9962 clear_buffer_p = 0;
9963
9964 if (which == 0)
9965 this_one = 0, the_other = 1;
9966 else if (which > 0)
9967 this_one = 1, the_other = 0;
9968 else
9969 {
9970 this_one = 0, the_other = 1;
9971 clear_buffer_p = 1;
9972
9973 /* We need a fresh one in case the current echo buffer equals
9974 the one containing the last displayed echo area message. */
9975 if (!NILP (echo_area_buffer[this_one])
9976 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
9977 echo_area_buffer[this_one] = Qnil;
9978 }
9979
9980 /* Choose a suitable buffer from echo_buffer[] is we don't
9981 have one. */
9982 if (NILP (echo_area_buffer[this_one]))
9983 {
9984 echo_area_buffer[this_one]
9985 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
9986 ? echo_buffer[the_other]
9987 : echo_buffer[this_one]);
9988 clear_buffer_p = 1;
9989 }
9990
9991 buffer = echo_area_buffer[this_one];
9992
9993 /* Don't get confused by reusing the buffer used for echoing
9994 for a different purpose. */
9995 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
9996 cancel_echoing ();
9997
9998 record_unwind_protect (unwind_with_echo_area_buffer,
9999 with_echo_area_buffer_unwind_data (w));
10000
10001 /* Make the echo area buffer current. Note that for display
10002 purposes, it is not necessary that the displayed window's buffer
10003 == current_buffer, except for text property lookup. So, let's
10004 only set that buffer temporarily here without doing a full
10005 Fset_window_buffer. We must also change w->pointm, though,
10006 because otherwise an assertions in unshow_buffer fails, and Emacs
10007 aborts. */
10008 set_buffer_internal_1 (XBUFFER (buffer));
10009 if (w)
10010 {
10011 wset_buffer (w, buffer);
10012 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10013 }
10014
10015 bset_undo_list (current_buffer, Qt);
10016 bset_read_only (current_buffer, Qnil);
10017 specbind (Qinhibit_read_only, Qt);
10018 specbind (Qinhibit_modification_hooks, Qt);
10019
10020 if (clear_buffer_p && Z > BEG)
10021 del_range (BEG, Z);
10022
10023 eassert (BEGV >= BEG);
10024 eassert (ZV <= Z && ZV >= BEGV);
10025
10026 rc = fn (a1, a2, a3, a4);
10027
10028 eassert (BEGV >= BEG);
10029 eassert (ZV <= Z && ZV >= BEGV);
10030
10031 unbind_to (count, Qnil);
10032 return rc;
10033 }
10034
10035
10036 /* Save state that should be preserved around the call to the function
10037 FN called in with_echo_area_buffer. */
10038
10039 static Lisp_Object
10040 with_echo_area_buffer_unwind_data (struct window *w)
10041 {
10042 int i = 0;
10043 Lisp_Object vector, tmp;
10044
10045 /* Reduce consing by keeping one vector in
10046 Vwith_echo_area_save_vector. */
10047 vector = Vwith_echo_area_save_vector;
10048 Vwith_echo_area_save_vector = Qnil;
10049
10050 if (NILP (vector))
10051 vector = Fmake_vector (make_number (7), Qnil);
10052
10053 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10054 ASET (vector, i, Vdeactivate_mark); ++i;
10055 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10056
10057 if (w)
10058 {
10059 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10060 ASET (vector, i, w->buffer); ++i;
10061 ASET (vector, i, make_number (XMARKER (w->pointm)->charpos)); ++i;
10062 ASET (vector, i, make_number (XMARKER (w->pointm)->bytepos)); ++i;
10063 }
10064 else
10065 {
10066 int end = i + 4;
10067 for (; i < end; ++i)
10068 ASET (vector, i, Qnil);
10069 }
10070
10071 eassert (i == ASIZE (vector));
10072 return vector;
10073 }
10074
10075
10076 /* Restore global state from VECTOR which was created by
10077 with_echo_area_buffer_unwind_data. */
10078
10079 static Lisp_Object
10080 unwind_with_echo_area_buffer (Lisp_Object vector)
10081 {
10082 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10083 Vdeactivate_mark = AREF (vector, 1);
10084 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10085
10086 if (WINDOWP (AREF (vector, 3)))
10087 {
10088 struct window *w;
10089 Lisp_Object buffer, charpos, bytepos;
10090
10091 w = XWINDOW (AREF (vector, 3));
10092 buffer = AREF (vector, 4);
10093 charpos = AREF (vector, 5);
10094 bytepos = AREF (vector, 6);
10095
10096 wset_buffer (w, buffer);
10097 set_marker_both (w->pointm, buffer,
10098 XFASTINT (charpos), XFASTINT (bytepos));
10099 }
10100
10101 Vwith_echo_area_save_vector = vector;
10102 return Qnil;
10103 }
10104
10105
10106 /* Set up the echo area for use by print functions. MULTIBYTE_P
10107 non-zero means we will print multibyte. */
10108
10109 void
10110 setup_echo_area_for_printing (int multibyte_p)
10111 {
10112 /* If we can't find an echo area any more, exit. */
10113 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10114 Fkill_emacs (Qnil);
10115
10116 ensure_echo_area_buffers ();
10117
10118 if (!message_buf_print)
10119 {
10120 /* A message has been output since the last time we printed.
10121 Choose a fresh echo area buffer. */
10122 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10123 echo_area_buffer[0] = echo_buffer[1];
10124 else
10125 echo_area_buffer[0] = echo_buffer[0];
10126
10127 /* Switch to that buffer and clear it. */
10128 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10129 bset_truncate_lines (current_buffer, Qnil);
10130
10131 if (Z > BEG)
10132 {
10133 ptrdiff_t count = SPECPDL_INDEX ();
10134 specbind (Qinhibit_read_only, Qt);
10135 /* Note that undo recording is always disabled. */
10136 del_range (BEG, Z);
10137 unbind_to (count, Qnil);
10138 }
10139 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10140
10141 /* Set up the buffer for the multibyteness we need. */
10142 if (multibyte_p
10143 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10144 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10145
10146 /* Raise the frame containing the echo area. */
10147 if (minibuffer_auto_raise)
10148 {
10149 struct frame *sf = SELECTED_FRAME ();
10150 Lisp_Object mini_window;
10151 mini_window = FRAME_MINIBUF_WINDOW (sf);
10152 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10153 }
10154
10155 message_log_maybe_newline ();
10156 message_buf_print = 1;
10157 }
10158 else
10159 {
10160 if (NILP (echo_area_buffer[0]))
10161 {
10162 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10163 echo_area_buffer[0] = echo_buffer[1];
10164 else
10165 echo_area_buffer[0] = echo_buffer[0];
10166 }
10167
10168 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10169 {
10170 /* Someone switched buffers between print requests. */
10171 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10172 bset_truncate_lines (current_buffer, Qnil);
10173 }
10174 }
10175 }
10176
10177
10178 /* Display an echo area message in window W. Value is non-zero if W's
10179 height is changed. If display_last_displayed_message_p is
10180 non-zero, display the message that was last displayed, otherwise
10181 display the current message. */
10182
10183 static int
10184 display_echo_area (struct window *w)
10185 {
10186 int i, no_message_p, window_height_changed_p;
10187
10188 /* Temporarily disable garbage collections while displaying the echo
10189 area. This is done because a GC can print a message itself.
10190 That message would modify the echo area buffer's contents while a
10191 redisplay of the buffer is going on, and seriously confuse
10192 redisplay. */
10193 ptrdiff_t count = inhibit_garbage_collection ();
10194
10195 /* If there is no message, we must call display_echo_area_1
10196 nevertheless because it resizes the window. But we will have to
10197 reset the echo_area_buffer in question to nil at the end because
10198 with_echo_area_buffer will sets it to an empty buffer. */
10199 i = display_last_displayed_message_p ? 1 : 0;
10200 no_message_p = NILP (echo_area_buffer[i]);
10201
10202 window_height_changed_p
10203 = with_echo_area_buffer (w, display_last_displayed_message_p,
10204 display_echo_area_1,
10205 (intptr_t) w, Qnil, 0, 0);
10206
10207 if (no_message_p)
10208 echo_area_buffer[i] = Qnil;
10209
10210 unbind_to (count, Qnil);
10211 return window_height_changed_p;
10212 }
10213
10214
10215 /* Helper for display_echo_area. Display the current buffer which
10216 contains the current echo area message in window W, a mini-window,
10217 a pointer to which is passed in A1. A2..A4 are currently not used.
10218 Change the height of W so that all of the message is displayed.
10219 Value is non-zero if height of W was changed. */
10220
10221 static int
10222 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2, ptrdiff_t a3, ptrdiff_t a4)
10223 {
10224 intptr_t i1 = a1;
10225 struct window *w = (struct window *) i1;
10226 Lisp_Object window;
10227 struct text_pos start;
10228 int window_height_changed_p = 0;
10229
10230 /* Do this before displaying, so that we have a large enough glyph
10231 matrix for the display. If we can't get enough space for the
10232 whole text, display the last N lines. That works by setting w->start. */
10233 window_height_changed_p = resize_mini_window (w, 0);
10234
10235 /* Use the starting position chosen by resize_mini_window. */
10236 SET_TEXT_POS_FROM_MARKER (start, w->start);
10237
10238 /* Display. */
10239 clear_glyph_matrix (w->desired_matrix);
10240 XSETWINDOW (window, w);
10241 try_window (window, start, 0);
10242
10243 return window_height_changed_p;
10244 }
10245
10246
10247 /* Resize the echo area window to exactly the size needed for the
10248 currently displayed message, if there is one. If a mini-buffer
10249 is active, don't shrink it. */
10250
10251 void
10252 resize_echo_area_exactly (void)
10253 {
10254 if (BUFFERP (echo_area_buffer[0])
10255 && WINDOWP (echo_area_window))
10256 {
10257 struct window *w = XWINDOW (echo_area_window);
10258 int resized_p;
10259 Lisp_Object resize_exactly;
10260
10261 if (minibuf_level == 0)
10262 resize_exactly = Qt;
10263 else
10264 resize_exactly = Qnil;
10265
10266 resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10267 (intptr_t) w, resize_exactly,
10268 0, 0);
10269 if (resized_p)
10270 {
10271 ++windows_or_buffers_changed;
10272 ++update_mode_lines;
10273 redisplay_internal ();
10274 }
10275 }
10276 }
10277
10278
10279 /* Callback function for with_echo_area_buffer, when used from
10280 resize_echo_area_exactly. A1 contains a pointer to the window to
10281 resize, EXACTLY non-nil means resize the mini-window exactly to the
10282 size of the text displayed. A3 and A4 are not used. Value is what
10283 resize_mini_window returns. */
10284
10285 static int
10286 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly, ptrdiff_t a3, ptrdiff_t a4)
10287 {
10288 intptr_t i1 = a1;
10289 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10290 }
10291
10292
10293 /* Resize mini-window W to fit the size of its contents. EXACT_P
10294 means size the window exactly to the size needed. Otherwise, it's
10295 only enlarged until W's buffer is empty.
10296
10297 Set W->start to the right place to begin display. If the whole
10298 contents fit, start at the beginning. Otherwise, start so as
10299 to make the end of the contents appear. This is particularly
10300 important for y-or-n-p, but seems desirable generally.
10301
10302 Value is non-zero if the window height has been changed. */
10303
10304 int
10305 resize_mini_window (struct window *w, int exact_p)
10306 {
10307 struct frame *f = XFRAME (w->frame);
10308 int window_height_changed_p = 0;
10309
10310 eassert (MINI_WINDOW_P (w));
10311
10312 /* By default, start display at the beginning. */
10313 set_marker_both (w->start, w->buffer,
10314 BUF_BEGV (XBUFFER (w->buffer)),
10315 BUF_BEGV_BYTE (XBUFFER (w->buffer)));
10316
10317 /* Don't resize windows while redisplaying a window; it would
10318 confuse redisplay functions when the size of the window they are
10319 displaying changes from under them. Such a resizing can happen,
10320 for instance, when which-func prints a long message while
10321 we are running fontification-functions. We're running these
10322 functions with safe_call which binds inhibit-redisplay to t. */
10323 if (!NILP (Vinhibit_redisplay))
10324 return 0;
10325
10326 /* Nil means don't try to resize. */
10327 if (NILP (Vresize_mini_windows)
10328 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10329 return 0;
10330
10331 if (!FRAME_MINIBUF_ONLY_P (f))
10332 {
10333 struct it it;
10334 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
10335 int total_height = WINDOW_TOTAL_LINES (root) + WINDOW_TOTAL_LINES (w);
10336 int height;
10337 EMACS_INT max_height;
10338 int unit = FRAME_LINE_HEIGHT (f);
10339 struct text_pos start;
10340 struct buffer *old_current_buffer = NULL;
10341
10342 if (current_buffer != XBUFFER (w->buffer))
10343 {
10344 old_current_buffer = current_buffer;
10345 set_buffer_internal (XBUFFER (w->buffer));
10346 }
10347
10348 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10349
10350 /* Compute the max. number of lines specified by the user. */
10351 if (FLOATP (Vmax_mini_window_height))
10352 max_height = XFLOATINT (Vmax_mini_window_height) * FRAME_LINES (f);
10353 else if (INTEGERP (Vmax_mini_window_height))
10354 max_height = XINT (Vmax_mini_window_height);
10355 else
10356 max_height = total_height / 4;
10357
10358 /* Correct that max. height if it's bogus. */
10359 max_height = max (1, max_height);
10360 max_height = min (total_height, max_height);
10361
10362 /* Find out the height of the text in the window. */
10363 if (it.line_wrap == TRUNCATE)
10364 height = 1;
10365 else
10366 {
10367 last_height = 0;
10368 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10369 if (it.max_ascent == 0 && it.max_descent == 0)
10370 height = it.current_y + last_height;
10371 else
10372 height = it.current_y + it.max_ascent + it.max_descent;
10373 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10374 height = (height + unit - 1) / unit;
10375 }
10376
10377 /* Compute a suitable window start. */
10378 if (height > max_height)
10379 {
10380 height = max_height;
10381 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10382 move_it_vertically_backward (&it, (height - 1) * unit);
10383 start = it.current.pos;
10384 }
10385 else
10386 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10387 SET_MARKER_FROM_TEXT_POS (w->start, start);
10388
10389 if (EQ (Vresize_mini_windows, Qgrow_only))
10390 {
10391 /* Let it grow only, until we display an empty message, in which
10392 case the window shrinks again. */
10393 if (height > WINDOW_TOTAL_LINES (w))
10394 {
10395 int old_height = WINDOW_TOTAL_LINES (w);
10396 freeze_window_starts (f, 1);
10397 grow_mini_window (w, height - WINDOW_TOTAL_LINES (w));
10398 window_height_changed_p = WINDOW_TOTAL_LINES (w) != old_height;
10399 }
10400 else if (height < WINDOW_TOTAL_LINES (w)
10401 && (exact_p || BEGV == ZV))
10402 {
10403 int old_height = WINDOW_TOTAL_LINES (w);
10404 freeze_window_starts (f, 0);
10405 shrink_mini_window (w);
10406 window_height_changed_p = WINDOW_TOTAL_LINES (w) != old_height;
10407 }
10408 }
10409 else
10410 {
10411 /* Always resize to exact size needed. */
10412 if (height > WINDOW_TOTAL_LINES (w))
10413 {
10414 int old_height = WINDOW_TOTAL_LINES (w);
10415 freeze_window_starts (f, 1);
10416 grow_mini_window (w, height - WINDOW_TOTAL_LINES (w));
10417 window_height_changed_p = WINDOW_TOTAL_LINES (w) != old_height;
10418 }
10419 else if (height < WINDOW_TOTAL_LINES (w))
10420 {
10421 int old_height = WINDOW_TOTAL_LINES (w);
10422 freeze_window_starts (f, 0);
10423 shrink_mini_window (w);
10424
10425 if (height)
10426 {
10427 freeze_window_starts (f, 1);
10428 grow_mini_window (w, height - WINDOW_TOTAL_LINES (w));
10429 }
10430
10431 window_height_changed_p = WINDOW_TOTAL_LINES (w) != old_height;
10432 }
10433 }
10434
10435 if (old_current_buffer)
10436 set_buffer_internal (old_current_buffer);
10437 }
10438
10439 return window_height_changed_p;
10440 }
10441
10442
10443 /* Value is the current message, a string, or nil if there is no
10444 current message. */
10445
10446 Lisp_Object
10447 current_message (void)
10448 {
10449 Lisp_Object msg;
10450
10451 if (!BUFFERP (echo_area_buffer[0]))
10452 msg = Qnil;
10453 else
10454 {
10455 with_echo_area_buffer (0, 0, current_message_1,
10456 (intptr_t) &msg, Qnil, 0, 0);
10457 if (NILP (msg))
10458 echo_area_buffer[0] = Qnil;
10459 }
10460
10461 return msg;
10462 }
10463
10464
10465 static int
10466 current_message_1 (ptrdiff_t a1, Lisp_Object a2, ptrdiff_t a3, ptrdiff_t a4)
10467 {
10468 intptr_t i1 = a1;
10469 Lisp_Object *msg = (Lisp_Object *) i1;
10470
10471 if (Z > BEG)
10472 *msg = make_buffer_string (BEG, Z, 1);
10473 else
10474 *msg = Qnil;
10475 return 0;
10476 }
10477
10478
10479 /* Push the current message on Vmessage_stack for later restoration
10480 by restore_message. Value is non-zero if the current message isn't
10481 empty. This is a relatively infrequent operation, so it's not
10482 worth optimizing. */
10483
10484 bool
10485 push_message (void)
10486 {
10487 Lisp_Object msg = current_message ();
10488 Vmessage_stack = Fcons (msg, Vmessage_stack);
10489 return STRINGP (msg);
10490 }
10491
10492
10493 /* Restore message display from the top of Vmessage_stack. */
10494
10495 void
10496 restore_message (void)
10497 {
10498 Lisp_Object msg;
10499
10500 eassert (CONSP (Vmessage_stack));
10501 msg = XCAR (Vmessage_stack);
10502 if (STRINGP (msg))
10503 message3_nolog (msg, SBYTES (msg), STRING_MULTIBYTE (msg));
10504 else
10505 message3_nolog (msg, 0, 0);
10506 }
10507
10508
10509 /* Handler for record_unwind_protect calling pop_message. */
10510
10511 Lisp_Object
10512 pop_message_unwind (Lisp_Object dummy)
10513 {
10514 pop_message ();
10515 return Qnil;
10516 }
10517
10518 /* Pop the top-most entry off Vmessage_stack. */
10519
10520 static void
10521 pop_message (void)
10522 {
10523 eassert (CONSP (Vmessage_stack));
10524 Vmessage_stack = XCDR (Vmessage_stack);
10525 }
10526
10527
10528 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10529 exits. If the stack is not empty, we have a missing pop_message
10530 somewhere. */
10531
10532 void
10533 check_message_stack (void)
10534 {
10535 if (!NILP (Vmessage_stack))
10536 emacs_abort ();
10537 }
10538
10539
10540 /* Truncate to NCHARS what will be displayed in the echo area the next
10541 time we display it---but don't redisplay it now. */
10542
10543 void
10544 truncate_echo_area (ptrdiff_t nchars)
10545 {
10546 if (nchars == 0)
10547 echo_area_buffer[0] = Qnil;
10548 /* A null message buffer means that the frame hasn't really been
10549 initialized yet. Error messages get reported properly by
10550 cmd_error, so this must be just an informative message; toss it. */
10551 else if (!noninteractive
10552 && INTERACTIVE
10553 && !NILP (echo_area_buffer[0]))
10554 {
10555 struct frame *sf = SELECTED_FRAME ();
10556 if (FRAME_MESSAGE_BUF (sf))
10557 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil, 0, 0);
10558 }
10559 }
10560
10561
10562 /* Helper function for truncate_echo_area. Truncate the current
10563 message to at most NCHARS characters. */
10564
10565 static int
10566 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2, ptrdiff_t a3, ptrdiff_t a4)
10567 {
10568 if (BEG + nchars < Z)
10569 del_range (BEG + nchars, Z);
10570 if (Z == BEG)
10571 echo_area_buffer[0] = Qnil;
10572 return 0;
10573 }
10574
10575 /* Set the current message to a substring of S or STRING.
10576
10577 If STRING is a Lisp string, set the message to the first NBYTES
10578 bytes from STRING. NBYTES zero means use the whole string. If
10579 STRING is multibyte, the message will be displayed multibyte.
10580
10581 If S is not null, set the message to the first LEN bytes of S. LEN
10582 zero means use the whole string. MULTIBYTE_P non-zero means S is
10583 multibyte. Display the message multibyte in that case.
10584
10585 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10586 to t before calling set_message_1 (which calls insert).
10587 */
10588
10589 static void
10590 set_message (const char *s, Lisp_Object string,
10591 ptrdiff_t nbytes, int multibyte_p)
10592 {
10593 ptrdiff_t count = SPECPDL_INDEX ();
10594
10595 message_enable_multibyte
10596 = ((s && multibyte_p)
10597 || (STRINGP (string) && STRING_MULTIBYTE (string)));
10598
10599 with_echo_area_buffer (0, -1, set_message_1,
10600 (intptr_t) s, string, nbytes, multibyte_p);
10601 message_buf_print = 0;
10602 help_echo_showing_p = 0;
10603
10604 if (NILP (Vinhibit_debug_on_message) && STRINGP (Vdebug_on_message)
10605 && fast_string_match (Vdebug_on_message, string) >= 0)
10606 {
10607 specbind (Qinhibit_debug_on_message, Qt);
10608 call_debugger (list2 (Qerror, string));
10609 }
10610
10611 unbind_to (count, Qnil);
10612 }
10613
10614
10615 /* Helper function for set_message. Arguments have the same meaning
10616 as there, with A1 corresponding to S and A2 corresponding to STRING
10617 This function is called with the echo area buffer being
10618 current. */
10619
10620 static int
10621 set_message_1 (ptrdiff_t a1, Lisp_Object a2, ptrdiff_t nbytes, ptrdiff_t multibyte_p)
10622 {
10623 intptr_t i1 = a1;
10624 const char *s = (const char *) i1;
10625 const unsigned char *msg = (const unsigned char *) s;
10626 Lisp_Object string = a2;
10627
10628 /* Change multibyteness of the echo buffer appropriately. */
10629 if (message_enable_multibyte
10630 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10631 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
10632
10633 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
10634 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
10635 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
10636
10637 /* Insert new message at BEG. */
10638 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10639
10640 if (STRINGP (string))
10641 {
10642 ptrdiff_t nchars;
10643
10644 if (nbytes == 0)
10645 nbytes = SBYTES (string);
10646 nchars = string_byte_to_char (string, nbytes);
10647
10648 /* This function takes care of single/multibyte conversion. We
10649 just have to ensure that the echo area buffer has the right
10650 setting of enable_multibyte_characters. */
10651 insert_from_string (string, 0, 0, nchars, nbytes, 1);
10652 }
10653 else if (s)
10654 {
10655 if (nbytes == 0)
10656 nbytes = strlen (s);
10657
10658 if (multibyte_p && NILP (BVAR (current_buffer, enable_multibyte_characters)))
10659 {
10660 /* Convert from multi-byte to single-byte. */
10661 ptrdiff_t i;
10662 int c, n;
10663 char work[1];
10664
10665 /* Convert a multibyte string to single-byte. */
10666 for (i = 0; i < nbytes; i += n)
10667 {
10668 c = string_char_and_length (msg + i, &n);
10669 work[0] = (ASCII_CHAR_P (c)
10670 ? c
10671 : multibyte_char_to_unibyte (c));
10672 insert_1_both (work, 1, 1, 1, 0, 0);
10673 }
10674 }
10675 else if (!multibyte_p
10676 && !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10677 {
10678 /* Convert from single-byte to multi-byte. */
10679 ptrdiff_t i;
10680 int c, n;
10681 unsigned char str[MAX_MULTIBYTE_LENGTH];
10682
10683 /* Convert a single-byte string to multibyte. */
10684 for (i = 0; i < nbytes; i++)
10685 {
10686 c = msg[i];
10687 MAKE_CHAR_MULTIBYTE (c);
10688 n = CHAR_STRING (c, str);
10689 insert_1_both ((char *) str, 1, n, 1, 0, 0);
10690 }
10691 }
10692 else
10693 insert_1 (s, nbytes, 1, 0, 0);
10694 }
10695
10696 return 0;
10697 }
10698
10699
10700 /* Clear messages. CURRENT_P non-zero means clear the current
10701 message. LAST_DISPLAYED_P non-zero means clear the message
10702 last displayed. */
10703
10704 void
10705 clear_message (int current_p, int last_displayed_p)
10706 {
10707 if (current_p)
10708 {
10709 echo_area_buffer[0] = Qnil;
10710 message_cleared_p = 1;
10711 }
10712
10713 if (last_displayed_p)
10714 echo_area_buffer[1] = Qnil;
10715
10716 message_buf_print = 0;
10717 }
10718
10719 /* Clear garbaged frames.
10720
10721 This function is used where the old redisplay called
10722 redraw_garbaged_frames which in turn called redraw_frame which in
10723 turn called clear_frame. The call to clear_frame was a source of
10724 flickering. I believe a clear_frame is not necessary. It should
10725 suffice in the new redisplay to invalidate all current matrices,
10726 and ensure a complete redisplay of all windows. */
10727
10728 static void
10729 clear_garbaged_frames (void)
10730 {
10731 if (frame_garbaged)
10732 {
10733 Lisp_Object tail, frame;
10734 int changed_count = 0;
10735
10736 FOR_EACH_FRAME (tail, frame)
10737 {
10738 struct frame *f = XFRAME (frame);
10739
10740 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
10741 {
10742 if (f->resized_p)
10743 {
10744 Fredraw_frame (frame);
10745 f->force_flush_display_p = 1;
10746 }
10747 clear_current_matrices (f);
10748 changed_count++;
10749 f->garbaged = 0;
10750 f->resized_p = 0;
10751 }
10752 }
10753
10754 frame_garbaged = 0;
10755 if (changed_count)
10756 ++windows_or_buffers_changed;
10757 }
10758 }
10759
10760
10761 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10762 is non-zero update selected_frame. Value is non-zero if the
10763 mini-windows height has been changed. */
10764
10765 static int
10766 echo_area_display (int update_frame_p)
10767 {
10768 Lisp_Object mini_window;
10769 struct window *w;
10770 struct frame *f;
10771 int window_height_changed_p = 0;
10772 struct frame *sf = SELECTED_FRAME ();
10773
10774 mini_window = FRAME_MINIBUF_WINDOW (sf);
10775 w = XWINDOW (mini_window);
10776 f = XFRAME (WINDOW_FRAME (w));
10777
10778 /* Don't display if frame is invisible or not yet initialized. */
10779 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
10780 return 0;
10781
10782 #ifdef HAVE_WINDOW_SYSTEM
10783 /* When Emacs starts, selected_frame may be the initial terminal
10784 frame. If we let this through, a message would be displayed on
10785 the terminal. */
10786 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
10787 return 0;
10788 #endif /* HAVE_WINDOW_SYSTEM */
10789
10790 /* Redraw garbaged frames. */
10791 if (frame_garbaged)
10792 clear_garbaged_frames ();
10793
10794 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
10795 {
10796 echo_area_window = mini_window;
10797 window_height_changed_p = display_echo_area (w);
10798 w->must_be_updated_p = 1;
10799
10800 /* Update the display, unless called from redisplay_internal.
10801 Also don't update the screen during redisplay itself. The
10802 update will happen at the end of redisplay, and an update
10803 here could cause confusion. */
10804 if (update_frame_p && !redisplaying_p)
10805 {
10806 int n = 0;
10807
10808 /* If the display update has been interrupted by pending
10809 input, update mode lines in the frame. Due to the
10810 pending input, it might have been that redisplay hasn't
10811 been called, so that mode lines above the echo area are
10812 garbaged. This looks odd, so we prevent it here. */
10813 if (!display_completed)
10814 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), 0);
10815
10816 if (window_height_changed_p
10817 /* Don't do this if Emacs is shutting down. Redisplay
10818 needs to run hooks. */
10819 && !NILP (Vrun_hooks))
10820 {
10821 /* Must update other windows. Likewise as in other
10822 cases, don't let this update be interrupted by
10823 pending input. */
10824 ptrdiff_t count = SPECPDL_INDEX ();
10825 specbind (Qredisplay_dont_pause, Qt);
10826 windows_or_buffers_changed = 1;
10827 redisplay_internal ();
10828 unbind_to (count, Qnil);
10829 }
10830 else if (FRAME_WINDOW_P (f) && n == 0)
10831 {
10832 /* Window configuration is the same as before.
10833 Can do with a display update of the echo area,
10834 unless we displayed some mode lines. */
10835 update_single_window (w, 1);
10836 FRAME_RIF (f)->flush_display (f);
10837 }
10838 else
10839 update_frame (f, 1, 1);
10840
10841 /* If cursor is in the echo area, make sure that the next
10842 redisplay displays the minibuffer, so that the cursor will
10843 be replaced with what the minibuffer wants. */
10844 if (cursor_in_echo_area)
10845 ++windows_or_buffers_changed;
10846 }
10847 }
10848 else if (!EQ (mini_window, selected_window))
10849 windows_or_buffers_changed++;
10850
10851 /* Last displayed message is now the current message. */
10852 echo_area_buffer[1] = echo_area_buffer[0];
10853 /* Inform read_char that we're not echoing. */
10854 echo_message_buffer = Qnil;
10855
10856 /* Prevent redisplay optimization in redisplay_internal by resetting
10857 this_line_start_pos. This is done because the mini-buffer now
10858 displays the message instead of its buffer text. */
10859 if (EQ (mini_window, selected_window))
10860 CHARPOS (this_line_start_pos) = 0;
10861
10862 return window_height_changed_p;
10863 }
10864
10865
10866 \f
10867 /***********************************************************************
10868 Mode Lines and Frame Titles
10869 ***********************************************************************/
10870
10871 /* A buffer for constructing non-propertized mode-line strings and
10872 frame titles in it; allocated from the heap in init_xdisp and
10873 resized as needed in store_mode_line_noprop_char. */
10874
10875 static char *mode_line_noprop_buf;
10876
10877 /* The buffer's end, and a current output position in it. */
10878
10879 static char *mode_line_noprop_buf_end;
10880 static char *mode_line_noprop_ptr;
10881
10882 #define MODE_LINE_NOPROP_LEN(start) \
10883 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10884
10885 static enum {
10886 MODE_LINE_DISPLAY = 0,
10887 MODE_LINE_TITLE,
10888 MODE_LINE_NOPROP,
10889 MODE_LINE_STRING
10890 } mode_line_target;
10891
10892 /* Alist that caches the results of :propertize.
10893 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10894 static Lisp_Object mode_line_proptrans_alist;
10895
10896 /* List of strings making up the mode-line. */
10897 static Lisp_Object mode_line_string_list;
10898
10899 /* Base face property when building propertized mode line string. */
10900 static Lisp_Object mode_line_string_face;
10901 static Lisp_Object mode_line_string_face_prop;
10902
10903
10904 /* Unwind data for mode line strings */
10905
10906 static Lisp_Object Vmode_line_unwind_vector;
10907
10908 static Lisp_Object
10909 format_mode_line_unwind_data (struct frame *target_frame,
10910 struct buffer *obuf,
10911 Lisp_Object owin,
10912 int save_proptrans)
10913 {
10914 Lisp_Object vector, tmp;
10915
10916 /* Reduce consing by keeping one vector in
10917 Vwith_echo_area_save_vector. */
10918 vector = Vmode_line_unwind_vector;
10919 Vmode_line_unwind_vector = Qnil;
10920
10921 if (NILP (vector))
10922 vector = Fmake_vector (make_number (10), Qnil);
10923
10924 ASET (vector, 0, make_number (mode_line_target));
10925 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10926 ASET (vector, 2, mode_line_string_list);
10927 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
10928 ASET (vector, 4, mode_line_string_face);
10929 ASET (vector, 5, mode_line_string_face_prop);
10930
10931 if (obuf)
10932 XSETBUFFER (tmp, obuf);
10933 else
10934 tmp = Qnil;
10935 ASET (vector, 6, tmp);
10936 ASET (vector, 7, owin);
10937 if (target_frame)
10938 {
10939 /* Similarly to `with-selected-window', if the operation selects
10940 a window on another frame, we must restore that frame's
10941 selected window, and (for a tty) the top-frame. */
10942 ASET (vector, 8, target_frame->selected_window);
10943 if (FRAME_TERMCAP_P (target_frame))
10944 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
10945 }
10946
10947 return vector;
10948 }
10949
10950 static Lisp_Object
10951 unwind_format_mode_line (Lisp_Object vector)
10952 {
10953 Lisp_Object old_window = AREF (vector, 7);
10954 Lisp_Object target_frame_window = AREF (vector, 8);
10955 Lisp_Object old_top_frame = AREF (vector, 9);
10956
10957 mode_line_target = XINT (AREF (vector, 0));
10958 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
10959 mode_line_string_list = AREF (vector, 2);
10960 if (! EQ (AREF (vector, 3), Qt))
10961 mode_line_proptrans_alist = AREF (vector, 3);
10962 mode_line_string_face = AREF (vector, 4);
10963 mode_line_string_face_prop = AREF (vector, 5);
10964
10965 /* Select window before buffer, since it may change the buffer. */
10966 if (!NILP (old_window))
10967 {
10968 /* If the operation that we are unwinding had selected a window
10969 on a different frame, reset its frame-selected-window. For a
10970 text terminal, reset its top-frame if necessary. */
10971 if (!NILP (target_frame_window))
10972 {
10973 Lisp_Object frame
10974 = WINDOW_FRAME (XWINDOW (target_frame_window));
10975
10976 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
10977 Fselect_window (target_frame_window, Qt);
10978
10979 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
10980 Fselect_frame (old_top_frame, Qt);
10981 }
10982
10983 Fselect_window (old_window, Qt);
10984 }
10985
10986 if (!NILP (AREF (vector, 6)))
10987 {
10988 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
10989 ASET (vector, 6, Qnil);
10990 }
10991
10992 Vmode_line_unwind_vector = vector;
10993 return Qnil;
10994 }
10995
10996
10997 /* Store a single character C for the frame title in mode_line_noprop_buf.
10998 Re-allocate mode_line_noprop_buf if necessary. */
10999
11000 static void
11001 store_mode_line_noprop_char (char c)
11002 {
11003 /* If output position has reached the end of the allocated buffer,
11004 increase the buffer's size. */
11005 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11006 {
11007 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11008 ptrdiff_t size = len;
11009 mode_line_noprop_buf =
11010 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11011 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11012 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11013 }
11014
11015 *mode_line_noprop_ptr++ = c;
11016 }
11017
11018
11019 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11020 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11021 characters that yield more columns than PRECISION; PRECISION <= 0
11022 means copy the whole string. Pad with spaces until FIELD_WIDTH
11023 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11024 pad. Called from display_mode_element when it is used to build a
11025 frame title. */
11026
11027 static int
11028 store_mode_line_noprop (const char *string, int field_width, int precision)
11029 {
11030 const unsigned char *str = (const unsigned char *) string;
11031 int n = 0;
11032 ptrdiff_t dummy, nbytes;
11033
11034 /* Copy at most PRECISION chars from STR. */
11035 nbytes = strlen (string);
11036 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11037 while (nbytes--)
11038 store_mode_line_noprop_char (*str++);
11039
11040 /* Fill up with spaces until FIELD_WIDTH reached. */
11041 while (field_width > 0
11042 && n < field_width)
11043 {
11044 store_mode_line_noprop_char (' ');
11045 ++n;
11046 }
11047
11048 return n;
11049 }
11050
11051 /***********************************************************************
11052 Frame Titles
11053 ***********************************************************************/
11054
11055 #ifdef HAVE_WINDOW_SYSTEM
11056
11057 /* Set the title of FRAME, if it has changed. The title format is
11058 Vicon_title_format if FRAME is iconified, otherwise it is
11059 frame_title_format. */
11060
11061 static void
11062 x_consider_frame_title (Lisp_Object frame)
11063 {
11064 struct frame *f = XFRAME (frame);
11065
11066 if (FRAME_WINDOW_P (f)
11067 || FRAME_MINIBUF_ONLY_P (f)
11068 || f->explicit_name)
11069 {
11070 /* Do we have more than one visible frame on this X display? */
11071 Lisp_Object tail;
11072 Lisp_Object fmt;
11073 ptrdiff_t title_start;
11074 char *title;
11075 ptrdiff_t len;
11076 struct it it;
11077 ptrdiff_t count = SPECPDL_INDEX ();
11078
11079 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
11080 {
11081 Lisp_Object other_frame = XCAR (tail);
11082 struct frame *tf = XFRAME (other_frame);
11083
11084 if (tf != f
11085 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11086 && !FRAME_MINIBUF_ONLY_P (tf)
11087 && !EQ (other_frame, tip_frame)
11088 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11089 break;
11090 }
11091
11092 /* Set global variable indicating that multiple frames exist. */
11093 multiple_frames = CONSP (tail);
11094
11095 /* Switch to the buffer of selected window of the frame. Set up
11096 mode_line_target so that display_mode_element will output into
11097 mode_line_noprop_buf; then display the title. */
11098 record_unwind_protect (unwind_format_mode_line,
11099 format_mode_line_unwind_data
11100 (f, current_buffer, selected_window, 0));
11101
11102 Fselect_window (f->selected_window, Qt);
11103 set_buffer_internal_1
11104 (XBUFFER (XWINDOW (f->selected_window)->buffer));
11105 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11106
11107 mode_line_target = MODE_LINE_TITLE;
11108 title_start = MODE_LINE_NOPROP_LEN (0);
11109 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11110 NULL, DEFAULT_FACE_ID);
11111 display_mode_element (&it, 0, -1, -1, fmt, Qnil, 0);
11112 len = MODE_LINE_NOPROP_LEN (title_start);
11113 title = mode_line_noprop_buf + title_start;
11114 unbind_to (count, Qnil);
11115
11116 /* Set the title only if it's changed. This avoids consing in
11117 the common case where it hasn't. (If it turns out that we've
11118 already wasted too much time by walking through the list with
11119 display_mode_element, then we might need to optimize at a
11120 higher level than this.) */
11121 if (! STRINGP (f->name)
11122 || SBYTES (f->name) != len
11123 || memcmp (title, SDATA (f->name), len) != 0)
11124 x_implicitly_set_name (f, make_string (title, len), Qnil);
11125 }
11126 }
11127
11128 #endif /* not HAVE_WINDOW_SYSTEM */
11129
11130 \f
11131 /***********************************************************************
11132 Menu Bars
11133 ***********************************************************************/
11134
11135
11136 /* Prepare for redisplay by updating menu-bar item lists when
11137 appropriate. This can call eval. */
11138
11139 void
11140 prepare_menu_bars (void)
11141 {
11142 int all_windows;
11143 struct gcpro gcpro1, gcpro2;
11144 struct frame *f;
11145 Lisp_Object tooltip_frame;
11146
11147 #ifdef HAVE_WINDOW_SYSTEM
11148 tooltip_frame = tip_frame;
11149 #else
11150 tooltip_frame = Qnil;
11151 #endif
11152
11153 /* Update all frame titles based on their buffer names, etc. We do
11154 this before the menu bars so that the buffer-menu will show the
11155 up-to-date frame titles. */
11156 #ifdef HAVE_WINDOW_SYSTEM
11157 if (windows_or_buffers_changed || update_mode_lines)
11158 {
11159 Lisp_Object tail, frame;
11160
11161 FOR_EACH_FRAME (tail, frame)
11162 {
11163 f = XFRAME (frame);
11164 if (!EQ (frame, tooltip_frame)
11165 && (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)))
11166 x_consider_frame_title (frame);
11167 }
11168 }
11169 #endif /* HAVE_WINDOW_SYSTEM */
11170
11171 /* Update the menu bar item lists, if appropriate. This has to be
11172 done before any actual redisplay or generation of display lines. */
11173 all_windows = (update_mode_lines
11174 || buffer_shared > 1
11175 || windows_or_buffers_changed);
11176 if (all_windows)
11177 {
11178 Lisp_Object tail, frame;
11179 ptrdiff_t count = SPECPDL_INDEX ();
11180 /* 1 means that update_menu_bar has run its hooks
11181 so any further calls to update_menu_bar shouldn't do so again. */
11182 int menu_bar_hooks_run = 0;
11183
11184 record_unwind_save_match_data ();
11185
11186 FOR_EACH_FRAME (tail, frame)
11187 {
11188 f = XFRAME (frame);
11189
11190 /* Ignore tooltip frame. */
11191 if (EQ (frame, tooltip_frame))
11192 continue;
11193
11194 /* If a window on this frame changed size, report that to
11195 the user and clear the size-change flag. */
11196 if (FRAME_WINDOW_SIZES_CHANGED (f))
11197 {
11198 Lisp_Object functions;
11199
11200 /* Clear flag first in case we get an error below. */
11201 FRAME_WINDOW_SIZES_CHANGED (f) = 0;
11202 functions = Vwindow_size_change_functions;
11203 GCPRO2 (tail, functions);
11204
11205 while (CONSP (functions))
11206 {
11207 if (!EQ (XCAR (functions), Qt))
11208 call1 (XCAR (functions), frame);
11209 functions = XCDR (functions);
11210 }
11211 UNGCPRO;
11212 }
11213
11214 GCPRO1 (tail);
11215 menu_bar_hooks_run = update_menu_bar (f, 0, menu_bar_hooks_run);
11216 #ifdef HAVE_WINDOW_SYSTEM
11217 update_tool_bar (f, 0);
11218 #endif
11219 #ifdef HAVE_NS
11220 if (windows_or_buffers_changed
11221 && FRAME_NS_P (f))
11222 ns_set_doc_edited
11223 (f, Fbuffer_modified_p (XWINDOW (f->selected_window)->buffer));
11224 #endif
11225 UNGCPRO;
11226 }
11227
11228 unbind_to (count, Qnil);
11229 }
11230 else
11231 {
11232 struct frame *sf = SELECTED_FRAME ();
11233 update_menu_bar (sf, 1, 0);
11234 #ifdef HAVE_WINDOW_SYSTEM
11235 update_tool_bar (sf, 1);
11236 #endif
11237 }
11238 }
11239
11240
11241 /* Update the menu bar item list for frame F. This has to be done
11242 before we start to fill in any display lines, because it can call
11243 eval.
11244
11245 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11246
11247 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11248 already ran the menu bar hooks for this redisplay, so there
11249 is no need to run them again. The return value is the
11250 updated value of this flag, to pass to the next call. */
11251
11252 static int
11253 update_menu_bar (struct frame *f, int save_match_data, int hooks_run)
11254 {
11255 Lisp_Object window;
11256 register struct window *w;
11257
11258 /* If called recursively during a menu update, do nothing. This can
11259 happen when, for instance, an activate-menubar-hook causes a
11260 redisplay. */
11261 if (inhibit_menubar_update)
11262 return hooks_run;
11263
11264 window = FRAME_SELECTED_WINDOW (f);
11265 w = XWINDOW (window);
11266
11267 if (FRAME_WINDOW_P (f)
11268 ?
11269 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11270 || defined (HAVE_NS) || defined (USE_GTK)
11271 FRAME_EXTERNAL_MENU_BAR (f)
11272 #else
11273 FRAME_MENU_BAR_LINES (f) > 0
11274 #endif
11275 : FRAME_MENU_BAR_LINES (f) > 0)
11276 {
11277 /* If the user has switched buffers or windows, we need to
11278 recompute to reflect the new bindings. But we'll
11279 recompute when update_mode_lines is set too; that means
11280 that people can use force-mode-line-update to request
11281 that the menu bar be recomputed. The adverse effect on
11282 the rest of the redisplay algorithm is about the same as
11283 windows_or_buffers_changed anyway. */
11284 if (windows_or_buffers_changed
11285 /* This used to test w->update_mode_line, but we believe
11286 there is no need to recompute the menu in that case. */
11287 || update_mode_lines
11288 || ((BUF_SAVE_MODIFF (XBUFFER (w->buffer))
11289 < BUF_MODIFF (XBUFFER (w->buffer)))
11290 != w->last_had_star)
11291 || ((!NILP (Vtransient_mark_mode)
11292 && !NILP (BVAR (XBUFFER (w->buffer), mark_active)))
11293 != !NILP (w->region_showing)))
11294 {
11295 struct buffer *prev = current_buffer;
11296 ptrdiff_t count = SPECPDL_INDEX ();
11297
11298 specbind (Qinhibit_menubar_update, Qt);
11299
11300 set_buffer_internal_1 (XBUFFER (w->buffer));
11301 if (save_match_data)
11302 record_unwind_save_match_data ();
11303 if (NILP (Voverriding_local_map_menu_flag))
11304 {
11305 specbind (Qoverriding_terminal_local_map, Qnil);
11306 specbind (Qoverriding_local_map, Qnil);
11307 }
11308
11309 if (!hooks_run)
11310 {
11311 /* Run the Lucid hook. */
11312 safe_run_hooks (Qactivate_menubar_hook);
11313
11314 /* If it has changed current-menubar from previous value,
11315 really recompute the menu-bar from the value. */
11316 if (! NILP (Vlucid_menu_bar_dirty_flag))
11317 call0 (Qrecompute_lucid_menubar);
11318
11319 safe_run_hooks (Qmenu_bar_update_hook);
11320
11321 hooks_run = 1;
11322 }
11323
11324 XSETFRAME (Vmenu_updating_frame, f);
11325 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11326
11327 /* Redisplay the menu bar in case we changed it. */
11328 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11329 || defined (HAVE_NS) || defined (USE_GTK)
11330 if (FRAME_WINDOW_P (f))
11331 {
11332 #if defined (HAVE_NS)
11333 /* All frames on Mac OS share the same menubar. So only
11334 the selected frame should be allowed to set it. */
11335 if (f == SELECTED_FRAME ())
11336 #endif
11337 set_frame_menubar (f, 0, 0);
11338 }
11339 else
11340 /* On a terminal screen, the menu bar is an ordinary screen
11341 line, and this makes it get updated. */
11342 w->update_mode_line = 1;
11343 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11344 /* In the non-toolkit version, the menu bar is an ordinary screen
11345 line, and this makes it get updated. */
11346 w->update_mode_line = 1;
11347 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11348
11349 unbind_to (count, Qnil);
11350 set_buffer_internal_1 (prev);
11351 }
11352 }
11353
11354 return hooks_run;
11355 }
11356
11357
11358 \f
11359 /***********************************************************************
11360 Output Cursor
11361 ***********************************************************************/
11362
11363 #ifdef HAVE_WINDOW_SYSTEM
11364
11365 /* EXPORT:
11366 Nominal cursor position -- where to draw output.
11367 HPOS and VPOS are window relative glyph matrix coordinates.
11368 X and Y are window relative pixel coordinates. */
11369
11370 struct cursor_pos output_cursor;
11371
11372
11373 /* EXPORT:
11374 Set the global variable output_cursor to CURSOR. All cursor
11375 positions are relative to updated_window. */
11376
11377 void
11378 set_output_cursor (struct cursor_pos *cursor)
11379 {
11380 output_cursor.hpos = cursor->hpos;
11381 output_cursor.vpos = cursor->vpos;
11382 output_cursor.x = cursor->x;
11383 output_cursor.y = cursor->y;
11384 }
11385
11386
11387 /* EXPORT for RIF:
11388 Set a nominal cursor position.
11389
11390 HPOS and VPOS are column/row positions in a window glyph matrix. X
11391 and Y are window text area relative pixel positions.
11392
11393 If this is done during an update, updated_window will contain the
11394 window that is being updated and the position is the future output
11395 cursor position for that window. If updated_window is null, use
11396 selected_window and display the cursor at the given position. */
11397
11398 void
11399 x_cursor_to (int vpos, int hpos, int y, int x)
11400 {
11401 struct window *w;
11402
11403 /* If updated_window is not set, work on selected_window. */
11404 if (updated_window)
11405 w = updated_window;
11406 else
11407 w = XWINDOW (selected_window);
11408
11409 /* Set the output cursor. */
11410 output_cursor.hpos = hpos;
11411 output_cursor.vpos = vpos;
11412 output_cursor.x = x;
11413 output_cursor.y = y;
11414
11415 /* If not called as part of an update, really display the cursor.
11416 This will also set the cursor position of W. */
11417 if (updated_window == NULL)
11418 {
11419 BLOCK_INPUT;
11420 display_and_set_cursor (w, 1, hpos, vpos, x, y);
11421 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional)
11422 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11423 UNBLOCK_INPUT;
11424 }
11425 }
11426
11427 #endif /* HAVE_WINDOW_SYSTEM */
11428
11429 \f
11430 /***********************************************************************
11431 Tool-bars
11432 ***********************************************************************/
11433
11434 #ifdef HAVE_WINDOW_SYSTEM
11435
11436 /* Where the mouse was last time we reported a mouse event. */
11437
11438 FRAME_PTR last_mouse_frame;
11439
11440 /* Tool-bar item index of the item on which a mouse button was pressed
11441 or -1. */
11442
11443 int last_tool_bar_item;
11444
11445
11446 static Lisp_Object
11447 update_tool_bar_unwind (Lisp_Object frame)
11448 {
11449 selected_frame = frame;
11450 return Qnil;
11451 }
11452
11453 /* Update the tool-bar item list for frame F. This has to be done
11454 before we start to fill in any display lines. Called from
11455 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11456 and restore it here. */
11457
11458 static void
11459 update_tool_bar (struct frame *f, int save_match_data)
11460 {
11461 #if defined (USE_GTK) || defined (HAVE_NS)
11462 int do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11463 #else
11464 int do_update = WINDOWP (f->tool_bar_window)
11465 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0;
11466 #endif
11467
11468 if (do_update)
11469 {
11470 Lisp_Object window;
11471 struct window *w;
11472
11473 window = FRAME_SELECTED_WINDOW (f);
11474 w = XWINDOW (window);
11475
11476 /* If the user has switched buffers or windows, we need to
11477 recompute to reflect the new bindings. But we'll
11478 recompute when update_mode_lines is set too; that means
11479 that people can use force-mode-line-update to request
11480 that the menu bar be recomputed. The adverse effect on
11481 the rest of the redisplay algorithm is about the same as
11482 windows_or_buffers_changed anyway. */
11483 if (windows_or_buffers_changed
11484 || w->update_mode_line
11485 || update_mode_lines
11486 || ((BUF_SAVE_MODIFF (XBUFFER (w->buffer))
11487 < BUF_MODIFF (XBUFFER (w->buffer)))
11488 != w->last_had_star)
11489 || ((!NILP (Vtransient_mark_mode)
11490 && !NILP (BVAR (XBUFFER (w->buffer), mark_active)))
11491 != !NILP (w->region_showing)))
11492 {
11493 struct buffer *prev = current_buffer;
11494 ptrdiff_t count = SPECPDL_INDEX ();
11495 Lisp_Object frame, new_tool_bar;
11496 int new_n_tool_bar;
11497 struct gcpro gcpro1;
11498
11499 /* Set current_buffer to the buffer of the selected
11500 window of the frame, so that we get the right local
11501 keymaps. */
11502 set_buffer_internal_1 (XBUFFER (w->buffer));
11503
11504 /* Save match data, if we must. */
11505 if (save_match_data)
11506 record_unwind_save_match_data ();
11507
11508 /* Make sure that we don't accidentally use bogus keymaps. */
11509 if (NILP (Voverriding_local_map_menu_flag))
11510 {
11511 specbind (Qoverriding_terminal_local_map, Qnil);
11512 specbind (Qoverriding_local_map, Qnil);
11513 }
11514
11515 GCPRO1 (new_tool_bar);
11516
11517 /* We must temporarily set the selected frame to this frame
11518 before calling tool_bar_items, because the calculation of
11519 the tool-bar keymap uses the selected frame (see
11520 `tool-bar-make-keymap' in tool-bar.el). */
11521 record_unwind_protect (update_tool_bar_unwind, selected_frame);
11522 XSETFRAME (frame, f);
11523 selected_frame = frame;
11524
11525 /* Build desired tool-bar items from keymaps. */
11526 new_tool_bar
11527 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
11528 &new_n_tool_bar);
11529
11530 /* Redisplay the tool-bar if we changed it. */
11531 if (new_n_tool_bar != f->n_tool_bar_items
11532 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
11533 {
11534 /* Redisplay that happens asynchronously due to an expose event
11535 may access f->tool_bar_items. Make sure we update both
11536 variables within BLOCK_INPUT so no such event interrupts. */
11537 BLOCK_INPUT;
11538 fset_tool_bar_items (f, new_tool_bar);
11539 f->n_tool_bar_items = new_n_tool_bar;
11540 w->update_mode_line = 1;
11541 UNBLOCK_INPUT;
11542 }
11543
11544 UNGCPRO;
11545
11546 unbind_to (count, Qnil);
11547 set_buffer_internal_1 (prev);
11548 }
11549 }
11550 }
11551
11552
11553 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11554 F's desired tool-bar contents. F->tool_bar_items must have
11555 been set up previously by calling prepare_menu_bars. */
11556
11557 static void
11558 build_desired_tool_bar_string (struct frame *f)
11559 {
11560 int i, size, size_needed;
11561 struct gcpro gcpro1, gcpro2, gcpro3;
11562 Lisp_Object image, plist, props;
11563
11564 image = plist = props = Qnil;
11565 GCPRO3 (image, plist, props);
11566
11567 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11568 Otherwise, make a new string. */
11569
11570 /* The size of the string we might be able to reuse. */
11571 size = (STRINGP (f->desired_tool_bar_string)
11572 ? SCHARS (f->desired_tool_bar_string)
11573 : 0);
11574
11575 /* We need one space in the string for each image. */
11576 size_needed = f->n_tool_bar_items;
11577
11578 /* Reuse f->desired_tool_bar_string, if possible. */
11579 if (size < size_needed || NILP (f->desired_tool_bar_string))
11580 fset_desired_tool_bar_string
11581 (f, Fmake_string (make_number (size_needed), make_number (' ')));
11582 else
11583 {
11584 props = list4 (Qdisplay, Qnil, Qmenu_item, Qnil);
11585 Fremove_text_properties (make_number (0), make_number (size),
11586 props, f->desired_tool_bar_string);
11587 }
11588
11589 /* Put a `display' property on the string for the images to display,
11590 put a `menu_item' property on tool-bar items with a value that
11591 is the index of the item in F's tool-bar item vector. */
11592 for (i = 0; i < f->n_tool_bar_items; ++i)
11593 {
11594 #define PROP(IDX) \
11595 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11596
11597 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
11598 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
11599 int hmargin, vmargin, relief, idx, end;
11600
11601 /* If image is a vector, choose the image according to the
11602 button state. */
11603 image = PROP (TOOL_BAR_ITEM_IMAGES);
11604 if (VECTORP (image))
11605 {
11606 if (enabled_p)
11607 idx = (selected_p
11608 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11609 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
11610 else
11611 idx = (selected_p
11612 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11613 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
11614
11615 eassert (ASIZE (image) >= idx);
11616 image = AREF (image, idx);
11617 }
11618 else
11619 idx = -1;
11620
11621 /* Ignore invalid image specifications. */
11622 if (!valid_image_p (image))
11623 continue;
11624
11625 /* Display the tool-bar button pressed, or depressed. */
11626 plist = Fcopy_sequence (XCDR (image));
11627
11628 /* Compute margin and relief to draw. */
11629 relief = (tool_bar_button_relief >= 0
11630 ? tool_bar_button_relief
11631 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
11632 hmargin = vmargin = relief;
11633
11634 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
11635 INT_MAX - max (hmargin, vmargin)))
11636 {
11637 hmargin += XFASTINT (Vtool_bar_button_margin);
11638 vmargin += XFASTINT (Vtool_bar_button_margin);
11639 }
11640 else if (CONSP (Vtool_bar_button_margin))
11641 {
11642 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
11643 INT_MAX - hmargin))
11644 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
11645
11646 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
11647 INT_MAX - vmargin))
11648 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
11649 }
11650
11651 if (auto_raise_tool_bar_buttons_p)
11652 {
11653 /* Add a `:relief' property to the image spec if the item is
11654 selected. */
11655 if (selected_p)
11656 {
11657 plist = Fplist_put (plist, QCrelief, make_number (-relief));
11658 hmargin -= relief;
11659 vmargin -= relief;
11660 }
11661 }
11662 else
11663 {
11664 /* If image is selected, display it pressed, i.e. with a
11665 negative relief. If it's not selected, display it with a
11666 raised relief. */
11667 plist = Fplist_put (plist, QCrelief,
11668 (selected_p
11669 ? make_number (-relief)
11670 : make_number (relief)));
11671 hmargin -= relief;
11672 vmargin -= relief;
11673 }
11674
11675 /* Put a margin around the image. */
11676 if (hmargin || vmargin)
11677 {
11678 if (hmargin == vmargin)
11679 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
11680 else
11681 plist = Fplist_put (plist, QCmargin,
11682 Fcons (make_number (hmargin),
11683 make_number (vmargin)));
11684 }
11685
11686 /* If button is not enabled, and we don't have special images
11687 for the disabled state, make the image appear disabled by
11688 applying an appropriate algorithm to it. */
11689 if (!enabled_p && idx < 0)
11690 plist = Fplist_put (plist, QCconversion, Qdisabled);
11691
11692 /* Put a `display' text property on the string for the image to
11693 display. Put a `menu-item' property on the string that gives
11694 the start of this item's properties in the tool-bar items
11695 vector. */
11696 image = Fcons (Qimage, plist);
11697 props = list4 (Qdisplay, image,
11698 Qmenu_item, make_number (i * TOOL_BAR_ITEM_NSLOTS));
11699
11700 /* Let the last image hide all remaining spaces in the tool bar
11701 string. The string can be longer than needed when we reuse a
11702 previous string. */
11703 if (i + 1 == f->n_tool_bar_items)
11704 end = SCHARS (f->desired_tool_bar_string);
11705 else
11706 end = i + 1;
11707 Fadd_text_properties (make_number (i), make_number (end),
11708 props, f->desired_tool_bar_string);
11709 #undef PROP
11710 }
11711
11712 UNGCPRO;
11713 }
11714
11715
11716 /* Display one line of the tool-bar of frame IT->f.
11717
11718 HEIGHT specifies the desired height of the tool-bar line.
11719 If the actual height of the glyph row is less than HEIGHT, the
11720 row's height is increased to HEIGHT, and the icons are centered
11721 vertically in the new height.
11722
11723 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11724 count a final empty row in case the tool-bar width exactly matches
11725 the window width.
11726 */
11727
11728 static void
11729 display_tool_bar_line (struct it *it, int height)
11730 {
11731 struct glyph_row *row = it->glyph_row;
11732 int max_x = it->last_visible_x;
11733 struct glyph *last;
11734
11735 prepare_desired_row (row);
11736 row->y = it->current_y;
11737
11738 /* Note that this isn't made use of if the face hasn't a box,
11739 so there's no need to check the face here. */
11740 it->start_of_box_run_p = 1;
11741
11742 while (it->current_x < max_x)
11743 {
11744 int x, n_glyphs_before, i, nglyphs;
11745 struct it it_before;
11746
11747 /* Get the next display element. */
11748 if (!get_next_display_element (it))
11749 {
11750 /* Don't count empty row if we are counting needed tool-bar lines. */
11751 if (height < 0 && !it->hpos)
11752 return;
11753 break;
11754 }
11755
11756 /* Produce glyphs. */
11757 n_glyphs_before = row->used[TEXT_AREA];
11758 it_before = *it;
11759
11760 PRODUCE_GLYPHS (it);
11761
11762 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
11763 i = 0;
11764 x = it_before.current_x;
11765 while (i < nglyphs)
11766 {
11767 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
11768
11769 if (x + glyph->pixel_width > max_x)
11770 {
11771 /* Glyph doesn't fit on line. Backtrack. */
11772 row->used[TEXT_AREA] = n_glyphs_before;
11773 *it = it_before;
11774 /* If this is the only glyph on this line, it will never fit on the
11775 tool-bar, so skip it. But ensure there is at least one glyph,
11776 so we don't accidentally disable the tool-bar. */
11777 if (n_glyphs_before == 0
11778 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
11779 break;
11780 goto out;
11781 }
11782
11783 ++it->hpos;
11784 x += glyph->pixel_width;
11785 ++i;
11786 }
11787
11788 /* Stop at line end. */
11789 if (ITERATOR_AT_END_OF_LINE_P (it))
11790 break;
11791
11792 set_iterator_to_next (it, 1);
11793 }
11794
11795 out:;
11796
11797 row->displays_text_p = row->used[TEXT_AREA] != 0;
11798
11799 /* Use default face for the border below the tool bar.
11800
11801 FIXME: When auto-resize-tool-bars is grow-only, there is
11802 no additional border below the possibly empty tool-bar lines.
11803 So to make the extra empty lines look "normal", we have to
11804 use the tool-bar face for the border too. */
11805 if (!row->displays_text_p && !EQ (Vauto_resize_tool_bars, Qgrow_only))
11806 it->face_id = DEFAULT_FACE_ID;
11807
11808 extend_face_to_end_of_line (it);
11809 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
11810 last->right_box_line_p = 1;
11811 if (last == row->glyphs[TEXT_AREA])
11812 last->left_box_line_p = 1;
11813
11814 /* Make line the desired height and center it vertically. */
11815 if ((height -= it->max_ascent + it->max_descent) > 0)
11816 {
11817 /* Don't add more than one line height. */
11818 height %= FRAME_LINE_HEIGHT (it->f);
11819 it->max_ascent += height / 2;
11820 it->max_descent += (height + 1) / 2;
11821 }
11822
11823 compute_line_metrics (it);
11824
11825 /* If line is empty, make it occupy the rest of the tool-bar. */
11826 if (!row->displays_text_p)
11827 {
11828 row->height = row->phys_height = it->last_visible_y - row->y;
11829 row->visible_height = row->height;
11830 row->ascent = row->phys_ascent = 0;
11831 row->extra_line_spacing = 0;
11832 }
11833
11834 row->full_width_p = 1;
11835 row->continued_p = 0;
11836 row->truncated_on_left_p = 0;
11837 row->truncated_on_right_p = 0;
11838
11839 it->current_x = it->hpos = 0;
11840 it->current_y += row->height;
11841 ++it->vpos;
11842 ++it->glyph_row;
11843 }
11844
11845
11846 /* Max tool-bar height. */
11847
11848 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11849 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11850
11851 /* Value is the number of screen lines needed to make all tool-bar
11852 items of frame F visible. The number of actual rows needed is
11853 returned in *N_ROWS if non-NULL. */
11854
11855 static int
11856 tool_bar_lines_needed (struct frame *f, int *n_rows)
11857 {
11858 struct window *w = XWINDOW (f->tool_bar_window);
11859 struct it it;
11860 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11861 the desired matrix, so use (unused) mode-line row as temporary row to
11862 avoid destroying the first tool-bar row. */
11863 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
11864
11865 /* Initialize an iterator for iteration over
11866 F->desired_tool_bar_string in the tool-bar window of frame F. */
11867 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
11868 it.first_visible_x = 0;
11869 it.last_visible_x = FRAME_TOTAL_COLS (f) * FRAME_COLUMN_WIDTH (f);
11870 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
11871 it.paragraph_embedding = L2R;
11872
11873 while (!ITERATOR_AT_END_P (&it))
11874 {
11875 clear_glyph_row (temp_row);
11876 it.glyph_row = temp_row;
11877 display_tool_bar_line (&it, -1);
11878 }
11879 clear_glyph_row (temp_row);
11880
11881 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11882 if (n_rows)
11883 *n_rows = it.vpos > 0 ? it.vpos : -1;
11884
11885 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
11886 }
11887
11888
11889 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed, Stool_bar_lines_needed,
11890 0, 1, 0,
11891 doc: /* Return the number of lines occupied by the tool bar of FRAME. */)
11892 (Lisp_Object frame)
11893 {
11894 struct frame *f;
11895 struct window *w;
11896 int nlines = 0;
11897
11898 if (NILP (frame))
11899 frame = selected_frame;
11900 else
11901 CHECK_FRAME (frame);
11902 f = XFRAME (frame);
11903
11904 if (WINDOWP (f->tool_bar_window)
11905 && (w = XWINDOW (f->tool_bar_window),
11906 WINDOW_TOTAL_LINES (w) > 0))
11907 {
11908 update_tool_bar (f, 1);
11909 if (f->n_tool_bar_items)
11910 {
11911 build_desired_tool_bar_string (f);
11912 nlines = tool_bar_lines_needed (f, NULL);
11913 }
11914 }
11915
11916 return make_number (nlines);
11917 }
11918
11919
11920 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11921 height should be changed. */
11922
11923 static int
11924 redisplay_tool_bar (struct frame *f)
11925 {
11926 struct window *w;
11927 struct it it;
11928 struct glyph_row *row;
11929
11930 #if defined (USE_GTK) || defined (HAVE_NS)
11931 if (FRAME_EXTERNAL_TOOL_BAR (f))
11932 update_frame_tool_bar (f);
11933 return 0;
11934 #endif
11935
11936 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11937 do anything. This means you must start with tool-bar-lines
11938 non-zero to get the auto-sizing effect. Or in other words, you
11939 can turn off tool-bars by specifying tool-bar-lines zero. */
11940 if (!WINDOWP (f->tool_bar_window)
11941 || (w = XWINDOW (f->tool_bar_window),
11942 WINDOW_TOTAL_LINES (w) == 0))
11943 return 0;
11944
11945 /* Set up an iterator for the tool-bar window. */
11946 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
11947 it.first_visible_x = 0;
11948 it.last_visible_x = FRAME_TOTAL_COLS (f) * FRAME_COLUMN_WIDTH (f);
11949 row = it.glyph_row;
11950
11951 /* Build a string that represents the contents of the tool-bar. */
11952 build_desired_tool_bar_string (f);
11953 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
11954 /* FIXME: This should be controlled by a user option. But it
11955 doesn't make sense to have an R2L tool bar if the menu bar cannot
11956 be drawn also R2L, and making the menu bar R2L is tricky due
11957 toolkit-specific code that implements it. If an R2L tool bar is
11958 ever supported, display_tool_bar_line should also be augmented to
11959 call unproduce_glyphs like display_line and display_string
11960 do. */
11961 it.paragraph_embedding = L2R;
11962
11963 if (f->n_tool_bar_rows == 0)
11964 {
11965 int nlines;
11966
11967 if ((nlines = tool_bar_lines_needed (f, &f->n_tool_bar_rows),
11968 nlines != WINDOW_TOTAL_LINES (w)))
11969 {
11970 Lisp_Object frame;
11971 int old_height = WINDOW_TOTAL_LINES (w);
11972
11973 XSETFRAME (frame, f);
11974 Fmodify_frame_parameters (frame,
11975 Fcons (Fcons (Qtool_bar_lines,
11976 make_number (nlines)),
11977 Qnil));
11978 if (WINDOW_TOTAL_LINES (w) != old_height)
11979 {
11980 clear_glyph_matrix (w->desired_matrix);
11981 fonts_changed_p = 1;
11982 return 1;
11983 }
11984 }
11985 }
11986
11987 /* Display as many lines as needed to display all tool-bar items. */
11988
11989 if (f->n_tool_bar_rows > 0)
11990 {
11991 int border, rows, height, extra;
11992
11993 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
11994 border = XINT (Vtool_bar_border);
11995 else if (EQ (Vtool_bar_border, Qinternal_border_width))
11996 border = FRAME_INTERNAL_BORDER_WIDTH (f);
11997 else if (EQ (Vtool_bar_border, Qborder_width))
11998 border = f->border_width;
11999 else
12000 border = 0;
12001 if (border < 0)
12002 border = 0;
12003
12004 rows = f->n_tool_bar_rows;
12005 height = max (1, (it.last_visible_y - border) / rows);
12006 extra = it.last_visible_y - border - height * rows;
12007
12008 while (it.current_y < it.last_visible_y)
12009 {
12010 int h = 0;
12011 if (extra > 0 && rows-- > 0)
12012 {
12013 h = (extra + rows - 1) / rows;
12014 extra -= h;
12015 }
12016 display_tool_bar_line (&it, height + h);
12017 }
12018 }
12019 else
12020 {
12021 while (it.current_y < it.last_visible_y)
12022 display_tool_bar_line (&it, 0);
12023 }
12024
12025 /* It doesn't make much sense to try scrolling in the tool-bar
12026 window, so don't do it. */
12027 w->desired_matrix->no_scrolling_p = 1;
12028 w->must_be_updated_p = 1;
12029
12030 if (!NILP (Vauto_resize_tool_bars))
12031 {
12032 int max_tool_bar_height = MAX_FRAME_TOOL_BAR_HEIGHT (f);
12033 int change_height_p = 0;
12034
12035 /* If we couldn't display everything, change the tool-bar's
12036 height if there is room for more. */
12037 if (IT_STRING_CHARPOS (it) < it.end_charpos
12038 && it.current_y < max_tool_bar_height)
12039 change_height_p = 1;
12040
12041 row = it.glyph_row - 1;
12042
12043 /* If there are blank lines at the end, except for a partially
12044 visible blank line at the end that is smaller than
12045 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12046 if (!row->displays_text_p
12047 && row->height >= FRAME_LINE_HEIGHT (f))
12048 change_height_p = 1;
12049
12050 /* If row displays tool-bar items, but is partially visible,
12051 change the tool-bar's height. */
12052 if (row->displays_text_p
12053 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y
12054 && MATRIX_ROW_BOTTOM_Y (row) < max_tool_bar_height)
12055 change_height_p = 1;
12056
12057 /* Resize windows as needed by changing the `tool-bar-lines'
12058 frame parameter. */
12059 if (change_height_p)
12060 {
12061 Lisp_Object frame;
12062 int old_height = WINDOW_TOTAL_LINES (w);
12063 int nrows;
12064 int nlines = tool_bar_lines_needed (f, &nrows);
12065
12066 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12067 && !f->minimize_tool_bar_window_p)
12068 ? (nlines > old_height)
12069 : (nlines != old_height));
12070 f->minimize_tool_bar_window_p = 0;
12071
12072 if (change_height_p)
12073 {
12074 XSETFRAME (frame, f);
12075 Fmodify_frame_parameters (frame,
12076 Fcons (Fcons (Qtool_bar_lines,
12077 make_number (nlines)),
12078 Qnil));
12079 if (WINDOW_TOTAL_LINES (w) != old_height)
12080 {
12081 clear_glyph_matrix (w->desired_matrix);
12082 f->n_tool_bar_rows = nrows;
12083 fonts_changed_p = 1;
12084 return 1;
12085 }
12086 }
12087 }
12088 }
12089
12090 f->minimize_tool_bar_window_p = 0;
12091 return 0;
12092 }
12093
12094
12095 /* Get information about the tool-bar item which is displayed in GLYPH
12096 on frame F. Return in *PROP_IDX the index where tool-bar item
12097 properties start in F->tool_bar_items. Value is zero if
12098 GLYPH doesn't display a tool-bar item. */
12099
12100 static int
12101 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12102 {
12103 Lisp_Object prop;
12104 int success_p;
12105 int charpos;
12106
12107 /* This function can be called asynchronously, which means we must
12108 exclude any possibility that Fget_text_property signals an
12109 error. */
12110 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12111 charpos = max (0, charpos);
12112
12113 /* Get the text property `menu-item' at pos. The value of that
12114 property is the start index of this item's properties in
12115 F->tool_bar_items. */
12116 prop = Fget_text_property (make_number (charpos),
12117 Qmenu_item, f->current_tool_bar_string);
12118 if (INTEGERP (prop))
12119 {
12120 *prop_idx = XINT (prop);
12121 success_p = 1;
12122 }
12123 else
12124 success_p = 0;
12125
12126 return success_p;
12127 }
12128
12129 \f
12130 /* Get information about the tool-bar item at position X/Y on frame F.
12131 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12132 the current matrix of the tool-bar window of F, or NULL if not
12133 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12134 item in F->tool_bar_items. Value is
12135
12136 -1 if X/Y is not on a tool-bar item
12137 0 if X/Y is on the same item that was highlighted before.
12138 1 otherwise. */
12139
12140 static int
12141 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12142 int *hpos, int *vpos, int *prop_idx)
12143 {
12144 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12145 struct window *w = XWINDOW (f->tool_bar_window);
12146 int area;
12147
12148 /* Find the glyph under X/Y. */
12149 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12150 if (*glyph == NULL)
12151 return -1;
12152
12153 /* Get the start of this tool-bar item's properties in
12154 f->tool_bar_items. */
12155 if (!tool_bar_item_info (f, *glyph, prop_idx))
12156 return -1;
12157
12158 /* Is mouse on the highlighted item? */
12159 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12160 && *vpos >= hlinfo->mouse_face_beg_row
12161 && *vpos <= hlinfo->mouse_face_end_row
12162 && (*vpos > hlinfo->mouse_face_beg_row
12163 || *hpos >= hlinfo->mouse_face_beg_col)
12164 && (*vpos < hlinfo->mouse_face_end_row
12165 || *hpos < hlinfo->mouse_face_end_col
12166 || hlinfo->mouse_face_past_end))
12167 return 0;
12168
12169 return 1;
12170 }
12171
12172
12173 /* EXPORT:
12174 Handle mouse button event on the tool-bar of frame F, at
12175 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12176 0 for button release. MODIFIERS is event modifiers for button
12177 release. */
12178
12179 void
12180 handle_tool_bar_click (struct frame *f, int x, int y, int down_p,
12181 int modifiers)
12182 {
12183 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12184 struct window *w = XWINDOW (f->tool_bar_window);
12185 int hpos, vpos, prop_idx;
12186 struct glyph *glyph;
12187 Lisp_Object enabled_p;
12188
12189 /* If not on the highlighted tool-bar item, return. */
12190 frame_to_window_pixel_xy (w, &x, &y);
12191 if (get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx) != 0)
12192 return;
12193
12194 /* If item is disabled, do nothing. */
12195 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12196 if (NILP (enabled_p))
12197 return;
12198
12199 if (down_p)
12200 {
12201 /* Show item in pressed state. */
12202 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12203 hlinfo->mouse_face_image_state = DRAW_IMAGE_SUNKEN;
12204 last_tool_bar_item = prop_idx;
12205 }
12206 else
12207 {
12208 Lisp_Object key, frame;
12209 struct input_event event;
12210 EVENT_INIT (event);
12211
12212 /* Show item in released state. */
12213 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12214 hlinfo->mouse_face_image_state = DRAW_IMAGE_RAISED;
12215
12216 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12217
12218 XSETFRAME (frame, f);
12219 event.kind = TOOL_BAR_EVENT;
12220 event.frame_or_window = frame;
12221 event.arg = frame;
12222 kbd_buffer_store_event (&event);
12223
12224 event.kind = TOOL_BAR_EVENT;
12225 event.frame_or_window = frame;
12226 event.arg = key;
12227 event.modifiers = modifiers;
12228 kbd_buffer_store_event (&event);
12229 last_tool_bar_item = -1;
12230 }
12231 }
12232
12233
12234 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12235 tool-bar window-relative coordinates X/Y. Called from
12236 note_mouse_highlight. */
12237
12238 static void
12239 note_tool_bar_highlight (struct frame *f, int x, int y)
12240 {
12241 Lisp_Object window = f->tool_bar_window;
12242 struct window *w = XWINDOW (window);
12243 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
12244 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12245 int hpos, vpos;
12246 struct glyph *glyph;
12247 struct glyph_row *row;
12248 int i;
12249 Lisp_Object enabled_p;
12250 int prop_idx;
12251 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12252 int mouse_down_p, rc;
12253
12254 /* Function note_mouse_highlight is called with negative X/Y
12255 values when mouse moves outside of the frame. */
12256 if (x <= 0 || y <= 0)
12257 {
12258 clear_mouse_face (hlinfo);
12259 return;
12260 }
12261
12262 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12263 if (rc < 0)
12264 {
12265 /* Not on tool-bar item. */
12266 clear_mouse_face (hlinfo);
12267 return;
12268 }
12269 else if (rc == 0)
12270 /* On same tool-bar item as before. */
12271 goto set_help_echo;
12272
12273 clear_mouse_face (hlinfo);
12274
12275 /* Mouse is down, but on different tool-bar item? */
12276 mouse_down_p = (dpyinfo->grabbed
12277 && f == last_mouse_frame
12278 && FRAME_LIVE_P (f));
12279 if (mouse_down_p
12280 && last_tool_bar_item != prop_idx)
12281 return;
12282
12283 hlinfo->mouse_face_image_state = DRAW_NORMAL_TEXT;
12284 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12285
12286 /* If tool-bar item is not enabled, don't highlight it. */
12287 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12288 if (!NILP (enabled_p))
12289 {
12290 /* Compute the x-position of the glyph. In front and past the
12291 image is a space. We include this in the highlighted area. */
12292 row = MATRIX_ROW (w->current_matrix, vpos);
12293 for (i = x = 0; i < hpos; ++i)
12294 x += row->glyphs[TEXT_AREA][i].pixel_width;
12295
12296 /* Record this as the current active region. */
12297 hlinfo->mouse_face_beg_col = hpos;
12298 hlinfo->mouse_face_beg_row = vpos;
12299 hlinfo->mouse_face_beg_x = x;
12300 hlinfo->mouse_face_beg_y = row->y;
12301 hlinfo->mouse_face_past_end = 0;
12302
12303 hlinfo->mouse_face_end_col = hpos + 1;
12304 hlinfo->mouse_face_end_row = vpos;
12305 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12306 hlinfo->mouse_face_end_y = row->y;
12307 hlinfo->mouse_face_window = window;
12308 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12309
12310 /* Display it as active. */
12311 show_mouse_face (hlinfo, draw);
12312 hlinfo->mouse_face_image_state = draw;
12313 }
12314
12315 set_help_echo:
12316
12317 /* Set help_echo_string to a help string to display for this tool-bar item.
12318 XTread_socket does the rest. */
12319 help_echo_object = help_echo_window = Qnil;
12320 help_echo_pos = -1;
12321 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12322 if (NILP (help_echo_string))
12323 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12324 }
12325
12326 #endif /* HAVE_WINDOW_SYSTEM */
12327
12328
12329 \f
12330 /************************************************************************
12331 Horizontal scrolling
12332 ************************************************************************/
12333
12334 static int hscroll_window_tree (Lisp_Object);
12335 static int hscroll_windows (Lisp_Object);
12336
12337 /* For all leaf windows in the window tree rooted at WINDOW, set their
12338 hscroll value so that PT is (i) visible in the window, and (ii) so
12339 that it is not within a certain margin at the window's left and
12340 right border. Value is non-zero if any window's hscroll has been
12341 changed. */
12342
12343 static int
12344 hscroll_window_tree (Lisp_Object window)
12345 {
12346 int hscrolled_p = 0;
12347 int hscroll_relative_p = FLOATP (Vhscroll_step);
12348 int hscroll_step_abs = 0;
12349 double hscroll_step_rel = 0;
12350
12351 if (hscroll_relative_p)
12352 {
12353 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12354 if (hscroll_step_rel < 0)
12355 {
12356 hscroll_relative_p = 0;
12357 hscroll_step_abs = 0;
12358 }
12359 }
12360 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12361 {
12362 hscroll_step_abs = XINT (Vhscroll_step);
12363 if (hscroll_step_abs < 0)
12364 hscroll_step_abs = 0;
12365 }
12366 else
12367 hscroll_step_abs = 0;
12368
12369 while (WINDOWP (window))
12370 {
12371 struct window *w = XWINDOW (window);
12372
12373 if (WINDOWP (w->hchild))
12374 hscrolled_p |= hscroll_window_tree (w->hchild);
12375 else if (WINDOWP (w->vchild))
12376 hscrolled_p |= hscroll_window_tree (w->vchild);
12377 else if (w->cursor.vpos >= 0)
12378 {
12379 int h_margin;
12380 int text_area_width;
12381 struct glyph_row *current_cursor_row
12382 = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12383 struct glyph_row *desired_cursor_row
12384 = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12385 struct glyph_row *cursor_row
12386 = (desired_cursor_row->enabled_p
12387 ? desired_cursor_row
12388 : current_cursor_row);
12389 int row_r2l_p = cursor_row->reversed_p;
12390
12391 text_area_width = window_box_width (w, TEXT_AREA);
12392
12393 /* Scroll when cursor is inside this scroll margin. */
12394 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12395
12396 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->buffer))
12397 /* For left-to-right rows, hscroll when cursor is either
12398 (i) inside the right hscroll margin, or (ii) if it is
12399 inside the left margin and the window is already
12400 hscrolled. */
12401 && ((!row_r2l_p
12402 && ((w->hscroll
12403 && w->cursor.x <= h_margin)
12404 || (cursor_row->enabled_p
12405 && cursor_row->truncated_on_right_p
12406 && (w->cursor.x >= text_area_width - h_margin))))
12407 /* For right-to-left rows, the logic is similar,
12408 except that rules for scrolling to left and right
12409 are reversed. E.g., if cursor.x <= h_margin, we
12410 need to hscroll "to the right" unconditionally,
12411 and that will scroll the screen to the left so as
12412 to reveal the next portion of the row. */
12413 || (row_r2l_p
12414 && ((cursor_row->enabled_p
12415 /* FIXME: It is confusing to set the
12416 truncated_on_right_p flag when R2L rows
12417 are actually truncated on the left. */
12418 && cursor_row->truncated_on_right_p
12419 && w->cursor.x <= h_margin)
12420 || (w->hscroll
12421 && (w->cursor.x >= text_area_width - h_margin))))))
12422 {
12423 struct it it;
12424 ptrdiff_t hscroll;
12425 struct buffer *saved_current_buffer;
12426 ptrdiff_t pt;
12427 int wanted_x;
12428
12429 /* Find point in a display of infinite width. */
12430 saved_current_buffer = current_buffer;
12431 current_buffer = XBUFFER (w->buffer);
12432
12433 if (w == XWINDOW (selected_window))
12434 pt = PT;
12435 else
12436 {
12437 pt = marker_position (w->pointm);
12438 pt = max (BEGV, pt);
12439 pt = min (ZV, pt);
12440 }
12441
12442 /* Move iterator to pt starting at cursor_row->start in
12443 a line with infinite width. */
12444 init_to_row_start (&it, w, cursor_row);
12445 it.last_visible_x = INFINITY;
12446 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12447 current_buffer = saved_current_buffer;
12448
12449 /* Position cursor in window. */
12450 if (!hscroll_relative_p && hscroll_step_abs == 0)
12451 hscroll = max (0, (it.current_x
12452 - (ITERATOR_AT_END_OF_LINE_P (&it)
12453 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12454 : (text_area_width / 2))))
12455 / FRAME_COLUMN_WIDTH (it.f);
12456 else if ((!row_r2l_p
12457 && w->cursor.x >= text_area_width - h_margin)
12458 || (row_r2l_p && w->cursor.x <= h_margin))
12459 {
12460 if (hscroll_relative_p)
12461 wanted_x = text_area_width * (1 - hscroll_step_rel)
12462 - h_margin;
12463 else
12464 wanted_x = text_area_width
12465 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12466 - h_margin;
12467 hscroll
12468 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12469 }
12470 else
12471 {
12472 if (hscroll_relative_p)
12473 wanted_x = text_area_width * hscroll_step_rel
12474 + h_margin;
12475 else
12476 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12477 + h_margin;
12478 hscroll
12479 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12480 }
12481 hscroll = max (hscroll, w->min_hscroll);
12482
12483 /* Don't prevent redisplay optimizations if hscroll
12484 hasn't changed, as it will unnecessarily slow down
12485 redisplay. */
12486 if (w->hscroll != hscroll)
12487 {
12488 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
12489 w->hscroll = hscroll;
12490 hscrolled_p = 1;
12491 }
12492 }
12493 }
12494
12495 window = w->next;
12496 }
12497
12498 /* Value is non-zero if hscroll of any leaf window has been changed. */
12499 return hscrolled_p;
12500 }
12501
12502
12503 /* Set hscroll so that cursor is visible and not inside horizontal
12504 scroll margins for all windows in the tree rooted at WINDOW. See
12505 also hscroll_window_tree above. Value is non-zero if any window's
12506 hscroll has been changed. If it has, desired matrices on the frame
12507 of WINDOW are cleared. */
12508
12509 static int
12510 hscroll_windows (Lisp_Object window)
12511 {
12512 int hscrolled_p = hscroll_window_tree (window);
12513 if (hscrolled_p)
12514 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
12515 return hscrolled_p;
12516 }
12517
12518
12519 \f
12520 /************************************************************************
12521 Redisplay
12522 ************************************************************************/
12523
12524 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12525 to a non-zero value. This is sometimes handy to have in a debugger
12526 session. */
12527
12528 #ifdef GLYPH_DEBUG
12529
12530 /* First and last unchanged row for try_window_id. */
12531
12532 static int debug_first_unchanged_at_end_vpos;
12533 static int debug_last_unchanged_at_beg_vpos;
12534
12535 /* Delta vpos and y. */
12536
12537 static int debug_dvpos, debug_dy;
12538
12539 /* Delta in characters and bytes for try_window_id. */
12540
12541 static ptrdiff_t debug_delta, debug_delta_bytes;
12542
12543 /* Values of window_end_pos and window_end_vpos at the end of
12544 try_window_id. */
12545
12546 static ptrdiff_t debug_end_vpos;
12547
12548 /* Append a string to W->desired_matrix->method. FMT is a printf
12549 format string. If trace_redisplay_p is non-zero also printf the
12550 resulting string to stderr. */
12551
12552 static void debug_method_add (struct window *, char const *, ...)
12553 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12554
12555 static void
12556 debug_method_add (struct window *w, char const *fmt, ...)
12557 {
12558 char *method = w->desired_matrix->method;
12559 int len = strlen (method);
12560 int size = sizeof w->desired_matrix->method;
12561 int remaining = size - len - 1;
12562 va_list ap;
12563
12564 if (len && remaining)
12565 {
12566 method[len] = '|';
12567 --remaining, ++len;
12568 }
12569
12570 va_start (ap, fmt);
12571 vsnprintf (method + len, remaining + 1, fmt, ap);
12572 va_end (ap);
12573
12574 if (trace_redisplay_p)
12575 fprintf (stderr, "%p (%s): %s\n",
12576 w,
12577 ((BUFFERP (w->buffer)
12578 && STRINGP (BVAR (XBUFFER (w->buffer), name)))
12579 ? SSDATA (BVAR (XBUFFER (w->buffer), name))
12580 : "no buffer"),
12581 method + len);
12582 }
12583
12584 #endif /* GLYPH_DEBUG */
12585
12586
12587 /* Value is non-zero if all changes in window W, which displays
12588 current_buffer, are in the text between START and END. START is a
12589 buffer position, END is given as a distance from Z. Used in
12590 redisplay_internal for display optimization. */
12591
12592 static inline int
12593 text_outside_line_unchanged_p (struct window *w,
12594 ptrdiff_t start, ptrdiff_t end)
12595 {
12596 int unchanged_p = 1;
12597
12598 /* If text or overlays have changed, see where. */
12599 if (w->last_modified < MODIFF
12600 || w->last_overlay_modified < OVERLAY_MODIFF)
12601 {
12602 /* Gap in the line? */
12603 if (GPT < start || Z - GPT < end)
12604 unchanged_p = 0;
12605
12606 /* Changes start in front of the line, or end after it? */
12607 if (unchanged_p
12608 && (BEG_UNCHANGED < start - 1
12609 || END_UNCHANGED < end))
12610 unchanged_p = 0;
12611
12612 /* If selective display, can't optimize if changes start at the
12613 beginning of the line. */
12614 if (unchanged_p
12615 && INTEGERP (BVAR (current_buffer, selective_display))
12616 && XINT (BVAR (current_buffer, selective_display)) > 0
12617 && (BEG_UNCHANGED < start || GPT <= start))
12618 unchanged_p = 0;
12619
12620 /* If there are overlays at the start or end of the line, these
12621 may have overlay strings with newlines in them. A change at
12622 START, for instance, may actually concern the display of such
12623 overlay strings as well, and they are displayed on different
12624 lines. So, quickly rule out this case. (For the future, it
12625 might be desirable to implement something more telling than
12626 just BEG/END_UNCHANGED.) */
12627 if (unchanged_p)
12628 {
12629 if (BEG + BEG_UNCHANGED == start
12630 && overlay_touches_p (start))
12631 unchanged_p = 0;
12632 if (END_UNCHANGED == end
12633 && overlay_touches_p (Z - end))
12634 unchanged_p = 0;
12635 }
12636
12637 /* Under bidi reordering, adding or deleting a character in the
12638 beginning of a paragraph, before the first strong directional
12639 character, can change the base direction of the paragraph (unless
12640 the buffer specifies a fixed paragraph direction), which will
12641 require to redisplay the whole paragraph. It might be worthwhile
12642 to find the paragraph limits and widen the range of redisplayed
12643 lines to that, but for now just give up this optimization. */
12644 if (!NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering))
12645 && NILP (BVAR (XBUFFER (w->buffer), bidi_paragraph_direction)))
12646 unchanged_p = 0;
12647 }
12648
12649 return unchanged_p;
12650 }
12651
12652
12653 /* Do a frame update, taking possible shortcuts into account. This is
12654 the main external entry point for redisplay.
12655
12656 If the last redisplay displayed an echo area message and that message
12657 is no longer requested, we clear the echo area or bring back the
12658 mini-buffer if that is in use. */
12659
12660 void
12661 redisplay (void)
12662 {
12663 redisplay_internal ();
12664 }
12665
12666
12667 static Lisp_Object
12668 overlay_arrow_string_or_property (Lisp_Object var)
12669 {
12670 Lisp_Object val;
12671
12672 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
12673 return val;
12674
12675 return Voverlay_arrow_string;
12676 }
12677
12678 /* Return 1 if there are any overlay-arrows in current_buffer. */
12679 static int
12680 overlay_arrow_in_current_buffer_p (void)
12681 {
12682 Lisp_Object vlist;
12683
12684 for (vlist = Voverlay_arrow_variable_list;
12685 CONSP (vlist);
12686 vlist = XCDR (vlist))
12687 {
12688 Lisp_Object var = XCAR (vlist);
12689 Lisp_Object val;
12690
12691 if (!SYMBOLP (var))
12692 continue;
12693 val = find_symbol_value (var);
12694 if (MARKERP (val)
12695 && current_buffer == XMARKER (val)->buffer)
12696 return 1;
12697 }
12698 return 0;
12699 }
12700
12701
12702 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12703 has changed. */
12704
12705 static int
12706 overlay_arrows_changed_p (void)
12707 {
12708 Lisp_Object vlist;
12709
12710 for (vlist = Voverlay_arrow_variable_list;
12711 CONSP (vlist);
12712 vlist = XCDR (vlist))
12713 {
12714 Lisp_Object var = XCAR (vlist);
12715 Lisp_Object val, pstr;
12716
12717 if (!SYMBOLP (var))
12718 continue;
12719 val = find_symbol_value (var);
12720 if (!MARKERP (val))
12721 continue;
12722 if (! EQ (COERCE_MARKER (val),
12723 Fget (var, Qlast_arrow_position))
12724 || ! (pstr = overlay_arrow_string_or_property (var),
12725 EQ (pstr, Fget (var, Qlast_arrow_string))))
12726 return 1;
12727 }
12728 return 0;
12729 }
12730
12731 /* Mark overlay arrows to be updated on next redisplay. */
12732
12733 static void
12734 update_overlay_arrows (int up_to_date)
12735 {
12736 Lisp_Object vlist;
12737
12738 for (vlist = Voverlay_arrow_variable_list;
12739 CONSP (vlist);
12740 vlist = XCDR (vlist))
12741 {
12742 Lisp_Object var = XCAR (vlist);
12743
12744 if (!SYMBOLP (var))
12745 continue;
12746
12747 if (up_to_date > 0)
12748 {
12749 Lisp_Object val = find_symbol_value (var);
12750 Fput (var, Qlast_arrow_position,
12751 COERCE_MARKER (val));
12752 Fput (var, Qlast_arrow_string,
12753 overlay_arrow_string_or_property (var));
12754 }
12755 else if (up_to_date < 0
12756 || !NILP (Fget (var, Qlast_arrow_position)))
12757 {
12758 Fput (var, Qlast_arrow_position, Qt);
12759 Fput (var, Qlast_arrow_string, Qt);
12760 }
12761 }
12762 }
12763
12764
12765 /* Return overlay arrow string to display at row.
12766 Return integer (bitmap number) for arrow bitmap in left fringe.
12767 Return nil if no overlay arrow. */
12768
12769 static Lisp_Object
12770 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
12771 {
12772 Lisp_Object vlist;
12773
12774 for (vlist = Voverlay_arrow_variable_list;
12775 CONSP (vlist);
12776 vlist = XCDR (vlist))
12777 {
12778 Lisp_Object var = XCAR (vlist);
12779 Lisp_Object val;
12780
12781 if (!SYMBOLP (var))
12782 continue;
12783
12784 val = find_symbol_value (var);
12785
12786 if (MARKERP (val)
12787 && current_buffer == XMARKER (val)->buffer
12788 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
12789 {
12790 if (FRAME_WINDOW_P (it->f)
12791 /* FIXME: if ROW->reversed_p is set, this should test
12792 the right fringe, not the left one. */
12793 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
12794 {
12795 #ifdef HAVE_WINDOW_SYSTEM
12796 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
12797 {
12798 int fringe_bitmap;
12799 if ((fringe_bitmap = lookup_fringe_bitmap (val)) != 0)
12800 return make_number (fringe_bitmap);
12801 }
12802 #endif
12803 return make_number (-1); /* Use default arrow bitmap */
12804 }
12805 return overlay_arrow_string_or_property (var);
12806 }
12807 }
12808
12809 return Qnil;
12810 }
12811
12812 /* Return 1 if point moved out of or into a composition. Otherwise
12813 return 0. PREV_BUF and PREV_PT are the last point buffer and
12814 position. BUF and PT are the current point buffer and position. */
12815
12816 static int
12817 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
12818 struct buffer *buf, ptrdiff_t pt)
12819 {
12820 ptrdiff_t start, end;
12821 Lisp_Object prop;
12822 Lisp_Object buffer;
12823
12824 XSETBUFFER (buffer, buf);
12825 /* Check a composition at the last point if point moved within the
12826 same buffer. */
12827 if (prev_buf == buf)
12828 {
12829 if (prev_pt == pt)
12830 /* Point didn't move. */
12831 return 0;
12832
12833 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
12834 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
12835 && COMPOSITION_VALID_P (start, end, prop)
12836 && start < prev_pt && end > prev_pt)
12837 /* The last point was within the composition. Return 1 iff
12838 point moved out of the composition. */
12839 return (pt <= start || pt >= end);
12840 }
12841
12842 /* Check a composition at the current point. */
12843 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
12844 && find_composition (pt, -1, &start, &end, &prop, buffer)
12845 && COMPOSITION_VALID_P (start, end, prop)
12846 && start < pt && end > pt);
12847 }
12848
12849
12850 /* Reconsider the setting of B->clip_changed which is displayed
12851 in window W. */
12852
12853 static inline void
12854 reconsider_clip_changes (struct window *w, struct buffer *b)
12855 {
12856 if (b->clip_changed
12857 && !NILP (w->window_end_valid)
12858 && w->current_matrix->buffer == b
12859 && w->current_matrix->zv == BUF_ZV (b)
12860 && w->current_matrix->begv == BUF_BEGV (b))
12861 b->clip_changed = 0;
12862
12863 /* If display wasn't paused, and W is not a tool bar window, see if
12864 point has been moved into or out of a composition. In that case,
12865 we set b->clip_changed to 1 to force updating the screen. If
12866 b->clip_changed has already been set to 1, we can skip this
12867 check. */
12868 if (!b->clip_changed
12869 && BUFFERP (w->buffer) && !NILP (w->window_end_valid))
12870 {
12871 ptrdiff_t pt;
12872
12873 if (w == XWINDOW (selected_window))
12874 pt = PT;
12875 else
12876 pt = marker_position (w->pointm);
12877
12878 if ((w->current_matrix->buffer != XBUFFER (w->buffer)
12879 || pt != w->last_point)
12880 && check_point_in_composition (w->current_matrix->buffer,
12881 w->last_point,
12882 XBUFFER (w->buffer), pt))
12883 b->clip_changed = 1;
12884 }
12885 }
12886 \f
12887
12888 /* Select FRAME to forward the values of frame-local variables into C
12889 variables so that the redisplay routines can access those values
12890 directly. */
12891
12892 static void
12893 select_frame_for_redisplay (Lisp_Object frame)
12894 {
12895 Lisp_Object tail, tem;
12896 Lisp_Object old = selected_frame;
12897 struct Lisp_Symbol *sym;
12898
12899 eassert (FRAMEP (frame) && FRAME_LIVE_P (XFRAME (frame)));
12900
12901 selected_frame = frame;
12902
12903 do {
12904 for (tail = XFRAME (frame)->param_alist;
12905 CONSP (tail); tail = XCDR (tail))
12906 if (CONSP (XCAR (tail))
12907 && (tem = XCAR (XCAR (tail)),
12908 SYMBOLP (tem))
12909 && (sym = indirect_variable (XSYMBOL (tem)),
12910 sym->redirect == SYMBOL_LOCALIZED)
12911 && sym->val.blv->frame_local)
12912 /* Use find_symbol_value rather than Fsymbol_value
12913 to avoid an error if it is void. */
12914 find_symbol_value (tem);
12915 } while (!EQ (frame, old) && (frame = old, 1));
12916 }
12917
12918
12919 #define STOP_POLLING \
12920 do { if (! polling_stopped_here) stop_polling (); \
12921 polling_stopped_here = 1; } while (0)
12922
12923 #define RESUME_POLLING \
12924 do { if (polling_stopped_here) start_polling (); \
12925 polling_stopped_here = 0; } while (0)
12926
12927
12928 /* Perhaps in the future avoid recentering windows if it
12929 is not necessary; currently that causes some problems. */
12930
12931 static void
12932 redisplay_internal (void)
12933 {
12934 struct window *w = XWINDOW (selected_window);
12935 struct window *sw;
12936 struct frame *fr;
12937 int pending;
12938 int must_finish = 0;
12939 struct text_pos tlbufpos, tlendpos;
12940 int number_of_visible_frames;
12941 ptrdiff_t count, count1;
12942 struct frame *sf;
12943 int polling_stopped_here = 0;
12944 Lisp_Object old_frame = selected_frame;
12945
12946 /* Non-zero means redisplay has to consider all windows on all
12947 frames. Zero means, only selected_window is considered. */
12948 int consider_all_windows_p;
12949
12950 /* Non-zero means redisplay has to redisplay the miniwindow */
12951 int update_miniwindow_p = 0;
12952
12953 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
12954
12955 /* No redisplay if running in batch mode or frame is not yet fully
12956 initialized, or redisplay is explicitly turned off by setting
12957 Vinhibit_redisplay. */
12958 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12959 || !NILP (Vinhibit_redisplay))
12960 return;
12961
12962 /* Don't examine these until after testing Vinhibit_redisplay.
12963 When Emacs is shutting down, perhaps because its connection to
12964 X has dropped, we should not look at them at all. */
12965 fr = XFRAME (w->frame);
12966 sf = SELECTED_FRAME ();
12967
12968 if (!fr->glyphs_initialized_p)
12969 return;
12970
12971 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12972 if (popup_activated ())
12973 return;
12974 #endif
12975
12976 /* I don't think this happens but let's be paranoid. */
12977 if (redisplaying_p)
12978 return;
12979
12980 /* Record a function that clears redisplaying_p
12981 when we leave this function. */
12982 count = SPECPDL_INDEX ();
12983 record_unwind_protect (unwind_redisplay, selected_frame);
12984 redisplaying_p = 1;
12985 specbind (Qinhibit_free_realized_faces, Qnil);
12986
12987 {
12988 Lisp_Object tail, frame;
12989
12990 FOR_EACH_FRAME (tail, frame)
12991 {
12992 struct frame *f = XFRAME (frame);
12993 f->already_hscrolled_p = 0;
12994 }
12995 }
12996
12997 retry:
12998 /* Remember the currently selected window. */
12999 sw = w;
13000
13001 if (!EQ (old_frame, selected_frame)
13002 && FRAME_LIVE_P (XFRAME (old_frame)))
13003 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
13004 selected_frame and selected_window to be temporarily out-of-sync so
13005 when we come back here via `goto retry', we need to resync because we
13006 may need to run Elisp code (via prepare_menu_bars). */
13007 select_frame_for_redisplay (old_frame);
13008
13009 pending = 0;
13010 reconsider_clip_changes (w, current_buffer);
13011 last_escape_glyph_frame = NULL;
13012 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13013 last_glyphless_glyph_frame = NULL;
13014 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13015
13016 /* If new fonts have been loaded that make a glyph matrix adjustment
13017 necessary, do it. */
13018 if (fonts_changed_p)
13019 {
13020 adjust_glyphs (NULL);
13021 ++windows_or_buffers_changed;
13022 fonts_changed_p = 0;
13023 }
13024
13025 /* If face_change_count is non-zero, init_iterator will free all
13026 realized faces, which includes the faces referenced from current
13027 matrices. So, we can't reuse current matrices in this case. */
13028 if (face_change_count)
13029 ++windows_or_buffers_changed;
13030
13031 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13032 && FRAME_TTY (sf)->previous_frame != sf)
13033 {
13034 /* Since frames on a single ASCII terminal share the same
13035 display area, displaying a different frame means redisplay
13036 the whole thing. */
13037 windows_or_buffers_changed++;
13038 SET_FRAME_GARBAGED (sf);
13039 #ifndef DOS_NT
13040 set_tty_color_mode (FRAME_TTY (sf), sf);
13041 #endif
13042 FRAME_TTY (sf)->previous_frame = sf;
13043 }
13044
13045 /* Set the visible flags for all frames. Do this before checking
13046 for resized or garbaged frames; they want to know if their frames
13047 are visible. See the comment in frame.h for
13048 FRAME_SAMPLE_VISIBILITY. */
13049 {
13050 Lisp_Object tail, frame;
13051
13052 number_of_visible_frames = 0;
13053
13054 FOR_EACH_FRAME (tail, frame)
13055 {
13056 struct frame *f = XFRAME (frame);
13057
13058 FRAME_SAMPLE_VISIBILITY (f);
13059 if (FRAME_VISIBLE_P (f))
13060 ++number_of_visible_frames;
13061 clear_desired_matrices (f);
13062 }
13063 }
13064
13065 /* Notice any pending interrupt request to change frame size. */
13066 do_pending_window_change (1);
13067
13068 /* do_pending_window_change could change the selected_window due to
13069 frame resizing which makes the selected window too small. */
13070 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13071 {
13072 sw = w;
13073 reconsider_clip_changes (w, current_buffer);
13074 }
13075
13076 /* Clear frames marked as garbaged. */
13077 if (frame_garbaged)
13078 clear_garbaged_frames ();
13079
13080 /* Build menubar and tool-bar items. */
13081 if (NILP (Vmemory_full))
13082 prepare_menu_bars ();
13083
13084 if (windows_or_buffers_changed)
13085 update_mode_lines++;
13086
13087 /* Detect case that we need to write or remove a star in the mode line. */
13088 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13089 {
13090 w->update_mode_line = 1;
13091 if (buffer_shared > 1)
13092 update_mode_lines++;
13093 }
13094
13095 /* Avoid invocation of point motion hooks by `current_column' below. */
13096 count1 = SPECPDL_INDEX ();
13097 specbind (Qinhibit_point_motion_hooks, Qt);
13098
13099 /* If %c is in the mode line, update it if needed. */
13100 if (!NILP (w->column_number_displayed)
13101 /* This alternative quickly identifies a common case
13102 where no change is needed. */
13103 && !(PT == w->last_point
13104 && w->last_modified >= MODIFF
13105 && w->last_overlay_modified >= OVERLAY_MODIFF)
13106 && (XFASTINT (w->column_number_displayed) != current_column ()))
13107 w->update_mode_line = 1;
13108
13109 unbind_to (count1, Qnil);
13110
13111 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w->frame)) = -1;
13112
13113 /* The variable buffer_shared is set in redisplay_window and
13114 indicates that we redisplay a buffer in different windows. See
13115 there. */
13116 consider_all_windows_p = (update_mode_lines || buffer_shared > 1
13117 || cursor_type_changed);
13118
13119 /* If specs for an arrow have changed, do thorough redisplay
13120 to ensure we remove any arrow that should no longer exist. */
13121 if (overlay_arrows_changed_p ())
13122 consider_all_windows_p = windows_or_buffers_changed = 1;
13123
13124 /* Normally the message* functions will have already displayed and
13125 updated the echo area, but the frame may have been trashed, or
13126 the update may have been preempted, so display the echo area
13127 again here. Checking message_cleared_p captures the case that
13128 the echo area should be cleared. */
13129 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13130 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13131 || (message_cleared_p
13132 && minibuf_level == 0
13133 /* If the mini-window is currently selected, this means the
13134 echo-area doesn't show through. */
13135 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13136 {
13137 int window_height_changed_p = echo_area_display (0);
13138
13139 if (message_cleared_p)
13140 update_miniwindow_p = 1;
13141
13142 must_finish = 1;
13143
13144 /* If we don't display the current message, don't clear the
13145 message_cleared_p flag, because, if we did, we wouldn't clear
13146 the echo area in the next redisplay which doesn't preserve
13147 the echo area. */
13148 if (!display_last_displayed_message_p)
13149 message_cleared_p = 0;
13150
13151 if (fonts_changed_p)
13152 goto retry;
13153 else if (window_height_changed_p)
13154 {
13155 consider_all_windows_p = 1;
13156 ++update_mode_lines;
13157 ++windows_or_buffers_changed;
13158
13159 /* If window configuration was changed, frames may have been
13160 marked garbaged. Clear them or we will experience
13161 surprises wrt scrolling. */
13162 if (frame_garbaged)
13163 clear_garbaged_frames ();
13164 }
13165 }
13166 else if (EQ (selected_window, minibuf_window)
13167 && (current_buffer->clip_changed
13168 || w->last_modified < MODIFF
13169 || w->last_overlay_modified < OVERLAY_MODIFF)
13170 && resize_mini_window (w, 0))
13171 {
13172 /* Resized active mini-window to fit the size of what it is
13173 showing if its contents might have changed. */
13174 must_finish = 1;
13175 /* FIXME: this causes all frames to be updated, which seems unnecessary
13176 since only the current frame needs to be considered. This function needs
13177 to be rewritten with two variables, consider_all_windows and
13178 consider_all_frames. */
13179 consider_all_windows_p = 1;
13180 ++windows_or_buffers_changed;
13181 ++update_mode_lines;
13182
13183 /* If window configuration was changed, frames may have been
13184 marked garbaged. Clear them or we will experience
13185 surprises wrt scrolling. */
13186 if (frame_garbaged)
13187 clear_garbaged_frames ();
13188 }
13189
13190
13191 /* If showing the region, and mark has changed, we must redisplay
13192 the whole window. The assignment to this_line_start_pos prevents
13193 the optimization directly below this if-statement. */
13194 if (((!NILP (Vtransient_mark_mode)
13195 && !NILP (BVAR (XBUFFER (w->buffer), mark_active)))
13196 != !NILP (w->region_showing))
13197 || (!NILP (w->region_showing)
13198 && !EQ (w->region_showing,
13199 Fmarker_position (BVAR (XBUFFER (w->buffer), mark)))))
13200 CHARPOS (this_line_start_pos) = 0;
13201
13202 /* Optimize the case that only the line containing the cursor in the
13203 selected window has changed. Variables starting with this_ are
13204 set in display_line and record information about the line
13205 containing the cursor. */
13206 tlbufpos = this_line_start_pos;
13207 tlendpos = this_line_end_pos;
13208 if (!consider_all_windows_p
13209 && CHARPOS (tlbufpos) > 0
13210 && !w->update_mode_line
13211 && !current_buffer->clip_changed
13212 && !current_buffer->prevent_redisplay_optimizations_p
13213 && FRAME_VISIBLE_P (XFRAME (w->frame))
13214 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13215 /* Make sure recorded data applies to current buffer, etc. */
13216 && this_line_buffer == current_buffer
13217 && current_buffer == XBUFFER (w->buffer)
13218 && !w->force_start
13219 && !w->optional_new_start
13220 /* Point must be on the line that we have info recorded about. */
13221 && PT >= CHARPOS (tlbufpos)
13222 && PT <= Z - CHARPOS (tlendpos)
13223 /* All text outside that line, including its final newline,
13224 must be unchanged. */
13225 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13226 CHARPOS (tlendpos)))
13227 {
13228 if (CHARPOS (tlbufpos) > BEGV
13229 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13230 && (CHARPOS (tlbufpos) == ZV
13231 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13232 /* Former continuation line has disappeared by becoming empty. */
13233 goto cancel;
13234 else if (w->last_modified < MODIFF
13235 || w->last_overlay_modified < OVERLAY_MODIFF
13236 || MINI_WINDOW_P (w))
13237 {
13238 /* We have to handle the case of continuation around a
13239 wide-column character (see the comment in indent.c around
13240 line 1340).
13241
13242 For instance, in the following case:
13243
13244 -------- Insert --------
13245 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13246 J_I_ ==> J_I_ `^^' are cursors.
13247 ^^ ^^
13248 -------- --------
13249
13250 As we have to redraw the line above, we cannot use this
13251 optimization. */
13252
13253 struct it it;
13254 int line_height_before = this_line_pixel_height;
13255
13256 /* Note that start_display will handle the case that the
13257 line starting at tlbufpos is a continuation line. */
13258 start_display (&it, w, tlbufpos);
13259
13260 /* Implementation note: It this still necessary? */
13261 if (it.current_x != this_line_start_x)
13262 goto cancel;
13263
13264 TRACE ((stderr, "trying display optimization 1\n"));
13265 w->cursor.vpos = -1;
13266 overlay_arrow_seen = 0;
13267 it.vpos = this_line_vpos;
13268 it.current_y = this_line_y;
13269 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13270 display_line (&it);
13271
13272 /* If line contains point, is not continued,
13273 and ends at same distance from eob as before, we win. */
13274 if (w->cursor.vpos >= 0
13275 /* Line is not continued, otherwise this_line_start_pos
13276 would have been set to 0 in display_line. */
13277 && CHARPOS (this_line_start_pos)
13278 /* Line ends as before. */
13279 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13280 /* Line has same height as before. Otherwise other lines
13281 would have to be shifted up or down. */
13282 && this_line_pixel_height == line_height_before)
13283 {
13284 /* If this is not the window's last line, we must adjust
13285 the charstarts of the lines below. */
13286 if (it.current_y < it.last_visible_y)
13287 {
13288 struct glyph_row *row
13289 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13290 ptrdiff_t delta, delta_bytes;
13291
13292 /* We used to distinguish between two cases here,
13293 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13294 when the line ends in a newline or the end of the
13295 buffer's accessible portion. But both cases did
13296 the same, so they were collapsed. */
13297 delta = (Z
13298 - CHARPOS (tlendpos)
13299 - MATRIX_ROW_START_CHARPOS (row));
13300 delta_bytes = (Z_BYTE
13301 - BYTEPOS (tlendpos)
13302 - MATRIX_ROW_START_BYTEPOS (row));
13303
13304 increment_matrix_positions (w->current_matrix,
13305 this_line_vpos + 1,
13306 w->current_matrix->nrows,
13307 delta, delta_bytes);
13308 }
13309
13310 /* If this row displays text now but previously didn't,
13311 or vice versa, w->window_end_vpos may have to be
13312 adjusted. */
13313 if ((it.glyph_row - 1)->displays_text_p)
13314 {
13315 if (XFASTINT (w->window_end_vpos) < this_line_vpos)
13316 wset_window_end_vpos (w, make_number (this_line_vpos));
13317 }
13318 else if (XFASTINT (w->window_end_vpos) == this_line_vpos
13319 && this_line_vpos > 0)
13320 wset_window_end_vpos (w, make_number (this_line_vpos - 1));
13321 wset_window_end_valid (w, Qnil);
13322
13323 /* Update hint: No need to try to scroll in update_window. */
13324 w->desired_matrix->no_scrolling_p = 1;
13325
13326 #ifdef GLYPH_DEBUG
13327 *w->desired_matrix->method = 0;
13328 debug_method_add (w, "optimization 1");
13329 #endif
13330 #ifdef HAVE_WINDOW_SYSTEM
13331 update_window_fringes (w, 0);
13332 #endif
13333 goto update;
13334 }
13335 else
13336 goto cancel;
13337 }
13338 else if (/* Cursor position hasn't changed. */
13339 PT == w->last_point
13340 /* Make sure the cursor was last displayed
13341 in this window. Otherwise we have to reposition it. */
13342 && 0 <= w->cursor.vpos
13343 && WINDOW_TOTAL_LINES (w) > w->cursor.vpos)
13344 {
13345 if (!must_finish)
13346 {
13347 do_pending_window_change (1);
13348 /* If selected_window changed, redisplay again. */
13349 if (WINDOWP (selected_window)
13350 && (w = XWINDOW (selected_window)) != sw)
13351 goto retry;
13352
13353 /* We used to always goto end_of_redisplay here, but this
13354 isn't enough if we have a blinking cursor. */
13355 if (w->cursor_off_p == w->last_cursor_off_p)
13356 goto end_of_redisplay;
13357 }
13358 goto update;
13359 }
13360 /* If highlighting the region, or if the cursor is in the echo area,
13361 then we can't just move the cursor. */
13362 else if (! (!NILP (Vtransient_mark_mode)
13363 && !NILP (BVAR (current_buffer, mark_active)))
13364 && (EQ (selected_window,
13365 BVAR (current_buffer, last_selected_window))
13366 || highlight_nonselected_windows)
13367 && NILP (w->region_showing)
13368 && NILP (Vshow_trailing_whitespace)
13369 && !cursor_in_echo_area)
13370 {
13371 struct it it;
13372 struct glyph_row *row;
13373
13374 /* Skip from tlbufpos to PT and see where it is. Note that
13375 PT may be in invisible text. If so, we will end at the
13376 next visible position. */
13377 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13378 NULL, DEFAULT_FACE_ID);
13379 it.current_x = this_line_start_x;
13380 it.current_y = this_line_y;
13381 it.vpos = this_line_vpos;
13382
13383 /* The call to move_it_to stops in front of PT, but
13384 moves over before-strings. */
13385 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13386
13387 if (it.vpos == this_line_vpos
13388 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13389 row->enabled_p))
13390 {
13391 eassert (this_line_vpos == it.vpos);
13392 eassert (this_line_y == it.current_y);
13393 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13394 #ifdef GLYPH_DEBUG
13395 *w->desired_matrix->method = 0;
13396 debug_method_add (w, "optimization 3");
13397 #endif
13398 goto update;
13399 }
13400 else
13401 goto cancel;
13402 }
13403
13404 cancel:
13405 /* Text changed drastically or point moved off of line. */
13406 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, 0);
13407 }
13408
13409 CHARPOS (this_line_start_pos) = 0;
13410 consider_all_windows_p |= buffer_shared > 1;
13411 ++clear_face_cache_count;
13412 #ifdef HAVE_WINDOW_SYSTEM
13413 ++clear_image_cache_count;
13414 #endif
13415
13416 /* Build desired matrices, and update the display. If
13417 consider_all_windows_p is non-zero, do it for all windows on all
13418 frames. Otherwise do it for selected_window, only. */
13419
13420 if (consider_all_windows_p)
13421 {
13422 Lisp_Object tail, frame;
13423
13424 FOR_EACH_FRAME (tail, frame)
13425 XFRAME (frame)->updated_p = 0;
13426
13427 /* Recompute # windows showing selected buffer. This will be
13428 incremented each time such a window is displayed. */
13429 buffer_shared = 0;
13430
13431 FOR_EACH_FRAME (tail, frame)
13432 {
13433 struct frame *f = XFRAME (frame);
13434
13435 /* We don't have to do anything for unselected terminal
13436 frames. */
13437 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13438 && !EQ (FRAME_TTY (f)->top_frame, frame))
13439 continue;
13440
13441 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13442 {
13443 if (! EQ (frame, selected_frame))
13444 /* Select the frame, for the sake of frame-local
13445 variables. */
13446 select_frame_for_redisplay (frame);
13447
13448 /* Mark all the scroll bars to be removed; we'll redeem
13449 the ones we want when we redisplay their windows. */
13450 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13451 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13452
13453 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13454 redisplay_windows (FRAME_ROOT_WINDOW (f));
13455
13456 /* The X error handler may have deleted that frame. */
13457 if (!FRAME_LIVE_P (f))
13458 continue;
13459
13460 /* Any scroll bars which redisplay_windows should have
13461 nuked should now go away. */
13462 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13463 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13464
13465 /* If fonts changed, display again. */
13466 /* ??? rms: I suspect it is a mistake to jump all the way
13467 back to retry here. It should just retry this frame. */
13468 if (fonts_changed_p)
13469 goto retry;
13470
13471 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13472 {
13473 /* See if we have to hscroll. */
13474 if (!f->already_hscrolled_p)
13475 {
13476 f->already_hscrolled_p = 1;
13477 if (hscroll_windows (f->root_window))
13478 goto retry;
13479 }
13480
13481 /* Prevent various kinds of signals during display
13482 update. stdio is not robust about handling
13483 signals, which can cause an apparent I/O
13484 error. */
13485 if (interrupt_input)
13486 unrequest_sigio ();
13487 STOP_POLLING;
13488
13489 /* Update the display. */
13490 set_window_update_flags (XWINDOW (f->root_window), 1);
13491 pending |= update_frame (f, 0, 0);
13492 f->updated_p = 1;
13493 }
13494 }
13495 }
13496
13497 if (!EQ (old_frame, selected_frame)
13498 && FRAME_LIVE_P (XFRAME (old_frame)))
13499 /* We played a bit fast-and-loose above and allowed selected_frame
13500 and selected_window to be temporarily out-of-sync but let's make
13501 sure this stays contained. */
13502 select_frame_for_redisplay (old_frame);
13503 eassert (EQ (XFRAME (selected_frame)->selected_window,
13504 selected_window));
13505
13506 if (!pending)
13507 {
13508 /* Do the mark_window_display_accurate after all windows have
13509 been redisplayed because this call resets flags in buffers
13510 which are needed for proper redisplay. */
13511 FOR_EACH_FRAME (tail, frame)
13512 {
13513 struct frame *f = XFRAME (frame);
13514 if (f->updated_p)
13515 {
13516 mark_window_display_accurate (f->root_window, 1);
13517 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13518 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13519 }
13520 }
13521 }
13522 }
13523 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13524 {
13525 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13526 struct frame *mini_frame;
13527
13528 displayed_buffer = XBUFFER (XWINDOW (selected_window)->buffer);
13529 /* Use list_of_error, not Qerror, so that
13530 we catch only errors and don't run the debugger. */
13531 internal_condition_case_1 (redisplay_window_1, selected_window,
13532 list_of_error,
13533 redisplay_window_error);
13534 if (update_miniwindow_p)
13535 internal_condition_case_1 (redisplay_window_1, mini_window,
13536 list_of_error,
13537 redisplay_window_error);
13538
13539 /* Compare desired and current matrices, perform output. */
13540
13541 update:
13542 /* If fonts changed, display again. */
13543 if (fonts_changed_p)
13544 goto retry;
13545
13546 /* Prevent various kinds of signals during display update.
13547 stdio is not robust about handling signals,
13548 which can cause an apparent I/O error. */
13549 if (interrupt_input)
13550 unrequest_sigio ();
13551 STOP_POLLING;
13552
13553 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13554 {
13555 if (hscroll_windows (selected_window))
13556 goto retry;
13557
13558 XWINDOW (selected_window)->must_be_updated_p = 1;
13559 pending = update_frame (sf, 0, 0);
13560 }
13561
13562 /* We may have called echo_area_display at the top of this
13563 function. If the echo area is on another frame, that may
13564 have put text on a frame other than the selected one, so the
13565 above call to update_frame would not have caught it. Catch
13566 it here. */
13567 mini_window = FRAME_MINIBUF_WINDOW (sf);
13568 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
13569
13570 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
13571 {
13572 XWINDOW (mini_window)->must_be_updated_p = 1;
13573 pending |= update_frame (mini_frame, 0, 0);
13574 if (!pending && hscroll_windows (mini_window))
13575 goto retry;
13576 }
13577 }
13578
13579 /* If display was paused because of pending input, make sure we do a
13580 thorough update the next time. */
13581 if (pending)
13582 {
13583 /* Prevent the optimization at the beginning of
13584 redisplay_internal that tries a single-line update of the
13585 line containing the cursor in the selected window. */
13586 CHARPOS (this_line_start_pos) = 0;
13587
13588 /* Let the overlay arrow be updated the next time. */
13589 update_overlay_arrows (0);
13590
13591 /* If we pause after scrolling, some rows in the current
13592 matrices of some windows are not valid. */
13593 if (!WINDOW_FULL_WIDTH_P (w)
13594 && !FRAME_WINDOW_P (XFRAME (w->frame)))
13595 update_mode_lines = 1;
13596 }
13597 else
13598 {
13599 if (!consider_all_windows_p)
13600 {
13601 /* This has already been done above if
13602 consider_all_windows_p is set. */
13603 mark_window_display_accurate_1 (w, 1);
13604
13605 /* Say overlay arrows are up to date. */
13606 update_overlay_arrows (1);
13607
13608 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
13609 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
13610 }
13611
13612 update_mode_lines = 0;
13613 windows_or_buffers_changed = 0;
13614 cursor_type_changed = 0;
13615 }
13616
13617 /* Start SIGIO interrupts coming again. Having them off during the
13618 code above makes it less likely one will discard output, but not
13619 impossible, since there might be stuff in the system buffer here.
13620 But it is much hairier to try to do anything about that. */
13621 if (interrupt_input)
13622 request_sigio ();
13623 RESUME_POLLING;
13624
13625 /* If a frame has become visible which was not before, redisplay
13626 again, so that we display it. Expose events for such a frame
13627 (which it gets when becoming visible) don't call the parts of
13628 redisplay constructing glyphs, so simply exposing a frame won't
13629 display anything in this case. So, we have to display these
13630 frames here explicitly. */
13631 if (!pending)
13632 {
13633 Lisp_Object tail, frame;
13634 int new_count = 0;
13635
13636 FOR_EACH_FRAME (tail, frame)
13637 {
13638 int this_is_visible = 0;
13639
13640 if (XFRAME (frame)->visible)
13641 this_is_visible = 1;
13642 FRAME_SAMPLE_VISIBILITY (XFRAME (frame));
13643 if (XFRAME (frame)->visible)
13644 this_is_visible = 1;
13645
13646 if (this_is_visible)
13647 new_count++;
13648 }
13649
13650 if (new_count != number_of_visible_frames)
13651 windows_or_buffers_changed++;
13652 }
13653
13654 /* Change frame size now if a change is pending. */
13655 do_pending_window_change (1);
13656
13657 /* If we just did a pending size change, or have additional
13658 visible frames, or selected_window changed, redisplay again. */
13659 if ((windows_or_buffers_changed && !pending)
13660 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
13661 goto retry;
13662
13663 /* Clear the face and image caches.
13664
13665 We used to do this only if consider_all_windows_p. But the cache
13666 needs to be cleared if a timer creates images in the current
13667 buffer (e.g. the test case in Bug#6230). */
13668
13669 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
13670 {
13671 clear_face_cache (0);
13672 clear_face_cache_count = 0;
13673 }
13674
13675 #ifdef HAVE_WINDOW_SYSTEM
13676 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
13677 {
13678 clear_image_caches (Qnil);
13679 clear_image_cache_count = 0;
13680 }
13681 #endif /* HAVE_WINDOW_SYSTEM */
13682
13683 end_of_redisplay:
13684 unbind_to (count, Qnil);
13685 RESUME_POLLING;
13686 }
13687
13688
13689 /* Redisplay, but leave alone any recent echo area message unless
13690 another message has been requested in its place.
13691
13692 This is useful in situations where you need to redisplay but no
13693 user action has occurred, making it inappropriate for the message
13694 area to be cleared. See tracking_off and
13695 wait_reading_process_output for examples of these situations.
13696
13697 FROM_WHERE is an integer saying from where this function was
13698 called. This is useful for debugging. */
13699
13700 void
13701 redisplay_preserve_echo_area (int from_where)
13702 {
13703 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
13704
13705 if (!NILP (echo_area_buffer[1]))
13706 {
13707 /* We have a previously displayed message, but no current
13708 message. Redisplay the previous message. */
13709 display_last_displayed_message_p = 1;
13710 redisplay_internal ();
13711 display_last_displayed_message_p = 0;
13712 }
13713 else
13714 redisplay_internal ();
13715
13716 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13717 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional)
13718 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL);
13719 }
13720
13721
13722 /* Function registered with record_unwind_protect in redisplay_internal.
13723 Clear redisplaying_p. Also, select the previously
13724 selected frame, unless it has been deleted (by an X connection
13725 failure during redisplay, for example). */
13726
13727 static Lisp_Object
13728 unwind_redisplay (Lisp_Object old_frame)
13729 {
13730 redisplaying_p = 0;
13731 if (! EQ (old_frame, selected_frame)
13732 && FRAME_LIVE_P (XFRAME (old_frame)))
13733 select_frame_for_redisplay (old_frame);
13734 return Qnil;
13735 }
13736
13737
13738 /* Mark the display of window W as accurate or inaccurate. If
13739 ACCURATE_P is non-zero mark display of W as accurate. If
13740 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13741 redisplay_internal is called. */
13742
13743 static void
13744 mark_window_display_accurate_1 (struct window *w, int accurate_p)
13745 {
13746 if (BUFFERP (w->buffer))
13747 {
13748 struct buffer *b = XBUFFER (w->buffer);
13749
13750 w->last_modified = accurate_p ? BUF_MODIFF(b) : 0;
13751 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF(b) : 0;
13752 w->last_had_star
13753 = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
13754
13755 if (accurate_p)
13756 {
13757 b->clip_changed = 0;
13758 b->prevent_redisplay_optimizations_p = 0;
13759
13760 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
13761 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
13762 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
13763 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
13764
13765 w->current_matrix->buffer = b;
13766 w->current_matrix->begv = BUF_BEGV (b);
13767 w->current_matrix->zv = BUF_ZV (b);
13768
13769 w->last_cursor = w->cursor;
13770 w->last_cursor_off_p = w->cursor_off_p;
13771
13772 if (w == XWINDOW (selected_window))
13773 w->last_point = BUF_PT (b);
13774 else
13775 w->last_point = XMARKER (w->pointm)->charpos;
13776 }
13777 }
13778
13779 if (accurate_p)
13780 {
13781 wset_window_end_valid (w, w->buffer);
13782 w->update_mode_line = 0;
13783 }
13784 }
13785
13786
13787 /* Mark the display of windows in the window tree rooted at WINDOW as
13788 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13789 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13790 be redisplayed the next time redisplay_internal is called. */
13791
13792 void
13793 mark_window_display_accurate (Lisp_Object window, int accurate_p)
13794 {
13795 struct window *w;
13796
13797 for (; !NILP (window); window = w->next)
13798 {
13799 w = XWINDOW (window);
13800 mark_window_display_accurate_1 (w, accurate_p);
13801
13802 if (!NILP (w->vchild))
13803 mark_window_display_accurate (w->vchild, accurate_p);
13804 if (!NILP (w->hchild))
13805 mark_window_display_accurate (w->hchild, accurate_p);
13806 }
13807
13808 if (accurate_p)
13809 {
13810 update_overlay_arrows (1);
13811 }
13812 else
13813 {
13814 /* Force a thorough redisplay the next time by setting
13815 last_arrow_position and last_arrow_string to t, which is
13816 unequal to any useful value of Voverlay_arrow_... */
13817 update_overlay_arrows (-1);
13818 }
13819 }
13820
13821
13822 /* Return value in display table DP (Lisp_Char_Table *) for character
13823 C. Since a display table doesn't have any parent, we don't have to
13824 follow parent. Do not call this function directly but use the
13825 macro DISP_CHAR_VECTOR. */
13826
13827 Lisp_Object
13828 disp_char_vector (struct Lisp_Char_Table *dp, int c)
13829 {
13830 Lisp_Object val;
13831
13832 if (ASCII_CHAR_P (c))
13833 {
13834 val = dp->ascii;
13835 if (SUB_CHAR_TABLE_P (val))
13836 val = XSUB_CHAR_TABLE (val)->contents[c];
13837 }
13838 else
13839 {
13840 Lisp_Object table;
13841
13842 XSETCHAR_TABLE (table, dp);
13843 val = char_table_ref (table, c);
13844 }
13845 if (NILP (val))
13846 val = dp->defalt;
13847 return val;
13848 }
13849
13850
13851 \f
13852 /***********************************************************************
13853 Window Redisplay
13854 ***********************************************************************/
13855
13856 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13857
13858 static void
13859 redisplay_windows (Lisp_Object window)
13860 {
13861 while (!NILP (window))
13862 {
13863 struct window *w = XWINDOW (window);
13864
13865 if (!NILP (w->hchild))
13866 redisplay_windows (w->hchild);
13867 else if (!NILP (w->vchild))
13868 redisplay_windows (w->vchild);
13869 else if (!NILP (w->buffer))
13870 {
13871 displayed_buffer = XBUFFER (w->buffer);
13872 /* Use list_of_error, not Qerror, so that
13873 we catch only errors and don't run the debugger. */
13874 internal_condition_case_1 (redisplay_window_0, window,
13875 list_of_error,
13876 redisplay_window_error);
13877 }
13878
13879 window = w->next;
13880 }
13881 }
13882
13883 static Lisp_Object
13884 redisplay_window_error (Lisp_Object ignore)
13885 {
13886 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
13887 return Qnil;
13888 }
13889
13890 static Lisp_Object
13891 redisplay_window_0 (Lisp_Object window)
13892 {
13893 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
13894 redisplay_window (window, 0);
13895 return Qnil;
13896 }
13897
13898 static Lisp_Object
13899 redisplay_window_1 (Lisp_Object window)
13900 {
13901 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
13902 redisplay_window (window, 1);
13903 return Qnil;
13904 }
13905 \f
13906
13907 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13908 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13909 which positions recorded in ROW differ from current buffer
13910 positions.
13911
13912 Return 0 if cursor is not on this row, 1 otherwise. */
13913
13914 static int
13915 set_cursor_from_row (struct window *w, struct glyph_row *row,
13916 struct glyph_matrix *matrix,
13917 ptrdiff_t delta, ptrdiff_t delta_bytes,
13918 int dy, int dvpos)
13919 {
13920 struct glyph *glyph = row->glyphs[TEXT_AREA];
13921 struct glyph *end = glyph + row->used[TEXT_AREA];
13922 struct glyph *cursor = NULL;
13923 /* The last known character position in row. */
13924 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
13925 int x = row->x;
13926 ptrdiff_t pt_old = PT - delta;
13927 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
13928 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
13929 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
13930 /* A glyph beyond the edge of TEXT_AREA which we should never
13931 touch. */
13932 struct glyph *glyphs_end = end;
13933 /* Non-zero means we've found a match for cursor position, but that
13934 glyph has the avoid_cursor_p flag set. */
13935 int match_with_avoid_cursor = 0;
13936 /* Non-zero means we've seen at least one glyph that came from a
13937 display string. */
13938 int string_seen = 0;
13939 /* Largest and smallest buffer positions seen so far during scan of
13940 glyph row. */
13941 ptrdiff_t bpos_max = pos_before;
13942 ptrdiff_t bpos_min = pos_after;
13943 /* Last buffer position covered by an overlay string with an integer
13944 `cursor' property. */
13945 ptrdiff_t bpos_covered = 0;
13946 /* Non-zero means the display string on which to display the cursor
13947 comes from a text property, not from an overlay. */
13948 int string_from_text_prop = 0;
13949
13950 /* Don't even try doing anything if called for a mode-line or
13951 header-line row, since the rest of the code isn't prepared to
13952 deal with such calamities. */
13953 eassert (!row->mode_line_p);
13954 if (row->mode_line_p)
13955 return 0;
13956
13957 /* Skip over glyphs not having an object at the start and the end of
13958 the row. These are special glyphs like truncation marks on
13959 terminal frames. */
13960 if (row->displays_text_p)
13961 {
13962 if (!row->reversed_p)
13963 {
13964 while (glyph < end
13965 && INTEGERP (glyph->object)
13966 && glyph->charpos < 0)
13967 {
13968 x += glyph->pixel_width;
13969 ++glyph;
13970 }
13971 while (end > glyph
13972 && INTEGERP ((end - 1)->object)
13973 /* CHARPOS is zero for blanks and stretch glyphs
13974 inserted by extend_face_to_end_of_line. */
13975 && (end - 1)->charpos <= 0)
13976 --end;
13977 glyph_before = glyph - 1;
13978 glyph_after = end;
13979 }
13980 else
13981 {
13982 struct glyph *g;
13983
13984 /* If the glyph row is reversed, we need to process it from back
13985 to front, so swap the edge pointers. */
13986 glyphs_end = end = glyph - 1;
13987 glyph += row->used[TEXT_AREA] - 1;
13988
13989 while (glyph > end + 1
13990 && INTEGERP (glyph->object)
13991 && glyph->charpos < 0)
13992 {
13993 --glyph;
13994 x -= glyph->pixel_width;
13995 }
13996 if (INTEGERP (glyph->object) && glyph->charpos < 0)
13997 --glyph;
13998 /* By default, in reversed rows we put the cursor on the
13999 rightmost (first in the reading order) glyph. */
14000 for (g = end + 1; g < glyph; g++)
14001 x += g->pixel_width;
14002 while (end < glyph
14003 && INTEGERP ((end + 1)->object)
14004 && (end + 1)->charpos <= 0)
14005 ++end;
14006 glyph_before = glyph + 1;
14007 glyph_after = end;
14008 }
14009 }
14010 else if (row->reversed_p)
14011 {
14012 /* In R2L rows that don't display text, put the cursor on the
14013 rightmost glyph. Case in point: an empty last line that is
14014 part of an R2L paragraph. */
14015 cursor = end - 1;
14016 /* Avoid placing the cursor on the last glyph of the row, where
14017 on terminal frames we hold the vertical border between
14018 adjacent windows. */
14019 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14020 && !WINDOW_RIGHTMOST_P (w)
14021 && cursor == row->glyphs[LAST_AREA] - 1)
14022 cursor--;
14023 x = -1; /* will be computed below, at label compute_x */
14024 }
14025
14026 /* Step 1: Try to find the glyph whose character position
14027 corresponds to point. If that's not possible, find 2 glyphs
14028 whose character positions are the closest to point, one before
14029 point, the other after it. */
14030 if (!row->reversed_p)
14031 while (/* not marched to end of glyph row */
14032 glyph < end
14033 /* glyph was not inserted by redisplay for internal purposes */
14034 && !INTEGERP (glyph->object))
14035 {
14036 if (BUFFERP (glyph->object))
14037 {
14038 ptrdiff_t dpos = glyph->charpos - pt_old;
14039
14040 if (glyph->charpos > bpos_max)
14041 bpos_max = glyph->charpos;
14042 if (glyph->charpos < bpos_min)
14043 bpos_min = glyph->charpos;
14044 if (!glyph->avoid_cursor_p)
14045 {
14046 /* If we hit point, we've found the glyph on which to
14047 display the cursor. */
14048 if (dpos == 0)
14049 {
14050 match_with_avoid_cursor = 0;
14051 break;
14052 }
14053 /* See if we've found a better approximation to
14054 POS_BEFORE or to POS_AFTER. */
14055 if (0 > dpos && dpos > pos_before - pt_old)
14056 {
14057 pos_before = glyph->charpos;
14058 glyph_before = glyph;
14059 }
14060 else if (0 < dpos && dpos < pos_after - pt_old)
14061 {
14062 pos_after = glyph->charpos;
14063 glyph_after = glyph;
14064 }
14065 }
14066 else if (dpos == 0)
14067 match_with_avoid_cursor = 1;
14068 }
14069 else if (STRINGP (glyph->object))
14070 {
14071 Lisp_Object chprop;
14072 ptrdiff_t glyph_pos = glyph->charpos;
14073
14074 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14075 glyph->object);
14076 if (!NILP (chprop))
14077 {
14078 /* If the string came from a `display' text property,
14079 look up the buffer position of that property and
14080 use that position to update bpos_max, as if we
14081 actually saw such a position in one of the row's
14082 glyphs. This helps with supporting integer values
14083 of `cursor' property on the display string in
14084 situations where most or all of the row's buffer
14085 text is completely covered by display properties,
14086 so that no glyph with valid buffer positions is
14087 ever seen in the row. */
14088 ptrdiff_t prop_pos =
14089 string_buffer_position_lim (glyph->object, pos_before,
14090 pos_after, 0);
14091
14092 if (prop_pos >= pos_before)
14093 bpos_max = prop_pos - 1;
14094 }
14095 if (INTEGERP (chprop))
14096 {
14097 bpos_covered = bpos_max + XINT (chprop);
14098 /* If the `cursor' property covers buffer positions up
14099 to and including point, we should display cursor on
14100 this glyph. Note that, if a `cursor' property on one
14101 of the string's characters has an integer value, we
14102 will break out of the loop below _before_ we get to
14103 the position match above. IOW, integer values of
14104 the `cursor' property override the "exact match for
14105 point" strategy of positioning the cursor. */
14106 /* Implementation note: bpos_max == pt_old when, e.g.,
14107 we are in an empty line, where bpos_max is set to
14108 MATRIX_ROW_START_CHARPOS, see above. */
14109 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14110 {
14111 cursor = glyph;
14112 break;
14113 }
14114 }
14115
14116 string_seen = 1;
14117 }
14118 x += glyph->pixel_width;
14119 ++glyph;
14120 }
14121 else if (glyph > end) /* row is reversed */
14122 while (!INTEGERP (glyph->object))
14123 {
14124 if (BUFFERP (glyph->object))
14125 {
14126 ptrdiff_t dpos = glyph->charpos - pt_old;
14127
14128 if (glyph->charpos > bpos_max)
14129 bpos_max = glyph->charpos;
14130 if (glyph->charpos < bpos_min)
14131 bpos_min = glyph->charpos;
14132 if (!glyph->avoid_cursor_p)
14133 {
14134 if (dpos == 0)
14135 {
14136 match_with_avoid_cursor = 0;
14137 break;
14138 }
14139 if (0 > dpos && dpos > pos_before - pt_old)
14140 {
14141 pos_before = glyph->charpos;
14142 glyph_before = glyph;
14143 }
14144 else if (0 < dpos && dpos < pos_after - pt_old)
14145 {
14146 pos_after = glyph->charpos;
14147 glyph_after = glyph;
14148 }
14149 }
14150 else if (dpos == 0)
14151 match_with_avoid_cursor = 1;
14152 }
14153 else if (STRINGP (glyph->object))
14154 {
14155 Lisp_Object chprop;
14156 ptrdiff_t glyph_pos = glyph->charpos;
14157
14158 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14159 glyph->object);
14160 if (!NILP (chprop))
14161 {
14162 ptrdiff_t prop_pos =
14163 string_buffer_position_lim (glyph->object, pos_before,
14164 pos_after, 0);
14165
14166 if (prop_pos >= pos_before)
14167 bpos_max = prop_pos - 1;
14168 }
14169 if (INTEGERP (chprop))
14170 {
14171 bpos_covered = bpos_max + XINT (chprop);
14172 /* If the `cursor' property covers buffer positions up
14173 to and including point, we should display cursor on
14174 this glyph. */
14175 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14176 {
14177 cursor = glyph;
14178 break;
14179 }
14180 }
14181 string_seen = 1;
14182 }
14183 --glyph;
14184 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14185 {
14186 x--; /* can't use any pixel_width */
14187 break;
14188 }
14189 x -= glyph->pixel_width;
14190 }
14191
14192 /* Step 2: If we didn't find an exact match for point, we need to
14193 look for a proper place to put the cursor among glyphs between
14194 GLYPH_BEFORE and GLYPH_AFTER. */
14195 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14196 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14197 && bpos_covered < pt_old)
14198 {
14199 /* An empty line has a single glyph whose OBJECT is zero and
14200 whose CHARPOS is the position of a newline on that line.
14201 Note that on a TTY, there are more glyphs after that, which
14202 were produced by extend_face_to_end_of_line, but their
14203 CHARPOS is zero or negative. */
14204 int empty_line_p =
14205 (row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14206 && INTEGERP (glyph->object) && glyph->charpos > 0;
14207
14208 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14209 {
14210 ptrdiff_t ellipsis_pos;
14211
14212 /* Scan back over the ellipsis glyphs. */
14213 if (!row->reversed_p)
14214 {
14215 ellipsis_pos = (glyph - 1)->charpos;
14216 while (glyph > row->glyphs[TEXT_AREA]
14217 && (glyph - 1)->charpos == ellipsis_pos)
14218 glyph--, x -= glyph->pixel_width;
14219 /* That loop always goes one position too far, including
14220 the glyph before the ellipsis. So scan forward over
14221 that one. */
14222 x += glyph->pixel_width;
14223 glyph++;
14224 }
14225 else /* row is reversed */
14226 {
14227 ellipsis_pos = (glyph + 1)->charpos;
14228 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14229 && (glyph + 1)->charpos == ellipsis_pos)
14230 glyph++, x += glyph->pixel_width;
14231 x -= glyph->pixel_width;
14232 glyph--;
14233 }
14234 }
14235 else if (match_with_avoid_cursor)
14236 {
14237 cursor = glyph_after;
14238 x = -1;
14239 }
14240 else if (string_seen)
14241 {
14242 int incr = row->reversed_p ? -1 : +1;
14243
14244 /* Need to find the glyph that came out of a string which is
14245 present at point. That glyph is somewhere between
14246 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14247 positioned between POS_BEFORE and POS_AFTER in the
14248 buffer. */
14249 struct glyph *start, *stop;
14250 ptrdiff_t pos = pos_before;
14251
14252 x = -1;
14253
14254 /* If the row ends in a newline from a display string,
14255 reordering could have moved the glyphs belonging to the
14256 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14257 in this case we extend the search to the last glyph in
14258 the row that was not inserted by redisplay. */
14259 if (row->ends_in_newline_from_string_p)
14260 {
14261 glyph_after = end;
14262 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14263 }
14264
14265 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14266 correspond to POS_BEFORE and POS_AFTER, respectively. We
14267 need START and STOP in the order that corresponds to the
14268 row's direction as given by its reversed_p flag. If the
14269 directionality of characters between POS_BEFORE and
14270 POS_AFTER is the opposite of the row's base direction,
14271 these characters will have been reordered for display,
14272 and we need to reverse START and STOP. */
14273 if (!row->reversed_p)
14274 {
14275 start = min (glyph_before, glyph_after);
14276 stop = max (glyph_before, glyph_after);
14277 }
14278 else
14279 {
14280 start = max (glyph_before, glyph_after);
14281 stop = min (glyph_before, glyph_after);
14282 }
14283 for (glyph = start + incr;
14284 row->reversed_p ? glyph > stop : glyph < stop; )
14285 {
14286
14287 /* Any glyphs that come from the buffer are here because
14288 of bidi reordering. Skip them, and only pay
14289 attention to glyphs that came from some string. */
14290 if (STRINGP (glyph->object))
14291 {
14292 Lisp_Object str;
14293 ptrdiff_t tem;
14294 /* If the display property covers the newline, we
14295 need to search for it one position farther. */
14296 ptrdiff_t lim = pos_after
14297 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14298
14299 string_from_text_prop = 0;
14300 str = glyph->object;
14301 tem = string_buffer_position_lim (str, pos, lim, 0);
14302 if (tem == 0 /* from overlay */
14303 || pos <= tem)
14304 {
14305 /* If the string from which this glyph came is
14306 found in the buffer at point, or at position
14307 that is closer to point than pos_after, then
14308 we've found the glyph we've been looking for.
14309 If it comes from an overlay (tem == 0), and
14310 it has the `cursor' property on one of its
14311 glyphs, record that glyph as a candidate for
14312 displaying the cursor. (As in the
14313 unidirectional version, we will display the
14314 cursor on the last candidate we find.) */
14315 if (tem == 0
14316 || tem == pt_old
14317 || (tem - pt_old > 0 && tem < pos_after))
14318 {
14319 /* The glyphs from this string could have
14320 been reordered. Find the one with the
14321 smallest string position. Or there could
14322 be a character in the string with the
14323 `cursor' property, which means display
14324 cursor on that character's glyph. */
14325 ptrdiff_t strpos = glyph->charpos;
14326
14327 if (tem)
14328 {
14329 cursor = glyph;
14330 string_from_text_prop = 1;
14331 }
14332 for ( ;
14333 (row->reversed_p ? glyph > stop : glyph < stop)
14334 && EQ (glyph->object, str);
14335 glyph += incr)
14336 {
14337 Lisp_Object cprop;
14338 ptrdiff_t gpos = glyph->charpos;
14339
14340 cprop = Fget_char_property (make_number (gpos),
14341 Qcursor,
14342 glyph->object);
14343 if (!NILP (cprop))
14344 {
14345 cursor = glyph;
14346 break;
14347 }
14348 if (tem && glyph->charpos < strpos)
14349 {
14350 strpos = glyph->charpos;
14351 cursor = glyph;
14352 }
14353 }
14354
14355 if (tem == pt_old
14356 || (tem - pt_old > 0 && tem < pos_after))
14357 goto compute_x;
14358 }
14359 if (tem)
14360 pos = tem + 1; /* don't find previous instances */
14361 }
14362 /* This string is not what we want; skip all of the
14363 glyphs that came from it. */
14364 while ((row->reversed_p ? glyph > stop : glyph < stop)
14365 && EQ (glyph->object, str))
14366 glyph += incr;
14367 }
14368 else
14369 glyph += incr;
14370 }
14371
14372 /* If we reached the end of the line, and END was from a string,
14373 the cursor is not on this line. */
14374 if (cursor == NULL
14375 && (row->reversed_p ? glyph <= end : glyph >= end)
14376 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14377 && STRINGP (end->object)
14378 && row->continued_p)
14379 return 0;
14380 }
14381 /* A truncated row may not include PT among its character positions.
14382 Setting the cursor inside the scroll margin will trigger
14383 recalculation of hscroll in hscroll_window_tree. But if a
14384 display string covers point, defer to the string-handling
14385 code below to figure this out. */
14386 else if (row->truncated_on_left_p && pt_old < bpos_min)
14387 {
14388 cursor = glyph_before;
14389 x = -1;
14390 }
14391 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14392 /* Zero-width characters produce no glyphs. */
14393 || (!empty_line_p
14394 && (row->reversed_p
14395 ? glyph_after > glyphs_end
14396 : glyph_after < glyphs_end)))
14397 {
14398 cursor = glyph_after;
14399 x = -1;
14400 }
14401 }
14402
14403 compute_x:
14404 if (cursor != NULL)
14405 glyph = cursor;
14406 else if (glyph == glyphs_end
14407 && pos_before == pos_after
14408 && STRINGP ((row->reversed_p
14409 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14410 : row->glyphs[TEXT_AREA])->object))
14411 {
14412 /* If all the glyphs of this row came from strings, put the
14413 cursor on the first glyph of the row. This avoids having the
14414 cursor outside of the text area in this very rare and hard
14415 use case. */
14416 glyph =
14417 row->reversed_p
14418 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14419 : row->glyphs[TEXT_AREA];
14420 }
14421 if (x < 0)
14422 {
14423 struct glyph *g;
14424
14425 /* Need to compute x that corresponds to GLYPH. */
14426 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14427 {
14428 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14429 emacs_abort ();
14430 x += g->pixel_width;
14431 }
14432 }
14433
14434 /* ROW could be part of a continued line, which, under bidi
14435 reordering, might have other rows whose start and end charpos
14436 occlude point. Only set w->cursor if we found a better
14437 approximation to the cursor position than we have from previously
14438 examined candidate rows belonging to the same continued line. */
14439 if (/* we already have a candidate row */
14440 w->cursor.vpos >= 0
14441 /* that candidate is not the row we are processing */
14442 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14443 /* Make sure cursor.vpos specifies a row whose start and end
14444 charpos occlude point, and it is valid candidate for being a
14445 cursor-row. This is because some callers of this function
14446 leave cursor.vpos at the row where the cursor was displayed
14447 during the last redisplay cycle. */
14448 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14449 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14450 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14451 {
14452 struct glyph *g1 =
14453 MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14454
14455 /* Don't consider glyphs that are outside TEXT_AREA. */
14456 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14457 return 0;
14458 /* Keep the candidate whose buffer position is the closest to
14459 point or has the `cursor' property. */
14460 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14461 w->cursor.hpos >= 0
14462 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14463 && ((BUFFERP (g1->object)
14464 && (g1->charpos == pt_old /* an exact match always wins */
14465 || (BUFFERP (glyph->object)
14466 && eabs (g1->charpos - pt_old)
14467 < eabs (glyph->charpos - pt_old))))
14468 /* previous candidate is a glyph from a string that has
14469 a non-nil `cursor' property */
14470 || (STRINGP (g1->object)
14471 && (!NILP (Fget_char_property (make_number (g1->charpos),
14472 Qcursor, g1->object))
14473 /* previous candidate is from the same display
14474 string as this one, and the display string
14475 came from a text property */
14476 || (EQ (g1->object, glyph->object)
14477 && string_from_text_prop)
14478 /* this candidate is from newline and its
14479 position is not an exact match */
14480 || (INTEGERP (glyph->object)
14481 && glyph->charpos != pt_old)))))
14482 return 0;
14483 /* If this candidate gives an exact match, use that. */
14484 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14485 /* If this candidate is a glyph created for the
14486 terminating newline of a line, and point is on that
14487 newline, it wins because it's an exact match. */
14488 || (!row->continued_p
14489 && INTEGERP (glyph->object)
14490 && glyph->charpos == 0
14491 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14492 /* Otherwise, keep the candidate that comes from a row
14493 spanning less buffer positions. This may win when one or
14494 both candidate positions are on glyphs that came from
14495 display strings, for which we cannot compare buffer
14496 positions. */
14497 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14498 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14499 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14500 return 0;
14501 }
14502 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14503 w->cursor.x = x;
14504 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14505 w->cursor.y = row->y + dy;
14506
14507 if (w == XWINDOW (selected_window))
14508 {
14509 if (!row->continued_p
14510 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14511 && row->x == 0)
14512 {
14513 this_line_buffer = XBUFFER (w->buffer);
14514
14515 CHARPOS (this_line_start_pos)
14516 = MATRIX_ROW_START_CHARPOS (row) + delta;
14517 BYTEPOS (this_line_start_pos)
14518 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14519
14520 CHARPOS (this_line_end_pos)
14521 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14522 BYTEPOS (this_line_end_pos)
14523 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14524
14525 this_line_y = w->cursor.y;
14526 this_line_pixel_height = row->height;
14527 this_line_vpos = w->cursor.vpos;
14528 this_line_start_x = row->x;
14529 }
14530 else
14531 CHARPOS (this_line_start_pos) = 0;
14532 }
14533
14534 return 1;
14535 }
14536
14537
14538 /* Run window scroll functions, if any, for WINDOW with new window
14539 start STARTP. Sets the window start of WINDOW to that position.
14540
14541 We assume that the window's buffer is really current. */
14542
14543 static inline struct text_pos
14544 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14545 {
14546 struct window *w = XWINDOW (window);
14547 SET_MARKER_FROM_TEXT_POS (w->start, startp);
14548
14549 if (current_buffer != XBUFFER (w->buffer))
14550 emacs_abort ();
14551
14552 if (!NILP (Vwindow_scroll_functions))
14553 {
14554 run_hook_with_args_2 (Qwindow_scroll_functions, window,
14555 make_number (CHARPOS (startp)));
14556 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14557 /* In case the hook functions switch buffers. */
14558 set_buffer_internal (XBUFFER (w->buffer));
14559 }
14560
14561 return startp;
14562 }
14563
14564
14565 /* Make sure the line containing the cursor is fully visible.
14566 A value of 1 means there is nothing to be done.
14567 (Either the line is fully visible, or it cannot be made so,
14568 or we cannot tell.)
14569
14570 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14571 is higher than window.
14572
14573 A value of 0 means the caller should do scrolling
14574 as if point had gone off the screen. */
14575
14576 static int
14577 cursor_row_fully_visible_p (struct window *w, int force_p, int current_matrix_p)
14578 {
14579 struct glyph_matrix *matrix;
14580 struct glyph_row *row;
14581 int window_height;
14582
14583 if (!make_cursor_line_fully_visible_p)
14584 return 1;
14585
14586 /* It's not always possible to find the cursor, e.g, when a window
14587 is full of overlay strings. Don't do anything in that case. */
14588 if (w->cursor.vpos < 0)
14589 return 1;
14590
14591 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
14592 row = MATRIX_ROW (matrix, w->cursor.vpos);
14593
14594 /* If the cursor row is not partially visible, there's nothing to do. */
14595 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
14596 return 1;
14597
14598 /* If the row the cursor is in is taller than the window's height,
14599 it's not clear what to do, so do nothing. */
14600 window_height = window_box_height (w);
14601 if (row->height >= window_height)
14602 {
14603 if (!force_p || MINI_WINDOW_P (w)
14604 || w->vscroll || w->cursor.vpos == 0)
14605 return 1;
14606 }
14607 return 0;
14608 }
14609
14610
14611 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14612 non-zero means only WINDOW is redisplayed in redisplay_internal.
14613 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14614 in redisplay_window to bring a partially visible line into view in
14615 the case that only the cursor has moved.
14616
14617 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14618 last screen line's vertical height extends past the end of the screen.
14619
14620 Value is
14621
14622 1 if scrolling succeeded
14623
14624 0 if scrolling didn't find point.
14625
14626 -1 if new fonts have been loaded so that we must interrupt
14627 redisplay, adjust glyph matrices, and try again. */
14628
14629 enum
14630 {
14631 SCROLLING_SUCCESS,
14632 SCROLLING_FAILED,
14633 SCROLLING_NEED_LARGER_MATRICES
14634 };
14635
14636 /* If scroll-conservatively is more than this, never recenter.
14637
14638 If you change this, don't forget to update the doc string of
14639 `scroll-conservatively' and the Emacs manual. */
14640 #define SCROLL_LIMIT 100
14641
14642 static int
14643 try_scrolling (Lisp_Object window, int just_this_one_p,
14644 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
14645 int temp_scroll_step, int last_line_misfit)
14646 {
14647 struct window *w = XWINDOW (window);
14648 struct frame *f = XFRAME (w->frame);
14649 struct text_pos pos, startp;
14650 struct it it;
14651 int this_scroll_margin, scroll_max, rc, height;
14652 int dy = 0, amount_to_scroll = 0, scroll_down_p = 0;
14653 int extra_scroll_margin_lines = last_line_misfit ? 1 : 0;
14654 Lisp_Object aggressive;
14655 /* We will never try scrolling more than this number of lines. */
14656 int scroll_limit = SCROLL_LIMIT;
14657
14658 #ifdef GLYPH_DEBUG
14659 debug_method_add (w, "try_scrolling");
14660 #endif
14661
14662 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14663
14664 /* Compute scroll margin height in pixels. We scroll when point is
14665 within this distance from the top or bottom of the window. */
14666 if (scroll_margin > 0)
14667 this_scroll_margin = min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4)
14668 * FRAME_LINE_HEIGHT (f);
14669 else
14670 this_scroll_margin = 0;
14671
14672 /* Force arg_scroll_conservatively to have a reasonable value, to
14673 avoid scrolling too far away with slow move_it_* functions. Note
14674 that the user can supply scroll-conservatively equal to
14675 `most-positive-fixnum', which can be larger than INT_MAX. */
14676 if (arg_scroll_conservatively > scroll_limit)
14677 {
14678 arg_scroll_conservatively = scroll_limit + 1;
14679 scroll_max = scroll_limit * FRAME_LINE_HEIGHT (f);
14680 }
14681 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
14682 /* Compute how much we should try to scroll maximally to bring
14683 point into view. */
14684 scroll_max = (max (scroll_step,
14685 max (arg_scroll_conservatively, temp_scroll_step))
14686 * FRAME_LINE_HEIGHT (f));
14687 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
14688 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
14689 /* We're trying to scroll because of aggressive scrolling but no
14690 scroll_step is set. Choose an arbitrary one. */
14691 scroll_max = 10 * FRAME_LINE_HEIGHT (f);
14692 else
14693 scroll_max = 0;
14694
14695 too_near_end:
14696
14697 /* Decide whether to scroll down. */
14698 if (PT > CHARPOS (startp))
14699 {
14700 int scroll_margin_y;
14701
14702 /* Compute the pixel ypos of the scroll margin, then move IT to
14703 either that ypos or PT, whichever comes first. */
14704 start_display (&it, w, startp);
14705 scroll_margin_y = it.last_visible_y - this_scroll_margin
14706 - FRAME_LINE_HEIGHT (f) * extra_scroll_margin_lines;
14707 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
14708 (MOVE_TO_POS | MOVE_TO_Y));
14709
14710 if (PT > CHARPOS (it.current.pos))
14711 {
14712 int y0 = line_bottom_y (&it);
14713 /* Compute how many pixels below window bottom to stop searching
14714 for PT. This avoids costly search for PT that is far away if
14715 the user limited scrolling by a small number of lines, but
14716 always finds PT if scroll_conservatively is set to a large
14717 number, such as most-positive-fixnum. */
14718 int slack = max (scroll_max, 10 * FRAME_LINE_HEIGHT (f));
14719 int y_to_move = it.last_visible_y + slack;
14720
14721 /* Compute the distance from the scroll margin to PT or to
14722 the scroll limit, whichever comes first. This should
14723 include the height of the cursor line, to make that line
14724 fully visible. */
14725 move_it_to (&it, PT, -1, y_to_move,
14726 -1, MOVE_TO_POS | MOVE_TO_Y);
14727 dy = line_bottom_y (&it) - y0;
14728
14729 if (dy > scroll_max)
14730 return SCROLLING_FAILED;
14731
14732 if (dy > 0)
14733 scroll_down_p = 1;
14734 }
14735 }
14736
14737 if (scroll_down_p)
14738 {
14739 /* Point is in or below the bottom scroll margin, so move the
14740 window start down. If scrolling conservatively, move it just
14741 enough down to make point visible. If scroll_step is set,
14742 move it down by scroll_step. */
14743 if (arg_scroll_conservatively)
14744 amount_to_scroll
14745 = min (max (dy, FRAME_LINE_HEIGHT (f)),
14746 FRAME_LINE_HEIGHT (f) * arg_scroll_conservatively);
14747 else if (scroll_step || temp_scroll_step)
14748 amount_to_scroll = scroll_max;
14749 else
14750 {
14751 aggressive = BVAR (current_buffer, scroll_up_aggressively);
14752 height = WINDOW_BOX_TEXT_HEIGHT (w);
14753 if (NUMBERP (aggressive))
14754 {
14755 double float_amount = XFLOATINT (aggressive) * height;
14756 amount_to_scroll = float_amount;
14757 if (amount_to_scroll == 0 && float_amount > 0)
14758 amount_to_scroll = 1;
14759 /* Don't let point enter the scroll margin near top of
14760 the window. */
14761 if (amount_to_scroll > height - 2*this_scroll_margin + dy)
14762 amount_to_scroll = height - 2*this_scroll_margin + dy;
14763 }
14764 }
14765
14766 if (amount_to_scroll <= 0)
14767 return SCROLLING_FAILED;
14768
14769 start_display (&it, w, startp);
14770 if (arg_scroll_conservatively <= scroll_limit)
14771 move_it_vertically (&it, amount_to_scroll);
14772 else
14773 {
14774 /* Extra precision for users who set scroll-conservatively
14775 to a large number: make sure the amount we scroll
14776 the window start is never less than amount_to_scroll,
14777 which was computed as distance from window bottom to
14778 point. This matters when lines at window top and lines
14779 below window bottom have different height. */
14780 struct it it1;
14781 void *it1data = NULL;
14782 /* We use a temporary it1 because line_bottom_y can modify
14783 its argument, if it moves one line down; see there. */
14784 int start_y;
14785
14786 SAVE_IT (it1, it, it1data);
14787 start_y = line_bottom_y (&it1);
14788 do {
14789 RESTORE_IT (&it, &it, it1data);
14790 move_it_by_lines (&it, 1);
14791 SAVE_IT (it1, it, it1data);
14792 } while (line_bottom_y (&it1) - start_y < amount_to_scroll);
14793 }
14794
14795 /* If STARTP is unchanged, move it down another screen line. */
14796 if (CHARPOS (it.current.pos) == CHARPOS (startp))
14797 move_it_by_lines (&it, 1);
14798 startp = it.current.pos;
14799 }
14800 else
14801 {
14802 struct text_pos scroll_margin_pos = startp;
14803
14804 /* See if point is inside the scroll margin at the top of the
14805 window. */
14806 if (this_scroll_margin)
14807 {
14808 start_display (&it, w, startp);
14809 move_it_vertically (&it, this_scroll_margin);
14810 scroll_margin_pos = it.current.pos;
14811 }
14812
14813 if (PT < CHARPOS (scroll_margin_pos))
14814 {
14815 /* Point is in the scroll margin at the top of the window or
14816 above what is displayed in the window. */
14817 int y0, y_to_move;
14818
14819 /* Compute the vertical distance from PT to the scroll
14820 margin position. Move as far as scroll_max allows, or
14821 one screenful, or 10 screen lines, whichever is largest.
14822 Give up if distance is greater than scroll_max. */
14823 SET_TEXT_POS (pos, PT, PT_BYTE);
14824 start_display (&it, w, pos);
14825 y0 = it.current_y;
14826 y_to_move = max (it.last_visible_y,
14827 max (scroll_max, 10 * FRAME_LINE_HEIGHT (f)));
14828 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
14829 y_to_move, -1,
14830 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
14831 dy = it.current_y - y0;
14832 if (dy > scroll_max)
14833 return SCROLLING_FAILED;
14834
14835 /* Compute new window start. */
14836 start_display (&it, w, startp);
14837
14838 if (arg_scroll_conservatively)
14839 amount_to_scroll = max (dy, FRAME_LINE_HEIGHT (f) *
14840 max (scroll_step, temp_scroll_step));
14841 else if (scroll_step || temp_scroll_step)
14842 amount_to_scroll = scroll_max;
14843 else
14844 {
14845 aggressive = BVAR (current_buffer, scroll_down_aggressively);
14846 height = WINDOW_BOX_TEXT_HEIGHT (w);
14847 if (NUMBERP (aggressive))
14848 {
14849 double float_amount = XFLOATINT (aggressive) * height;
14850 amount_to_scroll = float_amount;
14851 if (amount_to_scroll == 0 && float_amount > 0)
14852 amount_to_scroll = 1;
14853 amount_to_scroll -=
14854 this_scroll_margin - dy - FRAME_LINE_HEIGHT (f);
14855 /* Don't let point enter the scroll margin near
14856 bottom of the window. */
14857 if (amount_to_scroll > height - 2*this_scroll_margin + dy)
14858 amount_to_scroll = height - 2*this_scroll_margin + dy;
14859 }
14860 }
14861
14862 if (amount_to_scroll <= 0)
14863 return SCROLLING_FAILED;
14864
14865 move_it_vertically_backward (&it, amount_to_scroll);
14866 startp = it.current.pos;
14867 }
14868 }
14869
14870 /* Run window scroll functions. */
14871 startp = run_window_scroll_functions (window, startp);
14872
14873 /* Display the window. Give up if new fonts are loaded, or if point
14874 doesn't appear. */
14875 if (!try_window (window, startp, 0))
14876 rc = SCROLLING_NEED_LARGER_MATRICES;
14877 else if (w->cursor.vpos < 0)
14878 {
14879 clear_glyph_matrix (w->desired_matrix);
14880 rc = SCROLLING_FAILED;
14881 }
14882 else
14883 {
14884 /* Maybe forget recorded base line for line number display. */
14885 if (!just_this_one_p
14886 || current_buffer->clip_changed
14887 || BEG_UNCHANGED < CHARPOS (startp))
14888 wset_base_line_number (w, Qnil);
14889
14890 /* If cursor ends up on a partially visible line,
14891 treat that as being off the bottom of the screen. */
14892 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1, 0)
14893 /* It's possible that the cursor is on the first line of the
14894 buffer, which is partially obscured due to a vscroll
14895 (Bug#7537). In that case, avoid looping forever . */
14896 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
14897 {
14898 clear_glyph_matrix (w->desired_matrix);
14899 ++extra_scroll_margin_lines;
14900 goto too_near_end;
14901 }
14902 rc = SCROLLING_SUCCESS;
14903 }
14904
14905 return rc;
14906 }
14907
14908
14909 /* Compute a suitable window start for window W if display of W starts
14910 on a continuation line. Value is non-zero if a new window start
14911 was computed.
14912
14913 The new window start will be computed, based on W's width, starting
14914 from the start of the continued line. It is the start of the
14915 screen line with the minimum distance from the old start W->start. */
14916
14917 static int
14918 compute_window_start_on_continuation_line (struct window *w)
14919 {
14920 struct text_pos pos, start_pos;
14921 int window_start_changed_p = 0;
14922
14923 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
14924
14925 /* If window start is on a continuation line... Window start may be
14926 < BEGV in case there's invisible text at the start of the
14927 buffer (M-x rmail, for example). */
14928 if (CHARPOS (start_pos) > BEGV
14929 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
14930 {
14931 struct it it;
14932 struct glyph_row *row;
14933
14934 /* Handle the case that the window start is out of range. */
14935 if (CHARPOS (start_pos) < BEGV)
14936 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
14937 else if (CHARPOS (start_pos) > ZV)
14938 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
14939
14940 /* Find the start of the continued line. This should be fast
14941 because scan_buffer is fast (newline cache). */
14942 row = w->desired_matrix->rows + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0);
14943 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
14944 row, DEFAULT_FACE_ID);
14945 reseat_at_previous_visible_line_start (&it);
14946
14947 /* If the line start is "too far" away from the window start,
14948 say it takes too much time to compute a new window start. */
14949 if (CHARPOS (start_pos) - IT_CHARPOS (it)
14950 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
14951 {
14952 int min_distance, distance;
14953
14954 /* Move forward by display lines to find the new window
14955 start. If window width was enlarged, the new start can
14956 be expected to be > the old start. If window width was
14957 decreased, the new window start will be < the old start.
14958 So, we're looking for the display line start with the
14959 minimum distance from the old window start. */
14960 pos = it.current.pos;
14961 min_distance = INFINITY;
14962 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
14963 distance < min_distance)
14964 {
14965 min_distance = distance;
14966 pos = it.current.pos;
14967 move_it_by_lines (&it, 1);
14968 }
14969
14970 /* Set the window start there. */
14971 SET_MARKER_FROM_TEXT_POS (w->start, pos);
14972 window_start_changed_p = 1;
14973 }
14974 }
14975
14976 return window_start_changed_p;
14977 }
14978
14979
14980 /* Try cursor movement in case text has not changed in window WINDOW,
14981 with window start STARTP. Value is
14982
14983 CURSOR_MOVEMENT_SUCCESS if successful
14984
14985 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14986
14987 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14988 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14989 we want to scroll as if scroll-step were set to 1. See the code.
14990
14991 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14992 which case we have to abort this redisplay, and adjust matrices
14993 first. */
14994
14995 enum
14996 {
14997 CURSOR_MOVEMENT_SUCCESS,
14998 CURSOR_MOVEMENT_CANNOT_BE_USED,
14999 CURSOR_MOVEMENT_MUST_SCROLL,
15000 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15001 };
15002
15003 static int
15004 try_cursor_movement (Lisp_Object window, struct text_pos startp, int *scroll_step)
15005 {
15006 struct window *w = XWINDOW (window);
15007 struct frame *f = XFRAME (w->frame);
15008 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15009
15010 #ifdef GLYPH_DEBUG
15011 if (inhibit_try_cursor_movement)
15012 return rc;
15013 #endif
15014
15015 /* Previously, there was a check for Lisp integer in the
15016 if-statement below. Now, this field is converted to
15017 ptrdiff_t, thus zero means invalid position in a buffer. */
15018 eassert (w->last_point > 0);
15019
15020 /* Handle case where text has not changed, only point, and it has
15021 not moved off the frame. */
15022 if (/* Point may be in this window. */
15023 PT >= CHARPOS (startp)
15024 /* Selective display hasn't changed. */
15025 && !current_buffer->clip_changed
15026 /* Function force-mode-line-update is used to force a thorough
15027 redisplay. It sets either windows_or_buffers_changed or
15028 update_mode_lines. So don't take a shortcut here for these
15029 cases. */
15030 && !update_mode_lines
15031 && !windows_or_buffers_changed
15032 && !cursor_type_changed
15033 /* Can't use this case if highlighting a region. When a
15034 region exists, cursor movement has to do more than just
15035 set the cursor. */
15036 && !(!NILP (Vtransient_mark_mode)
15037 && !NILP (BVAR (current_buffer, mark_active)))
15038 && NILP (w->region_showing)
15039 && NILP (Vshow_trailing_whitespace)
15040 /* This code is not used for mini-buffer for the sake of the case
15041 of redisplaying to replace an echo area message; since in
15042 that case the mini-buffer contents per se are usually
15043 unchanged. This code is of no real use in the mini-buffer
15044 since the handling of this_line_start_pos, etc., in redisplay
15045 handles the same cases. */
15046 && !EQ (window, minibuf_window)
15047 /* When splitting windows or for new windows, it happens that
15048 redisplay is called with a nil window_end_vpos or one being
15049 larger than the window. This should really be fixed in
15050 window.c. I don't have this on my list, now, so we do
15051 approximately the same as the old redisplay code. --gerd. */
15052 && INTEGERP (w->window_end_vpos)
15053 && XFASTINT (w->window_end_vpos) < w->current_matrix->nrows
15054 && (FRAME_WINDOW_P (f)
15055 || !overlay_arrow_in_current_buffer_p ()))
15056 {
15057 int this_scroll_margin, top_scroll_margin;
15058 struct glyph_row *row = NULL;
15059
15060 #ifdef GLYPH_DEBUG
15061 debug_method_add (w, "cursor movement");
15062 #endif
15063
15064 /* Scroll if point within this distance from the top or bottom
15065 of the window. This is a pixel value. */
15066 if (scroll_margin > 0)
15067 {
15068 this_scroll_margin = min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4);
15069 this_scroll_margin *= FRAME_LINE_HEIGHT (f);
15070 }
15071 else
15072 this_scroll_margin = 0;
15073
15074 top_scroll_margin = this_scroll_margin;
15075 if (WINDOW_WANTS_HEADER_LINE_P (w))
15076 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15077
15078 /* Start with the row the cursor was displayed during the last
15079 not paused redisplay. Give up if that row is not valid. */
15080 if (w->last_cursor.vpos < 0
15081 || w->last_cursor.vpos >= w->current_matrix->nrows)
15082 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15083 else
15084 {
15085 row = MATRIX_ROW (w->current_matrix, w->last_cursor.vpos);
15086 if (row->mode_line_p)
15087 ++row;
15088 if (!row->enabled_p)
15089 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15090 }
15091
15092 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15093 {
15094 int scroll_p = 0, must_scroll = 0;
15095 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15096
15097 if (PT > w->last_point)
15098 {
15099 /* Point has moved forward. */
15100 while (MATRIX_ROW_END_CHARPOS (row) < PT
15101 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15102 {
15103 eassert (row->enabled_p);
15104 ++row;
15105 }
15106
15107 /* If the end position of a row equals the start
15108 position of the next row, and PT is at that position,
15109 we would rather display cursor in the next line. */
15110 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15111 && MATRIX_ROW_END_CHARPOS (row) == PT
15112 && row < w->current_matrix->rows
15113 + w->current_matrix->nrows - 1
15114 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15115 && !cursor_row_p (row))
15116 ++row;
15117
15118 /* If within the scroll margin, scroll. Note that
15119 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15120 the next line would be drawn, and that
15121 this_scroll_margin can be zero. */
15122 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15123 || PT > MATRIX_ROW_END_CHARPOS (row)
15124 /* Line is completely visible last line in window
15125 and PT is to be set in the next line. */
15126 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15127 && PT == MATRIX_ROW_END_CHARPOS (row)
15128 && !row->ends_at_zv_p
15129 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15130 scroll_p = 1;
15131 }
15132 else if (PT < w->last_point)
15133 {
15134 /* Cursor has to be moved backward. Note that PT >=
15135 CHARPOS (startp) because of the outer if-statement. */
15136 while (!row->mode_line_p
15137 && (MATRIX_ROW_START_CHARPOS (row) > PT
15138 || (MATRIX_ROW_START_CHARPOS (row) == PT
15139 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15140 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15141 row > w->current_matrix->rows
15142 && (row-1)->ends_in_newline_from_string_p))))
15143 && (row->y > top_scroll_margin
15144 || CHARPOS (startp) == BEGV))
15145 {
15146 eassert (row->enabled_p);
15147 --row;
15148 }
15149
15150 /* Consider the following case: Window starts at BEGV,
15151 there is invisible, intangible text at BEGV, so that
15152 display starts at some point START > BEGV. It can
15153 happen that we are called with PT somewhere between
15154 BEGV and START. Try to handle that case. */
15155 if (row < w->current_matrix->rows
15156 || row->mode_line_p)
15157 {
15158 row = w->current_matrix->rows;
15159 if (row->mode_line_p)
15160 ++row;
15161 }
15162
15163 /* Due to newlines in overlay strings, we may have to
15164 skip forward over overlay strings. */
15165 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15166 && MATRIX_ROW_END_CHARPOS (row) == PT
15167 && !cursor_row_p (row))
15168 ++row;
15169
15170 /* If within the scroll margin, scroll. */
15171 if (row->y < top_scroll_margin
15172 && CHARPOS (startp) != BEGV)
15173 scroll_p = 1;
15174 }
15175 else
15176 {
15177 /* Cursor did not move. So don't scroll even if cursor line
15178 is partially visible, as it was so before. */
15179 rc = CURSOR_MOVEMENT_SUCCESS;
15180 }
15181
15182 if (PT < MATRIX_ROW_START_CHARPOS (row)
15183 || PT > MATRIX_ROW_END_CHARPOS (row))
15184 {
15185 /* if PT is not in the glyph row, give up. */
15186 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15187 must_scroll = 1;
15188 }
15189 else if (rc != CURSOR_MOVEMENT_SUCCESS
15190 && !NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering)))
15191 {
15192 struct glyph_row *row1;
15193
15194 /* If rows are bidi-reordered and point moved, back up
15195 until we find a row that does not belong to a
15196 continuation line. This is because we must consider
15197 all rows of a continued line as candidates for the
15198 new cursor positioning, since row start and end
15199 positions change non-linearly with vertical position
15200 in such rows. */
15201 /* FIXME: Revisit this when glyph ``spilling'' in
15202 continuation lines' rows is implemented for
15203 bidi-reordered rows. */
15204 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15205 MATRIX_ROW_CONTINUATION_LINE_P (row);
15206 --row)
15207 {
15208 /* If we hit the beginning of the displayed portion
15209 without finding the first row of a continued
15210 line, give up. */
15211 if (row <= row1)
15212 {
15213 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15214 break;
15215 }
15216 eassert (row->enabled_p);
15217 }
15218 }
15219 if (must_scroll)
15220 ;
15221 else if (rc != CURSOR_MOVEMENT_SUCCESS
15222 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15223 /* Make sure this isn't a header line by any chance, since
15224 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15225 && !row->mode_line_p
15226 && make_cursor_line_fully_visible_p)
15227 {
15228 if (PT == MATRIX_ROW_END_CHARPOS (row)
15229 && !row->ends_at_zv_p
15230 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15231 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15232 else if (row->height > window_box_height (w))
15233 {
15234 /* If we end up in a partially visible line, let's
15235 make it fully visible, except when it's taller
15236 than the window, in which case we can't do much
15237 about it. */
15238 *scroll_step = 1;
15239 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15240 }
15241 else
15242 {
15243 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15244 if (!cursor_row_fully_visible_p (w, 0, 1))
15245 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15246 else
15247 rc = CURSOR_MOVEMENT_SUCCESS;
15248 }
15249 }
15250 else if (scroll_p)
15251 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15252 else if (rc != CURSOR_MOVEMENT_SUCCESS
15253 && !NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering)))
15254 {
15255 /* With bidi-reordered rows, there could be more than
15256 one candidate row whose start and end positions
15257 occlude point. We need to let set_cursor_from_row
15258 find the best candidate. */
15259 /* FIXME: Revisit this when glyph ``spilling'' in
15260 continuation lines' rows is implemented for
15261 bidi-reordered rows. */
15262 int rv = 0;
15263
15264 do
15265 {
15266 int at_zv_p = 0, exact_match_p = 0;
15267
15268 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15269 && PT <= MATRIX_ROW_END_CHARPOS (row)
15270 && cursor_row_p (row))
15271 rv |= set_cursor_from_row (w, row, w->current_matrix,
15272 0, 0, 0, 0);
15273 /* As soon as we've found the exact match for point,
15274 or the first suitable row whose ends_at_zv_p flag
15275 is set, we are done. */
15276 at_zv_p =
15277 MATRIX_ROW (w->current_matrix, w->cursor.vpos)->ends_at_zv_p;
15278 if (rv && !at_zv_p
15279 && w->cursor.hpos >= 0
15280 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15281 w->cursor.vpos))
15282 {
15283 struct glyph_row *candidate =
15284 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15285 struct glyph *g =
15286 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15287 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15288
15289 exact_match_p =
15290 (BUFFERP (g->object) && g->charpos == PT)
15291 || (INTEGERP (g->object)
15292 && (g->charpos == PT
15293 || (g->charpos == 0 && endpos - 1 == PT)));
15294 }
15295 if (rv && (at_zv_p || exact_match_p))
15296 {
15297 rc = CURSOR_MOVEMENT_SUCCESS;
15298 break;
15299 }
15300 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15301 break;
15302 ++row;
15303 }
15304 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15305 || row->continued_p)
15306 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15307 || (MATRIX_ROW_START_CHARPOS (row) == PT
15308 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15309 /* If we didn't find any candidate rows, or exited the
15310 loop before all the candidates were examined, signal
15311 to the caller that this method failed. */
15312 if (rc != CURSOR_MOVEMENT_SUCCESS
15313 && !(rv
15314 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15315 && !row->continued_p))
15316 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15317 else if (rv)
15318 rc = CURSOR_MOVEMENT_SUCCESS;
15319 }
15320 else
15321 {
15322 do
15323 {
15324 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15325 {
15326 rc = CURSOR_MOVEMENT_SUCCESS;
15327 break;
15328 }
15329 ++row;
15330 }
15331 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15332 && MATRIX_ROW_START_CHARPOS (row) == PT
15333 && cursor_row_p (row));
15334 }
15335 }
15336 }
15337
15338 return rc;
15339 }
15340
15341 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15342 static
15343 #endif
15344 void
15345 set_vertical_scroll_bar (struct window *w)
15346 {
15347 ptrdiff_t start, end, whole;
15348
15349 /* Calculate the start and end positions for the current window.
15350 At some point, it would be nice to choose between scrollbars
15351 which reflect the whole buffer size, with special markers
15352 indicating narrowing, and scrollbars which reflect only the
15353 visible region.
15354
15355 Note that mini-buffers sometimes aren't displaying any text. */
15356 if (!MINI_WINDOW_P (w)
15357 || (w == XWINDOW (minibuf_window)
15358 && NILP (echo_area_buffer[0])))
15359 {
15360 struct buffer *buf = XBUFFER (w->buffer);
15361 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15362 start = marker_position (w->start) - BUF_BEGV (buf);
15363 /* I don't think this is guaranteed to be right. For the
15364 moment, we'll pretend it is. */
15365 end = BUF_Z (buf) - XFASTINT (w->window_end_pos) - BUF_BEGV (buf);
15366
15367 if (end < start)
15368 end = start;
15369 if (whole < (end - start))
15370 whole = end - start;
15371 }
15372 else
15373 start = end = whole = 0;
15374
15375 /* Indicate what this scroll bar ought to be displaying now. */
15376 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15377 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15378 (w, end - start, whole, start);
15379 }
15380
15381
15382 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15383 selected_window is redisplayed.
15384
15385 We can return without actually redisplaying the window if
15386 fonts_changed_p. In that case, redisplay_internal will
15387 retry. */
15388
15389 static void
15390 redisplay_window (Lisp_Object window, int just_this_one_p)
15391 {
15392 struct window *w = XWINDOW (window);
15393 struct frame *f = XFRAME (w->frame);
15394 struct buffer *buffer = XBUFFER (w->buffer);
15395 struct buffer *old = current_buffer;
15396 struct text_pos lpoint, opoint, startp;
15397 int update_mode_line;
15398 int tem;
15399 struct it it;
15400 /* Record it now because it's overwritten. */
15401 int current_matrix_up_to_date_p = 0;
15402 int used_current_matrix_p = 0;
15403 /* This is less strict than current_matrix_up_to_date_p.
15404 It indicates that the buffer contents and narrowing are unchanged. */
15405 int buffer_unchanged_p = 0;
15406 int temp_scroll_step = 0;
15407 ptrdiff_t count = SPECPDL_INDEX ();
15408 int rc;
15409 int centering_position = -1;
15410 int last_line_misfit = 0;
15411 ptrdiff_t beg_unchanged, end_unchanged;
15412
15413 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15414 opoint = lpoint;
15415
15416 /* W must be a leaf window here. */
15417 eassert (!NILP (w->buffer));
15418 #ifdef GLYPH_DEBUG
15419 *w->desired_matrix->method = 0;
15420 #endif
15421
15422 restart:
15423 reconsider_clip_changes (w, buffer);
15424
15425 /* Has the mode line to be updated? */
15426 update_mode_line = (w->update_mode_line
15427 || update_mode_lines
15428 || buffer->clip_changed
15429 || buffer->prevent_redisplay_optimizations_p);
15430
15431 if (MINI_WINDOW_P (w))
15432 {
15433 if (w == XWINDOW (echo_area_window)
15434 && !NILP (echo_area_buffer[0]))
15435 {
15436 if (update_mode_line)
15437 /* We may have to update a tty frame's menu bar or a
15438 tool-bar. Example `M-x C-h C-h C-g'. */
15439 goto finish_menu_bars;
15440 else
15441 /* We've already displayed the echo area glyphs in this window. */
15442 goto finish_scroll_bars;
15443 }
15444 else if ((w != XWINDOW (minibuf_window)
15445 || minibuf_level == 0)
15446 /* When buffer is nonempty, redisplay window normally. */
15447 && BUF_Z (XBUFFER (w->buffer)) == BUF_BEG (XBUFFER (w->buffer))
15448 /* Quail displays non-mini buffers in minibuffer window.
15449 In that case, redisplay the window normally. */
15450 && !NILP (Fmemq (w->buffer, Vminibuffer_list)))
15451 {
15452 /* W is a mini-buffer window, but it's not active, so clear
15453 it. */
15454 int yb = window_text_bottom_y (w);
15455 struct glyph_row *row;
15456 int y;
15457
15458 for (y = 0, row = w->desired_matrix->rows;
15459 y < yb;
15460 y += row->height, ++row)
15461 blank_row (w, row, y);
15462 goto finish_scroll_bars;
15463 }
15464
15465 clear_glyph_matrix (w->desired_matrix);
15466 }
15467
15468 /* Otherwise set up data on this window; select its buffer and point
15469 value. */
15470 /* Really select the buffer, for the sake of buffer-local
15471 variables. */
15472 set_buffer_internal_1 (XBUFFER (w->buffer));
15473
15474 current_matrix_up_to_date_p
15475 = (!NILP (w->window_end_valid)
15476 && !current_buffer->clip_changed
15477 && !current_buffer->prevent_redisplay_optimizations_p
15478 && w->last_modified >= MODIFF
15479 && w->last_overlay_modified >= OVERLAY_MODIFF);
15480
15481 /* Run the window-bottom-change-functions
15482 if it is possible that the text on the screen has changed
15483 (either due to modification of the text, or any other reason). */
15484 if (!current_matrix_up_to_date_p
15485 && !NILP (Vwindow_text_change_functions))
15486 {
15487 safe_run_hooks (Qwindow_text_change_functions);
15488 goto restart;
15489 }
15490
15491 beg_unchanged = BEG_UNCHANGED;
15492 end_unchanged = END_UNCHANGED;
15493
15494 SET_TEXT_POS (opoint, PT, PT_BYTE);
15495
15496 specbind (Qinhibit_point_motion_hooks, Qt);
15497
15498 buffer_unchanged_p
15499 = (!NILP (w->window_end_valid)
15500 && !current_buffer->clip_changed
15501 && w->last_modified >= MODIFF
15502 && w->last_overlay_modified >= OVERLAY_MODIFF);
15503
15504 /* When windows_or_buffers_changed is non-zero, we can't rely on
15505 the window end being valid, so set it to nil there. */
15506 if (windows_or_buffers_changed)
15507 {
15508 /* If window starts on a continuation line, maybe adjust the
15509 window start in case the window's width changed. */
15510 if (XMARKER (w->start)->buffer == current_buffer)
15511 compute_window_start_on_continuation_line (w);
15512
15513 wset_window_end_valid (w, Qnil);
15514 }
15515
15516 /* Some sanity checks. */
15517 CHECK_WINDOW_END (w);
15518 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
15519 emacs_abort ();
15520 if (BYTEPOS (opoint) < CHARPOS (opoint))
15521 emacs_abort ();
15522
15523 /* If %c is in mode line, update it if needed. */
15524 if (!NILP (w->column_number_displayed)
15525 /* This alternative quickly identifies a common case
15526 where no change is needed. */
15527 && !(PT == w->last_point
15528 && w->last_modified >= MODIFF
15529 && w->last_overlay_modified >= OVERLAY_MODIFF)
15530 && (XFASTINT (w->column_number_displayed) != current_column ()))
15531 update_mode_line = 1;
15532
15533 /* Count number of windows showing the selected buffer. An indirect
15534 buffer counts as its base buffer. */
15535 if (!just_this_one_p)
15536 {
15537 struct buffer *current_base, *window_base;
15538 current_base = current_buffer;
15539 window_base = XBUFFER (XWINDOW (selected_window)->buffer);
15540 if (current_base->base_buffer)
15541 current_base = current_base->base_buffer;
15542 if (window_base->base_buffer)
15543 window_base = window_base->base_buffer;
15544 if (current_base == window_base)
15545 buffer_shared++;
15546 }
15547
15548 /* Point refers normally to the selected window. For any other
15549 window, set up appropriate value. */
15550 if (!EQ (window, selected_window))
15551 {
15552 ptrdiff_t new_pt = XMARKER (w->pointm)->charpos;
15553 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
15554 if (new_pt < BEGV)
15555 {
15556 new_pt = BEGV;
15557 new_pt_byte = BEGV_BYTE;
15558 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
15559 }
15560 else if (new_pt > (ZV - 1))
15561 {
15562 new_pt = ZV;
15563 new_pt_byte = ZV_BYTE;
15564 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
15565 }
15566
15567 /* We don't use SET_PT so that the point-motion hooks don't run. */
15568 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
15569 }
15570
15571 /* If any of the character widths specified in the display table
15572 have changed, invalidate the width run cache. It's true that
15573 this may be a bit late to catch such changes, but the rest of
15574 redisplay goes (non-fatally) haywire when the display table is
15575 changed, so why should we worry about doing any better? */
15576 if (current_buffer->width_run_cache)
15577 {
15578 struct Lisp_Char_Table *disptab = buffer_display_table ();
15579
15580 if (! disptab_matches_widthtab
15581 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
15582 {
15583 invalidate_region_cache (current_buffer,
15584 current_buffer->width_run_cache,
15585 BEG, Z);
15586 recompute_width_table (current_buffer, disptab);
15587 }
15588 }
15589
15590 /* If window-start is screwed up, choose a new one. */
15591 if (XMARKER (w->start)->buffer != current_buffer)
15592 goto recenter;
15593
15594 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15595
15596 /* If someone specified a new starting point but did not insist,
15597 check whether it can be used. */
15598 if (w->optional_new_start
15599 && CHARPOS (startp) >= BEGV
15600 && CHARPOS (startp) <= ZV)
15601 {
15602 w->optional_new_start = 0;
15603 start_display (&it, w, startp);
15604 move_it_to (&it, PT, 0, it.last_visible_y, -1,
15605 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15606 if (IT_CHARPOS (it) == PT)
15607 w->force_start = 1;
15608 /* IT may overshoot PT if text at PT is invisible. */
15609 else if (IT_CHARPOS (it) > PT && CHARPOS (startp) <= PT)
15610 w->force_start = 1;
15611 }
15612
15613 force_start:
15614
15615 /* Handle case where place to start displaying has been specified,
15616 unless the specified location is outside the accessible range. */
15617 if (w->force_start || w->frozen_window_start_p)
15618 {
15619 /* We set this later on if we have to adjust point. */
15620 int new_vpos = -1;
15621
15622 w->force_start = 0;
15623 w->vscroll = 0;
15624 wset_window_end_valid (w, Qnil);
15625
15626 /* Forget any recorded base line for line number display. */
15627 if (!buffer_unchanged_p)
15628 wset_base_line_number (w, Qnil);
15629
15630 /* Redisplay the mode line. Select the buffer properly for that.
15631 Also, run the hook window-scroll-functions
15632 because we have scrolled. */
15633 /* Note, we do this after clearing force_start because
15634 if there's an error, it is better to forget about force_start
15635 than to get into an infinite loop calling the hook functions
15636 and having them get more errors. */
15637 if (!update_mode_line
15638 || ! NILP (Vwindow_scroll_functions))
15639 {
15640 update_mode_line = 1;
15641 w->update_mode_line = 1;
15642 startp = run_window_scroll_functions (window, startp);
15643 }
15644
15645 w->last_modified = 0;
15646 w->last_overlay_modified = 0;
15647 if (CHARPOS (startp) < BEGV)
15648 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
15649 else if (CHARPOS (startp) > ZV)
15650 SET_TEXT_POS (startp, ZV, ZV_BYTE);
15651
15652 /* Redisplay, then check if cursor has been set during the
15653 redisplay. Give up if new fonts were loaded. */
15654 /* We used to issue a CHECK_MARGINS argument to try_window here,
15655 but this causes scrolling to fail when point begins inside
15656 the scroll margin (bug#148) -- cyd */
15657 if (!try_window (window, startp, 0))
15658 {
15659 w->force_start = 1;
15660 clear_glyph_matrix (w->desired_matrix);
15661 goto need_larger_matrices;
15662 }
15663
15664 if (w->cursor.vpos < 0 && !w->frozen_window_start_p)
15665 {
15666 /* If point does not appear, try to move point so it does
15667 appear. The desired matrix has been built above, so we
15668 can use it here. */
15669 new_vpos = window_box_height (w) / 2;
15670 }
15671
15672 if (!cursor_row_fully_visible_p (w, 0, 0))
15673 {
15674 /* Point does appear, but on a line partly visible at end of window.
15675 Move it back to a fully-visible line. */
15676 new_vpos = window_box_height (w);
15677 }
15678
15679 /* If we need to move point for either of the above reasons,
15680 now actually do it. */
15681 if (new_vpos >= 0)
15682 {
15683 struct glyph_row *row;
15684
15685 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
15686 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
15687 ++row;
15688
15689 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
15690 MATRIX_ROW_START_BYTEPOS (row));
15691
15692 if (w != XWINDOW (selected_window))
15693 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
15694 else if (current_buffer == old)
15695 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15696
15697 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
15698
15699 /* If we are highlighting the region, then we just changed
15700 the region, so redisplay to show it. */
15701 if (!NILP (Vtransient_mark_mode)
15702 && !NILP (BVAR (current_buffer, mark_active)))
15703 {
15704 clear_glyph_matrix (w->desired_matrix);
15705 if (!try_window (window, startp, 0))
15706 goto need_larger_matrices;
15707 }
15708 }
15709
15710 #ifdef GLYPH_DEBUG
15711 debug_method_add (w, "forced window start");
15712 #endif
15713 goto done;
15714 }
15715
15716 /* Handle case where text has not changed, only point, and it has
15717 not moved off the frame, and we are not retrying after hscroll.
15718 (current_matrix_up_to_date_p is nonzero when retrying.) */
15719 if (current_matrix_up_to_date_p
15720 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
15721 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
15722 {
15723 switch (rc)
15724 {
15725 case CURSOR_MOVEMENT_SUCCESS:
15726 used_current_matrix_p = 1;
15727 goto done;
15728
15729 case CURSOR_MOVEMENT_MUST_SCROLL:
15730 goto try_to_scroll;
15731
15732 default:
15733 emacs_abort ();
15734 }
15735 }
15736 /* If current starting point was originally the beginning of a line
15737 but no longer is, find a new starting point. */
15738 else if (w->start_at_line_beg
15739 && !(CHARPOS (startp) <= BEGV
15740 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
15741 {
15742 #ifdef GLYPH_DEBUG
15743 debug_method_add (w, "recenter 1");
15744 #endif
15745 goto recenter;
15746 }
15747
15748 /* Try scrolling with try_window_id. Value is > 0 if update has
15749 been done, it is -1 if we know that the same window start will
15750 not work. It is 0 if unsuccessful for some other reason. */
15751 else if ((tem = try_window_id (w)) != 0)
15752 {
15753 #ifdef GLYPH_DEBUG
15754 debug_method_add (w, "try_window_id %d", tem);
15755 #endif
15756
15757 if (fonts_changed_p)
15758 goto need_larger_matrices;
15759 if (tem > 0)
15760 goto done;
15761
15762 /* Otherwise try_window_id has returned -1 which means that we
15763 don't want the alternative below this comment to execute. */
15764 }
15765 else if (CHARPOS (startp) >= BEGV
15766 && CHARPOS (startp) <= ZV
15767 && PT >= CHARPOS (startp)
15768 && (CHARPOS (startp) < ZV
15769 /* Avoid starting at end of buffer. */
15770 || CHARPOS (startp) == BEGV
15771 || (w->last_modified >= MODIFF
15772 && w->last_overlay_modified >= OVERLAY_MODIFF)))
15773 {
15774 int d1, d2, d3, d4, d5, d6;
15775
15776 /* If first window line is a continuation line, and window start
15777 is inside the modified region, but the first change is before
15778 current window start, we must select a new window start.
15779
15780 However, if this is the result of a down-mouse event (e.g. by
15781 extending the mouse-drag-overlay), we don't want to select a
15782 new window start, since that would change the position under
15783 the mouse, resulting in an unwanted mouse-movement rather
15784 than a simple mouse-click. */
15785 if (!w->start_at_line_beg
15786 && NILP (do_mouse_tracking)
15787 && CHARPOS (startp) > BEGV
15788 && CHARPOS (startp) > BEG + beg_unchanged
15789 && CHARPOS (startp) <= Z - end_unchanged
15790 /* Even if w->start_at_line_beg is nil, a new window may
15791 start at a line_beg, since that's how set_buffer_window
15792 sets it. So, we need to check the return value of
15793 compute_window_start_on_continuation_line. (See also
15794 bug#197). */
15795 && XMARKER (w->start)->buffer == current_buffer
15796 && compute_window_start_on_continuation_line (w)
15797 /* It doesn't make sense to force the window start like we
15798 do at label force_start if it is already known that point
15799 will not be visible in the resulting window, because
15800 doing so will move point from its correct position
15801 instead of scrolling the window to bring point into view.
15802 See bug#9324. */
15803 && pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &d6))
15804 {
15805 w->force_start = 1;
15806 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15807 goto force_start;
15808 }
15809
15810 #ifdef GLYPH_DEBUG
15811 debug_method_add (w, "same window start");
15812 #endif
15813
15814 /* Try to redisplay starting at same place as before.
15815 If point has not moved off frame, accept the results. */
15816 if (!current_matrix_up_to_date_p
15817 /* Don't use try_window_reusing_current_matrix in this case
15818 because a window scroll function can have changed the
15819 buffer. */
15820 || !NILP (Vwindow_scroll_functions)
15821 || MINI_WINDOW_P (w)
15822 || !(used_current_matrix_p
15823 = try_window_reusing_current_matrix (w)))
15824 {
15825 IF_DEBUG (debug_method_add (w, "1"));
15826 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
15827 /* -1 means we need to scroll.
15828 0 means we need new matrices, but fonts_changed_p
15829 is set in that case, so we will detect it below. */
15830 goto try_to_scroll;
15831 }
15832
15833 if (fonts_changed_p)
15834 goto need_larger_matrices;
15835
15836 if (w->cursor.vpos >= 0)
15837 {
15838 if (!just_this_one_p
15839 || current_buffer->clip_changed
15840 || BEG_UNCHANGED < CHARPOS (startp))
15841 /* Forget any recorded base line for line number display. */
15842 wset_base_line_number (w, Qnil);
15843
15844 if (!cursor_row_fully_visible_p (w, 1, 0))
15845 {
15846 clear_glyph_matrix (w->desired_matrix);
15847 last_line_misfit = 1;
15848 }
15849 /* Drop through and scroll. */
15850 else
15851 goto done;
15852 }
15853 else
15854 clear_glyph_matrix (w->desired_matrix);
15855 }
15856
15857 try_to_scroll:
15858
15859 w->last_modified = 0;
15860 w->last_overlay_modified = 0;
15861
15862 /* Redisplay the mode line. Select the buffer properly for that. */
15863 if (!update_mode_line)
15864 {
15865 update_mode_line = 1;
15866 w->update_mode_line = 1;
15867 }
15868
15869 /* Try to scroll by specified few lines. */
15870 if ((scroll_conservatively
15871 || emacs_scroll_step
15872 || temp_scroll_step
15873 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
15874 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
15875 && CHARPOS (startp) >= BEGV
15876 && CHARPOS (startp) <= ZV)
15877 {
15878 /* The function returns -1 if new fonts were loaded, 1 if
15879 successful, 0 if not successful. */
15880 int ss = try_scrolling (window, just_this_one_p,
15881 scroll_conservatively,
15882 emacs_scroll_step,
15883 temp_scroll_step, last_line_misfit);
15884 switch (ss)
15885 {
15886 case SCROLLING_SUCCESS:
15887 goto done;
15888
15889 case SCROLLING_NEED_LARGER_MATRICES:
15890 goto need_larger_matrices;
15891
15892 case SCROLLING_FAILED:
15893 break;
15894
15895 default:
15896 emacs_abort ();
15897 }
15898 }
15899
15900 /* Finally, just choose a place to start which positions point
15901 according to user preferences. */
15902
15903 recenter:
15904
15905 #ifdef GLYPH_DEBUG
15906 debug_method_add (w, "recenter");
15907 #endif
15908
15909 /* w->vscroll = 0; */
15910
15911 /* Forget any previously recorded base line for line number display. */
15912 if (!buffer_unchanged_p)
15913 wset_base_line_number (w, Qnil);
15914
15915 /* Determine the window start relative to point. */
15916 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
15917 it.current_y = it.last_visible_y;
15918 if (centering_position < 0)
15919 {
15920 int margin =
15921 scroll_margin > 0
15922 ? min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4)
15923 : 0;
15924 ptrdiff_t margin_pos = CHARPOS (startp);
15925 Lisp_Object aggressive;
15926 int scrolling_up;
15927
15928 /* If there is a scroll margin at the top of the window, find
15929 its character position. */
15930 if (margin
15931 /* Cannot call start_display if startp is not in the
15932 accessible region of the buffer. This can happen when we
15933 have just switched to a different buffer and/or changed
15934 its restriction. In that case, startp is initialized to
15935 the character position 1 (BEGV) because we did not yet
15936 have chance to display the buffer even once. */
15937 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
15938 {
15939 struct it it1;
15940 void *it1data = NULL;
15941
15942 SAVE_IT (it1, it, it1data);
15943 start_display (&it1, w, startp);
15944 move_it_vertically (&it1, margin * FRAME_LINE_HEIGHT (f));
15945 margin_pos = IT_CHARPOS (it1);
15946 RESTORE_IT (&it, &it, it1data);
15947 }
15948 scrolling_up = PT > margin_pos;
15949 aggressive =
15950 scrolling_up
15951 ? BVAR (current_buffer, scroll_up_aggressively)
15952 : BVAR (current_buffer, scroll_down_aggressively);
15953
15954 if (!MINI_WINDOW_P (w)
15955 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
15956 {
15957 int pt_offset = 0;
15958
15959 /* Setting scroll-conservatively overrides
15960 scroll-*-aggressively. */
15961 if (!scroll_conservatively && NUMBERP (aggressive))
15962 {
15963 double float_amount = XFLOATINT (aggressive);
15964
15965 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
15966 if (pt_offset == 0 && float_amount > 0)
15967 pt_offset = 1;
15968 if (pt_offset && margin > 0)
15969 margin -= 1;
15970 }
15971 /* Compute how much to move the window start backward from
15972 point so that point will be displayed where the user
15973 wants it. */
15974 if (scrolling_up)
15975 {
15976 centering_position = it.last_visible_y;
15977 if (pt_offset)
15978 centering_position -= pt_offset;
15979 centering_position -=
15980 FRAME_LINE_HEIGHT (f) * (1 + margin + (last_line_misfit != 0))
15981 + WINDOW_HEADER_LINE_HEIGHT (w);
15982 /* Don't let point enter the scroll margin near top of
15983 the window. */
15984 if (centering_position < margin * FRAME_LINE_HEIGHT (f))
15985 centering_position = margin * FRAME_LINE_HEIGHT (f);
15986 }
15987 else
15988 centering_position = margin * FRAME_LINE_HEIGHT (f) + pt_offset;
15989 }
15990 else
15991 /* Set the window start half the height of the window backward
15992 from point. */
15993 centering_position = window_box_height (w) / 2;
15994 }
15995 move_it_vertically_backward (&it, centering_position);
15996
15997 eassert (IT_CHARPOS (it) >= BEGV);
15998
15999 /* The function move_it_vertically_backward may move over more
16000 than the specified y-distance. If it->w is small, e.g. a
16001 mini-buffer window, we may end up in front of the window's
16002 display area. Start displaying at the start of the line
16003 containing PT in this case. */
16004 if (it.current_y <= 0)
16005 {
16006 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16007 move_it_vertically_backward (&it, 0);
16008 it.current_y = 0;
16009 }
16010
16011 it.current_x = it.hpos = 0;
16012
16013 /* Set the window start position here explicitly, to avoid an
16014 infinite loop in case the functions in window-scroll-functions
16015 get errors. */
16016 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16017
16018 /* Run scroll hooks. */
16019 startp = run_window_scroll_functions (window, it.current.pos);
16020
16021 /* Redisplay the window. */
16022 if (!current_matrix_up_to_date_p
16023 || windows_or_buffers_changed
16024 || cursor_type_changed
16025 /* Don't use try_window_reusing_current_matrix in this case
16026 because it can have changed the buffer. */
16027 || !NILP (Vwindow_scroll_functions)
16028 || !just_this_one_p
16029 || MINI_WINDOW_P (w)
16030 || !(used_current_matrix_p
16031 = try_window_reusing_current_matrix (w)))
16032 try_window (window, startp, 0);
16033
16034 /* If new fonts have been loaded (due to fontsets), give up. We
16035 have to start a new redisplay since we need to re-adjust glyph
16036 matrices. */
16037 if (fonts_changed_p)
16038 goto need_larger_matrices;
16039
16040 /* If cursor did not appear assume that the middle of the window is
16041 in the first line of the window. Do it again with the next line.
16042 (Imagine a window of height 100, displaying two lines of height
16043 60. Moving back 50 from it->last_visible_y will end in the first
16044 line.) */
16045 if (w->cursor.vpos < 0)
16046 {
16047 if (!NILP (w->window_end_valid)
16048 && PT >= Z - XFASTINT (w->window_end_pos))
16049 {
16050 clear_glyph_matrix (w->desired_matrix);
16051 move_it_by_lines (&it, 1);
16052 try_window (window, it.current.pos, 0);
16053 }
16054 else if (PT < IT_CHARPOS (it))
16055 {
16056 clear_glyph_matrix (w->desired_matrix);
16057 move_it_by_lines (&it, -1);
16058 try_window (window, it.current.pos, 0);
16059 }
16060 else
16061 {
16062 /* Not much we can do about it. */
16063 }
16064 }
16065
16066 /* Consider the following case: Window starts at BEGV, there is
16067 invisible, intangible text at BEGV, so that display starts at
16068 some point START > BEGV. It can happen that we are called with
16069 PT somewhere between BEGV and START. Try to handle that case. */
16070 if (w->cursor.vpos < 0)
16071 {
16072 struct glyph_row *row = w->current_matrix->rows;
16073 if (row->mode_line_p)
16074 ++row;
16075 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16076 }
16077
16078 if (!cursor_row_fully_visible_p (w, 0, 0))
16079 {
16080 /* If vscroll is enabled, disable it and try again. */
16081 if (w->vscroll)
16082 {
16083 w->vscroll = 0;
16084 clear_glyph_matrix (w->desired_matrix);
16085 goto recenter;
16086 }
16087
16088 /* Users who set scroll-conservatively to a large number want
16089 point just above/below the scroll margin. If we ended up
16090 with point's row partially visible, move the window start to
16091 make that row fully visible and out of the margin. */
16092 if (scroll_conservatively > SCROLL_LIMIT)
16093 {
16094 int margin =
16095 scroll_margin > 0
16096 ? min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4)
16097 : 0;
16098 int move_down = w->cursor.vpos >= WINDOW_TOTAL_LINES (w) / 2;
16099
16100 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16101 clear_glyph_matrix (w->desired_matrix);
16102 if (1 == try_window (window, it.current.pos,
16103 TRY_WINDOW_CHECK_MARGINS))
16104 goto done;
16105 }
16106
16107 /* If centering point failed to make the whole line visible,
16108 put point at the top instead. That has to make the whole line
16109 visible, if it can be done. */
16110 if (centering_position == 0)
16111 goto done;
16112
16113 clear_glyph_matrix (w->desired_matrix);
16114 centering_position = 0;
16115 goto recenter;
16116 }
16117
16118 done:
16119
16120 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16121 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16122 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16123
16124 /* Display the mode line, if we must. */
16125 if ((update_mode_line
16126 /* If window not full width, must redo its mode line
16127 if (a) the window to its side is being redone and
16128 (b) we do a frame-based redisplay. This is a consequence
16129 of how inverted lines are drawn in frame-based redisplay. */
16130 || (!just_this_one_p
16131 && !FRAME_WINDOW_P (f)
16132 && !WINDOW_FULL_WIDTH_P (w))
16133 /* Line number to display. */
16134 || INTEGERP (w->base_line_pos)
16135 /* Column number is displayed and different from the one displayed. */
16136 || (!NILP (w->column_number_displayed)
16137 && (XFASTINT (w->column_number_displayed) != current_column ())))
16138 /* This means that the window has a mode line. */
16139 && (WINDOW_WANTS_MODELINE_P (w)
16140 || WINDOW_WANTS_HEADER_LINE_P (w)))
16141 {
16142 display_mode_lines (w);
16143
16144 /* If mode line height has changed, arrange for a thorough
16145 immediate redisplay using the correct mode line height. */
16146 if (WINDOW_WANTS_MODELINE_P (w)
16147 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16148 {
16149 fonts_changed_p = 1;
16150 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16151 = DESIRED_MODE_LINE_HEIGHT (w);
16152 }
16153
16154 /* If header line height has changed, arrange for a thorough
16155 immediate redisplay using the correct header line height. */
16156 if (WINDOW_WANTS_HEADER_LINE_P (w)
16157 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16158 {
16159 fonts_changed_p = 1;
16160 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16161 = DESIRED_HEADER_LINE_HEIGHT (w);
16162 }
16163
16164 if (fonts_changed_p)
16165 goto need_larger_matrices;
16166 }
16167
16168 if (!line_number_displayed
16169 && !BUFFERP (w->base_line_pos))
16170 {
16171 wset_base_line_pos (w, Qnil);
16172 wset_base_line_number (w, Qnil);
16173 }
16174
16175 finish_menu_bars:
16176
16177 /* When we reach a frame's selected window, redo the frame's menu bar. */
16178 if (update_mode_line
16179 && EQ (FRAME_SELECTED_WINDOW (f), window))
16180 {
16181 int redisplay_menu_p = 0;
16182
16183 if (FRAME_WINDOW_P (f))
16184 {
16185 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16186 || defined (HAVE_NS) || defined (USE_GTK)
16187 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16188 #else
16189 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16190 #endif
16191 }
16192 else
16193 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16194
16195 if (redisplay_menu_p)
16196 display_menu_bar (w);
16197
16198 #ifdef HAVE_WINDOW_SYSTEM
16199 if (FRAME_WINDOW_P (f))
16200 {
16201 #if defined (USE_GTK) || defined (HAVE_NS)
16202 if (FRAME_EXTERNAL_TOOL_BAR (f))
16203 redisplay_tool_bar (f);
16204 #else
16205 if (WINDOWP (f->tool_bar_window)
16206 && (FRAME_TOOL_BAR_LINES (f) > 0
16207 || !NILP (Vauto_resize_tool_bars))
16208 && redisplay_tool_bar (f))
16209 ignore_mouse_drag_p = 1;
16210 #endif
16211 }
16212 #endif
16213 }
16214
16215 #ifdef HAVE_WINDOW_SYSTEM
16216 if (FRAME_WINDOW_P (f)
16217 && update_window_fringes (w, (just_this_one_p
16218 || (!used_current_matrix_p && !overlay_arrow_seen)
16219 || w->pseudo_window_p)))
16220 {
16221 update_begin (f);
16222 BLOCK_INPUT;
16223 if (draw_window_fringes (w, 1))
16224 x_draw_vertical_border (w);
16225 UNBLOCK_INPUT;
16226 update_end (f);
16227 }
16228 #endif /* HAVE_WINDOW_SYSTEM */
16229
16230 /* We go to this label, with fonts_changed_p set,
16231 if it is necessary to try again using larger glyph matrices.
16232 We have to redeem the scroll bar even in this case,
16233 because the loop in redisplay_internal expects that. */
16234 need_larger_matrices:
16235 ;
16236 finish_scroll_bars:
16237
16238 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16239 {
16240 /* Set the thumb's position and size. */
16241 set_vertical_scroll_bar (w);
16242
16243 /* Note that we actually used the scroll bar attached to this
16244 window, so it shouldn't be deleted at the end of redisplay. */
16245 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16246 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16247 }
16248
16249 /* Restore current_buffer and value of point in it. The window
16250 update may have changed the buffer, so first make sure `opoint'
16251 is still valid (Bug#6177). */
16252 if (CHARPOS (opoint) < BEGV)
16253 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16254 else if (CHARPOS (opoint) > ZV)
16255 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16256 else
16257 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16258
16259 set_buffer_internal_1 (old);
16260 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16261 shorter. This can be caused by log truncation in *Messages*. */
16262 if (CHARPOS (lpoint) <= ZV)
16263 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16264
16265 unbind_to (count, Qnil);
16266 }
16267
16268
16269 /* Build the complete desired matrix of WINDOW with a window start
16270 buffer position POS.
16271
16272 Value is 1 if successful. It is zero if fonts were loaded during
16273 redisplay which makes re-adjusting glyph matrices necessary, and -1
16274 if point would appear in the scroll margins.
16275 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16276 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16277 set in FLAGS.) */
16278
16279 int
16280 try_window (Lisp_Object window, struct text_pos pos, int flags)
16281 {
16282 struct window *w = XWINDOW (window);
16283 struct it it;
16284 struct glyph_row *last_text_row = NULL;
16285 struct frame *f = XFRAME (w->frame);
16286
16287 /* Make POS the new window start. */
16288 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16289
16290 /* Mark cursor position as unknown. No overlay arrow seen. */
16291 w->cursor.vpos = -1;
16292 overlay_arrow_seen = 0;
16293
16294 /* Initialize iterator and info to start at POS. */
16295 start_display (&it, w, pos);
16296
16297 /* Display all lines of W. */
16298 while (it.current_y < it.last_visible_y)
16299 {
16300 if (display_line (&it))
16301 last_text_row = it.glyph_row - 1;
16302 if (fonts_changed_p && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16303 return 0;
16304 }
16305
16306 /* Don't let the cursor end in the scroll margins. */
16307 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16308 && !MINI_WINDOW_P (w))
16309 {
16310 int this_scroll_margin;
16311
16312 if (scroll_margin > 0)
16313 {
16314 this_scroll_margin = min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4);
16315 this_scroll_margin *= FRAME_LINE_HEIGHT (f);
16316 }
16317 else
16318 this_scroll_margin = 0;
16319
16320 if ((w->cursor.y >= 0 /* not vscrolled */
16321 && w->cursor.y < this_scroll_margin
16322 && CHARPOS (pos) > BEGV
16323 && IT_CHARPOS (it) < ZV)
16324 /* rms: considering make_cursor_line_fully_visible_p here
16325 seems to give wrong results. We don't want to recenter
16326 when the last line is partly visible, we want to allow
16327 that case to be handled in the usual way. */
16328 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
16329 {
16330 w->cursor.vpos = -1;
16331 clear_glyph_matrix (w->desired_matrix);
16332 return -1;
16333 }
16334 }
16335
16336 /* If bottom moved off end of frame, change mode line percentage. */
16337 if (XFASTINT (w->window_end_pos) <= 0
16338 && Z != IT_CHARPOS (it))
16339 w->update_mode_line = 1;
16340
16341 /* Set window_end_pos to the offset of the last character displayed
16342 on the window from the end of current_buffer. Set
16343 window_end_vpos to its row number. */
16344 if (last_text_row)
16345 {
16346 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
16347 w->window_end_bytepos
16348 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_text_row);
16349 wset_window_end_pos
16350 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (last_text_row)));
16351 wset_window_end_vpos
16352 (w, make_number (MATRIX_ROW_VPOS (last_text_row, w->desired_matrix)));
16353 eassert
16354 (MATRIX_ROW (w->desired_matrix,
16355 XFASTINT (w->window_end_vpos))->displays_text_p);
16356 }
16357 else
16358 {
16359 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
16360 wset_window_end_pos (w, make_number (Z - ZV));
16361 wset_window_end_vpos (w, make_number (0));
16362 }
16363
16364 /* But that is not valid info until redisplay finishes. */
16365 wset_window_end_valid (w, Qnil);
16366 return 1;
16367 }
16368
16369
16370 \f
16371 /************************************************************************
16372 Window redisplay reusing current matrix when buffer has not changed
16373 ************************************************************************/
16374
16375 /* Try redisplay of window W showing an unchanged buffer with a
16376 different window start than the last time it was displayed by
16377 reusing its current matrix. Value is non-zero if successful.
16378 W->start is the new window start. */
16379
16380 static int
16381 try_window_reusing_current_matrix (struct window *w)
16382 {
16383 struct frame *f = XFRAME (w->frame);
16384 struct glyph_row *bottom_row;
16385 struct it it;
16386 struct run run;
16387 struct text_pos start, new_start;
16388 int nrows_scrolled, i;
16389 struct glyph_row *last_text_row;
16390 struct glyph_row *last_reused_text_row;
16391 struct glyph_row *start_row;
16392 int start_vpos, min_y, max_y;
16393
16394 #ifdef GLYPH_DEBUG
16395 if (inhibit_try_window_reusing)
16396 return 0;
16397 #endif
16398
16399 if (/* This function doesn't handle terminal frames. */
16400 !FRAME_WINDOW_P (f)
16401 /* Don't try to reuse the display if windows have been split
16402 or such. */
16403 || windows_or_buffers_changed
16404 || cursor_type_changed)
16405 return 0;
16406
16407 /* Can't do this if region may have changed. */
16408 if ((!NILP (Vtransient_mark_mode)
16409 && !NILP (BVAR (current_buffer, mark_active)))
16410 || !NILP (w->region_showing)
16411 || !NILP (Vshow_trailing_whitespace))
16412 return 0;
16413
16414 /* If top-line visibility has changed, give up. */
16415 if (WINDOW_WANTS_HEADER_LINE_P (w)
16416 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
16417 return 0;
16418
16419 /* Give up if old or new display is scrolled vertically. We could
16420 make this function handle this, but right now it doesn't. */
16421 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16422 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
16423 return 0;
16424
16425 /* The variable new_start now holds the new window start. The old
16426 start `start' can be determined from the current matrix. */
16427 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
16428 start = start_row->minpos;
16429 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
16430
16431 /* Clear the desired matrix for the display below. */
16432 clear_glyph_matrix (w->desired_matrix);
16433
16434 if (CHARPOS (new_start) <= CHARPOS (start))
16435 {
16436 /* Don't use this method if the display starts with an ellipsis
16437 displayed for invisible text. It's not easy to handle that case
16438 below, and it's certainly not worth the effort since this is
16439 not a frequent case. */
16440 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
16441 return 0;
16442
16443 IF_DEBUG (debug_method_add (w, "twu1"));
16444
16445 /* Display up to a row that can be reused. The variable
16446 last_text_row is set to the last row displayed that displays
16447 text. Note that it.vpos == 0 if or if not there is a
16448 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16449 start_display (&it, w, new_start);
16450 w->cursor.vpos = -1;
16451 last_text_row = last_reused_text_row = NULL;
16452
16453 while (it.current_y < it.last_visible_y
16454 && !fonts_changed_p)
16455 {
16456 /* If we have reached into the characters in the START row,
16457 that means the line boundaries have changed. So we
16458 can't start copying with the row START. Maybe it will
16459 work to start copying with the following row. */
16460 while (IT_CHARPOS (it) > CHARPOS (start))
16461 {
16462 /* Advance to the next row as the "start". */
16463 start_row++;
16464 start = start_row->minpos;
16465 /* If there are no more rows to try, or just one, give up. */
16466 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
16467 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
16468 || CHARPOS (start) == ZV)
16469 {
16470 clear_glyph_matrix (w->desired_matrix);
16471 return 0;
16472 }
16473
16474 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
16475 }
16476 /* If we have reached alignment, we can copy the rest of the
16477 rows. */
16478 if (IT_CHARPOS (it) == CHARPOS (start)
16479 /* Don't accept "alignment" inside a display vector,
16480 since start_row could have started in the middle of
16481 that same display vector (thus their character
16482 positions match), and we have no way of telling if
16483 that is the case. */
16484 && it.current.dpvec_index < 0)
16485 break;
16486
16487 if (display_line (&it))
16488 last_text_row = it.glyph_row - 1;
16489
16490 }
16491
16492 /* A value of current_y < last_visible_y means that we stopped
16493 at the previous window start, which in turn means that we
16494 have at least one reusable row. */
16495 if (it.current_y < it.last_visible_y)
16496 {
16497 struct glyph_row *row;
16498
16499 /* IT.vpos always starts from 0; it counts text lines. */
16500 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
16501
16502 /* Find PT if not already found in the lines displayed. */
16503 if (w->cursor.vpos < 0)
16504 {
16505 int dy = it.current_y - start_row->y;
16506
16507 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16508 row = row_containing_pos (w, PT, row, NULL, dy);
16509 if (row)
16510 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
16511 dy, nrows_scrolled);
16512 else
16513 {
16514 clear_glyph_matrix (w->desired_matrix);
16515 return 0;
16516 }
16517 }
16518
16519 /* Scroll the display. Do it before the current matrix is
16520 changed. The problem here is that update has not yet
16521 run, i.e. part of the current matrix is not up to date.
16522 scroll_run_hook will clear the cursor, and use the
16523 current matrix to get the height of the row the cursor is
16524 in. */
16525 run.current_y = start_row->y;
16526 run.desired_y = it.current_y;
16527 run.height = it.last_visible_y - it.current_y;
16528
16529 if (run.height > 0 && run.current_y != run.desired_y)
16530 {
16531 update_begin (f);
16532 FRAME_RIF (f)->update_window_begin_hook (w);
16533 FRAME_RIF (f)->clear_window_mouse_face (w);
16534 FRAME_RIF (f)->scroll_run_hook (w, &run);
16535 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
16536 update_end (f);
16537 }
16538
16539 /* Shift current matrix down by nrows_scrolled lines. */
16540 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
16541 rotate_matrix (w->current_matrix,
16542 start_vpos,
16543 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
16544 nrows_scrolled);
16545
16546 /* Disable lines that must be updated. */
16547 for (i = 0; i < nrows_scrolled; ++i)
16548 (start_row + i)->enabled_p = 0;
16549
16550 /* Re-compute Y positions. */
16551 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
16552 max_y = it.last_visible_y;
16553 for (row = start_row + nrows_scrolled;
16554 row < bottom_row;
16555 ++row)
16556 {
16557 row->y = it.current_y;
16558 row->visible_height = row->height;
16559
16560 if (row->y < min_y)
16561 row->visible_height -= min_y - row->y;
16562 if (row->y + row->height > max_y)
16563 row->visible_height -= row->y + row->height - max_y;
16564 if (row->fringe_bitmap_periodic_p)
16565 row->redraw_fringe_bitmaps_p = 1;
16566
16567 it.current_y += row->height;
16568
16569 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
16570 last_reused_text_row = row;
16571 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
16572 break;
16573 }
16574
16575 /* Disable lines in the current matrix which are now
16576 below the window. */
16577 for (++row; row < bottom_row; ++row)
16578 row->enabled_p = row->mode_line_p = 0;
16579 }
16580
16581 /* Update window_end_pos etc.; last_reused_text_row is the last
16582 reused row from the current matrix containing text, if any.
16583 The value of last_text_row is the last displayed line
16584 containing text. */
16585 if (last_reused_text_row)
16586 {
16587 w->window_end_bytepos
16588 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_reused_text_row);
16589 wset_window_end_pos
16590 (w, make_number (Z
16591 - MATRIX_ROW_END_CHARPOS (last_reused_text_row)));
16592 wset_window_end_vpos
16593 (w, make_number (MATRIX_ROW_VPOS (last_reused_text_row,
16594 w->current_matrix)));
16595 }
16596 else if (last_text_row)
16597 {
16598 w->window_end_bytepos
16599 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_text_row);
16600 wset_window_end_pos
16601 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (last_text_row)));
16602 wset_window_end_vpos
16603 (w, make_number (MATRIX_ROW_VPOS (last_text_row,
16604 w->desired_matrix)));
16605 }
16606 else
16607 {
16608 /* This window must be completely empty. */
16609 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
16610 wset_window_end_pos (w, make_number (Z - ZV));
16611 wset_window_end_vpos (w, make_number (0));
16612 }
16613 wset_window_end_valid (w, Qnil);
16614
16615 /* Update hint: don't try scrolling again in update_window. */
16616 w->desired_matrix->no_scrolling_p = 1;
16617
16618 #ifdef GLYPH_DEBUG
16619 debug_method_add (w, "try_window_reusing_current_matrix 1");
16620 #endif
16621 return 1;
16622 }
16623 else if (CHARPOS (new_start) > CHARPOS (start))
16624 {
16625 struct glyph_row *pt_row, *row;
16626 struct glyph_row *first_reusable_row;
16627 struct glyph_row *first_row_to_display;
16628 int dy;
16629 int yb = window_text_bottom_y (w);
16630
16631 /* Find the row starting at new_start, if there is one. Don't
16632 reuse a partially visible line at the end. */
16633 first_reusable_row = start_row;
16634 while (first_reusable_row->enabled_p
16635 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
16636 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
16637 < CHARPOS (new_start)))
16638 ++first_reusable_row;
16639
16640 /* Give up if there is no row to reuse. */
16641 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
16642 || !first_reusable_row->enabled_p
16643 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
16644 != CHARPOS (new_start)))
16645 return 0;
16646
16647 /* We can reuse fully visible rows beginning with
16648 first_reusable_row to the end of the window. Set
16649 first_row_to_display to the first row that cannot be reused.
16650 Set pt_row to the row containing point, if there is any. */
16651 pt_row = NULL;
16652 for (first_row_to_display = first_reusable_row;
16653 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
16654 ++first_row_to_display)
16655 {
16656 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
16657 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
16658 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
16659 && first_row_to_display->ends_at_zv_p
16660 && pt_row == NULL)))
16661 pt_row = first_row_to_display;
16662 }
16663
16664 /* Start displaying at the start of first_row_to_display. */
16665 eassert (first_row_to_display->y < yb);
16666 init_to_row_start (&it, w, first_row_to_display);
16667
16668 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
16669 - start_vpos);
16670 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
16671 - nrows_scrolled);
16672 it.current_y = (first_row_to_display->y - first_reusable_row->y
16673 + WINDOW_HEADER_LINE_HEIGHT (w));
16674
16675 /* Display lines beginning with first_row_to_display in the
16676 desired matrix. Set last_text_row to the last row displayed
16677 that displays text. */
16678 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
16679 if (pt_row == NULL)
16680 w->cursor.vpos = -1;
16681 last_text_row = NULL;
16682 while (it.current_y < it.last_visible_y && !fonts_changed_p)
16683 if (display_line (&it))
16684 last_text_row = it.glyph_row - 1;
16685
16686 /* If point is in a reused row, adjust y and vpos of the cursor
16687 position. */
16688 if (pt_row)
16689 {
16690 w->cursor.vpos -= nrows_scrolled;
16691 w->cursor.y -= first_reusable_row->y - start_row->y;
16692 }
16693
16694 /* Give up if point isn't in a row displayed or reused. (This
16695 also handles the case where w->cursor.vpos < nrows_scrolled
16696 after the calls to display_line, which can happen with scroll
16697 margins. See bug#1295.) */
16698 if (w->cursor.vpos < 0)
16699 {
16700 clear_glyph_matrix (w->desired_matrix);
16701 return 0;
16702 }
16703
16704 /* Scroll the display. */
16705 run.current_y = first_reusable_row->y;
16706 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
16707 run.height = it.last_visible_y - run.current_y;
16708 dy = run.current_y - run.desired_y;
16709
16710 if (run.height)
16711 {
16712 update_begin (f);
16713 FRAME_RIF (f)->update_window_begin_hook (w);
16714 FRAME_RIF (f)->clear_window_mouse_face (w);
16715 FRAME_RIF (f)->scroll_run_hook (w, &run);
16716 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
16717 update_end (f);
16718 }
16719
16720 /* Adjust Y positions of reused rows. */
16721 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
16722 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
16723 max_y = it.last_visible_y;
16724 for (row = first_reusable_row; row < first_row_to_display; ++row)
16725 {
16726 row->y -= dy;
16727 row->visible_height = row->height;
16728 if (row->y < min_y)
16729 row->visible_height -= min_y - row->y;
16730 if (row->y + row->height > max_y)
16731 row->visible_height -= row->y + row->height - max_y;
16732 if (row->fringe_bitmap_periodic_p)
16733 row->redraw_fringe_bitmaps_p = 1;
16734 }
16735
16736 /* Scroll the current matrix. */
16737 eassert (nrows_scrolled > 0);
16738 rotate_matrix (w->current_matrix,
16739 start_vpos,
16740 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
16741 -nrows_scrolled);
16742
16743 /* Disable rows not reused. */
16744 for (row -= nrows_scrolled; row < bottom_row; ++row)
16745 row->enabled_p = 0;
16746
16747 /* Point may have moved to a different line, so we cannot assume that
16748 the previous cursor position is valid; locate the correct row. */
16749 if (pt_row)
16750 {
16751 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
16752 row < bottom_row
16753 && PT >= MATRIX_ROW_END_CHARPOS (row)
16754 && !row->ends_at_zv_p;
16755 row++)
16756 {
16757 w->cursor.vpos++;
16758 w->cursor.y = row->y;
16759 }
16760 if (row < bottom_row)
16761 {
16762 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
16763 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
16764
16765 /* Can't use this optimization with bidi-reordered glyph
16766 rows, unless cursor is already at point. */
16767 if (!NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering)))
16768 {
16769 if (!(w->cursor.hpos >= 0
16770 && w->cursor.hpos < row->used[TEXT_AREA]
16771 && BUFFERP (glyph->object)
16772 && glyph->charpos == PT))
16773 return 0;
16774 }
16775 else
16776 for (; glyph < end
16777 && (!BUFFERP (glyph->object)
16778 || glyph->charpos < PT);
16779 glyph++)
16780 {
16781 w->cursor.hpos++;
16782 w->cursor.x += glyph->pixel_width;
16783 }
16784 }
16785 }
16786
16787 /* Adjust window end. A null value of last_text_row means that
16788 the window end is in reused rows which in turn means that
16789 only its vpos can have changed. */
16790 if (last_text_row)
16791 {
16792 w->window_end_bytepos
16793 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_text_row);
16794 wset_window_end_pos
16795 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (last_text_row)));
16796 wset_window_end_vpos
16797 (w, make_number (MATRIX_ROW_VPOS (last_text_row,
16798 w->desired_matrix)));
16799 }
16800 else
16801 {
16802 wset_window_end_vpos
16803 (w, make_number (XFASTINT (w->window_end_vpos) - nrows_scrolled));
16804 }
16805
16806 wset_window_end_valid (w, Qnil);
16807 w->desired_matrix->no_scrolling_p = 1;
16808
16809 #ifdef GLYPH_DEBUG
16810 debug_method_add (w, "try_window_reusing_current_matrix 2");
16811 #endif
16812 return 1;
16813 }
16814
16815 return 0;
16816 }
16817
16818
16819 \f
16820 /************************************************************************
16821 Window redisplay reusing current matrix when buffer has changed
16822 ************************************************************************/
16823
16824 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
16825 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
16826 ptrdiff_t *, ptrdiff_t *);
16827 static struct glyph_row *
16828 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
16829 struct glyph_row *);
16830
16831
16832 /* Return the last row in MATRIX displaying text. If row START is
16833 non-null, start searching with that row. IT gives the dimensions
16834 of the display. Value is null if matrix is empty; otherwise it is
16835 a pointer to the row found. */
16836
16837 static struct glyph_row *
16838 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
16839 struct glyph_row *start)
16840 {
16841 struct glyph_row *row, *row_found;
16842
16843 /* Set row_found to the last row in IT->w's current matrix
16844 displaying text. The loop looks funny but think of partially
16845 visible lines. */
16846 row_found = NULL;
16847 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
16848 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
16849 {
16850 eassert (row->enabled_p);
16851 row_found = row;
16852 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
16853 break;
16854 ++row;
16855 }
16856
16857 return row_found;
16858 }
16859
16860
16861 /* Return the last row in the current matrix of W that is not affected
16862 by changes at the start of current_buffer that occurred since W's
16863 current matrix was built. Value is null if no such row exists.
16864
16865 BEG_UNCHANGED us the number of characters unchanged at the start of
16866 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16867 first changed character in current_buffer. Characters at positions <
16868 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16869 when the current matrix was built. */
16870
16871 static struct glyph_row *
16872 find_last_unchanged_at_beg_row (struct window *w)
16873 {
16874 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
16875 struct glyph_row *row;
16876 struct glyph_row *row_found = NULL;
16877 int yb = window_text_bottom_y (w);
16878
16879 /* Find the last row displaying unchanged text. */
16880 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16881 MATRIX_ROW_DISPLAYS_TEXT_P (row)
16882 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
16883 ++row)
16884 {
16885 if (/* If row ends before first_changed_pos, it is unchanged,
16886 except in some case. */
16887 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
16888 /* When row ends in ZV and we write at ZV it is not
16889 unchanged. */
16890 && !row->ends_at_zv_p
16891 /* When first_changed_pos is the end of a continued line,
16892 row is not unchanged because it may be no longer
16893 continued. */
16894 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
16895 && (row->continued_p
16896 || row->exact_window_width_line_p))
16897 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16898 needs to be recomputed, so don't consider this row as
16899 unchanged. This happens when the last line was
16900 bidi-reordered and was killed immediately before this
16901 redisplay cycle. In that case, ROW->end stores the
16902 buffer position of the first visual-order character of
16903 the killed text, which is now beyond ZV. */
16904 && CHARPOS (row->end.pos) <= ZV)
16905 row_found = row;
16906
16907 /* Stop if last visible row. */
16908 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
16909 break;
16910 }
16911
16912 return row_found;
16913 }
16914
16915
16916 /* Find the first glyph row in the current matrix of W that is not
16917 affected by changes at the end of current_buffer since the
16918 time W's current matrix was built.
16919
16920 Return in *DELTA the number of chars by which buffer positions in
16921 unchanged text at the end of current_buffer must be adjusted.
16922
16923 Return in *DELTA_BYTES the corresponding number of bytes.
16924
16925 Value is null if no such row exists, i.e. all rows are affected by
16926 changes. */
16927
16928 static struct glyph_row *
16929 find_first_unchanged_at_end_row (struct window *w,
16930 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
16931 {
16932 struct glyph_row *row;
16933 struct glyph_row *row_found = NULL;
16934
16935 *delta = *delta_bytes = 0;
16936
16937 /* Display must not have been paused, otherwise the current matrix
16938 is not up to date. */
16939 eassert (!NILP (w->window_end_valid));
16940
16941 /* A value of window_end_pos >= END_UNCHANGED means that the window
16942 end is in the range of changed text. If so, there is no
16943 unchanged row at the end of W's current matrix. */
16944 if (XFASTINT (w->window_end_pos) >= END_UNCHANGED)
16945 return NULL;
16946
16947 /* Set row to the last row in W's current matrix displaying text. */
16948 row = MATRIX_ROW (w->current_matrix, XFASTINT (w->window_end_vpos));
16949
16950 /* If matrix is entirely empty, no unchanged row exists. */
16951 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
16952 {
16953 /* The value of row is the last glyph row in the matrix having a
16954 meaningful buffer position in it. The end position of row
16955 corresponds to window_end_pos. This allows us to translate
16956 buffer positions in the current matrix to current buffer
16957 positions for characters not in changed text. */
16958 ptrdiff_t Z_old =
16959 MATRIX_ROW_END_CHARPOS (row) + XFASTINT (w->window_end_pos);
16960 ptrdiff_t Z_BYTE_old =
16961 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
16962 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
16963 struct glyph_row *first_text_row
16964 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16965
16966 *delta = Z - Z_old;
16967 *delta_bytes = Z_BYTE - Z_BYTE_old;
16968
16969 /* Set last_unchanged_pos to the buffer position of the last
16970 character in the buffer that has not been changed. Z is the
16971 index + 1 of the last character in current_buffer, i.e. by
16972 subtracting END_UNCHANGED we get the index of the last
16973 unchanged character, and we have to add BEG to get its buffer
16974 position. */
16975 last_unchanged_pos = Z - END_UNCHANGED + BEG;
16976 last_unchanged_pos_old = last_unchanged_pos - *delta;
16977
16978 /* Search backward from ROW for a row displaying a line that
16979 starts at a minimum position >= last_unchanged_pos_old. */
16980 for (; row > first_text_row; --row)
16981 {
16982 /* This used to abort, but it can happen.
16983 It is ok to just stop the search instead here. KFS. */
16984 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
16985 break;
16986
16987 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
16988 row_found = row;
16989 }
16990 }
16991
16992 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
16993
16994 return row_found;
16995 }
16996
16997
16998 /* Make sure that glyph rows in the current matrix of window W
16999 reference the same glyph memory as corresponding rows in the
17000 frame's frame matrix. This function is called after scrolling W's
17001 current matrix on a terminal frame in try_window_id and
17002 try_window_reusing_current_matrix. */
17003
17004 static void
17005 sync_frame_with_window_matrix_rows (struct window *w)
17006 {
17007 struct frame *f = XFRAME (w->frame);
17008 struct glyph_row *window_row, *window_row_end, *frame_row;
17009
17010 /* Preconditions: W must be a leaf window and full-width. Its frame
17011 must have a frame matrix. */
17012 eassert (NILP (w->hchild) && NILP (w->vchild));
17013 eassert (WINDOW_FULL_WIDTH_P (w));
17014 eassert (!FRAME_WINDOW_P (f));
17015
17016 /* If W is a full-width window, glyph pointers in W's current matrix
17017 have, by definition, to be the same as glyph pointers in the
17018 corresponding frame matrix. Note that frame matrices have no
17019 marginal areas (see build_frame_matrix). */
17020 window_row = w->current_matrix->rows;
17021 window_row_end = window_row + w->current_matrix->nrows;
17022 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17023 while (window_row < window_row_end)
17024 {
17025 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17026 struct glyph *end = window_row->glyphs[LAST_AREA];
17027
17028 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17029 frame_row->glyphs[TEXT_AREA] = start;
17030 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17031 frame_row->glyphs[LAST_AREA] = end;
17032
17033 /* Disable frame rows whose corresponding window rows have
17034 been disabled in try_window_id. */
17035 if (!window_row->enabled_p)
17036 frame_row->enabled_p = 0;
17037
17038 ++window_row, ++frame_row;
17039 }
17040 }
17041
17042
17043 /* Find the glyph row in window W containing CHARPOS. Consider all
17044 rows between START and END (not inclusive). END null means search
17045 all rows to the end of the display area of W. Value is the row
17046 containing CHARPOS or null. */
17047
17048 struct glyph_row *
17049 row_containing_pos (struct window *w, ptrdiff_t charpos,
17050 struct glyph_row *start, struct glyph_row *end, int dy)
17051 {
17052 struct glyph_row *row = start;
17053 struct glyph_row *best_row = NULL;
17054 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->buffer)) + 1;
17055 int last_y;
17056
17057 /* If we happen to start on a header-line, skip that. */
17058 if (row->mode_line_p)
17059 ++row;
17060
17061 if ((end && row >= end) || !row->enabled_p)
17062 return NULL;
17063
17064 last_y = window_text_bottom_y (w) - dy;
17065
17066 while (1)
17067 {
17068 /* Give up if we have gone too far. */
17069 if (end && row >= end)
17070 return NULL;
17071 /* This formerly returned if they were equal.
17072 I think that both quantities are of a "last plus one" type;
17073 if so, when they are equal, the row is within the screen. -- rms. */
17074 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17075 return NULL;
17076
17077 /* If it is in this row, return this row. */
17078 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17079 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17080 /* The end position of a row equals the start
17081 position of the next row. If CHARPOS is there, we
17082 would rather display it in the next line, except
17083 when this line ends in ZV. */
17084 && !row->ends_at_zv_p
17085 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
17086 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17087 {
17088 struct glyph *g;
17089
17090 if (NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering))
17091 || (!best_row && !row->continued_p))
17092 return row;
17093 /* In bidi-reordered rows, there could be several rows
17094 occluding point, all of them belonging to the same
17095 continued line. We need to find the row which fits
17096 CHARPOS the best. */
17097 for (g = row->glyphs[TEXT_AREA];
17098 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17099 g++)
17100 {
17101 if (!STRINGP (g->object))
17102 {
17103 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17104 {
17105 mindif = eabs (g->charpos - charpos);
17106 best_row = row;
17107 /* Exact match always wins. */
17108 if (mindif == 0)
17109 return best_row;
17110 }
17111 }
17112 }
17113 }
17114 else if (best_row && !row->continued_p)
17115 return best_row;
17116 ++row;
17117 }
17118 }
17119
17120
17121 /* Try to redisplay window W by reusing its existing display. W's
17122 current matrix must be up to date when this function is called,
17123 i.e. window_end_valid must not be nil.
17124
17125 Value is
17126
17127 1 if display has been updated
17128 0 if otherwise unsuccessful
17129 -1 if redisplay with same window start is known not to succeed
17130
17131 The following steps are performed:
17132
17133 1. Find the last row in the current matrix of W that is not
17134 affected by changes at the start of current_buffer. If no such row
17135 is found, give up.
17136
17137 2. Find the first row in W's current matrix that is not affected by
17138 changes at the end of current_buffer. Maybe there is no such row.
17139
17140 3. Display lines beginning with the row + 1 found in step 1 to the
17141 row found in step 2 or, if step 2 didn't find a row, to the end of
17142 the window.
17143
17144 4. If cursor is not known to appear on the window, give up.
17145
17146 5. If display stopped at the row found in step 2, scroll the
17147 display and current matrix as needed.
17148
17149 6. Maybe display some lines at the end of W, if we must. This can
17150 happen under various circumstances, like a partially visible line
17151 becoming fully visible, or because newly displayed lines are displayed
17152 in smaller font sizes.
17153
17154 7. Update W's window end information. */
17155
17156 static int
17157 try_window_id (struct window *w)
17158 {
17159 struct frame *f = XFRAME (w->frame);
17160 struct glyph_matrix *current_matrix = w->current_matrix;
17161 struct glyph_matrix *desired_matrix = w->desired_matrix;
17162 struct glyph_row *last_unchanged_at_beg_row;
17163 struct glyph_row *first_unchanged_at_end_row;
17164 struct glyph_row *row;
17165 struct glyph_row *bottom_row;
17166 int bottom_vpos;
17167 struct it it;
17168 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17169 int dvpos, dy;
17170 struct text_pos start_pos;
17171 struct run run;
17172 int first_unchanged_at_end_vpos = 0;
17173 struct glyph_row *last_text_row, *last_text_row_at_end;
17174 struct text_pos start;
17175 ptrdiff_t first_changed_charpos, last_changed_charpos;
17176
17177 #ifdef GLYPH_DEBUG
17178 if (inhibit_try_window_id)
17179 return 0;
17180 #endif
17181
17182 /* This is handy for debugging. */
17183 #if 0
17184 #define GIVE_UP(X) \
17185 do { \
17186 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17187 return 0; \
17188 } while (0)
17189 #else
17190 #define GIVE_UP(X) return 0
17191 #endif
17192
17193 SET_TEXT_POS_FROM_MARKER (start, w->start);
17194
17195 /* Don't use this for mini-windows because these can show
17196 messages and mini-buffers, and we don't handle that here. */
17197 if (MINI_WINDOW_P (w))
17198 GIVE_UP (1);
17199
17200 /* This flag is used to prevent redisplay optimizations. */
17201 if (windows_or_buffers_changed || cursor_type_changed)
17202 GIVE_UP (2);
17203
17204 /* Verify that narrowing has not changed.
17205 Also verify that we were not told to prevent redisplay optimizations.
17206 It would be nice to further
17207 reduce the number of cases where this prevents try_window_id. */
17208 if (current_buffer->clip_changed
17209 || current_buffer->prevent_redisplay_optimizations_p)
17210 GIVE_UP (3);
17211
17212 /* Window must either use window-based redisplay or be full width. */
17213 if (!FRAME_WINDOW_P (f)
17214 && (!FRAME_LINE_INS_DEL_OK (f)
17215 || !WINDOW_FULL_WIDTH_P (w)))
17216 GIVE_UP (4);
17217
17218 /* Give up if point is known NOT to appear in W. */
17219 if (PT < CHARPOS (start))
17220 GIVE_UP (5);
17221
17222 /* Another way to prevent redisplay optimizations. */
17223 if (w->last_modified == 0)
17224 GIVE_UP (6);
17225
17226 /* Verify that window is not hscrolled. */
17227 if (w->hscroll != 0)
17228 GIVE_UP (7);
17229
17230 /* Verify that display wasn't paused. */
17231 if (NILP (w->window_end_valid))
17232 GIVE_UP (8);
17233
17234 /* Can't use this if highlighting a region because a cursor movement
17235 will do more than just set the cursor. */
17236 if (!NILP (Vtransient_mark_mode)
17237 && !NILP (BVAR (current_buffer, mark_active)))
17238 GIVE_UP (9);
17239
17240 /* Likewise if highlighting trailing whitespace. */
17241 if (!NILP (Vshow_trailing_whitespace))
17242 GIVE_UP (11);
17243
17244 /* Likewise if showing a region. */
17245 if (!NILP (w->region_showing))
17246 GIVE_UP (10);
17247
17248 /* Can't use this if overlay arrow position and/or string have
17249 changed. */
17250 if (overlay_arrows_changed_p ())
17251 GIVE_UP (12);
17252
17253 /* When word-wrap is on, adding a space to the first word of a
17254 wrapped line can change the wrap position, altering the line
17255 above it. It might be worthwhile to handle this more
17256 intelligently, but for now just redisplay from scratch. */
17257 if (!NILP (BVAR (XBUFFER (w->buffer), word_wrap)))
17258 GIVE_UP (21);
17259
17260 /* Under bidi reordering, adding or deleting a character in the
17261 beginning of a paragraph, before the first strong directional
17262 character, can change the base direction of the paragraph (unless
17263 the buffer specifies a fixed paragraph direction), which will
17264 require to redisplay the whole paragraph. It might be worthwhile
17265 to find the paragraph limits and widen the range of redisplayed
17266 lines to that, but for now just give up this optimization and
17267 redisplay from scratch. */
17268 if (!NILP (BVAR (XBUFFER (w->buffer), bidi_display_reordering))
17269 && NILP (BVAR (XBUFFER (w->buffer), bidi_paragraph_direction)))
17270 GIVE_UP (22);
17271
17272 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17273 only if buffer has really changed. The reason is that the gap is
17274 initially at Z for freshly visited files. The code below would
17275 set end_unchanged to 0 in that case. */
17276 if (MODIFF > SAVE_MODIFF
17277 /* This seems to happen sometimes after saving a buffer. */
17278 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17279 {
17280 if (GPT - BEG < BEG_UNCHANGED)
17281 BEG_UNCHANGED = GPT - BEG;
17282 if (Z - GPT < END_UNCHANGED)
17283 END_UNCHANGED = Z - GPT;
17284 }
17285
17286 /* The position of the first and last character that has been changed. */
17287 first_changed_charpos = BEG + BEG_UNCHANGED;
17288 last_changed_charpos = Z - END_UNCHANGED;
17289
17290 /* If window starts after a line end, and the last change is in
17291 front of that newline, then changes don't affect the display.
17292 This case happens with stealth-fontification. Note that although
17293 the display is unchanged, glyph positions in the matrix have to
17294 be adjusted, of course. */
17295 row = MATRIX_ROW (w->current_matrix, XFASTINT (w->window_end_vpos));
17296 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17297 && ((last_changed_charpos < CHARPOS (start)
17298 && CHARPOS (start) == BEGV)
17299 || (last_changed_charpos < CHARPOS (start) - 1
17300 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17301 {
17302 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17303 struct glyph_row *r0;
17304
17305 /* Compute how many chars/bytes have been added to or removed
17306 from the buffer. */
17307 Z_old = MATRIX_ROW_END_CHARPOS (row) + XFASTINT (w->window_end_pos);
17308 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17309 Z_delta = Z - Z_old;
17310 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17311
17312 /* Give up if PT is not in the window. Note that it already has
17313 been checked at the start of try_window_id that PT is not in
17314 front of the window start. */
17315 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17316 GIVE_UP (13);
17317
17318 /* If window start is unchanged, we can reuse the whole matrix
17319 as is, after adjusting glyph positions. No need to compute
17320 the window end again, since its offset from Z hasn't changed. */
17321 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17322 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17323 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17324 /* PT must not be in a partially visible line. */
17325 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17326 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17327 {
17328 /* Adjust positions in the glyph matrix. */
17329 if (Z_delta || Z_delta_bytes)
17330 {
17331 struct glyph_row *r1
17332 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17333 increment_matrix_positions (w->current_matrix,
17334 MATRIX_ROW_VPOS (r0, current_matrix),
17335 MATRIX_ROW_VPOS (r1, current_matrix),
17336 Z_delta, Z_delta_bytes);
17337 }
17338
17339 /* Set the cursor. */
17340 row = row_containing_pos (w, PT, r0, NULL, 0);
17341 if (row)
17342 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17343 else
17344 emacs_abort ();
17345 return 1;
17346 }
17347 }
17348
17349 /* Handle the case that changes are all below what is displayed in
17350 the window, and that PT is in the window. This shortcut cannot
17351 be taken if ZV is visible in the window, and text has been added
17352 there that is visible in the window. */
17353 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
17354 /* ZV is not visible in the window, or there are no
17355 changes at ZV, actually. */
17356 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
17357 || first_changed_charpos == last_changed_charpos))
17358 {
17359 struct glyph_row *r0;
17360
17361 /* Give up if PT is not in the window. Note that it already has
17362 been checked at the start of try_window_id that PT is not in
17363 front of the window start. */
17364 if (PT >= MATRIX_ROW_END_CHARPOS (row))
17365 GIVE_UP (14);
17366
17367 /* If window start is unchanged, we can reuse the whole matrix
17368 as is, without changing glyph positions since no text has
17369 been added/removed in front of the window end. */
17370 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17371 if (TEXT_POS_EQUAL_P (start, r0->minpos)
17372 /* PT must not be in a partially visible line. */
17373 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
17374 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17375 {
17376 /* We have to compute the window end anew since text
17377 could have been added/removed after it. */
17378 wset_window_end_pos
17379 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (row)));
17380 w->window_end_bytepos
17381 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17382
17383 /* Set the cursor. */
17384 row = row_containing_pos (w, PT, r0, NULL, 0);
17385 if (row)
17386 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17387 else
17388 emacs_abort ();
17389 return 2;
17390 }
17391 }
17392
17393 /* Give up if window start is in the changed area.
17394
17395 The condition used to read
17396
17397 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17398
17399 but why that was tested escapes me at the moment. */
17400 if (CHARPOS (start) >= first_changed_charpos
17401 && CHARPOS (start) <= last_changed_charpos)
17402 GIVE_UP (15);
17403
17404 /* Check that window start agrees with the start of the first glyph
17405 row in its current matrix. Check this after we know the window
17406 start is not in changed text, otherwise positions would not be
17407 comparable. */
17408 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
17409 if (!TEXT_POS_EQUAL_P (start, row->minpos))
17410 GIVE_UP (16);
17411
17412 /* Give up if the window ends in strings. Overlay strings
17413 at the end are difficult to handle, so don't try. */
17414 row = MATRIX_ROW (current_matrix, XFASTINT (w->window_end_vpos));
17415 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
17416 GIVE_UP (20);
17417
17418 /* Compute the position at which we have to start displaying new
17419 lines. Some of the lines at the top of the window might be
17420 reusable because they are not displaying changed text. Find the
17421 last row in W's current matrix not affected by changes at the
17422 start of current_buffer. Value is null if changes start in the
17423 first line of window. */
17424 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
17425 if (last_unchanged_at_beg_row)
17426 {
17427 /* Avoid starting to display in the middle of a character, a TAB
17428 for instance. This is easier than to set up the iterator
17429 exactly, and it's not a frequent case, so the additional
17430 effort wouldn't really pay off. */
17431 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
17432 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
17433 && last_unchanged_at_beg_row > w->current_matrix->rows)
17434 --last_unchanged_at_beg_row;
17435
17436 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
17437 GIVE_UP (17);
17438
17439 if (init_to_row_end (&it, w, last_unchanged_at_beg_row) == 0)
17440 GIVE_UP (18);
17441 start_pos = it.current.pos;
17442
17443 /* Start displaying new lines in the desired matrix at the same
17444 vpos we would use in the current matrix, i.e. below
17445 last_unchanged_at_beg_row. */
17446 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
17447 current_matrix);
17448 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
17449 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
17450
17451 eassert (it.hpos == 0 && it.current_x == 0);
17452 }
17453 else
17454 {
17455 /* There are no reusable lines at the start of the window.
17456 Start displaying in the first text line. */
17457 start_display (&it, w, start);
17458 it.vpos = it.first_vpos;
17459 start_pos = it.current.pos;
17460 }
17461
17462 /* Find the first row that is not affected by changes at the end of
17463 the buffer. Value will be null if there is no unchanged row, in
17464 which case we must redisplay to the end of the window. delta
17465 will be set to the value by which buffer positions beginning with
17466 first_unchanged_at_end_row have to be adjusted due to text
17467 changes. */
17468 first_unchanged_at_end_row
17469 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
17470 IF_DEBUG (debug_delta = delta);
17471 IF_DEBUG (debug_delta_bytes = delta_bytes);
17472
17473 /* Set stop_pos to the buffer position up to which we will have to
17474 display new lines. If first_unchanged_at_end_row != NULL, this
17475 is the buffer position of the start of the line displayed in that
17476 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17477 that we don't stop at a buffer position. */
17478 stop_pos = 0;
17479 if (first_unchanged_at_end_row)
17480 {
17481 eassert (last_unchanged_at_beg_row == NULL
17482 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
17483
17484 /* If this is a continuation line, move forward to the next one
17485 that isn't. Changes in lines above affect this line.
17486 Caution: this may move first_unchanged_at_end_row to a row
17487 not displaying text. */
17488 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
17489 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
17490 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
17491 < it.last_visible_y))
17492 ++first_unchanged_at_end_row;
17493
17494 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
17495 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
17496 >= it.last_visible_y))
17497 first_unchanged_at_end_row = NULL;
17498 else
17499 {
17500 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
17501 + delta);
17502 first_unchanged_at_end_vpos
17503 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
17504 eassert (stop_pos >= Z - END_UNCHANGED);
17505 }
17506 }
17507 else if (last_unchanged_at_beg_row == NULL)
17508 GIVE_UP (19);
17509
17510
17511 #ifdef GLYPH_DEBUG
17512
17513 /* Either there is no unchanged row at the end, or the one we have
17514 now displays text. This is a necessary condition for the window
17515 end pos calculation at the end of this function. */
17516 eassert (first_unchanged_at_end_row == NULL
17517 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
17518
17519 debug_last_unchanged_at_beg_vpos
17520 = (last_unchanged_at_beg_row
17521 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
17522 : -1);
17523 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
17524
17525 #endif /* GLYPH_DEBUG */
17526
17527
17528 /* Display new lines. Set last_text_row to the last new line
17529 displayed which has text on it, i.e. might end up as being the
17530 line where the window_end_vpos is. */
17531 w->cursor.vpos = -1;
17532 last_text_row = NULL;
17533 overlay_arrow_seen = 0;
17534 while (it.current_y < it.last_visible_y
17535 && !fonts_changed_p
17536 && (first_unchanged_at_end_row == NULL
17537 || IT_CHARPOS (it) < stop_pos))
17538 {
17539 if (display_line (&it))
17540 last_text_row = it.glyph_row - 1;
17541 }
17542
17543 if (fonts_changed_p)
17544 return -1;
17545
17546
17547 /* Compute differences in buffer positions, y-positions etc. for
17548 lines reused at the bottom of the window. Compute what we can
17549 scroll. */
17550 if (first_unchanged_at_end_row
17551 /* No lines reused because we displayed everything up to the
17552 bottom of the window. */
17553 && it.current_y < it.last_visible_y)
17554 {
17555 dvpos = (it.vpos
17556 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
17557 current_matrix));
17558 dy = it.current_y - first_unchanged_at_end_row->y;
17559 run.current_y = first_unchanged_at_end_row->y;
17560 run.desired_y = run.current_y + dy;
17561 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
17562 }
17563 else
17564 {
17565 delta = delta_bytes = dvpos = dy
17566 = run.current_y = run.desired_y = run.height = 0;
17567 first_unchanged_at_end_row = NULL;
17568 }
17569 IF_DEBUG (debug_dvpos = dvpos; debug_dy = dy);
17570
17571
17572 /* Find the cursor if not already found. We have to decide whether
17573 PT will appear on this window (it sometimes doesn't, but this is
17574 not a very frequent case.) This decision has to be made before
17575 the current matrix is altered. A value of cursor.vpos < 0 means
17576 that PT is either in one of the lines beginning at
17577 first_unchanged_at_end_row or below the window. Don't care for
17578 lines that might be displayed later at the window end; as
17579 mentioned, this is not a frequent case. */
17580 if (w->cursor.vpos < 0)
17581 {
17582 /* Cursor in unchanged rows at the top? */
17583 if (PT < CHARPOS (start_pos)
17584 && last_unchanged_at_beg_row)
17585 {
17586 row = row_containing_pos (w, PT,
17587 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
17588 last_unchanged_at_beg_row + 1, 0);
17589 if (row)
17590 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
17591 }
17592
17593 /* Start from first_unchanged_at_end_row looking for PT. */
17594 else if (first_unchanged_at_end_row)
17595 {
17596 row = row_containing_pos (w, PT - delta,
17597 first_unchanged_at_end_row, NULL, 0);
17598 if (row)
17599 set_cursor_from_row (w, row, w->current_matrix, delta,
17600 delta_bytes, dy, dvpos);
17601 }
17602
17603 /* Give up if cursor was not found. */
17604 if (w->cursor.vpos < 0)
17605 {
17606 clear_glyph_matrix (w->desired_matrix);
17607 return -1;
17608 }
17609 }
17610
17611 /* Don't let the cursor end in the scroll margins. */
17612 {
17613 int this_scroll_margin, cursor_height;
17614
17615 this_scroll_margin =
17616 max (0, min (scroll_margin, WINDOW_TOTAL_LINES (w) / 4));
17617 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
17618 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
17619
17620 if ((w->cursor.y < this_scroll_margin
17621 && CHARPOS (start) > BEGV)
17622 /* Old redisplay didn't take scroll margin into account at the bottom,
17623 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17624 || (w->cursor.y + (make_cursor_line_fully_visible_p
17625 ? cursor_height + this_scroll_margin
17626 : 1)) > it.last_visible_y)
17627 {
17628 w->cursor.vpos = -1;
17629 clear_glyph_matrix (w->desired_matrix);
17630 return -1;
17631 }
17632 }
17633
17634 /* Scroll the display. Do it before changing the current matrix so
17635 that xterm.c doesn't get confused about where the cursor glyph is
17636 found. */
17637 if (dy && run.height)
17638 {
17639 update_begin (f);
17640
17641 if (FRAME_WINDOW_P (f))
17642 {
17643 FRAME_RIF (f)->update_window_begin_hook (w);
17644 FRAME_RIF (f)->clear_window_mouse_face (w);
17645 FRAME_RIF (f)->scroll_run_hook (w, &run);
17646 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17647 }
17648 else
17649 {
17650 /* Terminal frame. In this case, dvpos gives the number of
17651 lines to scroll by; dvpos < 0 means scroll up. */
17652 int from_vpos
17653 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
17654 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
17655 int end = (WINDOW_TOP_EDGE_LINE (w)
17656 + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0)
17657 + window_internal_height (w));
17658
17659 #if defined (HAVE_GPM) || defined (MSDOS)
17660 x_clear_window_mouse_face (w);
17661 #endif
17662 /* Perform the operation on the screen. */
17663 if (dvpos > 0)
17664 {
17665 /* Scroll last_unchanged_at_beg_row to the end of the
17666 window down dvpos lines. */
17667 set_terminal_window (f, end);
17668
17669 /* On dumb terminals delete dvpos lines at the end
17670 before inserting dvpos empty lines. */
17671 if (!FRAME_SCROLL_REGION_OK (f))
17672 ins_del_lines (f, end - dvpos, -dvpos);
17673
17674 /* Insert dvpos empty lines in front of
17675 last_unchanged_at_beg_row. */
17676 ins_del_lines (f, from, dvpos);
17677 }
17678 else if (dvpos < 0)
17679 {
17680 /* Scroll up last_unchanged_at_beg_vpos to the end of
17681 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17682 set_terminal_window (f, end);
17683
17684 /* Delete dvpos lines in front of
17685 last_unchanged_at_beg_vpos. ins_del_lines will set
17686 the cursor to the given vpos and emit |dvpos| delete
17687 line sequences. */
17688 ins_del_lines (f, from + dvpos, dvpos);
17689
17690 /* On a dumb terminal insert dvpos empty lines at the
17691 end. */
17692 if (!FRAME_SCROLL_REGION_OK (f))
17693 ins_del_lines (f, end + dvpos, -dvpos);
17694 }
17695
17696 set_terminal_window (f, 0);
17697 }
17698
17699 update_end (f);
17700 }
17701
17702 /* Shift reused rows of the current matrix to the right position.
17703 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17704 text. */
17705 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17706 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
17707 if (dvpos < 0)
17708 {
17709 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
17710 bottom_vpos, dvpos);
17711 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
17712 bottom_vpos);
17713 }
17714 else if (dvpos > 0)
17715 {
17716 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
17717 bottom_vpos, dvpos);
17718 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
17719 first_unchanged_at_end_vpos + dvpos);
17720 }
17721
17722 /* For frame-based redisplay, make sure that current frame and window
17723 matrix are in sync with respect to glyph memory. */
17724 if (!FRAME_WINDOW_P (f))
17725 sync_frame_with_window_matrix_rows (w);
17726
17727 /* Adjust buffer positions in reused rows. */
17728 if (delta || delta_bytes)
17729 increment_matrix_positions (current_matrix,
17730 first_unchanged_at_end_vpos + dvpos,
17731 bottom_vpos, delta, delta_bytes);
17732
17733 /* Adjust Y positions. */
17734 if (dy)
17735 shift_glyph_matrix (w, current_matrix,
17736 first_unchanged_at_end_vpos + dvpos,
17737 bottom_vpos, dy);
17738
17739 if (first_unchanged_at_end_row)
17740 {
17741 first_unchanged_at_end_row += dvpos;
17742 if (first_unchanged_at_end_row->y >= it.last_visible_y
17743 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
17744 first_unchanged_at_end_row = NULL;
17745 }
17746
17747 /* If scrolling up, there may be some lines to display at the end of
17748 the window. */
17749 last_text_row_at_end = NULL;
17750 if (dy < 0)
17751 {
17752 /* Scrolling up can leave for example a partially visible line
17753 at the end of the window to be redisplayed. */
17754 /* Set last_row to the glyph row in the current matrix where the
17755 window end line is found. It has been moved up or down in
17756 the matrix by dvpos. */
17757 int last_vpos = XFASTINT (w->window_end_vpos) + dvpos;
17758 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
17759
17760 /* If last_row is the window end line, it should display text. */
17761 eassert (last_row->displays_text_p);
17762
17763 /* If window end line was partially visible before, begin
17764 displaying at that line. Otherwise begin displaying with the
17765 line following it. */
17766 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
17767 {
17768 init_to_row_start (&it, w, last_row);
17769 it.vpos = last_vpos;
17770 it.current_y = last_row->y;
17771 }
17772 else
17773 {
17774 init_to_row_end (&it, w, last_row);
17775 it.vpos = 1 + last_vpos;
17776 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
17777 ++last_row;
17778 }
17779
17780 /* We may start in a continuation line. If so, we have to
17781 get the right continuation_lines_width and current_x. */
17782 it.continuation_lines_width = last_row->continuation_lines_width;
17783 it.hpos = it.current_x = 0;
17784
17785 /* Display the rest of the lines at the window end. */
17786 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
17787 while (it.current_y < it.last_visible_y
17788 && !fonts_changed_p)
17789 {
17790 /* Is it always sure that the display agrees with lines in
17791 the current matrix? I don't think so, so we mark rows
17792 displayed invalid in the current matrix by setting their
17793 enabled_p flag to zero. */
17794 MATRIX_ROW (w->current_matrix, it.vpos)->enabled_p = 0;
17795 if (display_line (&it))
17796 last_text_row_at_end = it.glyph_row - 1;
17797 }
17798 }
17799
17800 /* Update window_end_pos and window_end_vpos. */
17801 if (first_unchanged_at_end_row
17802 && !last_text_row_at_end)
17803 {
17804 /* Window end line if one of the preserved rows from the current
17805 matrix. Set row to the last row displaying text in current
17806 matrix starting at first_unchanged_at_end_row, after
17807 scrolling. */
17808 eassert (first_unchanged_at_end_row->displays_text_p);
17809 row = find_last_row_displaying_text (w->current_matrix, &it,
17810 first_unchanged_at_end_row);
17811 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
17812
17813 wset_window_end_pos (w, make_number (Z - MATRIX_ROW_END_CHARPOS (row)));
17814 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17815 wset_window_end_vpos
17816 (w, make_number (MATRIX_ROW_VPOS (row, w->current_matrix)));
17817 eassert (w->window_end_bytepos >= 0);
17818 IF_DEBUG (debug_method_add (w, "A"));
17819 }
17820 else if (last_text_row_at_end)
17821 {
17822 wset_window_end_pos
17823 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (last_text_row_at_end)));
17824 w->window_end_bytepos
17825 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_text_row_at_end);
17826 wset_window_end_vpos
17827 (w, make_number (MATRIX_ROW_VPOS (last_text_row_at_end,
17828 desired_matrix)));
17829 eassert (w->window_end_bytepos >= 0);
17830 IF_DEBUG (debug_method_add (w, "B"));
17831 }
17832 else if (last_text_row)
17833 {
17834 /* We have displayed either to the end of the window or at the
17835 end of the window, i.e. the last row with text is to be found
17836 in the desired matrix. */
17837 wset_window_end_pos
17838 (w, make_number (Z - MATRIX_ROW_END_CHARPOS (last_text_row)));
17839 w->window_end_bytepos
17840 = Z_BYTE - MATRIX_ROW_END_BYTEPOS (last_text_row);
17841 wset_window_end_vpos
17842 (w, make_number (MATRIX_ROW_VPOS (last_text_row, desired_matrix)));
17843 eassert (w->window_end_bytepos >= 0);
17844 }
17845 else if (first_unchanged_at_end_row == NULL
17846 && last_text_row == NULL
17847 && last_text_row_at_end == NULL)
17848 {
17849 /* Displayed to end of window, but no line containing text was
17850 displayed. Lines were deleted at the end of the window. */
17851 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
17852 int vpos = XFASTINT (w->window_end_vpos);
17853 struct glyph_row *current_row = current_matrix->rows + vpos;
17854 struct glyph_row *desired_row = desired_matrix->rows + vpos;
17855
17856 for (row = NULL;
17857 row == NULL && vpos >= first_vpos;
17858 --vpos, --current_row, --desired_row)
17859 {
17860 if (desired_row->enabled_p)
17861 {
17862 if (desired_row->displays_text_p)
17863 row = desired_row;
17864 }
17865 else if (current_row->displays_text_p)
17866 row = current_row;
17867 }
17868
17869 eassert (row != NULL);
17870 wset_window_end_vpos (w, make_number (vpos + 1));
17871 wset_window_end_pos (w, make_number (Z - MATRIX_ROW_END_CHARPOS (row)));
17872 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17873 eassert (w->window_end_bytepos >= 0);
17874 IF_DEBUG (debug_method_add (w, "C"));
17875 }
17876 else
17877 emacs_abort ();
17878
17879 IF_DEBUG (debug_end_pos = XFASTINT (w->window_end_pos);
17880 debug_end_vpos = XFASTINT (w->window_end_vpos));
17881
17882 /* Record that display has not been completed. */
17883 wset_window_end_valid (w, Qnil);
17884 w->desired_matrix->no_scrolling_p = 1;
17885 return 3;
17886
17887 #undef GIVE_UP
17888 }
17889
17890
17891 \f
17892 /***********************************************************************
17893 More debugging support
17894 ***********************************************************************/
17895
17896 #ifdef GLYPH_DEBUG
17897
17898 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
17899 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
17900 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
17901
17902
17903 /* Dump the contents of glyph matrix MATRIX on stderr.
17904
17905 GLYPHS 0 means don't show glyph contents.
17906 GLYPHS 1 means show glyphs in short form
17907 GLYPHS > 1 means show glyphs in long form. */
17908
17909 void
17910 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
17911 {
17912 int i;
17913 for (i = 0; i < matrix->nrows; ++i)
17914 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
17915 }
17916
17917
17918 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17919 the glyph row and area where the glyph comes from. */
17920
17921 void
17922 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
17923 {
17924 if (glyph->type == CHAR_GLYPH)
17925 {
17926 fprintf (stderr,
17927 " %5td %4c %6"pI"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17928 glyph - row->glyphs[TEXT_AREA],
17929 'C',
17930 glyph->charpos,
17931 (BUFFERP (glyph->object)
17932 ? 'B'
17933 : (STRINGP (glyph->object)
17934 ? 'S'
17935 : '-')),
17936 glyph->pixel_width,
17937 glyph->u.ch,
17938 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
17939 ? glyph->u.ch
17940 : '.'),
17941 glyph->face_id,
17942 glyph->left_box_line_p,
17943 glyph->right_box_line_p);
17944 }
17945 else if (glyph->type == STRETCH_GLYPH)
17946 {
17947 fprintf (stderr,
17948 " %5td %4c %6"pI"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17949 glyph - row->glyphs[TEXT_AREA],
17950 'S',
17951 glyph->charpos,
17952 (BUFFERP (glyph->object)
17953 ? 'B'
17954 : (STRINGP (glyph->object)
17955 ? 'S'
17956 : '-')),
17957 glyph->pixel_width,
17958 0,
17959 '.',
17960 glyph->face_id,
17961 glyph->left_box_line_p,
17962 glyph->right_box_line_p);
17963 }
17964 else if (glyph->type == IMAGE_GLYPH)
17965 {
17966 fprintf (stderr,
17967 " %5td %4c %6"pI"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17968 glyph - row->glyphs[TEXT_AREA],
17969 'I',
17970 glyph->charpos,
17971 (BUFFERP (glyph->object)
17972 ? 'B'
17973 : (STRINGP (glyph->object)
17974 ? 'S'
17975 : '-')),
17976 glyph->pixel_width,
17977 glyph->u.img_id,
17978 '.',
17979 glyph->face_id,
17980 glyph->left_box_line_p,
17981 glyph->right_box_line_p);
17982 }
17983 else if (glyph->type == COMPOSITE_GLYPH)
17984 {
17985 fprintf (stderr,
17986 " %5td %4c %6"pI"d %c %3d 0x%05x",
17987 glyph - row->glyphs[TEXT_AREA],
17988 '+',
17989 glyph->charpos,
17990 (BUFFERP (glyph->object)
17991 ? 'B'
17992 : (STRINGP (glyph->object)
17993 ? 'S'
17994 : '-')),
17995 glyph->pixel_width,
17996 glyph->u.cmp.id);
17997 if (glyph->u.cmp.automatic)
17998 fprintf (stderr,
17999 "[%d-%d]",
18000 glyph->slice.cmp.from, glyph->slice.cmp.to);
18001 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18002 glyph->face_id,
18003 glyph->left_box_line_p,
18004 glyph->right_box_line_p);
18005 }
18006 }
18007
18008
18009 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18010 GLYPHS 0 means don't show glyph contents.
18011 GLYPHS 1 means show glyphs in short form
18012 GLYPHS > 1 means show glyphs in long form. */
18013
18014 void
18015 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18016 {
18017 if (glyphs != 1)
18018 {
18019 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18020 fprintf (stderr, "======================================================================\n");
18021
18022 fprintf (stderr, "%3d %5"pI"d %5"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18023 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18024 vpos,
18025 MATRIX_ROW_START_CHARPOS (row),
18026 MATRIX_ROW_END_CHARPOS (row),
18027 row->used[TEXT_AREA],
18028 row->contains_overlapping_glyphs_p,
18029 row->enabled_p,
18030 row->truncated_on_left_p,
18031 row->truncated_on_right_p,
18032 row->continued_p,
18033 MATRIX_ROW_CONTINUATION_LINE_P (row),
18034 row->displays_text_p,
18035 row->ends_at_zv_p,
18036 row->fill_line_p,
18037 row->ends_in_middle_of_char_p,
18038 row->starts_in_middle_of_char_p,
18039 row->mouse_face_p,
18040 row->x,
18041 row->y,
18042 row->pixel_width,
18043 row->height,
18044 row->visible_height,
18045 row->ascent,
18046 row->phys_ascent);
18047 fprintf (stderr, "%9"pD"d %5"pD"d\t%5d\n", row->start.overlay_string_index,
18048 row->end.overlay_string_index,
18049 row->continuation_lines_width);
18050 fprintf (stderr, "%9"pI"d %5"pI"d\n",
18051 CHARPOS (row->start.string_pos),
18052 CHARPOS (row->end.string_pos));
18053 fprintf (stderr, "%9d %5d\n", row->start.dpvec_index,
18054 row->end.dpvec_index);
18055 }
18056
18057 if (glyphs > 1)
18058 {
18059 int area;
18060
18061 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18062 {
18063 struct glyph *glyph = row->glyphs[area];
18064 struct glyph *glyph_end = glyph + row->used[area];
18065
18066 /* Glyph for a line end in text. */
18067 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18068 ++glyph_end;
18069
18070 if (glyph < glyph_end)
18071 fprintf (stderr, " Glyph Type Pos O W Code C Face LR\n");
18072
18073 for (; glyph < glyph_end; ++glyph)
18074 dump_glyph (row, glyph, area);
18075 }
18076 }
18077 else if (glyphs == 1)
18078 {
18079 int area;
18080
18081 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18082 {
18083 char *s = alloca (row->used[area] + 1);
18084 int i;
18085
18086 for (i = 0; i < row->used[area]; ++i)
18087 {
18088 struct glyph *glyph = row->glyphs[area] + i;
18089 if (glyph->type == CHAR_GLYPH
18090 && glyph->u.ch < 0x80
18091 && glyph->u.ch >= ' ')
18092 s[i] = glyph->u.ch;
18093 else
18094 s[i] = '.';
18095 }
18096
18097 s[i] = '\0';
18098 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18099 }
18100 }
18101 }
18102
18103
18104 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18105 Sdump_glyph_matrix, 0, 1, "p",
18106 doc: /* Dump the current matrix of the selected window to stderr.
18107 Shows contents of glyph row structures. With non-nil
18108 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18109 glyphs in short form, otherwise show glyphs in long form. */)
18110 (Lisp_Object glyphs)
18111 {
18112 struct window *w = XWINDOW (selected_window);
18113 struct buffer *buffer = XBUFFER (w->buffer);
18114
18115 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18116 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18117 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18118 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18119 fprintf (stderr, "=============================================\n");
18120 dump_glyph_matrix (w->current_matrix,
18121 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18122 return Qnil;
18123 }
18124
18125
18126 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18127 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* */)
18128 (void)
18129 {
18130 struct frame *f = XFRAME (selected_frame);
18131 dump_glyph_matrix (f->current_matrix, 1);
18132 return Qnil;
18133 }
18134
18135
18136 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18137 doc: /* Dump glyph row ROW to stderr.
18138 GLYPH 0 means don't dump glyphs.
18139 GLYPH 1 means dump glyphs in short form.
18140 GLYPH > 1 or omitted means dump glyphs in long form. */)
18141 (Lisp_Object row, Lisp_Object glyphs)
18142 {
18143 struct glyph_matrix *matrix;
18144 EMACS_INT vpos;
18145
18146 CHECK_NUMBER (row);
18147 matrix = XWINDOW (selected_window)->current_matrix;
18148 vpos = XINT (row);
18149 if (vpos >= 0 && vpos < matrix->nrows)
18150 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18151 vpos,
18152 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18153 return Qnil;
18154 }
18155
18156
18157 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18158 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18159 GLYPH 0 means don't dump glyphs.
18160 GLYPH 1 means dump glyphs in short form.
18161 GLYPH > 1 or omitted means dump glyphs in long form. */)
18162 (Lisp_Object row, Lisp_Object glyphs)
18163 {
18164 struct frame *sf = SELECTED_FRAME ();
18165 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18166 EMACS_INT vpos;
18167
18168 CHECK_NUMBER (row);
18169 vpos = XINT (row);
18170 if (vpos >= 0 && vpos < m->nrows)
18171 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18172 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18173 return Qnil;
18174 }
18175
18176
18177 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18178 doc: /* Toggle tracing of redisplay.
18179 With ARG, turn tracing on if and only if ARG is positive. */)
18180 (Lisp_Object arg)
18181 {
18182 if (NILP (arg))
18183 trace_redisplay_p = !trace_redisplay_p;
18184 else
18185 {
18186 arg = Fprefix_numeric_value (arg);
18187 trace_redisplay_p = XINT (arg) > 0;
18188 }
18189
18190 return Qnil;
18191 }
18192
18193
18194 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18195 doc: /* Like `format', but print result to stderr.
18196 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18197 (ptrdiff_t nargs, Lisp_Object *args)
18198 {
18199 Lisp_Object s = Fformat (nargs, args);
18200 fprintf (stderr, "%s", SDATA (s));
18201 return Qnil;
18202 }
18203
18204 #endif /* GLYPH_DEBUG */
18205
18206
18207 \f
18208 /***********************************************************************
18209 Building Desired Matrix Rows
18210 ***********************************************************************/
18211
18212 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18213 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18214
18215 static struct glyph_row *
18216 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18217 {
18218 struct frame *f = XFRAME (WINDOW_FRAME (w));
18219 struct buffer *buffer = XBUFFER (w->buffer);
18220 struct buffer *old = current_buffer;
18221 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18222 int arrow_len = SCHARS (overlay_arrow_string);
18223 const unsigned char *arrow_end = arrow_string + arrow_len;
18224 const unsigned char *p;
18225 struct it it;
18226 int multibyte_p;
18227 int n_glyphs_before;
18228
18229 set_buffer_temp (buffer);
18230 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18231 it.glyph_row->used[TEXT_AREA] = 0;
18232 SET_TEXT_POS (it.position, 0, 0);
18233
18234 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18235 p = arrow_string;
18236 while (p < arrow_end)
18237 {
18238 Lisp_Object face, ilisp;
18239
18240 /* Get the next character. */
18241 if (multibyte_p)
18242 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18243 else
18244 {
18245 it.c = it.char_to_display = *p, it.len = 1;
18246 if (! ASCII_CHAR_P (it.c))
18247 it.char_to_display = BYTE8_TO_CHAR (it.c);
18248 }
18249 p += it.len;
18250
18251 /* Get its face. */
18252 ilisp = make_number (p - arrow_string);
18253 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18254 it.face_id = compute_char_face (f, it.char_to_display, face);
18255
18256 /* Compute its width, get its glyphs. */
18257 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18258 SET_TEXT_POS (it.position, -1, -1);
18259 PRODUCE_GLYPHS (&it);
18260
18261 /* If this character doesn't fit any more in the line, we have
18262 to remove some glyphs. */
18263 if (it.current_x > it.last_visible_x)
18264 {
18265 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18266 break;
18267 }
18268 }
18269
18270 set_buffer_temp (old);
18271 return it.glyph_row;
18272 }
18273
18274
18275 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18276 glyphs to insert is determined by produce_special_glyphs. */
18277
18278 static void
18279 insert_left_trunc_glyphs (struct it *it)
18280 {
18281 struct it truncate_it;
18282 struct glyph *from, *end, *to, *toend;
18283
18284 eassert (!FRAME_WINDOW_P (it->f)
18285 || (!it->glyph_row->reversed_p
18286 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18287 || (it->glyph_row->reversed_p
18288 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18289
18290 /* Get the truncation glyphs. */
18291 truncate_it = *it;
18292 truncate_it.current_x = 0;
18293 truncate_it.face_id = DEFAULT_FACE_ID;
18294 truncate_it.glyph_row = &scratch_glyph_row;
18295 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18296 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18297 truncate_it.object = make_number (0);
18298 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18299
18300 /* Overwrite glyphs from IT with truncation glyphs. */
18301 if (!it->glyph_row->reversed_p)
18302 {
18303 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18304
18305 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18306 end = from + tused;
18307 to = it->glyph_row->glyphs[TEXT_AREA];
18308 toend = to + it->glyph_row->used[TEXT_AREA];
18309 if (FRAME_WINDOW_P (it->f))
18310 {
18311 /* On GUI frames, when variable-size fonts are displayed,
18312 the truncation glyphs may need more pixels than the row's
18313 glyphs they overwrite. We overwrite more glyphs to free
18314 enough screen real estate, and enlarge the stretch glyph
18315 on the right (see display_line), if there is one, to
18316 preserve the screen position of the truncation glyphs on
18317 the right. */
18318 int w = 0;
18319 struct glyph *g = to;
18320 short used;
18321
18322 /* The first glyph could be partially visible, in which case
18323 it->glyph_row->x will be negative. But we want the left
18324 truncation glyphs to be aligned at the left margin of the
18325 window, so we override the x coordinate at which the row
18326 will begin. */
18327 it->glyph_row->x = 0;
18328 while (g < toend && w < it->truncation_pixel_width)
18329 {
18330 w += g->pixel_width;
18331 ++g;
18332 }
18333 if (g - to - tused > 0)
18334 {
18335 memmove (to + tused, g, (toend - g) * sizeof(*g));
18336 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
18337 }
18338 used = it->glyph_row->used[TEXT_AREA];
18339 if (it->glyph_row->truncated_on_right_p
18340 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
18341 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
18342 == STRETCH_GLYPH)
18343 {
18344 int extra = w - it->truncation_pixel_width;
18345
18346 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
18347 }
18348 }
18349
18350 while (from < end)
18351 *to++ = *from++;
18352
18353 /* There may be padding glyphs left over. Overwrite them too. */
18354 if (!FRAME_WINDOW_P (it->f))
18355 {
18356 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
18357 {
18358 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18359 while (from < end)
18360 *to++ = *from++;
18361 }
18362 }
18363
18364 if (to > toend)
18365 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
18366 }
18367 else
18368 {
18369 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18370
18371 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18372 that back to front. */
18373 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
18374 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
18375 toend = it->glyph_row->glyphs[TEXT_AREA];
18376 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
18377 if (FRAME_WINDOW_P (it->f))
18378 {
18379 int w = 0;
18380 struct glyph *g = to;
18381
18382 while (g >= toend && w < it->truncation_pixel_width)
18383 {
18384 w += g->pixel_width;
18385 --g;
18386 }
18387 if (to - g - tused > 0)
18388 to = g + tused;
18389 if (it->glyph_row->truncated_on_right_p
18390 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
18391 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
18392 {
18393 int extra = w - it->truncation_pixel_width;
18394
18395 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
18396 }
18397 }
18398
18399 while (from >= end && to >= toend)
18400 *to-- = *from--;
18401 if (!FRAME_WINDOW_P (it->f))
18402 {
18403 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
18404 {
18405 from =
18406 truncate_it.glyph_row->glyphs[TEXT_AREA]
18407 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
18408 while (from >= end && to >= toend)
18409 *to-- = *from--;
18410 }
18411 }
18412 if (from >= end)
18413 {
18414 /* Need to free some room before prepending additional
18415 glyphs. */
18416 int move_by = from - end + 1;
18417 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
18418 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
18419
18420 for ( ; g >= g0; g--)
18421 g[move_by] = *g;
18422 while (from >= end)
18423 *to-- = *from--;
18424 it->glyph_row->used[TEXT_AREA] += move_by;
18425 }
18426 }
18427 }
18428
18429 /* Compute the hash code for ROW. */
18430 unsigned
18431 row_hash (struct glyph_row *row)
18432 {
18433 int area, k;
18434 unsigned hashval = 0;
18435
18436 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18437 for (k = 0; k < row->used[area]; ++k)
18438 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
18439 + row->glyphs[area][k].u.val
18440 + row->glyphs[area][k].face_id
18441 + row->glyphs[area][k].padding_p
18442 + (row->glyphs[area][k].type << 2));
18443
18444 return hashval;
18445 }
18446
18447 /* Compute the pixel height and width of IT->glyph_row.
18448
18449 Most of the time, ascent and height of a display line will be equal
18450 to the max_ascent and max_height values of the display iterator
18451 structure. This is not the case if
18452
18453 1. We hit ZV without displaying anything. In this case, max_ascent
18454 and max_height will be zero.
18455
18456 2. We have some glyphs that don't contribute to the line height.
18457 (The glyph row flag contributes_to_line_height_p is for future
18458 pixmap extensions).
18459
18460 The first case is easily covered by using default values because in
18461 these cases, the line height does not really matter, except that it
18462 must not be zero. */
18463
18464 static void
18465 compute_line_metrics (struct it *it)
18466 {
18467 struct glyph_row *row = it->glyph_row;
18468
18469 if (FRAME_WINDOW_P (it->f))
18470 {
18471 int i, min_y, max_y;
18472
18473 /* The line may consist of one space only, that was added to
18474 place the cursor on it. If so, the row's height hasn't been
18475 computed yet. */
18476 if (row->height == 0)
18477 {
18478 if (it->max_ascent + it->max_descent == 0)
18479 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
18480 row->ascent = it->max_ascent;
18481 row->height = it->max_ascent + it->max_descent;
18482 row->phys_ascent = it->max_phys_ascent;
18483 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
18484 row->extra_line_spacing = it->max_extra_line_spacing;
18485 }
18486
18487 /* Compute the width of this line. */
18488 row->pixel_width = row->x;
18489 for (i = 0; i < row->used[TEXT_AREA]; ++i)
18490 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
18491
18492 eassert (row->pixel_width >= 0);
18493 eassert (row->ascent >= 0 && row->height > 0);
18494
18495 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
18496 || MATRIX_ROW_OVERLAPS_PRED_P (row));
18497
18498 /* If first line's physical ascent is larger than its logical
18499 ascent, use the physical ascent, and make the row taller.
18500 This makes accented characters fully visible. */
18501 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
18502 && row->phys_ascent > row->ascent)
18503 {
18504 row->height += row->phys_ascent - row->ascent;
18505 row->ascent = row->phys_ascent;
18506 }
18507
18508 /* Compute how much of the line is visible. */
18509 row->visible_height = row->height;
18510
18511 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
18512 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
18513
18514 if (row->y < min_y)
18515 row->visible_height -= min_y - row->y;
18516 if (row->y + row->height > max_y)
18517 row->visible_height -= row->y + row->height - max_y;
18518 }
18519 else
18520 {
18521 row->pixel_width = row->used[TEXT_AREA];
18522 if (row->continued_p)
18523 row->pixel_width -= it->continuation_pixel_width;
18524 else if (row->truncated_on_right_p)
18525 row->pixel_width -= it->truncation_pixel_width;
18526 row->ascent = row->phys_ascent = 0;
18527 row->height = row->phys_height = row->visible_height = 1;
18528 row->extra_line_spacing = 0;
18529 }
18530
18531 /* Compute a hash code for this row. */
18532 row->hash = row_hash (row);
18533
18534 it->max_ascent = it->max_descent = 0;
18535 it->max_phys_ascent = it->max_phys_descent = 0;
18536 }
18537
18538
18539 /* Append one space to the glyph row of iterator IT if doing a
18540 window-based redisplay. The space has the same face as
18541 IT->face_id. Value is non-zero if a space was added.
18542
18543 This function is called to make sure that there is always one glyph
18544 at the end of a glyph row that the cursor can be set on under
18545 window-systems. (If there weren't such a glyph we would not know
18546 how wide and tall a box cursor should be displayed).
18547
18548 At the same time this space let's a nicely handle clearing to the
18549 end of the line if the row ends in italic text. */
18550
18551 static int
18552 append_space_for_newline (struct it *it, int default_face_p)
18553 {
18554 if (FRAME_WINDOW_P (it->f))
18555 {
18556 int n = it->glyph_row->used[TEXT_AREA];
18557
18558 if (it->glyph_row->glyphs[TEXT_AREA] + n
18559 < it->glyph_row->glyphs[1 + TEXT_AREA])
18560 {
18561 /* Save some values that must not be changed.
18562 Must save IT->c and IT->len because otherwise
18563 ITERATOR_AT_END_P wouldn't work anymore after
18564 append_space_for_newline has been called. */
18565 enum display_element_type saved_what = it->what;
18566 int saved_c = it->c, saved_len = it->len;
18567 int saved_char_to_display = it->char_to_display;
18568 int saved_x = it->current_x;
18569 int saved_face_id = it->face_id;
18570 struct text_pos saved_pos;
18571 Lisp_Object saved_object;
18572 struct face *face;
18573
18574 saved_object = it->object;
18575 saved_pos = it->position;
18576
18577 it->what = IT_CHARACTER;
18578 memset (&it->position, 0, sizeof it->position);
18579 it->object = make_number (0);
18580 it->c = it->char_to_display = ' ';
18581 it->len = 1;
18582
18583 /* If the default face was remapped, be sure to use the
18584 remapped face for the appended newline. */
18585 if (default_face_p)
18586 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
18587 else if (it->face_before_selective_p)
18588 it->face_id = it->saved_face_id;
18589 face = FACE_FROM_ID (it->f, it->face_id);
18590 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
18591
18592 PRODUCE_GLYPHS (it);
18593
18594 it->override_ascent = -1;
18595 it->constrain_row_ascent_descent_p = 0;
18596 it->current_x = saved_x;
18597 it->object = saved_object;
18598 it->position = saved_pos;
18599 it->what = saved_what;
18600 it->face_id = saved_face_id;
18601 it->len = saved_len;
18602 it->c = saved_c;
18603 it->char_to_display = saved_char_to_display;
18604 return 1;
18605 }
18606 }
18607
18608 return 0;
18609 }
18610
18611
18612 /* Extend the face of the last glyph in the text area of IT->glyph_row
18613 to the end of the display line. Called from display_line. If the
18614 glyph row is empty, add a space glyph to it so that we know the
18615 face to draw. Set the glyph row flag fill_line_p. If the glyph
18616 row is R2L, prepend a stretch glyph to cover the empty space to the
18617 left of the leftmost glyph. */
18618
18619 static void
18620 extend_face_to_end_of_line (struct it *it)
18621 {
18622 struct face *face, *default_face;
18623 struct frame *f = it->f;
18624
18625 /* If line is already filled, do nothing. Non window-system frames
18626 get a grace of one more ``pixel'' because their characters are
18627 1-``pixel'' wide, so they hit the equality too early. This grace
18628 is needed only for R2L rows that are not continued, to produce
18629 one extra blank where we could display the cursor. */
18630 if (it->current_x >= it->last_visible_x
18631 + (!FRAME_WINDOW_P (f)
18632 && it->glyph_row->reversed_p
18633 && !it->glyph_row->continued_p))
18634 return;
18635
18636 /* The default face, possibly remapped. */
18637 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
18638
18639 /* Face extension extends the background and box of IT->face_id
18640 to the end of the line. If the background equals the background
18641 of the frame, we don't have to do anything. */
18642 if (it->face_before_selective_p)
18643 face = FACE_FROM_ID (f, it->saved_face_id);
18644 else
18645 face = FACE_FROM_ID (f, it->face_id);
18646
18647 if (FRAME_WINDOW_P (f)
18648 && it->glyph_row->displays_text_p
18649 && face->box == FACE_NO_BOX
18650 && face->background == FRAME_BACKGROUND_PIXEL (f)
18651 && !face->stipple
18652 && !it->glyph_row->reversed_p)
18653 return;
18654
18655 /* Set the glyph row flag indicating that the face of the last glyph
18656 in the text area has to be drawn to the end of the text area. */
18657 it->glyph_row->fill_line_p = 1;
18658
18659 /* If current character of IT is not ASCII, make sure we have the
18660 ASCII face. This will be automatically undone the next time
18661 get_next_display_element returns a multibyte character. Note
18662 that the character will always be single byte in unibyte
18663 text. */
18664 if (!ASCII_CHAR_P (it->c))
18665 {
18666 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
18667 }
18668
18669 if (FRAME_WINDOW_P (f))
18670 {
18671 /* If the row is empty, add a space with the current face of IT,
18672 so that we know which face to draw. */
18673 if (it->glyph_row->used[TEXT_AREA] == 0)
18674 {
18675 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
18676 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
18677 it->glyph_row->used[TEXT_AREA] = 1;
18678 }
18679 #ifdef HAVE_WINDOW_SYSTEM
18680 if (it->glyph_row->reversed_p)
18681 {
18682 /* Prepend a stretch glyph to the row, such that the
18683 rightmost glyph will be drawn flushed all the way to the
18684 right margin of the window. The stretch glyph that will
18685 occupy the empty space, if any, to the left of the
18686 glyphs. */
18687 struct font *font = face->font ? face->font : FRAME_FONT (f);
18688 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
18689 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
18690 struct glyph *g;
18691 int row_width, stretch_ascent, stretch_width;
18692 struct text_pos saved_pos;
18693 int saved_face_id, saved_avoid_cursor;
18694
18695 for (row_width = 0, g = row_start; g < row_end; g++)
18696 row_width += g->pixel_width;
18697 stretch_width = window_box_width (it->w, TEXT_AREA) - row_width;
18698 if (stretch_width > 0)
18699 {
18700 stretch_ascent =
18701 (((it->ascent + it->descent)
18702 * FONT_BASE (font)) / FONT_HEIGHT (font));
18703 saved_pos = it->position;
18704 memset (&it->position, 0, sizeof it->position);
18705 saved_avoid_cursor = it->avoid_cursor_p;
18706 it->avoid_cursor_p = 1;
18707 saved_face_id = it->face_id;
18708 /* The last row's stretch glyph should get the default
18709 face, to avoid painting the rest of the window with
18710 the region face, if the region ends at ZV. */
18711 if (it->glyph_row->ends_at_zv_p)
18712 it->face_id = default_face->id;
18713 else
18714 it->face_id = face->id;
18715 append_stretch_glyph (it, make_number (0), stretch_width,
18716 it->ascent + it->descent, stretch_ascent);
18717 it->position = saved_pos;
18718 it->avoid_cursor_p = saved_avoid_cursor;
18719 it->face_id = saved_face_id;
18720 }
18721 }
18722 #endif /* HAVE_WINDOW_SYSTEM */
18723 }
18724 else
18725 {
18726 /* Save some values that must not be changed. */
18727 int saved_x = it->current_x;
18728 struct text_pos saved_pos;
18729 Lisp_Object saved_object;
18730 enum display_element_type saved_what = it->what;
18731 int saved_face_id = it->face_id;
18732
18733 saved_object = it->object;
18734 saved_pos = it->position;
18735
18736 it->what = IT_CHARACTER;
18737 memset (&it->position, 0, sizeof it->position);
18738 it->object = make_number (0);
18739 it->c = it->char_to_display = ' ';
18740 it->len = 1;
18741 /* The last row's blank glyphs should get the default face, to
18742 avoid painting the rest of the window with the region face,
18743 if the region ends at ZV. */
18744 if (it->glyph_row->ends_at_zv_p)
18745 it->face_id = default_face->id;
18746 else
18747 it->face_id = face->id;
18748
18749 PRODUCE_GLYPHS (it);
18750
18751 while (it->current_x <= it->last_visible_x)
18752 PRODUCE_GLYPHS (it);
18753
18754 /* Don't count these blanks really. It would let us insert a left
18755 truncation glyph below and make us set the cursor on them, maybe. */
18756 it->current_x = saved_x;
18757 it->object = saved_object;
18758 it->position = saved_pos;
18759 it->what = saved_what;
18760 it->face_id = saved_face_id;
18761 }
18762 }
18763
18764
18765 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18766 trailing whitespace. */
18767
18768 static int
18769 trailing_whitespace_p (ptrdiff_t charpos)
18770 {
18771 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
18772 int c = 0;
18773
18774 while (bytepos < ZV_BYTE
18775 && (c = FETCH_CHAR (bytepos),
18776 c == ' ' || c == '\t'))
18777 ++bytepos;
18778
18779 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
18780 {
18781 if (bytepos != PT_BYTE)
18782 return 1;
18783 }
18784 return 0;
18785 }
18786
18787
18788 /* Highlight trailing whitespace, if any, in ROW. */
18789
18790 static void
18791 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
18792 {
18793 int used = row->used[TEXT_AREA];
18794
18795 if (used)
18796 {
18797 struct glyph *start = row->glyphs[TEXT_AREA];
18798 struct glyph *glyph = start + used - 1;
18799
18800 if (row->reversed_p)
18801 {
18802 /* Right-to-left rows need to be processed in the opposite
18803 direction, so swap the edge pointers. */
18804 glyph = start;
18805 start = row->glyphs[TEXT_AREA] + used - 1;
18806 }
18807
18808 /* Skip over glyphs inserted to display the cursor at the
18809 end of a line, for extending the face of the last glyph
18810 to the end of the line on terminals, and for truncation
18811 and continuation glyphs. */
18812 if (!row->reversed_p)
18813 {
18814 while (glyph >= start
18815 && glyph->type == CHAR_GLYPH
18816 && INTEGERP (glyph->object))
18817 --glyph;
18818 }
18819 else
18820 {
18821 while (glyph <= start
18822 && glyph->type == CHAR_GLYPH
18823 && INTEGERP (glyph->object))
18824 ++glyph;
18825 }
18826
18827 /* If last glyph is a space or stretch, and it's trailing
18828 whitespace, set the face of all trailing whitespace glyphs in
18829 IT->glyph_row to `trailing-whitespace'. */
18830 if ((row->reversed_p ? glyph <= start : glyph >= start)
18831 && BUFFERP (glyph->object)
18832 && (glyph->type == STRETCH_GLYPH
18833 || (glyph->type == CHAR_GLYPH
18834 && glyph->u.ch == ' '))
18835 && trailing_whitespace_p (glyph->charpos))
18836 {
18837 int face_id = lookup_named_face (f, Qtrailing_whitespace, 0);
18838 if (face_id < 0)
18839 return;
18840
18841 if (!row->reversed_p)
18842 {
18843 while (glyph >= start
18844 && BUFFERP (glyph->object)
18845 && (glyph->type == STRETCH_GLYPH
18846 || (glyph->type == CHAR_GLYPH
18847 && glyph->u.ch == ' ')))
18848 (glyph--)->face_id = face_id;
18849 }
18850 else
18851 {
18852 while (glyph <= start
18853 && BUFFERP (glyph->object)
18854 && (glyph->type == STRETCH_GLYPH
18855 || (glyph->type == CHAR_GLYPH
18856 && glyph->u.ch == ' ')))
18857 (glyph++)->face_id = face_id;
18858 }
18859 }
18860 }
18861 }
18862
18863
18864 /* Value is non-zero if glyph row ROW should be
18865 used to hold the cursor. */
18866
18867 static int
18868 cursor_row_p (struct glyph_row *row)
18869 {
18870 int result = 1;
18871
18872 if (PT == CHARPOS (row->end.pos)
18873 || PT == MATRIX_ROW_END_CHARPOS (row))
18874 {
18875 /* Suppose the row ends on a string.
18876 Unless the row is continued, that means it ends on a newline
18877 in the string. If it's anything other than a display string
18878 (e.g., a before-string from an overlay), we don't want the
18879 cursor there. (This heuristic seems to give the optimal
18880 behavior for the various types of multi-line strings.)
18881 One exception: if the string has `cursor' property on one of
18882 its characters, we _do_ want the cursor there. */
18883 if (CHARPOS (row->end.string_pos) >= 0)
18884 {
18885 if (row->continued_p)
18886 result = 1;
18887 else
18888 {
18889 /* Check for `display' property. */
18890 struct glyph *beg = row->glyphs[TEXT_AREA];
18891 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
18892 struct glyph *glyph;
18893
18894 result = 0;
18895 for (glyph = end; glyph >= beg; --glyph)
18896 if (STRINGP (glyph->object))
18897 {
18898 Lisp_Object prop
18899 = Fget_char_property (make_number (PT),
18900 Qdisplay, Qnil);
18901 result =
18902 (!NILP (prop)
18903 && display_prop_string_p (prop, glyph->object));
18904 /* If there's a `cursor' property on one of the
18905 string's characters, this row is a cursor row,
18906 even though this is not a display string. */
18907 if (!result)
18908 {
18909 Lisp_Object s = glyph->object;
18910
18911 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
18912 {
18913 ptrdiff_t gpos = glyph->charpos;
18914
18915 if (!NILP (Fget_char_property (make_number (gpos),
18916 Qcursor, s)))
18917 {
18918 result = 1;
18919 break;
18920 }
18921 }
18922 }
18923 break;
18924 }
18925 }
18926 }
18927 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
18928 {
18929 /* If the row ends in middle of a real character,
18930 and the line is continued, we want the cursor here.
18931 That's because CHARPOS (ROW->end.pos) would equal
18932 PT if PT is before the character. */
18933 if (!row->ends_in_ellipsis_p)
18934 result = row->continued_p;
18935 else
18936 /* If the row ends in an ellipsis, then
18937 CHARPOS (ROW->end.pos) will equal point after the
18938 invisible text. We want that position to be displayed
18939 after the ellipsis. */
18940 result = 0;
18941 }
18942 /* If the row ends at ZV, display the cursor at the end of that
18943 row instead of at the start of the row below. */
18944 else if (row->ends_at_zv_p)
18945 result = 1;
18946 else
18947 result = 0;
18948 }
18949
18950 return result;
18951 }
18952
18953 \f
18954
18955 /* Push the property PROP so that it will be rendered at the current
18956 position in IT. Return 1 if PROP was successfully pushed, 0
18957 otherwise. Called from handle_line_prefix to handle the
18958 `line-prefix' and `wrap-prefix' properties. */
18959
18960 static int
18961 push_prefix_prop (struct it *it, Lisp_Object prop)
18962 {
18963 struct text_pos pos =
18964 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
18965
18966 eassert (it->method == GET_FROM_BUFFER
18967 || it->method == GET_FROM_DISPLAY_VECTOR
18968 || it->method == GET_FROM_STRING);
18969
18970 /* We need to save the current buffer/string position, so it will be
18971 restored by pop_it, because iterate_out_of_display_property
18972 depends on that being set correctly, but some situations leave
18973 it->position not yet set when this function is called. */
18974 push_it (it, &pos);
18975
18976 if (STRINGP (prop))
18977 {
18978 if (SCHARS (prop) == 0)
18979 {
18980 pop_it (it);
18981 return 0;
18982 }
18983
18984 it->string = prop;
18985 it->string_from_prefix_prop_p = 1;
18986 it->multibyte_p = STRING_MULTIBYTE (it->string);
18987 it->current.overlay_string_index = -1;
18988 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
18989 it->end_charpos = it->string_nchars = SCHARS (it->string);
18990 it->method = GET_FROM_STRING;
18991 it->stop_charpos = 0;
18992 it->prev_stop = 0;
18993 it->base_level_stop = 0;
18994
18995 /* Force paragraph direction to be that of the parent
18996 buffer/string. */
18997 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
18998 it->paragraph_embedding = it->bidi_it.paragraph_dir;
18999 else
19000 it->paragraph_embedding = L2R;
19001
19002 /* Set up the bidi iterator for this display string. */
19003 if (it->bidi_p)
19004 {
19005 it->bidi_it.string.lstring = it->string;
19006 it->bidi_it.string.s = NULL;
19007 it->bidi_it.string.schars = it->end_charpos;
19008 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19009 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19010 it->bidi_it.string.unibyte = !it->multibyte_p;
19011 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19012 }
19013 }
19014 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19015 {
19016 it->method = GET_FROM_STRETCH;
19017 it->object = prop;
19018 }
19019 #ifdef HAVE_WINDOW_SYSTEM
19020 else if (IMAGEP (prop))
19021 {
19022 it->what = IT_IMAGE;
19023 it->image_id = lookup_image (it->f, prop);
19024 it->method = GET_FROM_IMAGE;
19025 }
19026 #endif /* HAVE_WINDOW_SYSTEM */
19027 else
19028 {
19029 pop_it (it); /* bogus display property, give up */
19030 return 0;
19031 }
19032
19033 return 1;
19034 }
19035
19036 /* Return the character-property PROP at the current position in IT. */
19037
19038 static Lisp_Object
19039 get_it_property (struct it *it, Lisp_Object prop)
19040 {
19041 Lisp_Object position;
19042
19043 if (STRINGP (it->object))
19044 position = make_number (IT_STRING_CHARPOS (*it));
19045 else if (BUFFERP (it->object))
19046 position = make_number (IT_CHARPOS (*it));
19047 else
19048 return Qnil;
19049
19050 return Fget_char_property (position, prop, it->object);
19051 }
19052
19053 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19054
19055 static void
19056 handle_line_prefix (struct it *it)
19057 {
19058 Lisp_Object prefix;
19059
19060 if (it->continuation_lines_width > 0)
19061 {
19062 prefix = get_it_property (it, Qwrap_prefix);
19063 if (NILP (prefix))
19064 prefix = Vwrap_prefix;
19065 }
19066 else
19067 {
19068 prefix = get_it_property (it, Qline_prefix);
19069 if (NILP (prefix))
19070 prefix = Vline_prefix;
19071 }
19072 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19073 {
19074 /* If the prefix is wider than the window, and we try to wrap
19075 it, it would acquire its own wrap prefix, and so on till the
19076 iterator stack overflows. So, don't wrap the prefix. */
19077 it->line_wrap = TRUNCATE;
19078 it->avoid_cursor_p = 1;
19079 }
19080 }
19081
19082 \f
19083
19084 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19085 only for R2L lines from display_line and display_string, when they
19086 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19087 the line/string needs to be continued on the next glyph row. */
19088 static void
19089 unproduce_glyphs (struct it *it, int n)
19090 {
19091 struct glyph *glyph, *end;
19092
19093 eassert (it->glyph_row);
19094 eassert (it->glyph_row->reversed_p);
19095 eassert (it->area == TEXT_AREA);
19096 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19097
19098 if (n > it->glyph_row->used[TEXT_AREA])
19099 n = it->glyph_row->used[TEXT_AREA];
19100 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19101 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19102 for ( ; glyph < end; glyph++)
19103 glyph[-n] = *glyph;
19104 }
19105
19106 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19107 and ROW->maxpos. */
19108 static void
19109 find_row_edges (struct it *it, struct glyph_row *row,
19110 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19111 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19112 {
19113 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19114 lines' rows is implemented for bidi-reordered rows. */
19115
19116 /* ROW->minpos is the value of min_pos, the minimal buffer position
19117 we have in ROW, or ROW->start.pos if that is smaller. */
19118 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19119 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19120 else
19121 /* We didn't find buffer positions smaller than ROW->start, or
19122 didn't find _any_ valid buffer positions in any of the glyphs,
19123 so we must trust the iterator's computed positions. */
19124 row->minpos = row->start.pos;
19125 if (max_pos <= 0)
19126 {
19127 max_pos = CHARPOS (it->current.pos);
19128 max_bpos = BYTEPOS (it->current.pos);
19129 }
19130
19131 /* Here are the various use-cases for ending the row, and the
19132 corresponding values for ROW->maxpos:
19133
19134 Line ends in a newline from buffer eol_pos + 1
19135 Line is continued from buffer max_pos + 1
19136 Line is truncated on right it->current.pos
19137 Line ends in a newline from string max_pos + 1(*)
19138 (*) + 1 only when line ends in a forward scan
19139 Line is continued from string max_pos
19140 Line is continued from display vector max_pos
19141 Line is entirely from a string min_pos == max_pos
19142 Line is entirely from a display vector min_pos == max_pos
19143 Line that ends at ZV ZV
19144
19145 If you discover other use-cases, please add them here as
19146 appropriate. */
19147 if (row->ends_at_zv_p)
19148 row->maxpos = it->current.pos;
19149 else if (row->used[TEXT_AREA])
19150 {
19151 int seen_this_string = 0;
19152 struct glyph_row *r1 = row - 1;
19153
19154 /* Did we see the same display string on the previous row? */
19155 if (STRINGP (it->object)
19156 /* this is not the first row */
19157 && row > it->w->desired_matrix->rows
19158 /* previous row is not the header line */
19159 && !r1->mode_line_p
19160 /* previous row also ends in a newline from a string */
19161 && r1->ends_in_newline_from_string_p)
19162 {
19163 struct glyph *start, *end;
19164
19165 /* Search for the last glyph of the previous row that came
19166 from buffer or string. Depending on whether the row is
19167 L2R or R2L, we need to process it front to back or the
19168 other way round. */
19169 if (!r1->reversed_p)
19170 {
19171 start = r1->glyphs[TEXT_AREA];
19172 end = start + r1->used[TEXT_AREA];
19173 /* Glyphs inserted by redisplay have an integer (zero)
19174 as their object. */
19175 while (end > start
19176 && INTEGERP ((end - 1)->object)
19177 && (end - 1)->charpos <= 0)
19178 --end;
19179 if (end > start)
19180 {
19181 if (EQ ((end - 1)->object, it->object))
19182 seen_this_string = 1;
19183 }
19184 else
19185 /* If all the glyphs of the previous row were inserted
19186 by redisplay, it means the previous row was
19187 produced from a single newline, which is only
19188 possible if that newline came from the same string
19189 as the one which produced this ROW. */
19190 seen_this_string = 1;
19191 }
19192 else
19193 {
19194 end = r1->glyphs[TEXT_AREA] - 1;
19195 start = end + r1->used[TEXT_AREA];
19196 while (end < start
19197 && INTEGERP ((end + 1)->object)
19198 && (end + 1)->charpos <= 0)
19199 ++end;
19200 if (end < start)
19201 {
19202 if (EQ ((end + 1)->object, it->object))
19203 seen_this_string = 1;
19204 }
19205 else
19206 seen_this_string = 1;
19207 }
19208 }
19209 /* Take note of each display string that covers a newline only
19210 once, the first time we see it. This is for when a display
19211 string includes more than one newline in it. */
19212 if (row->ends_in_newline_from_string_p && !seen_this_string)
19213 {
19214 /* If we were scanning the buffer forward when we displayed
19215 the string, we want to account for at least one buffer
19216 position that belongs to this row (position covered by
19217 the display string), so that cursor positioning will
19218 consider this row as a candidate when point is at the end
19219 of the visual line represented by this row. This is not
19220 required when scanning back, because max_pos will already
19221 have a much larger value. */
19222 if (CHARPOS (row->end.pos) > max_pos)
19223 INC_BOTH (max_pos, max_bpos);
19224 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19225 }
19226 else if (CHARPOS (it->eol_pos) > 0)
19227 SET_TEXT_POS (row->maxpos,
19228 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
19229 else if (row->continued_p)
19230 {
19231 /* If max_pos is different from IT's current position, it
19232 means IT->method does not belong to the display element
19233 at max_pos. However, it also means that the display
19234 element at max_pos was displayed in its entirety on this
19235 line, which is equivalent to saying that the next line
19236 starts at the next buffer position. */
19237 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
19238 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19239 else
19240 {
19241 INC_BOTH (max_pos, max_bpos);
19242 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19243 }
19244 }
19245 else if (row->truncated_on_right_p)
19246 /* display_line already called reseat_at_next_visible_line_start,
19247 which puts the iterator at the beginning of the next line, in
19248 the logical order. */
19249 row->maxpos = it->current.pos;
19250 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
19251 /* A line that is entirely from a string/image/stretch... */
19252 row->maxpos = row->minpos;
19253 else
19254 emacs_abort ();
19255 }
19256 else
19257 row->maxpos = it->current.pos;
19258 }
19259
19260 /* Construct the glyph row IT->glyph_row in the desired matrix of
19261 IT->w from text at the current position of IT. See dispextern.h
19262 for an overview of struct it. Value is non-zero if
19263 IT->glyph_row displays text, as opposed to a line displaying ZV
19264 only. */
19265
19266 static int
19267 display_line (struct it *it)
19268 {
19269 struct glyph_row *row = it->glyph_row;
19270 Lisp_Object overlay_arrow_string;
19271 struct it wrap_it;
19272 void *wrap_data = NULL;
19273 int may_wrap = 0, wrap_x IF_LINT (= 0);
19274 int wrap_row_used = -1;
19275 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
19276 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
19277 int wrap_row_extra_line_spacing IF_LINT (= 0);
19278 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
19279 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
19280 int cvpos;
19281 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
19282 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
19283
19284 /* We always start displaying at hpos zero even if hscrolled. */
19285 eassert (it->hpos == 0 && it->current_x == 0);
19286
19287 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
19288 >= it->w->desired_matrix->nrows)
19289 {
19290 it->w->nrows_scale_factor++;
19291 fonts_changed_p = 1;
19292 return 0;
19293 }
19294
19295 /* Is IT->w showing the region? */
19296 wset_region_showing (it->w, it->region_beg_charpos > 0 ? Qt : Qnil);
19297
19298 /* Clear the result glyph row and enable it. */
19299 prepare_desired_row (row);
19300
19301 row->y = it->current_y;
19302 row->start = it->start;
19303 row->continuation_lines_width = it->continuation_lines_width;
19304 row->displays_text_p = 1;
19305 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
19306 it->starts_in_middle_of_char_p = 0;
19307
19308 /* Arrange the overlays nicely for our purposes. Usually, we call
19309 display_line on only one line at a time, in which case this
19310 can't really hurt too much, or we call it on lines which appear
19311 one after another in the buffer, in which case all calls to
19312 recenter_overlay_lists but the first will be pretty cheap. */
19313 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
19314
19315 /* Move over display elements that are not visible because we are
19316 hscrolled. This may stop at an x-position < IT->first_visible_x
19317 if the first glyph is partially visible or if we hit a line end. */
19318 if (it->current_x < it->first_visible_x)
19319 {
19320 enum move_it_result move_result;
19321
19322 this_line_min_pos = row->start.pos;
19323 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
19324 MOVE_TO_POS | MOVE_TO_X);
19325 /* If we are under a large hscroll, move_it_in_display_line_to
19326 could hit the end of the line without reaching
19327 it->first_visible_x. Pretend that we did reach it. This is
19328 especially important on a TTY, where we will call
19329 extend_face_to_end_of_line, which needs to know how many
19330 blank glyphs to produce. */
19331 if (it->current_x < it->first_visible_x
19332 && (move_result == MOVE_NEWLINE_OR_CR
19333 || move_result == MOVE_POS_MATCH_OR_ZV))
19334 it->current_x = it->first_visible_x;
19335
19336 /* Record the smallest positions seen while we moved over
19337 display elements that are not visible. This is needed by
19338 redisplay_internal for optimizing the case where the cursor
19339 stays inside the same line. The rest of this function only
19340 considers positions that are actually displayed, so
19341 RECORD_MAX_MIN_POS will not otherwise record positions that
19342 are hscrolled to the left of the left edge of the window. */
19343 min_pos = CHARPOS (this_line_min_pos);
19344 min_bpos = BYTEPOS (this_line_min_pos);
19345 }
19346 else
19347 {
19348 /* We only do this when not calling `move_it_in_display_line_to'
19349 above, because move_it_in_display_line_to calls
19350 handle_line_prefix itself. */
19351 handle_line_prefix (it);
19352 }
19353
19354 /* Get the initial row height. This is either the height of the
19355 text hscrolled, if there is any, or zero. */
19356 row->ascent = it->max_ascent;
19357 row->height = it->max_ascent + it->max_descent;
19358 row->phys_ascent = it->max_phys_ascent;
19359 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19360 row->extra_line_spacing = it->max_extra_line_spacing;
19361
19362 /* Utility macro to record max and min buffer positions seen until now. */
19363 #define RECORD_MAX_MIN_POS(IT) \
19364 do \
19365 { \
19366 int composition_p = !STRINGP ((IT)->string) \
19367 && ((IT)->what == IT_COMPOSITION); \
19368 ptrdiff_t current_pos = \
19369 composition_p ? (IT)->cmp_it.charpos \
19370 : IT_CHARPOS (*(IT)); \
19371 ptrdiff_t current_bpos = \
19372 composition_p ? CHAR_TO_BYTE (current_pos) \
19373 : IT_BYTEPOS (*(IT)); \
19374 if (current_pos < min_pos) \
19375 { \
19376 min_pos = current_pos; \
19377 min_bpos = current_bpos; \
19378 } \
19379 if (IT_CHARPOS (*it) > max_pos) \
19380 { \
19381 max_pos = IT_CHARPOS (*it); \
19382 max_bpos = IT_BYTEPOS (*it); \
19383 } \
19384 } \
19385 while (0)
19386
19387 /* Loop generating characters. The loop is left with IT on the next
19388 character to display. */
19389 while (1)
19390 {
19391 int n_glyphs_before, hpos_before, x_before;
19392 int x, nglyphs;
19393 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
19394
19395 /* Retrieve the next thing to display. Value is zero if end of
19396 buffer reached. */
19397 if (!get_next_display_element (it))
19398 {
19399 /* Maybe add a space at the end of this line that is used to
19400 display the cursor there under X. Set the charpos of the
19401 first glyph of blank lines not corresponding to any text
19402 to -1. */
19403 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
19404 row->exact_window_width_line_p = 1;
19405 else if ((append_space_for_newline (it, 1) && row->used[TEXT_AREA] == 1)
19406 || row->used[TEXT_AREA] == 0)
19407 {
19408 row->glyphs[TEXT_AREA]->charpos = -1;
19409 row->displays_text_p = 0;
19410
19411 if (!NILP (BVAR (XBUFFER (it->w->buffer), indicate_empty_lines))
19412 && (!MINI_WINDOW_P (it->w)
19413 || (minibuf_level && EQ (it->window, minibuf_window))))
19414 row->indicate_empty_line_p = 1;
19415 }
19416
19417 it->continuation_lines_width = 0;
19418 row->ends_at_zv_p = 1;
19419 /* A row that displays right-to-left text must always have
19420 its last face extended all the way to the end of line,
19421 even if this row ends in ZV, because we still write to
19422 the screen left to right. We also need to extend the
19423 last face if the default face is remapped to some
19424 different face, otherwise the functions that clear
19425 portions of the screen will clear with the default face's
19426 background color. */
19427 if (row->reversed_p
19428 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
19429 extend_face_to_end_of_line (it);
19430 break;
19431 }
19432
19433 /* Now, get the metrics of what we want to display. This also
19434 generates glyphs in `row' (which is IT->glyph_row). */
19435 n_glyphs_before = row->used[TEXT_AREA];
19436 x = it->current_x;
19437
19438 /* Remember the line height so far in case the next element doesn't
19439 fit on the line. */
19440 if (it->line_wrap != TRUNCATE)
19441 {
19442 ascent = it->max_ascent;
19443 descent = it->max_descent;
19444 phys_ascent = it->max_phys_ascent;
19445 phys_descent = it->max_phys_descent;
19446
19447 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
19448 {
19449 if (IT_DISPLAYING_WHITESPACE (it))
19450 may_wrap = 1;
19451 else if (may_wrap)
19452 {
19453 SAVE_IT (wrap_it, *it, wrap_data);
19454 wrap_x = x;
19455 wrap_row_used = row->used[TEXT_AREA];
19456 wrap_row_ascent = row->ascent;
19457 wrap_row_height = row->height;
19458 wrap_row_phys_ascent = row->phys_ascent;
19459 wrap_row_phys_height = row->phys_height;
19460 wrap_row_extra_line_spacing = row->extra_line_spacing;
19461 wrap_row_min_pos = min_pos;
19462 wrap_row_min_bpos = min_bpos;
19463 wrap_row_max_pos = max_pos;
19464 wrap_row_max_bpos = max_bpos;
19465 may_wrap = 0;
19466 }
19467 }
19468 }
19469
19470 PRODUCE_GLYPHS (it);
19471
19472 /* If this display element was in marginal areas, continue with
19473 the next one. */
19474 if (it->area != TEXT_AREA)
19475 {
19476 row->ascent = max (row->ascent, it->max_ascent);
19477 row->height = max (row->height, it->max_ascent + it->max_descent);
19478 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
19479 row->phys_height = max (row->phys_height,
19480 it->max_phys_ascent + it->max_phys_descent);
19481 row->extra_line_spacing = max (row->extra_line_spacing,
19482 it->max_extra_line_spacing);
19483 set_iterator_to_next (it, 1);
19484 continue;
19485 }
19486
19487 /* Does the display element fit on the line? If we truncate
19488 lines, we should draw past the right edge of the window. If
19489 we don't truncate, we want to stop so that we can display the
19490 continuation glyph before the right margin. If lines are
19491 continued, there are two possible strategies for characters
19492 resulting in more than 1 glyph (e.g. tabs): Display as many
19493 glyphs as possible in this line and leave the rest for the
19494 continuation line, or display the whole element in the next
19495 line. Original redisplay did the former, so we do it also. */
19496 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
19497 hpos_before = it->hpos;
19498 x_before = x;
19499
19500 if (/* Not a newline. */
19501 nglyphs > 0
19502 /* Glyphs produced fit entirely in the line. */
19503 && it->current_x < it->last_visible_x)
19504 {
19505 it->hpos += nglyphs;
19506 row->ascent = max (row->ascent, it->max_ascent);
19507 row->height = max (row->height, it->max_ascent + it->max_descent);
19508 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
19509 row->phys_height = max (row->phys_height,
19510 it->max_phys_ascent + it->max_phys_descent);
19511 row->extra_line_spacing = max (row->extra_line_spacing,
19512 it->max_extra_line_spacing);
19513 if (it->current_x - it->pixel_width < it->first_visible_x)
19514 row->x = x - it->first_visible_x;
19515 /* Record the maximum and minimum buffer positions seen so
19516 far in glyphs that will be displayed by this row. */
19517 if (it->bidi_p)
19518 RECORD_MAX_MIN_POS (it);
19519 }
19520 else
19521 {
19522 int i, new_x;
19523 struct glyph *glyph;
19524
19525 for (i = 0; i < nglyphs; ++i, x = new_x)
19526 {
19527 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
19528 new_x = x + glyph->pixel_width;
19529
19530 if (/* Lines are continued. */
19531 it->line_wrap != TRUNCATE
19532 && (/* Glyph doesn't fit on the line. */
19533 new_x > it->last_visible_x
19534 /* Or it fits exactly on a window system frame. */
19535 || (new_x == it->last_visible_x
19536 && FRAME_WINDOW_P (it->f)
19537 && (row->reversed_p
19538 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
19539 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
19540 {
19541 /* End of a continued line. */
19542
19543 if (it->hpos == 0
19544 || (new_x == it->last_visible_x
19545 && FRAME_WINDOW_P (it->f)
19546 && (row->reversed_p
19547 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
19548 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
19549 {
19550 /* Current glyph is the only one on the line or
19551 fits exactly on the line. We must continue
19552 the line because we can't draw the cursor
19553 after the glyph. */
19554 row->continued_p = 1;
19555 it->current_x = new_x;
19556 it->continuation_lines_width += new_x;
19557 ++it->hpos;
19558 if (i == nglyphs - 1)
19559 {
19560 /* If line-wrap is on, check if a previous
19561 wrap point was found. */
19562 if (wrap_row_used > 0
19563 /* Even if there is a previous wrap
19564 point, continue the line here as
19565 usual, if (i) the previous character
19566 was a space or tab AND (ii) the
19567 current character is not. */
19568 && (!may_wrap
19569 || IT_DISPLAYING_WHITESPACE (it)))
19570 goto back_to_wrap;
19571
19572 /* Record the maximum and minimum buffer
19573 positions seen so far in glyphs that will be
19574 displayed by this row. */
19575 if (it->bidi_p)
19576 RECORD_MAX_MIN_POS (it);
19577 set_iterator_to_next (it, 1);
19578 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
19579 {
19580 if (!get_next_display_element (it))
19581 {
19582 row->exact_window_width_line_p = 1;
19583 it->continuation_lines_width = 0;
19584 row->continued_p = 0;
19585 row->ends_at_zv_p = 1;
19586 }
19587 else if (ITERATOR_AT_END_OF_LINE_P (it))
19588 {
19589 row->continued_p = 0;
19590 row->exact_window_width_line_p = 1;
19591 }
19592 }
19593 }
19594 else if (it->bidi_p)
19595 RECORD_MAX_MIN_POS (it);
19596 }
19597 else if (CHAR_GLYPH_PADDING_P (*glyph)
19598 && !FRAME_WINDOW_P (it->f))
19599 {
19600 /* A padding glyph that doesn't fit on this line.
19601 This means the whole character doesn't fit
19602 on the line. */
19603 if (row->reversed_p)
19604 unproduce_glyphs (it, row->used[TEXT_AREA]
19605 - n_glyphs_before);
19606 row->used[TEXT_AREA] = n_glyphs_before;
19607
19608 /* Fill the rest of the row with continuation
19609 glyphs like in 20.x. */
19610 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
19611 < row->glyphs[1 + TEXT_AREA])
19612 produce_special_glyphs (it, IT_CONTINUATION);
19613
19614 row->continued_p = 1;
19615 it->current_x = x_before;
19616 it->continuation_lines_width += x_before;
19617
19618 /* Restore the height to what it was before the
19619 element not fitting on the line. */
19620 it->max_ascent = ascent;
19621 it->max_descent = descent;
19622 it->max_phys_ascent = phys_ascent;
19623 it->max_phys_descent = phys_descent;
19624 }
19625 else if (wrap_row_used > 0)
19626 {
19627 back_to_wrap:
19628 if (row->reversed_p)
19629 unproduce_glyphs (it,
19630 row->used[TEXT_AREA] - wrap_row_used);
19631 RESTORE_IT (it, &wrap_it, wrap_data);
19632 it->continuation_lines_width += wrap_x;
19633 row->used[TEXT_AREA] = wrap_row_used;
19634 row->ascent = wrap_row_ascent;
19635 row->height = wrap_row_height;
19636 row->phys_ascent = wrap_row_phys_ascent;
19637 row->phys_height = wrap_row_phys_height;
19638 row->extra_line_spacing = wrap_row_extra_line_spacing;
19639 min_pos = wrap_row_min_pos;
19640 min_bpos = wrap_row_min_bpos;
19641 max_pos = wrap_row_max_pos;
19642 max_bpos = wrap_row_max_bpos;
19643 row->continued_p = 1;
19644 row->ends_at_zv_p = 0;
19645 row->exact_window_width_line_p = 0;
19646 it->continuation_lines_width += x;
19647
19648 /* Make sure that a non-default face is extended
19649 up to the right margin of the window. */
19650 extend_face_to_end_of_line (it);
19651 }
19652 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
19653 {
19654 /* A TAB that extends past the right edge of the
19655 window. This produces a single glyph on
19656 window system frames. We leave the glyph in
19657 this row and let it fill the row, but don't
19658 consume the TAB. */
19659 if ((row->reversed_p
19660 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
19661 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
19662 produce_special_glyphs (it, IT_CONTINUATION);
19663 it->continuation_lines_width += it->last_visible_x;
19664 row->ends_in_middle_of_char_p = 1;
19665 row->continued_p = 1;
19666 glyph->pixel_width = it->last_visible_x - x;
19667 it->starts_in_middle_of_char_p = 1;
19668 }
19669 else
19670 {
19671 /* Something other than a TAB that draws past
19672 the right edge of the window. Restore
19673 positions to values before the element. */
19674 if (row->reversed_p)
19675 unproduce_glyphs (it, row->used[TEXT_AREA]
19676 - (n_glyphs_before + i));
19677 row->used[TEXT_AREA] = n_glyphs_before + i;
19678
19679 /* Display continuation glyphs. */
19680 it->current_x = x_before;
19681 it->continuation_lines_width += x;
19682 if (!FRAME_WINDOW_P (it->f)
19683 || (row->reversed_p
19684 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
19685 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
19686 produce_special_glyphs (it, IT_CONTINUATION);
19687 row->continued_p = 1;
19688
19689 extend_face_to_end_of_line (it);
19690
19691 if (nglyphs > 1 && i > 0)
19692 {
19693 row->ends_in_middle_of_char_p = 1;
19694 it->starts_in_middle_of_char_p = 1;
19695 }
19696
19697 /* Restore the height to what it was before the
19698 element not fitting on the line. */
19699 it->max_ascent = ascent;
19700 it->max_descent = descent;
19701 it->max_phys_ascent = phys_ascent;
19702 it->max_phys_descent = phys_descent;
19703 }
19704
19705 break;
19706 }
19707 else if (new_x > it->first_visible_x)
19708 {
19709 /* Increment number of glyphs actually displayed. */
19710 ++it->hpos;
19711
19712 /* Record the maximum and minimum buffer positions
19713 seen so far in glyphs that will be displayed by
19714 this row. */
19715 if (it->bidi_p)
19716 RECORD_MAX_MIN_POS (it);
19717
19718 if (x < it->first_visible_x)
19719 /* Glyph is partially visible, i.e. row starts at
19720 negative X position. */
19721 row->x = x - it->first_visible_x;
19722 }
19723 else
19724 {
19725 /* Glyph is completely off the left margin of the
19726 window. This should not happen because of the
19727 move_it_in_display_line at the start of this
19728 function, unless the text display area of the
19729 window is empty. */
19730 eassert (it->first_visible_x <= it->last_visible_x);
19731 }
19732 }
19733 /* Even if this display element produced no glyphs at all,
19734 we want to record its position. */
19735 if (it->bidi_p && nglyphs == 0)
19736 RECORD_MAX_MIN_POS (it);
19737
19738 row->ascent = max (row->ascent, it->max_ascent);
19739 row->height = max (row->height, it->max_ascent + it->max_descent);
19740 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
19741 row->phys_height = max (row->phys_height,
19742 it->max_phys_ascent + it->max_phys_descent);
19743 row->extra_line_spacing = max (row->extra_line_spacing,
19744 it->max_extra_line_spacing);
19745
19746 /* End of this display line if row is continued. */
19747 if (row->continued_p || row->ends_at_zv_p)
19748 break;
19749 }
19750
19751 at_end_of_line:
19752 /* Is this a line end? If yes, we're also done, after making
19753 sure that a non-default face is extended up to the right
19754 margin of the window. */
19755 if (ITERATOR_AT_END_OF_LINE_P (it))
19756 {
19757 int used_before = row->used[TEXT_AREA];
19758
19759 row->ends_in_newline_from_string_p = STRINGP (it->object);
19760
19761 /* Add a space at the end of the line that is used to
19762 display the cursor there. */
19763 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
19764 append_space_for_newline (it, 0);
19765
19766 /* Extend the face to the end of the line. */
19767 extend_face_to_end_of_line (it);
19768
19769 /* Make sure we have the position. */
19770 if (used_before == 0)
19771 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
19772
19773 /* Record the position of the newline, for use in
19774 find_row_edges. */
19775 it->eol_pos = it->current.pos;
19776
19777 /* Consume the line end. This skips over invisible lines. */
19778 set_iterator_to_next (it, 1);
19779 it->continuation_lines_width = 0;
19780 break;
19781 }
19782
19783 /* Proceed with next display element. Note that this skips
19784 over lines invisible because of selective display. */
19785 set_iterator_to_next (it, 1);
19786
19787 /* If we truncate lines, we are done when the last displayed
19788 glyphs reach past the right margin of the window. */
19789 if (it->line_wrap == TRUNCATE
19790 && (FRAME_WINDOW_P (it->f) && WINDOW_RIGHT_FRINGE_WIDTH (it->w)
19791 ? (it->current_x >= it->last_visible_x)
19792 : (it->current_x > it->last_visible_x)))
19793 {
19794 /* Maybe add truncation glyphs. */
19795 if (!FRAME_WINDOW_P (it->f)
19796 || (row->reversed_p
19797 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
19798 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
19799 {
19800 int i, n;
19801
19802 if (!row->reversed_p)
19803 {
19804 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
19805 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
19806 break;
19807 }
19808 else
19809 {
19810 for (i = 0; i < row->used[TEXT_AREA]; i++)
19811 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
19812 break;
19813 /* Remove any padding glyphs at the front of ROW, to
19814 make room for the truncation glyphs we will be
19815 adding below. The loop below always inserts at
19816 least one truncation glyph, so also remove the
19817 last glyph added to ROW. */
19818 unproduce_glyphs (it, i + 1);
19819 /* Adjust i for the loop below. */
19820 i = row->used[TEXT_AREA] - (i + 1);
19821 }
19822
19823 it->current_x = x_before;
19824 if (!FRAME_WINDOW_P (it->f))
19825 {
19826 for (n = row->used[TEXT_AREA]; i < n; ++i)
19827 {
19828 row->used[TEXT_AREA] = i;
19829 produce_special_glyphs (it, IT_TRUNCATION);
19830 }
19831 }
19832 else
19833 {
19834 row->used[TEXT_AREA] = i;
19835 produce_special_glyphs (it, IT_TRUNCATION);
19836 }
19837 }
19838 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
19839 {
19840 /* Don't truncate if we can overflow newline into fringe. */
19841 if (!get_next_display_element (it))
19842 {
19843 it->continuation_lines_width = 0;
19844 row->ends_at_zv_p = 1;
19845 row->exact_window_width_line_p = 1;
19846 break;
19847 }
19848 if (ITERATOR_AT_END_OF_LINE_P (it))
19849 {
19850 row->exact_window_width_line_p = 1;
19851 goto at_end_of_line;
19852 }
19853 it->current_x = x_before;
19854 }
19855
19856 row->truncated_on_right_p = 1;
19857 it->continuation_lines_width = 0;
19858 reseat_at_next_visible_line_start (it, 0);
19859 row->ends_at_zv_p = FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n';
19860 it->hpos = hpos_before;
19861 break;
19862 }
19863 }
19864
19865 if (wrap_data)
19866 bidi_unshelve_cache (wrap_data, 1);
19867
19868 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19869 at the left window margin. */
19870 if (it->first_visible_x
19871 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
19872 {
19873 if (!FRAME_WINDOW_P (it->f)
19874 || (row->reversed_p
19875 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
19876 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
19877 insert_left_trunc_glyphs (it);
19878 row->truncated_on_left_p = 1;
19879 }
19880
19881 /* Remember the position at which this line ends.
19882
19883 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19884 cannot be before the call to find_row_edges below, since that is
19885 where these positions are determined. */
19886 row->end = it->current;
19887 if (!it->bidi_p)
19888 {
19889 row->minpos = row->start.pos;
19890 row->maxpos = row->end.pos;
19891 }
19892 else
19893 {
19894 /* ROW->minpos and ROW->maxpos must be the smallest and
19895 `1 + the largest' buffer positions in ROW. But if ROW was
19896 bidi-reordered, these two positions can be anywhere in the
19897 row, so we must determine them now. */
19898 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
19899 }
19900
19901 /* If the start of this line is the overlay arrow-position, then
19902 mark this glyph row as the one containing the overlay arrow.
19903 This is clearly a mess with variable size fonts. It would be
19904 better to let it be displayed like cursors under X. */
19905 if ((row->displays_text_p || !overlay_arrow_seen)
19906 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
19907 !NILP (overlay_arrow_string)))
19908 {
19909 /* Overlay arrow in window redisplay is a fringe bitmap. */
19910 if (STRINGP (overlay_arrow_string))
19911 {
19912 struct glyph_row *arrow_row
19913 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
19914 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
19915 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
19916 struct glyph *p = row->glyphs[TEXT_AREA];
19917 struct glyph *p2, *end;
19918
19919 /* Copy the arrow glyphs. */
19920 while (glyph < arrow_end)
19921 *p++ = *glyph++;
19922
19923 /* Throw away padding glyphs. */
19924 p2 = p;
19925 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
19926 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
19927 ++p2;
19928 if (p2 > p)
19929 {
19930 while (p2 < end)
19931 *p++ = *p2++;
19932 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
19933 }
19934 }
19935 else
19936 {
19937 eassert (INTEGERP (overlay_arrow_string));
19938 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
19939 }
19940 overlay_arrow_seen = 1;
19941 }
19942
19943 /* Highlight trailing whitespace. */
19944 if (!NILP (Vshow_trailing_whitespace))
19945 highlight_trailing_whitespace (it->f, it->glyph_row);
19946
19947 /* Compute pixel dimensions of this line. */
19948 compute_line_metrics (it);
19949
19950 /* Implementation note: No changes in the glyphs of ROW or in their
19951 faces can be done past this point, because compute_line_metrics
19952 computes ROW's hash value and stores it within the glyph_row
19953 structure. */
19954
19955 /* Record whether this row ends inside an ellipsis. */
19956 row->ends_in_ellipsis_p
19957 = (it->method == GET_FROM_DISPLAY_VECTOR
19958 && it->ellipsis_p);
19959
19960 /* Save fringe bitmaps in this row. */
19961 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
19962 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
19963 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
19964 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
19965
19966 it->left_user_fringe_bitmap = 0;
19967 it->left_user_fringe_face_id = 0;
19968 it->right_user_fringe_bitmap = 0;
19969 it->right_user_fringe_face_id = 0;
19970
19971 /* Maybe set the cursor. */
19972 cvpos = it->w->cursor.vpos;
19973 if ((cvpos < 0
19974 /* In bidi-reordered rows, keep checking for proper cursor
19975 position even if one has been found already, because buffer
19976 positions in such rows change non-linearly with ROW->VPOS,
19977 when a line is continued. One exception: when we are at ZV,
19978 display cursor on the first suitable glyph row, since all
19979 the empty rows after that also have their position set to ZV. */
19980 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19981 lines' rows is implemented for bidi-reordered rows. */
19982 || (it->bidi_p
19983 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
19984 && PT >= MATRIX_ROW_START_CHARPOS (row)
19985 && PT <= MATRIX_ROW_END_CHARPOS (row)
19986 && cursor_row_p (row))
19987 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
19988
19989 /* Prepare for the next line. This line starts horizontally at (X
19990 HPOS) = (0 0). Vertical positions are incremented. As a
19991 convenience for the caller, IT->glyph_row is set to the next
19992 row to be used. */
19993 it->current_x = it->hpos = 0;
19994 it->current_y += row->height;
19995 SET_TEXT_POS (it->eol_pos, 0, 0);
19996 ++it->vpos;
19997 ++it->glyph_row;
19998 /* The next row should by default use the same value of the
19999 reversed_p flag as this one. set_iterator_to_next decides when
20000 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20001 the flag accordingly. */
20002 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20003 it->glyph_row->reversed_p = row->reversed_p;
20004 it->start = row->end;
20005 return row->displays_text_p;
20006
20007 #undef RECORD_MAX_MIN_POS
20008 }
20009
20010 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20011 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20012 doc: /* Return paragraph direction at point in BUFFER.
20013 Value is either `left-to-right' or `right-to-left'.
20014 If BUFFER is omitted or nil, it defaults to the current buffer.
20015
20016 Paragraph direction determines how the text in the paragraph is displayed.
20017 In left-to-right paragraphs, text begins at the left margin of the window
20018 and the reading direction is generally left to right. In right-to-left
20019 paragraphs, text begins at the right margin and is read from right to left.
20020
20021 See also `bidi-paragraph-direction'. */)
20022 (Lisp_Object buffer)
20023 {
20024 struct buffer *buf = current_buffer;
20025 struct buffer *old = buf;
20026
20027 if (! NILP (buffer))
20028 {
20029 CHECK_BUFFER (buffer);
20030 buf = XBUFFER (buffer);
20031 }
20032
20033 if (NILP (BVAR (buf, bidi_display_reordering))
20034 || NILP (BVAR (buf, enable_multibyte_characters))
20035 /* When we are loading loadup.el, the character property tables
20036 needed for bidi iteration are not yet available. */
20037 || !NILP (Vpurify_flag))
20038 return Qleft_to_right;
20039 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20040 return BVAR (buf, bidi_paragraph_direction);
20041 else
20042 {
20043 /* Determine the direction from buffer text. We could try to
20044 use current_matrix if it is up to date, but this seems fast
20045 enough as it is. */
20046 struct bidi_it itb;
20047 ptrdiff_t pos = BUF_PT (buf);
20048 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20049 int c;
20050 void *itb_data = bidi_shelve_cache ();
20051
20052 set_buffer_temp (buf);
20053 /* bidi_paragraph_init finds the base direction of the paragraph
20054 by searching forward from paragraph start. We need the base
20055 direction of the current or _previous_ paragraph, so we need
20056 to make sure we are within that paragraph. To that end, find
20057 the previous non-empty line. */
20058 if (pos >= ZV && pos > BEGV)
20059 {
20060 pos--;
20061 bytepos = CHAR_TO_BYTE (pos);
20062 }
20063 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20064 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
20065 {
20066 while ((c = FETCH_BYTE (bytepos)) == '\n'
20067 || c == ' ' || c == '\t' || c == '\f')
20068 {
20069 if (bytepos <= BEGV_BYTE)
20070 break;
20071 bytepos--;
20072 pos--;
20073 }
20074 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
20075 bytepos--;
20076 }
20077 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
20078 itb.paragraph_dir = NEUTRAL_DIR;
20079 itb.string.s = NULL;
20080 itb.string.lstring = Qnil;
20081 itb.string.bufpos = 0;
20082 itb.string.unibyte = 0;
20083 bidi_paragraph_init (NEUTRAL_DIR, &itb, 1);
20084 bidi_unshelve_cache (itb_data, 0);
20085 set_buffer_temp (old);
20086 switch (itb.paragraph_dir)
20087 {
20088 case L2R:
20089 return Qleft_to_right;
20090 break;
20091 case R2L:
20092 return Qright_to_left;
20093 break;
20094 default:
20095 emacs_abort ();
20096 }
20097 }
20098 }
20099
20100
20101 \f
20102 /***********************************************************************
20103 Menu Bar
20104 ***********************************************************************/
20105
20106 /* Redisplay the menu bar in the frame for window W.
20107
20108 The menu bar of X frames that don't have X toolkit support is
20109 displayed in a special window W->frame->menu_bar_window.
20110
20111 The menu bar of terminal frames is treated specially as far as
20112 glyph matrices are concerned. Menu bar lines are not part of
20113 windows, so the update is done directly on the frame matrix rows
20114 for the menu bar. */
20115
20116 static void
20117 display_menu_bar (struct window *w)
20118 {
20119 struct frame *f = XFRAME (WINDOW_FRAME (w));
20120 struct it it;
20121 Lisp_Object items;
20122 int i;
20123
20124 /* Don't do all this for graphical frames. */
20125 #ifdef HAVE_NTGUI
20126 if (FRAME_W32_P (f))
20127 return;
20128 #endif
20129 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20130 if (FRAME_X_P (f))
20131 return;
20132 #endif
20133
20134 #ifdef HAVE_NS
20135 if (FRAME_NS_P (f))
20136 return;
20137 #endif /* HAVE_NS */
20138
20139 #ifdef USE_X_TOOLKIT
20140 eassert (!FRAME_WINDOW_P (f));
20141 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
20142 it.first_visible_x = 0;
20143 it.last_visible_x = FRAME_TOTAL_COLS (f) * FRAME_COLUMN_WIDTH (f);
20144 #else /* not USE_X_TOOLKIT */
20145 if (FRAME_WINDOW_P (f))
20146 {
20147 /* Menu bar lines are displayed in the desired matrix of the
20148 dummy window menu_bar_window. */
20149 struct window *menu_w;
20150 eassert (WINDOWP (f->menu_bar_window));
20151 menu_w = XWINDOW (f->menu_bar_window);
20152 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
20153 MENU_FACE_ID);
20154 it.first_visible_x = 0;
20155 it.last_visible_x = FRAME_TOTAL_COLS (f) * FRAME_COLUMN_WIDTH (f);
20156 }
20157 else
20158 {
20159 /* This is a TTY frame, i.e. character hpos/vpos are used as
20160 pixel x/y. */
20161 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
20162 MENU_FACE_ID);
20163 it.first_visible_x = 0;
20164 it.last_visible_x = FRAME_COLS (f);
20165 }
20166 #endif /* not USE_X_TOOLKIT */
20167
20168 /* FIXME: This should be controlled by a user option. See the
20169 comments in redisplay_tool_bar and display_mode_line about
20170 this. */
20171 it.paragraph_embedding = L2R;
20172
20173 if (! mode_line_inverse_video)
20174 /* Force the menu-bar to be displayed in the default face. */
20175 it.base_face_id = it.face_id = DEFAULT_FACE_ID;
20176
20177 /* Clear all rows of the menu bar. */
20178 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
20179 {
20180 struct glyph_row *row = it.glyph_row + i;
20181 clear_glyph_row (row);
20182 row->enabled_p = 1;
20183 row->full_width_p = 1;
20184 }
20185
20186 /* Display all items of the menu bar. */
20187 items = FRAME_MENU_BAR_ITEMS (it.f);
20188 for (i = 0; i < ASIZE (items); i += 4)
20189 {
20190 Lisp_Object string;
20191
20192 /* Stop at nil string. */
20193 string = AREF (items, i + 1);
20194 if (NILP (string))
20195 break;
20196
20197 /* Remember where item was displayed. */
20198 ASET (items, i + 3, make_number (it.hpos));
20199
20200 /* Display the item, pad with one space. */
20201 if (it.current_x < it.last_visible_x)
20202 display_string (NULL, string, Qnil, 0, 0, &it,
20203 SCHARS (string) + 1, 0, 0, -1);
20204 }
20205
20206 /* Fill out the line with spaces. */
20207 if (it.current_x < it.last_visible_x)
20208 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
20209
20210 /* Compute the total height of the lines. */
20211 compute_line_metrics (&it);
20212 }
20213
20214
20215 \f
20216 /***********************************************************************
20217 Mode Line
20218 ***********************************************************************/
20219
20220 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20221 FORCE is non-zero, redisplay mode lines unconditionally.
20222 Otherwise, redisplay only mode lines that are garbaged. Value is
20223 the number of windows whose mode lines were redisplayed. */
20224
20225 static int
20226 redisplay_mode_lines (Lisp_Object window, int force)
20227 {
20228 int nwindows = 0;
20229
20230 while (!NILP (window))
20231 {
20232 struct window *w = XWINDOW (window);
20233
20234 if (WINDOWP (w->hchild))
20235 nwindows += redisplay_mode_lines (w->hchild, force);
20236 else if (WINDOWP (w->vchild))
20237 nwindows += redisplay_mode_lines (w->vchild, force);
20238 else if (force
20239 || FRAME_GARBAGED_P (XFRAME (w->frame))
20240 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
20241 {
20242 struct text_pos lpoint;
20243 struct buffer *old = current_buffer;
20244
20245 /* Set the window's buffer for the mode line display. */
20246 SET_TEXT_POS (lpoint, PT, PT_BYTE);
20247 set_buffer_internal_1 (XBUFFER (w->buffer));
20248
20249 /* Point refers normally to the selected window. For any
20250 other window, set up appropriate value. */
20251 if (!EQ (window, selected_window))
20252 {
20253 struct text_pos pt;
20254
20255 SET_TEXT_POS_FROM_MARKER (pt, w->pointm);
20256 if (CHARPOS (pt) < BEGV)
20257 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
20258 else if (CHARPOS (pt) > (ZV - 1))
20259 TEMP_SET_PT_BOTH (ZV, ZV_BYTE);
20260 else
20261 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
20262 }
20263
20264 /* Display mode lines. */
20265 clear_glyph_matrix (w->desired_matrix);
20266 if (display_mode_lines (w))
20267 {
20268 ++nwindows;
20269 w->must_be_updated_p = 1;
20270 }
20271
20272 /* Restore old settings. */
20273 set_buffer_internal_1 (old);
20274 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
20275 }
20276
20277 window = w->next;
20278 }
20279
20280 return nwindows;
20281 }
20282
20283
20284 /* Display the mode and/or header line of window W. Value is the
20285 sum number of mode lines and header lines displayed. */
20286
20287 static int
20288 display_mode_lines (struct window *w)
20289 {
20290 Lisp_Object old_selected_window, old_selected_frame;
20291 int n = 0;
20292
20293 old_selected_frame = selected_frame;
20294 selected_frame = w->frame;
20295 old_selected_window = selected_window;
20296 XSETWINDOW (selected_window, w);
20297
20298 /* These will be set while the mode line specs are processed. */
20299 line_number_displayed = 0;
20300 wset_column_number_displayed (w, Qnil);
20301
20302 if (WINDOW_WANTS_MODELINE_P (w))
20303 {
20304 struct window *sel_w = XWINDOW (old_selected_window);
20305
20306 /* Select mode line face based on the real selected window. */
20307 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
20308 BVAR (current_buffer, mode_line_format));
20309 ++n;
20310 }
20311
20312 if (WINDOW_WANTS_HEADER_LINE_P (w))
20313 {
20314 display_mode_line (w, HEADER_LINE_FACE_ID,
20315 BVAR (current_buffer, header_line_format));
20316 ++n;
20317 }
20318
20319 selected_frame = old_selected_frame;
20320 selected_window = old_selected_window;
20321 return n;
20322 }
20323
20324
20325 /* Display mode or header line of window W. FACE_ID specifies which
20326 line to display; it is either MODE_LINE_FACE_ID or
20327 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20328 display. Value is the pixel height of the mode/header line
20329 displayed. */
20330
20331 static int
20332 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
20333 {
20334 struct it it;
20335 struct face *face;
20336 ptrdiff_t count = SPECPDL_INDEX ();
20337
20338 init_iterator (&it, w, -1, -1, NULL, face_id);
20339 /* Don't extend on a previously drawn mode-line.
20340 This may happen if called from pos_visible_p. */
20341 it.glyph_row->enabled_p = 0;
20342 prepare_desired_row (it.glyph_row);
20343
20344 it.glyph_row->mode_line_p = 1;
20345
20346 if (! mode_line_inverse_video)
20347 /* Force the mode-line to be displayed in the default face. */
20348 it.base_face_id = it.face_id = DEFAULT_FACE_ID;
20349
20350 /* FIXME: This should be controlled by a user option. But
20351 supporting such an option is not trivial, since the mode line is
20352 made up of many separate strings. */
20353 it.paragraph_embedding = L2R;
20354
20355 record_unwind_protect (unwind_format_mode_line,
20356 format_mode_line_unwind_data (NULL, NULL, Qnil, 0));
20357
20358 mode_line_target = MODE_LINE_DISPLAY;
20359
20360 /* Temporarily make frame's keyboard the current kboard so that
20361 kboard-local variables in the mode_line_format will get the right
20362 values. */
20363 push_kboard (FRAME_KBOARD (it.f));
20364 record_unwind_save_match_data ();
20365 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
20366 pop_kboard ();
20367
20368 unbind_to (count, Qnil);
20369
20370 /* Fill up with spaces. */
20371 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
20372
20373 compute_line_metrics (&it);
20374 it.glyph_row->full_width_p = 1;
20375 it.glyph_row->continued_p = 0;
20376 it.glyph_row->truncated_on_left_p = 0;
20377 it.glyph_row->truncated_on_right_p = 0;
20378
20379 /* Make a 3D mode-line have a shadow at its right end. */
20380 face = FACE_FROM_ID (it.f, face_id);
20381 extend_face_to_end_of_line (&it);
20382 if (face->box != FACE_NO_BOX)
20383 {
20384 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
20385 + it.glyph_row->used[TEXT_AREA] - 1);
20386 last->right_box_line_p = 1;
20387 }
20388
20389 return it.glyph_row->height;
20390 }
20391
20392 /* Move element ELT in LIST to the front of LIST.
20393 Return the updated list. */
20394
20395 static Lisp_Object
20396 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
20397 {
20398 register Lisp_Object tail, prev;
20399 register Lisp_Object tem;
20400
20401 tail = list;
20402 prev = Qnil;
20403 while (CONSP (tail))
20404 {
20405 tem = XCAR (tail);
20406
20407 if (EQ (elt, tem))
20408 {
20409 /* Splice out the link TAIL. */
20410 if (NILP (prev))
20411 list = XCDR (tail);
20412 else
20413 Fsetcdr (prev, XCDR (tail));
20414
20415 /* Now make it the first. */
20416 Fsetcdr (tail, list);
20417 return tail;
20418 }
20419 else
20420 prev = tail;
20421 tail = XCDR (tail);
20422 QUIT;
20423 }
20424
20425 /* Not found--return unchanged LIST. */
20426 return list;
20427 }
20428
20429 /* Contribute ELT to the mode line for window IT->w. How it
20430 translates into text depends on its data type.
20431
20432 IT describes the display environment in which we display, as usual.
20433
20434 DEPTH is the depth in recursion. It is used to prevent
20435 infinite recursion here.
20436
20437 FIELD_WIDTH is the number of characters the display of ELT should
20438 occupy in the mode line, and PRECISION is the maximum number of
20439 characters to display from ELT's representation. See
20440 display_string for details.
20441
20442 Returns the hpos of the end of the text generated by ELT.
20443
20444 PROPS is a property list to add to any string we encounter.
20445
20446 If RISKY is nonzero, remove (disregard) any properties in any string
20447 we encounter, and ignore :eval and :propertize.
20448
20449 The global variable `mode_line_target' determines whether the
20450 output is passed to `store_mode_line_noprop',
20451 `store_mode_line_string', or `display_string'. */
20452
20453 static int
20454 display_mode_element (struct it *it, int depth, int field_width, int precision,
20455 Lisp_Object elt, Lisp_Object props, int risky)
20456 {
20457 int n = 0, field, prec;
20458 int literal = 0;
20459
20460 tail_recurse:
20461 if (depth > 100)
20462 elt = build_string ("*too-deep*");
20463
20464 depth++;
20465
20466 switch (XTYPE (elt))
20467 {
20468 case Lisp_String:
20469 {
20470 /* A string: output it and check for %-constructs within it. */
20471 unsigned char c;
20472 ptrdiff_t offset = 0;
20473
20474 if (SCHARS (elt) > 0
20475 && (!NILP (props) || risky))
20476 {
20477 Lisp_Object oprops, aelt;
20478 oprops = Ftext_properties_at (make_number (0), elt);
20479
20480 /* If the starting string's properties are not what
20481 we want, translate the string. Also, if the string
20482 is risky, do that anyway. */
20483
20484 if (NILP (Fequal (props, oprops)) || risky)
20485 {
20486 /* If the starting string has properties,
20487 merge the specified ones onto the existing ones. */
20488 if (! NILP (oprops) && !risky)
20489 {
20490 Lisp_Object tem;
20491
20492 oprops = Fcopy_sequence (oprops);
20493 tem = props;
20494 while (CONSP (tem))
20495 {
20496 oprops = Fplist_put (oprops, XCAR (tem),
20497 XCAR (XCDR (tem)));
20498 tem = XCDR (XCDR (tem));
20499 }
20500 props = oprops;
20501 }
20502
20503 aelt = Fassoc (elt, mode_line_proptrans_alist);
20504 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
20505 {
20506 /* AELT is what we want. Move it to the front
20507 without consing. */
20508 elt = XCAR (aelt);
20509 mode_line_proptrans_alist
20510 = move_elt_to_front (aelt, mode_line_proptrans_alist);
20511 }
20512 else
20513 {
20514 Lisp_Object tem;
20515
20516 /* If AELT has the wrong props, it is useless.
20517 so get rid of it. */
20518 if (! NILP (aelt))
20519 mode_line_proptrans_alist
20520 = Fdelq (aelt, mode_line_proptrans_alist);
20521
20522 elt = Fcopy_sequence (elt);
20523 Fset_text_properties (make_number (0), Flength (elt),
20524 props, elt);
20525 /* Add this item to mode_line_proptrans_alist. */
20526 mode_line_proptrans_alist
20527 = Fcons (Fcons (elt, props),
20528 mode_line_proptrans_alist);
20529 /* Truncate mode_line_proptrans_alist
20530 to at most 50 elements. */
20531 tem = Fnthcdr (make_number (50),
20532 mode_line_proptrans_alist);
20533 if (! NILP (tem))
20534 XSETCDR (tem, Qnil);
20535 }
20536 }
20537 }
20538
20539 offset = 0;
20540
20541 if (literal)
20542 {
20543 prec = precision - n;
20544 switch (mode_line_target)
20545 {
20546 case MODE_LINE_NOPROP:
20547 case MODE_LINE_TITLE:
20548 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
20549 break;
20550 case MODE_LINE_STRING:
20551 n += store_mode_line_string (NULL, elt, 1, 0, prec, Qnil);
20552 break;
20553 case MODE_LINE_DISPLAY:
20554 n += display_string (NULL, elt, Qnil, 0, 0, it,
20555 0, prec, 0, STRING_MULTIBYTE (elt));
20556 break;
20557 }
20558
20559 break;
20560 }
20561
20562 /* Handle the non-literal case. */
20563
20564 while ((precision <= 0 || n < precision)
20565 && SREF (elt, offset) != 0
20566 && (mode_line_target != MODE_LINE_DISPLAY
20567 || it->current_x < it->last_visible_x))
20568 {
20569 ptrdiff_t last_offset = offset;
20570
20571 /* Advance to end of string or next format specifier. */
20572 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
20573 ;
20574
20575 if (offset - 1 != last_offset)
20576 {
20577 ptrdiff_t nchars, nbytes;
20578
20579 /* Output to end of string or up to '%'. Field width
20580 is length of string. Don't output more than
20581 PRECISION allows us. */
20582 offset--;
20583
20584 prec = c_string_width (SDATA (elt) + last_offset,
20585 offset - last_offset, precision - n,
20586 &nchars, &nbytes);
20587
20588 switch (mode_line_target)
20589 {
20590 case MODE_LINE_NOPROP:
20591 case MODE_LINE_TITLE:
20592 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
20593 break;
20594 case MODE_LINE_STRING:
20595 {
20596 ptrdiff_t bytepos = last_offset;
20597 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
20598 ptrdiff_t endpos = (precision <= 0
20599 ? string_byte_to_char (elt, offset)
20600 : charpos + nchars);
20601
20602 n += store_mode_line_string (NULL,
20603 Fsubstring (elt, make_number (charpos),
20604 make_number (endpos)),
20605 0, 0, 0, Qnil);
20606 }
20607 break;
20608 case MODE_LINE_DISPLAY:
20609 {
20610 ptrdiff_t bytepos = last_offset;
20611 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
20612
20613 if (precision <= 0)
20614 nchars = string_byte_to_char (elt, offset) - charpos;
20615 n += display_string (NULL, elt, Qnil, 0, charpos,
20616 it, 0, nchars, 0,
20617 STRING_MULTIBYTE (elt));
20618 }
20619 break;
20620 }
20621 }
20622 else /* c == '%' */
20623 {
20624 ptrdiff_t percent_position = offset;
20625
20626 /* Get the specified minimum width. Zero means
20627 don't pad. */
20628 field = 0;
20629 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
20630 field = field * 10 + c - '0';
20631
20632 /* Don't pad beyond the total padding allowed. */
20633 if (field_width - n > 0 && field > field_width - n)
20634 field = field_width - n;
20635
20636 /* Note that either PRECISION <= 0 or N < PRECISION. */
20637 prec = precision - n;
20638
20639 if (c == 'M')
20640 n += display_mode_element (it, depth, field, prec,
20641 Vglobal_mode_string, props,
20642 risky);
20643 else if (c != 0)
20644 {
20645 int multibyte;
20646 ptrdiff_t bytepos, charpos;
20647 const char *spec;
20648 Lisp_Object string;
20649
20650 bytepos = percent_position;
20651 charpos = (STRING_MULTIBYTE (elt)
20652 ? string_byte_to_char (elt, bytepos)
20653 : bytepos);
20654 spec = decode_mode_spec (it->w, c, field, &string);
20655 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
20656
20657 switch (mode_line_target)
20658 {
20659 case MODE_LINE_NOPROP:
20660 case MODE_LINE_TITLE:
20661 n += store_mode_line_noprop (spec, field, prec);
20662 break;
20663 case MODE_LINE_STRING:
20664 {
20665 Lisp_Object tem = build_string (spec);
20666 props = Ftext_properties_at (make_number (charpos), elt);
20667 /* Should only keep face property in props */
20668 n += store_mode_line_string (NULL, tem, 0, field, prec, props);
20669 }
20670 break;
20671 case MODE_LINE_DISPLAY:
20672 {
20673 int nglyphs_before, nwritten;
20674
20675 nglyphs_before = it->glyph_row->used[TEXT_AREA];
20676 nwritten = display_string (spec, string, elt,
20677 charpos, 0, it,
20678 field, prec, 0,
20679 multibyte);
20680
20681 /* Assign to the glyphs written above the
20682 string where the `%x' came from, position
20683 of the `%'. */
20684 if (nwritten > 0)
20685 {
20686 struct glyph *glyph
20687 = (it->glyph_row->glyphs[TEXT_AREA]
20688 + nglyphs_before);
20689 int i;
20690
20691 for (i = 0; i < nwritten; ++i)
20692 {
20693 glyph[i].object = elt;
20694 glyph[i].charpos = charpos;
20695 }
20696
20697 n += nwritten;
20698 }
20699 }
20700 break;
20701 }
20702 }
20703 else /* c == 0 */
20704 break;
20705 }
20706 }
20707 }
20708 break;
20709
20710 case Lisp_Symbol:
20711 /* A symbol: process the value of the symbol recursively
20712 as if it appeared here directly. Avoid error if symbol void.
20713 Special case: if value of symbol is a string, output the string
20714 literally. */
20715 {
20716 register Lisp_Object tem;
20717
20718 /* If the variable is not marked as risky to set
20719 then its contents are risky to use. */
20720 if (NILP (Fget (elt, Qrisky_local_variable)))
20721 risky = 1;
20722
20723 tem = Fboundp (elt);
20724 if (!NILP (tem))
20725 {
20726 tem = Fsymbol_value (elt);
20727 /* If value is a string, output that string literally:
20728 don't check for % within it. */
20729 if (STRINGP (tem))
20730 literal = 1;
20731
20732 if (!EQ (tem, elt))
20733 {
20734 /* Give up right away for nil or t. */
20735 elt = tem;
20736 goto tail_recurse;
20737 }
20738 }
20739 }
20740 break;
20741
20742 case Lisp_Cons:
20743 {
20744 register Lisp_Object car, tem;
20745
20746 /* A cons cell: five distinct cases.
20747 If first element is :eval or :propertize, do something special.
20748 If first element is a string or a cons, process all the elements
20749 and effectively concatenate them.
20750 If first element is a negative number, truncate displaying cdr to
20751 at most that many characters. If positive, pad (with spaces)
20752 to at least that many characters.
20753 If first element is a symbol, process the cadr or caddr recursively
20754 according to whether the symbol's value is non-nil or nil. */
20755 car = XCAR (elt);
20756 if (EQ (car, QCeval))
20757 {
20758 /* An element of the form (:eval FORM) means evaluate FORM
20759 and use the result as mode line elements. */
20760
20761 if (risky)
20762 break;
20763
20764 if (CONSP (XCDR (elt)))
20765 {
20766 Lisp_Object spec;
20767 spec = safe_eval (XCAR (XCDR (elt)));
20768 n += display_mode_element (it, depth, field_width - n,
20769 precision - n, spec, props,
20770 risky);
20771 }
20772 }
20773 else if (EQ (car, QCpropertize))
20774 {
20775 /* An element of the form (:propertize ELT PROPS...)
20776 means display ELT but applying properties PROPS. */
20777
20778 if (risky)
20779 break;
20780
20781 if (CONSP (XCDR (elt)))
20782 n += display_mode_element (it, depth, field_width - n,
20783 precision - n, XCAR (XCDR (elt)),
20784 XCDR (XCDR (elt)), risky);
20785 }
20786 else if (SYMBOLP (car))
20787 {
20788 tem = Fboundp (car);
20789 elt = XCDR (elt);
20790 if (!CONSP (elt))
20791 goto invalid;
20792 /* elt is now the cdr, and we know it is a cons cell.
20793 Use its car if CAR has a non-nil value. */
20794 if (!NILP (tem))
20795 {
20796 tem = Fsymbol_value (car);
20797 if (!NILP (tem))
20798 {
20799 elt = XCAR (elt);
20800 goto tail_recurse;
20801 }
20802 }
20803 /* Symbol's value is nil (or symbol is unbound)
20804 Get the cddr of the original list
20805 and if possible find the caddr and use that. */
20806 elt = XCDR (elt);
20807 if (NILP (elt))
20808 break;
20809 else if (!CONSP (elt))
20810 goto invalid;
20811 elt = XCAR (elt);
20812 goto tail_recurse;
20813 }
20814 else if (INTEGERP (car))
20815 {
20816 register int lim = XINT (car);
20817 elt = XCDR (elt);
20818 if (lim < 0)
20819 {
20820 /* Negative int means reduce maximum width. */
20821 if (precision <= 0)
20822 precision = -lim;
20823 else
20824 precision = min (precision, -lim);
20825 }
20826 else if (lim > 0)
20827 {
20828 /* Padding specified. Don't let it be more than
20829 current maximum. */
20830 if (precision > 0)
20831 lim = min (precision, lim);
20832
20833 /* If that's more padding than already wanted, queue it.
20834 But don't reduce padding already specified even if
20835 that is beyond the current truncation point. */
20836 field_width = max (lim, field_width);
20837 }
20838 goto tail_recurse;
20839 }
20840 else if (STRINGP (car) || CONSP (car))
20841 {
20842 Lisp_Object halftail = elt;
20843 int len = 0;
20844
20845 while (CONSP (elt)
20846 && (precision <= 0 || n < precision))
20847 {
20848 n += display_mode_element (it, depth,
20849 /* Do padding only after the last
20850 element in the list. */
20851 (! CONSP (XCDR (elt))
20852 ? field_width - n
20853 : 0),
20854 precision - n, XCAR (elt),
20855 props, risky);
20856 elt = XCDR (elt);
20857 len++;
20858 if ((len & 1) == 0)
20859 halftail = XCDR (halftail);
20860 /* Check for cycle. */
20861 if (EQ (halftail, elt))
20862 break;
20863 }
20864 }
20865 }
20866 break;
20867
20868 default:
20869 invalid:
20870 elt = build_string ("*invalid*");
20871 goto tail_recurse;
20872 }
20873
20874 /* Pad to FIELD_WIDTH. */
20875 if (field_width > 0 && n < field_width)
20876 {
20877 switch (mode_line_target)
20878 {
20879 case MODE_LINE_NOPROP:
20880 case MODE_LINE_TITLE:
20881 n += store_mode_line_noprop ("", field_width - n, 0);
20882 break;
20883 case MODE_LINE_STRING:
20884 n += store_mode_line_string ("", Qnil, 0, field_width - n, 0, Qnil);
20885 break;
20886 case MODE_LINE_DISPLAY:
20887 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
20888 0, 0, 0);
20889 break;
20890 }
20891 }
20892
20893 return n;
20894 }
20895
20896 /* Store a mode-line string element in mode_line_string_list.
20897
20898 If STRING is non-null, display that C string. Otherwise, the Lisp
20899 string LISP_STRING is displayed.
20900
20901 FIELD_WIDTH is the minimum number of output glyphs to produce.
20902 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20903 with spaces. FIELD_WIDTH <= 0 means don't pad.
20904
20905 PRECISION is the maximum number of characters to output from
20906 STRING. PRECISION <= 0 means don't truncate the string.
20907
20908 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20909 properties to the string.
20910
20911 PROPS are the properties to add to the string.
20912 The mode_line_string_face face property is always added to the string.
20913 */
20914
20915 static int
20916 store_mode_line_string (const char *string, Lisp_Object lisp_string, int copy_string,
20917 int field_width, int precision, Lisp_Object props)
20918 {
20919 ptrdiff_t len;
20920 int n = 0;
20921
20922 if (string != NULL)
20923 {
20924 len = strlen (string);
20925 if (precision > 0 && len > precision)
20926 len = precision;
20927 lisp_string = make_string (string, len);
20928 if (NILP (props))
20929 props = mode_line_string_face_prop;
20930 else if (!NILP (mode_line_string_face))
20931 {
20932 Lisp_Object face = Fplist_get (props, Qface);
20933 props = Fcopy_sequence (props);
20934 if (NILP (face))
20935 face = mode_line_string_face;
20936 else
20937 face = Fcons (face, Fcons (mode_line_string_face, Qnil));
20938 props = Fplist_put (props, Qface, face);
20939 }
20940 Fadd_text_properties (make_number (0), make_number (len),
20941 props, lisp_string);
20942 }
20943 else
20944 {
20945 len = XFASTINT (Flength (lisp_string));
20946 if (precision > 0 && len > precision)
20947 {
20948 len = precision;
20949 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
20950 precision = -1;
20951 }
20952 if (!NILP (mode_line_string_face))
20953 {
20954 Lisp_Object face;
20955 if (NILP (props))
20956 props = Ftext_properties_at (make_number (0), lisp_string);
20957 face = Fplist_get (props, Qface);
20958 if (NILP (face))
20959 face = mode_line_string_face;
20960 else
20961 face = Fcons (face, Fcons (mode_line_string_face, Qnil));
20962 props = Fcons (Qface, Fcons (face, Qnil));
20963 if (copy_string)
20964 lisp_string = Fcopy_sequence (lisp_string);
20965 }
20966 if (!NILP (props))
20967 Fadd_text_properties (make_number (0), make_number (len),
20968 props, lisp_string);
20969 }
20970
20971 if (len > 0)
20972 {
20973 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
20974 n += len;
20975 }
20976
20977 if (field_width > len)
20978 {
20979 field_width -= len;
20980 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
20981 if (!NILP (props))
20982 Fadd_text_properties (make_number (0), make_number (field_width),
20983 props, lisp_string);
20984 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
20985 n += field_width;
20986 }
20987
20988 return n;
20989 }
20990
20991
20992 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
20993 1, 4, 0,
20994 doc: /* Format a string out of a mode line format specification.
20995 First arg FORMAT specifies the mode line format (see `mode-line-format'
20996 for details) to use.
20997
20998 By default, the format is evaluated for the currently selected window.
20999
21000 Optional second arg FACE specifies the face property to put on all
21001 characters for which no face is specified. The value nil means the
21002 default face. The value t means whatever face the window's mode line
21003 currently uses (either `mode-line' or `mode-line-inactive',
21004 depending on whether the window is the selected window or not).
21005 An integer value means the value string has no text
21006 properties.
21007
21008 Optional third and fourth args WINDOW and BUFFER specify the window
21009 and buffer to use as the context for the formatting (defaults
21010 are the selected window and the WINDOW's buffer). */)
21011 (Lisp_Object format, Lisp_Object face,
21012 Lisp_Object window, Lisp_Object buffer)
21013 {
21014 struct it it;
21015 int len;
21016 struct window *w;
21017 struct buffer *old_buffer = NULL;
21018 int face_id;
21019 int no_props = INTEGERP (face);
21020 ptrdiff_t count = SPECPDL_INDEX ();
21021 Lisp_Object str;
21022 int string_start = 0;
21023
21024 if (NILP (window))
21025 window = selected_window;
21026 CHECK_WINDOW (window);
21027 w = XWINDOW (window);
21028
21029 if (NILP (buffer))
21030 buffer = w->buffer;
21031 CHECK_BUFFER (buffer);
21032
21033 /* Make formatting the modeline a non-op when noninteractive, otherwise
21034 there will be problems later caused by a partially initialized frame. */
21035 if (NILP (format) || noninteractive)
21036 return empty_unibyte_string;
21037
21038 if (no_props)
21039 face = Qnil;
21040
21041 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
21042 : EQ (face, Qt) ? (EQ (window, selected_window)
21043 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
21044 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
21045 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
21046 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
21047 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
21048 : DEFAULT_FACE_ID;
21049
21050 if (XBUFFER (buffer) != current_buffer)
21051 old_buffer = current_buffer;
21052
21053 /* Save things including mode_line_proptrans_alist,
21054 and set that to nil so that we don't alter the outer value. */
21055 record_unwind_protect (unwind_format_mode_line,
21056 format_mode_line_unwind_data
21057 (XFRAME (WINDOW_FRAME (XWINDOW (window))),
21058 old_buffer, selected_window, 1));
21059 mode_line_proptrans_alist = Qnil;
21060
21061 Fselect_window (window, Qt);
21062 if (old_buffer)
21063 set_buffer_internal_1 (XBUFFER (buffer));
21064
21065 init_iterator (&it, w, -1, -1, NULL, face_id);
21066
21067 if (no_props)
21068 {
21069 mode_line_target = MODE_LINE_NOPROP;
21070 mode_line_string_face_prop = Qnil;
21071 mode_line_string_list = Qnil;
21072 string_start = MODE_LINE_NOPROP_LEN (0);
21073 }
21074 else
21075 {
21076 mode_line_target = MODE_LINE_STRING;
21077 mode_line_string_list = Qnil;
21078 mode_line_string_face = face;
21079 mode_line_string_face_prop
21080 = (NILP (face) ? Qnil : Fcons (Qface, Fcons (face, Qnil)));
21081 }
21082
21083 push_kboard (FRAME_KBOARD (it.f));
21084 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
21085 pop_kboard ();
21086
21087 if (no_props)
21088 {
21089 len = MODE_LINE_NOPROP_LEN (string_start);
21090 str = make_string (mode_line_noprop_buf + string_start, len);
21091 }
21092 else
21093 {
21094 mode_line_string_list = Fnreverse (mode_line_string_list);
21095 str = Fmapconcat (intern ("identity"), mode_line_string_list,
21096 empty_unibyte_string);
21097 }
21098
21099 unbind_to (count, Qnil);
21100 return str;
21101 }
21102
21103 /* Write a null-terminated, right justified decimal representation of
21104 the positive integer D to BUF using a minimal field width WIDTH. */
21105
21106 static void
21107 pint2str (register char *buf, register int width, register ptrdiff_t d)
21108 {
21109 register char *p = buf;
21110
21111 if (d <= 0)
21112 *p++ = '0';
21113 else
21114 {
21115 while (d > 0)
21116 {
21117 *p++ = d % 10 + '0';
21118 d /= 10;
21119 }
21120 }
21121
21122 for (width -= (int) (p - buf); width > 0; --width)
21123 *p++ = ' ';
21124 *p-- = '\0';
21125 while (p > buf)
21126 {
21127 d = *buf;
21128 *buf++ = *p;
21129 *p-- = d;
21130 }
21131 }
21132
21133 /* Write a null-terminated, right justified decimal and "human
21134 readable" representation of the nonnegative integer D to BUF using
21135 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21136
21137 static const char power_letter[] =
21138 {
21139 0, /* no letter */
21140 'k', /* kilo */
21141 'M', /* mega */
21142 'G', /* giga */
21143 'T', /* tera */
21144 'P', /* peta */
21145 'E', /* exa */
21146 'Z', /* zetta */
21147 'Y' /* yotta */
21148 };
21149
21150 static void
21151 pint2hrstr (char *buf, int width, ptrdiff_t d)
21152 {
21153 /* We aim to represent the nonnegative integer D as
21154 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21155 ptrdiff_t quotient = d;
21156 int remainder = 0;
21157 /* -1 means: do not use TENTHS. */
21158 int tenths = -1;
21159 int exponent = 0;
21160
21161 /* Length of QUOTIENT.TENTHS as a string. */
21162 int length;
21163
21164 char * psuffix;
21165 char * p;
21166
21167 if (1000 <= quotient)
21168 {
21169 /* Scale to the appropriate EXPONENT. */
21170 do
21171 {
21172 remainder = quotient % 1000;
21173 quotient /= 1000;
21174 exponent++;
21175 }
21176 while (1000 <= quotient);
21177
21178 /* Round to nearest and decide whether to use TENTHS or not. */
21179 if (quotient <= 9)
21180 {
21181 tenths = remainder / 100;
21182 if (50 <= remainder % 100)
21183 {
21184 if (tenths < 9)
21185 tenths++;
21186 else
21187 {
21188 quotient++;
21189 if (quotient == 10)
21190 tenths = -1;
21191 else
21192 tenths = 0;
21193 }
21194 }
21195 }
21196 else
21197 if (500 <= remainder)
21198 {
21199 if (quotient < 999)
21200 quotient++;
21201 else
21202 {
21203 quotient = 1;
21204 exponent++;
21205 tenths = 0;
21206 }
21207 }
21208 }
21209
21210 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21211 if (tenths == -1 && quotient <= 99)
21212 if (quotient <= 9)
21213 length = 1;
21214 else
21215 length = 2;
21216 else
21217 length = 3;
21218 p = psuffix = buf + max (width, length);
21219
21220 /* Print EXPONENT. */
21221 *psuffix++ = power_letter[exponent];
21222 *psuffix = '\0';
21223
21224 /* Print TENTHS. */
21225 if (tenths >= 0)
21226 {
21227 *--p = '0' + tenths;
21228 *--p = '.';
21229 }
21230
21231 /* Print QUOTIENT. */
21232 do
21233 {
21234 int digit = quotient % 10;
21235 *--p = '0' + digit;
21236 }
21237 while ((quotient /= 10) != 0);
21238
21239 /* Print leading spaces. */
21240 while (buf < p)
21241 *--p = ' ';
21242 }
21243
21244 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21245 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21246 type of CODING_SYSTEM. Return updated pointer into BUF. */
21247
21248 static unsigned char invalid_eol_type[] = "(*invalid*)";
21249
21250 static char *
21251 decode_mode_spec_coding (Lisp_Object coding_system, register char *buf, int eol_flag)
21252 {
21253 Lisp_Object val;
21254 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
21255 const unsigned char *eol_str;
21256 int eol_str_len;
21257 /* The EOL conversion we are using. */
21258 Lisp_Object eoltype;
21259
21260 val = CODING_SYSTEM_SPEC (coding_system);
21261 eoltype = Qnil;
21262
21263 if (!VECTORP (val)) /* Not yet decided. */
21264 {
21265 *buf++ = multibyte ? '-' : ' ';
21266 if (eol_flag)
21267 eoltype = eol_mnemonic_undecided;
21268 /* Don't mention EOL conversion if it isn't decided. */
21269 }
21270 else
21271 {
21272 Lisp_Object attrs;
21273 Lisp_Object eolvalue;
21274
21275 attrs = AREF (val, 0);
21276 eolvalue = AREF (val, 2);
21277
21278 *buf++ = multibyte
21279 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
21280 : ' ';
21281
21282 if (eol_flag)
21283 {
21284 /* The EOL conversion that is normal on this system. */
21285
21286 if (NILP (eolvalue)) /* Not yet decided. */
21287 eoltype = eol_mnemonic_undecided;
21288 else if (VECTORP (eolvalue)) /* Not yet decided. */
21289 eoltype = eol_mnemonic_undecided;
21290 else /* eolvalue is Qunix, Qdos, or Qmac. */
21291 eoltype = (EQ (eolvalue, Qunix)
21292 ? eol_mnemonic_unix
21293 : (EQ (eolvalue, Qdos) == 1
21294 ? eol_mnemonic_dos : eol_mnemonic_mac));
21295 }
21296 }
21297
21298 if (eol_flag)
21299 {
21300 /* Mention the EOL conversion if it is not the usual one. */
21301 if (STRINGP (eoltype))
21302 {
21303 eol_str = SDATA (eoltype);
21304 eol_str_len = SBYTES (eoltype);
21305 }
21306 else if (CHARACTERP (eoltype))
21307 {
21308 unsigned char *tmp = alloca (MAX_MULTIBYTE_LENGTH);
21309 int c = XFASTINT (eoltype);
21310 eol_str_len = CHAR_STRING (c, tmp);
21311 eol_str = tmp;
21312 }
21313 else
21314 {
21315 eol_str = invalid_eol_type;
21316 eol_str_len = sizeof (invalid_eol_type) - 1;
21317 }
21318 memcpy (buf, eol_str, eol_str_len);
21319 buf += eol_str_len;
21320 }
21321
21322 return buf;
21323 }
21324
21325 /* Return a string for the output of a mode line %-spec for window W,
21326 generated by character C. FIELD_WIDTH > 0 means pad the string
21327 returned with spaces to that value. Return a Lisp string in
21328 *STRING if the resulting string is taken from that Lisp string.
21329
21330 Note we operate on the current buffer for most purposes,
21331 the exception being w->base_line_pos. */
21332
21333 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21334
21335 static const char *
21336 decode_mode_spec (struct window *w, register int c, int field_width,
21337 Lisp_Object *string)
21338 {
21339 Lisp_Object obj;
21340 struct frame *f = XFRAME (WINDOW_FRAME (w));
21341 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
21342 struct buffer *b = current_buffer;
21343
21344 obj = Qnil;
21345 *string = Qnil;
21346
21347 switch (c)
21348 {
21349 case '*':
21350 if (!NILP (BVAR (b, read_only)))
21351 return "%";
21352 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
21353 return "*";
21354 return "-";
21355
21356 case '+':
21357 /* This differs from %* only for a modified read-only buffer. */
21358 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
21359 return "*";
21360 if (!NILP (BVAR (b, read_only)))
21361 return "%";
21362 return "-";
21363
21364 case '&':
21365 /* This differs from %* in ignoring read-only-ness. */
21366 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
21367 return "*";
21368 return "-";
21369
21370 case '%':
21371 return "%";
21372
21373 case '[':
21374 {
21375 int i;
21376 char *p;
21377
21378 if (command_loop_level > 5)
21379 return "[[[... ";
21380 p = decode_mode_spec_buf;
21381 for (i = 0; i < command_loop_level; i++)
21382 *p++ = '[';
21383 *p = 0;
21384 return decode_mode_spec_buf;
21385 }
21386
21387 case ']':
21388 {
21389 int i;
21390 char *p;
21391
21392 if (command_loop_level > 5)
21393 return " ...]]]";
21394 p = decode_mode_spec_buf;
21395 for (i = 0; i < command_loop_level; i++)
21396 *p++ = ']';
21397 *p = 0;
21398 return decode_mode_spec_buf;
21399 }
21400
21401 case '-':
21402 {
21403 register int i;
21404
21405 /* Let lots_of_dashes be a string of infinite length. */
21406 if (mode_line_target == MODE_LINE_NOPROP ||
21407 mode_line_target == MODE_LINE_STRING)
21408 return "--";
21409 if (field_width <= 0
21410 || field_width > sizeof (lots_of_dashes))
21411 {
21412 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
21413 decode_mode_spec_buf[i] = '-';
21414 decode_mode_spec_buf[i] = '\0';
21415 return decode_mode_spec_buf;
21416 }
21417 else
21418 return lots_of_dashes;
21419 }
21420
21421 case 'b':
21422 obj = BVAR (b, name);
21423 break;
21424
21425 case 'c':
21426 /* %c and %l are ignored in `frame-title-format'.
21427 (In redisplay_internal, the frame title is drawn _before_ the
21428 windows are updated, so the stuff which depends on actual
21429 window contents (such as %l) may fail to render properly, or
21430 even crash emacs.) */
21431 if (mode_line_target == MODE_LINE_TITLE)
21432 return "";
21433 else
21434 {
21435 ptrdiff_t col = current_column ();
21436 wset_column_number_displayed (w, make_number (col));
21437 pint2str (decode_mode_spec_buf, field_width, col);
21438 return decode_mode_spec_buf;
21439 }
21440
21441 case 'e':
21442 #ifndef SYSTEM_MALLOC
21443 {
21444 if (NILP (Vmemory_full))
21445 return "";
21446 else
21447 return "!MEM FULL! ";
21448 }
21449 #else
21450 return "";
21451 #endif
21452
21453 case 'F':
21454 /* %F displays the frame name. */
21455 if (!NILP (f->title))
21456 return SSDATA (f->title);
21457 if (f->explicit_name || ! FRAME_WINDOW_P (f))
21458 return SSDATA (f->name);
21459 return "Emacs";
21460
21461 case 'f':
21462 obj = BVAR (b, filename);
21463 break;
21464
21465 case 'i':
21466 {
21467 ptrdiff_t size = ZV - BEGV;
21468 pint2str (decode_mode_spec_buf, field_width, size);
21469 return decode_mode_spec_buf;
21470 }
21471
21472 case 'I':
21473 {
21474 ptrdiff_t size = ZV - BEGV;
21475 pint2hrstr (decode_mode_spec_buf, field_width, size);
21476 return decode_mode_spec_buf;
21477 }
21478
21479 case 'l':
21480 {
21481 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
21482 ptrdiff_t topline, nlines, height;
21483 ptrdiff_t junk;
21484
21485 /* %c and %l are ignored in `frame-title-format'. */
21486 if (mode_line_target == MODE_LINE_TITLE)
21487 return "";
21488
21489 startpos = XMARKER (w->start)->charpos;
21490 startpos_byte = marker_byte_position (w->start);
21491 height = WINDOW_TOTAL_LINES (w);
21492
21493 /* If we decided that this buffer isn't suitable for line numbers,
21494 don't forget that too fast. */
21495 if (EQ (w->base_line_pos, w->buffer))
21496 goto no_value;
21497 /* But do forget it, if the window shows a different buffer now. */
21498 else if (BUFFERP (w->base_line_pos))
21499 wset_base_line_pos (w, Qnil);
21500
21501 /* If the buffer is very big, don't waste time. */
21502 if (INTEGERP (Vline_number_display_limit)
21503 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
21504 {
21505 wset_base_line_pos (w, Qnil);
21506 wset_base_line_number (w, Qnil);
21507 goto no_value;
21508 }
21509
21510 if (INTEGERP (w->base_line_number)
21511 && INTEGERP (w->base_line_pos)
21512 && XFASTINT (w->base_line_pos) <= startpos)
21513 {
21514 line = XFASTINT (w->base_line_number);
21515 linepos = XFASTINT (w->base_line_pos);
21516 linepos_byte = buf_charpos_to_bytepos (b, linepos);
21517 }
21518 else
21519 {
21520 line = 1;
21521 linepos = BUF_BEGV (b);
21522 linepos_byte = BUF_BEGV_BYTE (b);
21523 }
21524
21525 /* Count lines from base line to window start position. */
21526 nlines = display_count_lines (linepos_byte,
21527 startpos_byte,
21528 startpos, &junk);
21529
21530 topline = nlines + line;
21531
21532 /* Determine a new base line, if the old one is too close
21533 or too far away, or if we did not have one.
21534 "Too close" means it's plausible a scroll-down would
21535 go back past it. */
21536 if (startpos == BUF_BEGV (b))
21537 {
21538 wset_base_line_number (w, make_number (topline));
21539 wset_base_line_pos (w, make_number (BUF_BEGV (b)));
21540 }
21541 else if (nlines < height + 25 || nlines > height * 3 + 50
21542 || linepos == BUF_BEGV (b))
21543 {
21544 ptrdiff_t limit = BUF_BEGV (b);
21545 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
21546 ptrdiff_t position;
21547 ptrdiff_t distance =
21548 (height * 2 + 30) * line_number_display_limit_width;
21549
21550 if (startpos - distance > limit)
21551 {
21552 limit = startpos - distance;
21553 limit_byte = CHAR_TO_BYTE (limit);
21554 }
21555
21556 nlines = display_count_lines (startpos_byte,
21557 limit_byte,
21558 - (height * 2 + 30),
21559 &position);
21560 /* If we couldn't find the lines we wanted within
21561 line_number_display_limit_width chars per line,
21562 give up on line numbers for this window. */
21563 if (position == limit_byte && limit == startpos - distance)
21564 {
21565 wset_base_line_pos (w, w->buffer);
21566 wset_base_line_number (w, Qnil);
21567 goto no_value;
21568 }
21569
21570 wset_base_line_number (w, make_number (topline - nlines));
21571 wset_base_line_pos (w, make_number (BYTE_TO_CHAR (position)));
21572 }
21573
21574 /* Now count lines from the start pos to point. */
21575 nlines = display_count_lines (startpos_byte,
21576 PT_BYTE, PT, &junk);
21577
21578 /* Record that we did display the line number. */
21579 line_number_displayed = 1;
21580
21581 /* Make the string to show. */
21582 pint2str (decode_mode_spec_buf, field_width, topline + nlines);
21583 return decode_mode_spec_buf;
21584 no_value:
21585 {
21586 char* p = decode_mode_spec_buf;
21587 int pad = field_width - 2;
21588 while (pad-- > 0)
21589 *p++ = ' ';
21590 *p++ = '?';
21591 *p++ = '?';
21592 *p = '\0';
21593 return decode_mode_spec_buf;
21594 }
21595 }
21596 break;
21597
21598 case 'm':
21599 obj = BVAR (b, mode_name);
21600 break;
21601
21602 case 'n':
21603 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
21604 return " Narrow";
21605 break;
21606
21607 case 'p':
21608 {
21609 ptrdiff_t pos = marker_position (w->start);
21610 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
21611
21612 if (XFASTINT (w->window_end_pos) <= BUF_Z (b) - BUF_ZV (b))
21613 {
21614 if (pos <= BUF_BEGV (b))
21615 return "All";
21616 else
21617 return "Bottom";
21618 }
21619 else if (pos <= BUF_BEGV (b))
21620 return "Top";
21621 else
21622 {
21623 if (total > 1000000)
21624 /* Do it differently for a large value, to avoid overflow. */
21625 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
21626 else
21627 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
21628 /* We can't normally display a 3-digit number,
21629 so get us a 2-digit number that is close. */
21630 if (total == 100)
21631 total = 99;
21632 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
21633 return decode_mode_spec_buf;
21634 }
21635 }
21636
21637 /* Display percentage of size above the bottom of the screen. */
21638 case 'P':
21639 {
21640 ptrdiff_t toppos = marker_position (w->start);
21641 ptrdiff_t botpos = BUF_Z (b) - XFASTINT (w->window_end_pos);
21642 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
21643
21644 if (botpos >= BUF_ZV (b))
21645 {
21646 if (toppos <= BUF_BEGV (b))
21647 return "All";
21648 else
21649 return "Bottom";
21650 }
21651 else
21652 {
21653 if (total > 1000000)
21654 /* Do it differently for a large value, to avoid overflow. */
21655 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
21656 else
21657 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
21658 /* We can't normally display a 3-digit number,
21659 so get us a 2-digit number that is close. */
21660 if (total == 100)
21661 total = 99;
21662 if (toppos <= BUF_BEGV (b))
21663 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
21664 else
21665 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
21666 return decode_mode_spec_buf;
21667 }
21668 }
21669
21670 case 's':
21671 /* status of process */
21672 obj = Fget_buffer_process (Fcurrent_buffer ());
21673 if (NILP (obj))
21674 return "no process";
21675 #ifndef MSDOS
21676 obj = Fsymbol_name (Fprocess_status (obj));
21677 #endif
21678 break;
21679
21680 case '@':
21681 {
21682 ptrdiff_t count = inhibit_garbage_collection ();
21683 Lisp_Object val = call1 (intern ("file-remote-p"),
21684 BVAR (current_buffer, directory));
21685 unbind_to (count, Qnil);
21686
21687 if (NILP (val))
21688 return "-";
21689 else
21690 return "@";
21691 }
21692
21693 case 't': /* indicate TEXT or BINARY */
21694 return "T";
21695
21696 case 'z':
21697 /* coding-system (not including end-of-line format) */
21698 case 'Z':
21699 /* coding-system (including end-of-line type) */
21700 {
21701 int eol_flag = (c == 'Z');
21702 char *p = decode_mode_spec_buf;
21703
21704 if (! FRAME_WINDOW_P (f))
21705 {
21706 /* No need to mention EOL here--the terminal never needs
21707 to do EOL conversion. */
21708 p = decode_mode_spec_coding (CODING_ID_NAME
21709 (FRAME_KEYBOARD_CODING (f)->id),
21710 p, 0);
21711 p = decode_mode_spec_coding (CODING_ID_NAME
21712 (FRAME_TERMINAL_CODING (f)->id),
21713 p, 0);
21714 }
21715 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
21716 p, eol_flag);
21717
21718 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21719 #ifdef subprocesses
21720 obj = Fget_buffer_process (Fcurrent_buffer ());
21721 if (PROCESSP (obj))
21722 {
21723 p = decode_mode_spec_coding
21724 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
21725 p = decode_mode_spec_coding
21726 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
21727 }
21728 #endif /* subprocesses */
21729 #endif /* 0 */
21730 *p = 0;
21731 return decode_mode_spec_buf;
21732 }
21733 }
21734
21735 if (STRINGP (obj))
21736 {
21737 *string = obj;
21738 return SSDATA (obj);
21739 }
21740 else
21741 return "";
21742 }
21743
21744
21745 /* Count up to COUNT lines starting from START_BYTE.
21746 But don't go beyond LIMIT_BYTE.
21747 Return the number of lines thus found (always nonnegative).
21748
21749 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21750
21751 static ptrdiff_t
21752 display_count_lines (ptrdiff_t start_byte,
21753 ptrdiff_t limit_byte, ptrdiff_t count,
21754 ptrdiff_t *byte_pos_ptr)
21755 {
21756 register unsigned char *cursor;
21757 unsigned char *base;
21758
21759 register ptrdiff_t ceiling;
21760 register unsigned char *ceiling_addr;
21761 ptrdiff_t orig_count = count;
21762
21763 /* If we are not in selective display mode,
21764 check only for newlines. */
21765 int selective_display = (!NILP (BVAR (current_buffer, selective_display))
21766 && !INTEGERP (BVAR (current_buffer, selective_display)));
21767
21768 if (count > 0)
21769 {
21770 while (start_byte < limit_byte)
21771 {
21772 ceiling = BUFFER_CEILING_OF (start_byte);
21773 ceiling = min (limit_byte - 1, ceiling);
21774 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
21775 base = (cursor = BYTE_POS_ADDR (start_byte));
21776 while (1)
21777 {
21778 if (selective_display)
21779 while (*cursor != '\n' && *cursor != 015 && ++cursor != ceiling_addr)
21780 ;
21781 else
21782 while (*cursor != '\n' && ++cursor != ceiling_addr)
21783 ;
21784
21785 if (cursor != ceiling_addr)
21786 {
21787 if (--count == 0)
21788 {
21789 start_byte += cursor - base + 1;
21790 *byte_pos_ptr = start_byte;
21791 return orig_count;
21792 }
21793 else
21794 if (++cursor == ceiling_addr)
21795 break;
21796 }
21797 else
21798 break;
21799 }
21800 start_byte += cursor - base;
21801 }
21802 }
21803 else
21804 {
21805 while (start_byte > limit_byte)
21806 {
21807 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
21808 ceiling = max (limit_byte, ceiling);
21809 ceiling_addr = BYTE_POS_ADDR (ceiling) - 1;
21810 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
21811 while (1)
21812 {
21813 if (selective_display)
21814 while (--cursor != ceiling_addr
21815 && *cursor != '\n' && *cursor != 015)
21816 ;
21817 else
21818 while (--cursor != ceiling_addr && *cursor != '\n')
21819 ;
21820
21821 if (cursor != ceiling_addr)
21822 {
21823 if (++count == 0)
21824 {
21825 start_byte += cursor - base + 1;
21826 *byte_pos_ptr = start_byte;
21827 /* When scanning backwards, we should
21828 not count the newline posterior to which we stop. */
21829 return - orig_count - 1;
21830 }
21831 }
21832 else
21833 break;
21834 }
21835 /* Here we add 1 to compensate for the last decrement
21836 of CURSOR, which took it past the valid range. */
21837 start_byte += cursor - base + 1;
21838 }
21839 }
21840
21841 *byte_pos_ptr = limit_byte;
21842
21843 if (count < 0)
21844 return - orig_count + count;
21845 return orig_count - count;
21846
21847 }
21848
21849
21850 \f
21851 /***********************************************************************
21852 Displaying strings
21853 ***********************************************************************/
21854
21855 /* Display a NUL-terminated string, starting with index START.
21856
21857 If STRING is non-null, display that C string. Otherwise, the Lisp
21858 string LISP_STRING is displayed. There's a case that STRING is
21859 non-null and LISP_STRING is not nil. It means STRING is a string
21860 data of LISP_STRING. In that case, we display LISP_STRING while
21861 ignoring its text properties.
21862
21863 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21864 FACE_STRING. Display STRING or LISP_STRING with the face at
21865 FACE_STRING_POS in FACE_STRING:
21866
21867 Display the string in the environment given by IT, but use the
21868 standard display table, temporarily.
21869
21870 FIELD_WIDTH is the minimum number of output glyphs to produce.
21871 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21872 with spaces. If STRING has more characters, more than FIELD_WIDTH
21873 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21874
21875 PRECISION is the maximum number of characters to output from
21876 STRING. PRECISION < 0 means don't truncate the string.
21877
21878 This is roughly equivalent to printf format specifiers:
21879
21880 FIELD_WIDTH PRECISION PRINTF
21881 ----------------------------------------
21882 -1 -1 %s
21883 -1 10 %.10s
21884 10 -1 %10s
21885 20 10 %20.10s
21886
21887 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21888 display them, and < 0 means obey the current buffer's value of
21889 enable_multibyte_characters.
21890
21891 Value is the number of columns displayed. */
21892
21893 static int
21894 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
21895 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
21896 int field_width, int precision, int max_x, int multibyte)
21897 {
21898 int hpos_at_start = it->hpos;
21899 int saved_face_id = it->face_id;
21900 struct glyph_row *row = it->glyph_row;
21901 ptrdiff_t it_charpos;
21902
21903 /* Initialize the iterator IT for iteration over STRING beginning
21904 with index START. */
21905 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
21906 precision, field_width, multibyte);
21907 if (string && STRINGP (lisp_string))
21908 /* LISP_STRING is the one returned by decode_mode_spec. We should
21909 ignore its text properties. */
21910 it->stop_charpos = it->end_charpos;
21911
21912 /* If displaying STRING, set up the face of the iterator from
21913 FACE_STRING, if that's given. */
21914 if (STRINGP (face_string))
21915 {
21916 ptrdiff_t endptr;
21917 struct face *face;
21918
21919 it->face_id
21920 = face_at_string_position (it->w, face_string, face_string_pos,
21921 0, it->region_beg_charpos,
21922 it->region_end_charpos,
21923 &endptr, it->base_face_id, 0);
21924 face = FACE_FROM_ID (it->f, it->face_id);
21925 it->face_box_p = face->box != FACE_NO_BOX;
21926 }
21927
21928 /* Set max_x to the maximum allowed X position. Don't let it go
21929 beyond the right edge of the window. */
21930 if (max_x <= 0)
21931 max_x = it->last_visible_x;
21932 else
21933 max_x = min (max_x, it->last_visible_x);
21934
21935 /* Skip over display elements that are not visible. because IT->w is
21936 hscrolled. */
21937 if (it->current_x < it->first_visible_x)
21938 move_it_in_display_line_to (it, 100000, it->first_visible_x,
21939 MOVE_TO_POS | MOVE_TO_X);
21940
21941 row->ascent = it->max_ascent;
21942 row->height = it->max_ascent + it->max_descent;
21943 row->phys_ascent = it->max_phys_ascent;
21944 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
21945 row->extra_line_spacing = it->max_extra_line_spacing;
21946
21947 if (STRINGP (it->string))
21948 it_charpos = IT_STRING_CHARPOS (*it);
21949 else
21950 it_charpos = IT_CHARPOS (*it);
21951
21952 /* This condition is for the case that we are called with current_x
21953 past last_visible_x. */
21954 while (it->current_x < max_x)
21955 {
21956 int x_before, x, n_glyphs_before, i, nglyphs;
21957
21958 /* Get the next display element. */
21959 if (!get_next_display_element (it))
21960 break;
21961
21962 /* Produce glyphs. */
21963 x_before = it->current_x;
21964 n_glyphs_before = row->used[TEXT_AREA];
21965 PRODUCE_GLYPHS (it);
21966
21967 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
21968 i = 0;
21969 x = x_before;
21970 while (i < nglyphs)
21971 {
21972 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
21973
21974 if (it->line_wrap != TRUNCATE
21975 && x + glyph->pixel_width > max_x)
21976 {
21977 /* End of continued line or max_x reached. */
21978 if (CHAR_GLYPH_PADDING_P (*glyph))
21979 {
21980 /* A wide character is unbreakable. */
21981 if (row->reversed_p)
21982 unproduce_glyphs (it, row->used[TEXT_AREA]
21983 - n_glyphs_before);
21984 row->used[TEXT_AREA] = n_glyphs_before;
21985 it->current_x = x_before;
21986 }
21987 else
21988 {
21989 if (row->reversed_p)
21990 unproduce_glyphs (it, row->used[TEXT_AREA]
21991 - (n_glyphs_before + i));
21992 row->used[TEXT_AREA] = n_glyphs_before + i;
21993 it->current_x = x;
21994 }
21995 break;
21996 }
21997 else if (x + glyph->pixel_width >= it->first_visible_x)
21998 {
21999 /* Glyph is at least partially visible. */
22000 ++it->hpos;
22001 if (x < it->first_visible_x)
22002 row->x = x - it->first_visible_x;
22003 }
22004 else
22005 {
22006 /* Glyph is off the left margin of the display area.
22007 Should not happen. */
22008 emacs_abort ();
22009 }
22010
22011 row->ascent = max (row->ascent, it->max_ascent);
22012 row->height = max (row->height, it->max_ascent + it->max_descent);
22013 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
22014 row->phys_height = max (row->phys_height,
22015 it->max_phys_ascent + it->max_phys_descent);
22016 row->extra_line_spacing = max (row->extra_line_spacing,
22017 it->max_extra_line_spacing);
22018 x += glyph->pixel_width;
22019 ++i;
22020 }
22021
22022 /* Stop if max_x reached. */
22023 if (i < nglyphs)
22024 break;
22025
22026 /* Stop at line ends. */
22027 if (ITERATOR_AT_END_OF_LINE_P (it))
22028 {
22029 it->continuation_lines_width = 0;
22030 break;
22031 }
22032
22033 set_iterator_to_next (it, 1);
22034 if (STRINGP (it->string))
22035 it_charpos = IT_STRING_CHARPOS (*it);
22036 else
22037 it_charpos = IT_CHARPOS (*it);
22038
22039 /* Stop if truncating at the right edge. */
22040 if (it->line_wrap == TRUNCATE
22041 && it->current_x >= it->last_visible_x)
22042 {
22043 /* Add truncation mark, but don't do it if the line is
22044 truncated at a padding space. */
22045 if (it_charpos < it->string_nchars)
22046 {
22047 if (!FRAME_WINDOW_P (it->f))
22048 {
22049 int ii, n;
22050
22051 if (it->current_x > it->last_visible_x)
22052 {
22053 if (!row->reversed_p)
22054 {
22055 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
22056 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
22057 break;
22058 }
22059 else
22060 {
22061 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
22062 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
22063 break;
22064 unproduce_glyphs (it, ii + 1);
22065 ii = row->used[TEXT_AREA] - (ii + 1);
22066 }
22067 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
22068 {
22069 row->used[TEXT_AREA] = ii;
22070 produce_special_glyphs (it, IT_TRUNCATION);
22071 }
22072 }
22073 produce_special_glyphs (it, IT_TRUNCATION);
22074 }
22075 row->truncated_on_right_p = 1;
22076 }
22077 break;
22078 }
22079 }
22080
22081 /* Maybe insert a truncation at the left. */
22082 if (it->first_visible_x
22083 && it_charpos > 0)
22084 {
22085 if (!FRAME_WINDOW_P (it->f)
22086 || (row->reversed_p
22087 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
22088 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
22089 insert_left_trunc_glyphs (it);
22090 row->truncated_on_left_p = 1;
22091 }
22092
22093 it->face_id = saved_face_id;
22094
22095 /* Value is number of columns displayed. */
22096 return it->hpos - hpos_at_start;
22097 }
22098
22099
22100 \f
22101 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22102 appears as an element of LIST or as the car of an element of LIST.
22103 If PROPVAL is a list, compare each element against LIST in that
22104 way, and return 1/2 if any element of PROPVAL is found in LIST.
22105 Otherwise return 0. This function cannot quit.
22106 The return value is 2 if the text is invisible but with an ellipsis
22107 and 1 if it's invisible and without an ellipsis. */
22108
22109 int
22110 invisible_p (register Lisp_Object propval, Lisp_Object list)
22111 {
22112 register Lisp_Object tail, proptail;
22113
22114 for (tail = list; CONSP (tail); tail = XCDR (tail))
22115 {
22116 register Lisp_Object tem;
22117 tem = XCAR (tail);
22118 if (EQ (propval, tem))
22119 return 1;
22120 if (CONSP (tem) && EQ (propval, XCAR (tem)))
22121 return NILP (XCDR (tem)) ? 1 : 2;
22122 }
22123
22124 if (CONSP (propval))
22125 {
22126 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
22127 {
22128 Lisp_Object propelt;
22129 propelt = XCAR (proptail);
22130 for (tail = list; CONSP (tail); tail = XCDR (tail))
22131 {
22132 register Lisp_Object tem;
22133 tem = XCAR (tail);
22134 if (EQ (propelt, tem))
22135 return 1;
22136 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
22137 return NILP (XCDR (tem)) ? 1 : 2;
22138 }
22139 }
22140 }
22141
22142 return 0;
22143 }
22144
22145 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
22146 doc: /* Non-nil if the property makes the text invisible.
22147 POS-OR-PROP can be a marker or number, in which case it is taken to be
22148 a position in the current buffer and the value of the `invisible' property
22149 is checked; or it can be some other value, which is then presumed to be the
22150 value of the `invisible' property of the text of interest.
22151 The non-nil value returned can be t for truly invisible text or something
22152 else if the text is replaced by an ellipsis. */)
22153 (Lisp_Object pos_or_prop)
22154 {
22155 Lisp_Object prop
22156 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
22157 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
22158 : pos_or_prop);
22159 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
22160 return (invis == 0 ? Qnil
22161 : invis == 1 ? Qt
22162 : make_number (invis));
22163 }
22164
22165 /* Calculate a width or height in pixels from a specification using
22166 the following elements:
22167
22168 SPEC ::=
22169 NUM - a (fractional) multiple of the default font width/height
22170 (NUM) - specifies exactly NUM pixels
22171 UNIT - a fixed number of pixels, see below.
22172 ELEMENT - size of a display element in pixels, see below.
22173 (NUM . SPEC) - equals NUM * SPEC
22174 (+ SPEC SPEC ...) - add pixel values
22175 (- SPEC SPEC ...) - subtract pixel values
22176 (- SPEC) - negate pixel value
22177
22178 NUM ::=
22179 INT or FLOAT - a number constant
22180 SYMBOL - use symbol's (buffer local) variable binding.
22181
22182 UNIT ::=
22183 in - pixels per inch *)
22184 mm - pixels per 1/1000 meter *)
22185 cm - pixels per 1/100 meter *)
22186 width - width of current font in pixels.
22187 height - height of current font in pixels.
22188
22189 *) using the ratio(s) defined in display-pixels-per-inch.
22190
22191 ELEMENT ::=
22192
22193 left-fringe - left fringe width in pixels
22194 right-fringe - right fringe width in pixels
22195
22196 left-margin - left margin width in pixels
22197 right-margin - right margin width in pixels
22198
22199 scroll-bar - scroll-bar area width in pixels
22200
22201 Examples:
22202
22203 Pixels corresponding to 5 inches:
22204 (5 . in)
22205
22206 Total width of non-text areas on left side of window (if scroll-bar is on left):
22207 '(space :width (+ left-fringe left-margin scroll-bar))
22208
22209 Align to first text column (in header line):
22210 '(space :align-to 0)
22211
22212 Align to middle of text area minus half the width of variable `my-image'
22213 containing a loaded image:
22214 '(space :align-to (0.5 . (- text my-image)))
22215
22216 Width of left margin minus width of 1 character in the default font:
22217 '(space :width (- left-margin 1))
22218
22219 Width of left margin minus width of 2 characters in the current font:
22220 '(space :width (- left-margin (2 . width)))
22221
22222 Center 1 character over left-margin (in header line):
22223 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22224
22225 Different ways to express width of left fringe plus left margin minus one pixel:
22226 '(space :width (- (+ left-fringe left-margin) (1)))
22227 '(space :width (+ left-fringe left-margin (- (1))))
22228 '(space :width (+ left-fringe left-margin (-1)))
22229
22230 */
22231
22232 #define NUMVAL(X) \
22233 ((INTEGERP (X) || FLOATP (X)) \
22234 ? XFLOATINT (X) \
22235 : - 1)
22236
22237 static int
22238 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
22239 struct font *font, int width_p, int *align_to)
22240 {
22241 double pixels;
22242
22243 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22244 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22245
22246 if (NILP (prop))
22247 return OK_PIXELS (0);
22248
22249 eassert (FRAME_LIVE_P (it->f));
22250
22251 if (SYMBOLP (prop))
22252 {
22253 if (SCHARS (SYMBOL_NAME (prop)) == 2)
22254 {
22255 char *unit = SSDATA (SYMBOL_NAME (prop));
22256
22257 if (unit[0] == 'i' && unit[1] == 'n')
22258 pixels = 1.0;
22259 else if (unit[0] == 'm' && unit[1] == 'm')
22260 pixels = 25.4;
22261 else if (unit[0] == 'c' && unit[1] == 'm')
22262 pixels = 2.54;
22263 else
22264 pixels = 0;
22265 if (pixels > 0)
22266 {
22267 double ppi;
22268 #ifdef HAVE_WINDOW_SYSTEM
22269 if (FRAME_WINDOW_P (it->f)
22270 && (ppi = (width_p
22271 ? FRAME_X_DISPLAY_INFO (it->f)->resx
22272 : FRAME_X_DISPLAY_INFO (it->f)->resy),
22273 ppi > 0))
22274 return OK_PIXELS (ppi / pixels);
22275 #endif
22276
22277 if ((ppi = NUMVAL (Vdisplay_pixels_per_inch), ppi > 0)
22278 || (CONSP (Vdisplay_pixels_per_inch)
22279 && (ppi = (width_p
22280 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch))
22281 : NUMVAL (XCDR (Vdisplay_pixels_per_inch))),
22282 ppi > 0)))
22283 return OK_PIXELS (ppi / pixels);
22284
22285 return 0;
22286 }
22287 }
22288
22289 #ifdef HAVE_WINDOW_SYSTEM
22290 if (EQ (prop, Qheight))
22291 return OK_PIXELS (font ? FONT_HEIGHT (font) : FRAME_LINE_HEIGHT (it->f));
22292 if (EQ (prop, Qwidth))
22293 return OK_PIXELS (font ? FONT_WIDTH (font) : FRAME_COLUMN_WIDTH (it->f));
22294 #else
22295 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
22296 return OK_PIXELS (1);
22297 #endif
22298
22299 if (EQ (prop, Qtext))
22300 return OK_PIXELS (width_p
22301 ? window_box_width (it->w, TEXT_AREA)
22302 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
22303
22304 if (align_to && *align_to < 0)
22305 {
22306 *res = 0;
22307 if (EQ (prop, Qleft))
22308 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
22309 if (EQ (prop, Qright))
22310 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
22311 if (EQ (prop, Qcenter))
22312 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
22313 + window_box_width (it->w, TEXT_AREA) / 2);
22314 if (EQ (prop, Qleft_fringe))
22315 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
22316 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
22317 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
22318 if (EQ (prop, Qright_fringe))
22319 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
22320 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
22321 : window_box_right_offset (it->w, TEXT_AREA));
22322 if (EQ (prop, Qleft_margin))
22323 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
22324 if (EQ (prop, Qright_margin))
22325 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
22326 if (EQ (prop, Qscroll_bar))
22327 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
22328 ? 0
22329 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
22330 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
22331 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
22332 : 0)));
22333 }
22334 else
22335 {
22336 if (EQ (prop, Qleft_fringe))
22337 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
22338 if (EQ (prop, Qright_fringe))
22339 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
22340 if (EQ (prop, Qleft_margin))
22341 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
22342 if (EQ (prop, Qright_margin))
22343 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
22344 if (EQ (prop, Qscroll_bar))
22345 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
22346 }
22347
22348 prop = buffer_local_value_1 (prop, it->w->buffer);
22349 if (EQ (prop, Qunbound))
22350 prop = Qnil;
22351 }
22352
22353 if (INTEGERP (prop) || FLOATP (prop))
22354 {
22355 int base_unit = (width_p
22356 ? FRAME_COLUMN_WIDTH (it->f)
22357 : FRAME_LINE_HEIGHT (it->f));
22358 return OK_PIXELS (XFLOATINT (prop) * base_unit);
22359 }
22360
22361 if (CONSP (prop))
22362 {
22363 Lisp_Object car = XCAR (prop);
22364 Lisp_Object cdr = XCDR (prop);
22365
22366 if (SYMBOLP (car))
22367 {
22368 #ifdef HAVE_WINDOW_SYSTEM
22369 if (FRAME_WINDOW_P (it->f)
22370 && valid_image_p (prop))
22371 {
22372 ptrdiff_t id = lookup_image (it->f, prop);
22373 struct image *img = IMAGE_FROM_ID (it->f, id);
22374
22375 return OK_PIXELS (width_p ? img->width : img->height);
22376 }
22377 #endif
22378 if (EQ (car, Qplus) || EQ (car, Qminus))
22379 {
22380 int first = 1;
22381 double px;
22382
22383 pixels = 0;
22384 while (CONSP (cdr))
22385 {
22386 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
22387 font, width_p, align_to))
22388 return 0;
22389 if (first)
22390 pixels = (EQ (car, Qplus) ? px : -px), first = 0;
22391 else
22392 pixels += px;
22393 cdr = XCDR (cdr);
22394 }
22395 if (EQ (car, Qminus))
22396 pixels = -pixels;
22397 return OK_PIXELS (pixels);
22398 }
22399
22400 car = buffer_local_value_1 (car, it->w->buffer);
22401 if (EQ (car, Qunbound))
22402 car = Qnil;
22403 }
22404
22405 if (INTEGERP (car) || FLOATP (car))
22406 {
22407 double fact;
22408 pixels = XFLOATINT (car);
22409 if (NILP (cdr))
22410 return OK_PIXELS (pixels);
22411 if (calc_pixel_width_or_height (&fact, it, cdr,
22412 font, width_p, align_to))
22413 return OK_PIXELS (pixels * fact);
22414 return 0;
22415 }
22416
22417 return 0;
22418 }
22419
22420 return 0;
22421 }
22422
22423 \f
22424 /***********************************************************************
22425 Glyph Display
22426 ***********************************************************************/
22427
22428 #ifdef HAVE_WINDOW_SYSTEM
22429
22430 #ifdef GLYPH_DEBUG
22431
22432 void
22433 dump_glyph_string (struct glyph_string *s)
22434 {
22435 fprintf (stderr, "glyph string\n");
22436 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
22437 s->x, s->y, s->width, s->height);
22438 fprintf (stderr, " ybase = %d\n", s->ybase);
22439 fprintf (stderr, " hl = %d\n", s->hl);
22440 fprintf (stderr, " left overhang = %d, right = %d\n",
22441 s->left_overhang, s->right_overhang);
22442 fprintf (stderr, " nchars = %d\n", s->nchars);
22443 fprintf (stderr, " extends to end of line = %d\n",
22444 s->extends_to_end_of_line_p);
22445 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
22446 fprintf (stderr, " bg width = %d\n", s->background_width);
22447 }
22448
22449 #endif /* GLYPH_DEBUG */
22450
22451 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22452 of XChar2b structures for S; it can't be allocated in
22453 init_glyph_string because it must be allocated via `alloca'. W
22454 is the window on which S is drawn. ROW and AREA are the glyph row
22455 and area within the row from which S is constructed. START is the
22456 index of the first glyph structure covered by S. HL is a
22457 face-override for drawing S. */
22458
22459 #ifdef HAVE_NTGUI
22460 #define OPTIONAL_HDC(hdc) HDC hdc,
22461 #define DECLARE_HDC(hdc) HDC hdc;
22462 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22463 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22464 #endif
22465
22466 #ifndef OPTIONAL_HDC
22467 #define OPTIONAL_HDC(hdc)
22468 #define DECLARE_HDC(hdc)
22469 #define ALLOCATE_HDC(hdc, f)
22470 #define RELEASE_HDC(hdc, f)
22471 #endif
22472
22473 static void
22474 init_glyph_string (struct glyph_string *s,
22475 OPTIONAL_HDC (hdc)
22476 XChar2b *char2b, struct window *w, struct glyph_row *row,
22477 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
22478 {
22479 memset (s, 0, sizeof *s);
22480 s->w = w;
22481 s->f = XFRAME (w->frame);
22482 #ifdef HAVE_NTGUI
22483 s->hdc = hdc;
22484 #endif
22485 s->display = FRAME_X_DISPLAY (s->f);
22486 s->window = FRAME_X_WINDOW (s->f);
22487 s->char2b = char2b;
22488 s->hl = hl;
22489 s->row = row;
22490 s->area = area;
22491 s->first_glyph = row->glyphs[area] + start;
22492 s->height = row->height;
22493 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
22494 s->ybase = s->y + row->ascent;
22495 }
22496
22497
22498 /* Append the list of glyph strings with head H and tail T to the list
22499 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22500
22501 static inline void
22502 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
22503 struct glyph_string *h, struct glyph_string *t)
22504 {
22505 if (h)
22506 {
22507 if (*head)
22508 (*tail)->next = h;
22509 else
22510 *head = h;
22511 h->prev = *tail;
22512 *tail = t;
22513 }
22514 }
22515
22516
22517 /* Prepend the list of glyph strings with head H and tail T to the
22518 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22519 result. */
22520
22521 static inline void
22522 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
22523 struct glyph_string *h, struct glyph_string *t)
22524 {
22525 if (h)
22526 {
22527 if (*head)
22528 (*head)->prev = t;
22529 else
22530 *tail = t;
22531 t->next = *head;
22532 *head = h;
22533 }
22534 }
22535
22536
22537 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22538 Set *HEAD and *TAIL to the resulting list. */
22539
22540 static inline void
22541 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
22542 struct glyph_string *s)
22543 {
22544 s->next = s->prev = NULL;
22545 append_glyph_string_lists (head, tail, s, s);
22546 }
22547
22548
22549 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22550 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22551 make sure that X resources for the face returned are allocated.
22552 Value is a pointer to a realized face that is ready for display if
22553 DISPLAY_P is non-zero. */
22554
22555 static inline struct face *
22556 get_char_face_and_encoding (struct frame *f, int c, int face_id,
22557 XChar2b *char2b, int display_p)
22558 {
22559 struct face *face = FACE_FROM_ID (f, face_id);
22560
22561 if (face->font)
22562 {
22563 unsigned code = face->font->driver->encode_char (face->font, c);
22564
22565 if (code != FONT_INVALID_CODE)
22566 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
22567 else
22568 STORE_XCHAR2B (char2b, 0, 0);
22569 }
22570
22571 /* Make sure X resources of the face are allocated. */
22572 #ifdef HAVE_X_WINDOWS
22573 if (display_p)
22574 #endif
22575 {
22576 eassert (face != NULL);
22577 PREPARE_FACE_FOR_DISPLAY (f, face);
22578 }
22579
22580 return face;
22581 }
22582
22583
22584 /* Get face and two-byte form of character glyph GLYPH on frame F.
22585 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22586 a pointer to a realized face that is ready for display. */
22587
22588 static inline struct face *
22589 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
22590 XChar2b *char2b, int *two_byte_p)
22591 {
22592 struct face *face;
22593
22594 eassert (glyph->type == CHAR_GLYPH);
22595 face = FACE_FROM_ID (f, glyph->face_id);
22596
22597 if (two_byte_p)
22598 *two_byte_p = 0;
22599
22600 if (face->font)
22601 {
22602 unsigned code;
22603
22604 if (CHAR_BYTE8_P (glyph->u.ch))
22605 code = CHAR_TO_BYTE8 (glyph->u.ch);
22606 else
22607 code = face->font->driver->encode_char (face->font, glyph->u.ch);
22608
22609 if (code != FONT_INVALID_CODE)
22610 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
22611 else
22612 STORE_XCHAR2B (char2b, 0, 0);
22613 }
22614
22615 /* Make sure X resources of the face are allocated. */
22616 eassert (face != NULL);
22617 PREPARE_FACE_FOR_DISPLAY (f, face);
22618 return face;
22619 }
22620
22621
22622 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22623 Return 1 if FONT has a glyph for C, otherwise return 0. */
22624
22625 static inline int
22626 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
22627 {
22628 unsigned code;
22629
22630 if (CHAR_BYTE8_P (c))
22631 code = CHAR_TO_BYTE8 (c);
22632 else
22633 code = font->driver->encode_char (font, c);
22634
22635 if (code == FONT_INVALID_CODE)
22636 return 0;
22637 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
22638 return 1;
22639 }
22640
22641
22642 /* Fill glyph string S with composition components specified by S->cmp.
22643
22644 BASE_FACE is the base face of the composition.
22645 S->cmp_from is the index of the first component for S.
22646
22647 OVERLAPS non-zero means S should draw the foreground only, and use
22648 its physical height for clipping. See also draw_glyphs.
22649
22650 Value is the index of a component not in S. */
22651
22652 static int
22653 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
22654 int overlaps)
22655 {
22656 int i;
22657 /* For all glyphs of this composition, starting at the offset
22658 S->cmp_from, until we reach the end of the definition or encounter a
22659 glyph that requires the different face, add it to S. */
22660 struct face *face;
22661
22662 eassert (s);
22663
22664 s->for_overlaps = overlaps;
22665 s->face = NULL;
22666 s->font = NULL;
22667 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
22668 {
22669 int c = COMPOSITION_GLYPH (s->cmp, i);
22670
22671 /* TAB in a composition means display glyphs with padding space
22672 on the left or right. */
22673 if (c != '\t')
22674 {
22675 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
22676 -1, Qnil);
22677
22678 face = get_char_face_and_encoding (s->f, c, face_id,
22679 s->char2b + i, 1);
22680 if (face)
22681 {
22682 if (! s->face)
22683 {
22684 s->face = face;
22685 s->font = s->face->font;
22686 }
22687 else if (s->face != face)
22688 break;
22689 }
22690 }
22691 ++s->nchars;
22692 }
22693 s->cmp_to = i;
22694
22695 if (s->face == NULL)
22696 {
22697 s->face = base_face->ascii_face;
22698 s->font = s->face->font;
22699 }
22700
22701 /* All glyph strings for the same composition has the same width,
22702 i.e. the width set for the first component of the composition. */
22703 s->width = s->first_glyph->pixel_width;
22704
22705 /* If the specified font could not be loaded, use the frame's
22706 default font, but record the fact that we couldn't load it in
22707 the glyph string so that we can draw rectangles for the
22708 characters of the glyph string. */
22709 if (s->font == NULL)
22710 {
22711 s->font_not_found_p = 1;
22712 s->font = FRAME_FONT (s->f);
22713 }
22714
22715 /* Adjust base line for subscript/superscript text. */
22716 s->ybase += s->first_glyph->voffset;
22717
22718 /* This glyph string must always be drawn with 16-bit functions. */
22719 s->two_byte_p = 1;
22720
22721 return s->cmp_to;
22722 }
22723
22724 static int
22725 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
22726 int start, int end, int overlaps)
22727 {
22728 struct glyph *glyph, *last;
22729 Lisp_Object lgstring;
22730 int i;
22731
22732 s->for_overlaps = overlaps;
22733 glyph = s->row->glyphs[s->area] + start;
22734 last = s->row->glyphs[s->area] + end;
22735 s->cmp_id = glyph->u.cmp.id;
22736 s->cmp_from = glyph->slice.cmp.from;
22737 s->cmp_to = glyph->slice.cmp.to + 1;
22738 s->face = FACE_FROM_ID (s->f, face_id);
22739 lgstring = composition_gstring_from_id (s->cmp_id);
22740 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
22741 glyph++;
22742 while (glyph < last
22743 && glyph->u.cmp.automatic
22744 && glyph->u.cmp.id == s->cmp_id
22745 && s->cmp_to == glyph->slice.cmp.from)
22746 s->cmp_to = (glyph++)->slice.cmp.to + 1;
22747
22748 for (i = s->cmp_from; i < s->cmp_to; i++)
22749 {
22750 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
22751 unsigned code = LGLYPH_CODE (lglyph);
22752
22753 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
22754 }
22755 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
22756 return glyph - s->row->glyphs[s->area];
22757 }
22758
22759
22760 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22761 See the comment of fill_glyph_string for arguments.
22762 Value is the index of the first glyph not in S. */
22763
22764
22765 static int
22766 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
22767 int start, int end, int overlaps)
22768 {
22769 struct glyph *glyph, *last;
22770 int voffset;
22771
22772 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
22773 s->for_overlaps = overlaps;
22774 glyph = s->row->glyphs[s->area] + start;
22775 last = s->row->glyphs[s->area] + end;
22776 voffset = glyph->voffset;
22777 s->face = FACE_FROM_ID (s->f, face_id);
22778 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
22779 s->nchars = 1;
22780 s->width = glyph->pixel_width;
22781 glyph++;
22782 while (glyph < last
22783 && glyph->type == GLYPHLESS_GLYPH
22784 && glyph->voffset == voffset
22785 && glyph->face_id == face_id)
22786 {
22787 s->nchars++;
22788 s->width += glyph->pixel_width;
22789 glyph++;
22790 }
22791 s->ybase += voffset;
22792 return glyph - s->row->glyphs[s->area];
22793 }
22794
22795
22796 /* Fill glyph string S from a sequence of character glyphs.
22797
22798 FACE_ID is the face id of the string. START is the index of the
22799 first glyph to consider, END is the index of the last + 1.
22800 OVERLAPS non-zero means S should draw the foreground only, and use
22801 its physical height for clipping. See also draw_glyphs.
22802
22803 Value is the index of the first glyph not in S. */
22804
22805 static int
22806 fill_glyph_string (struct glyph_string *s, int face_id,
22807 int start, int end, int overlaps)
22808 {
22809 struct glyph *glyph, *last;
22810 int voffset;
22811 int glyph_not_available_p;
22812
22813 eassert (s->f == XFRAME (s->w->frame));
22814 eassert (s->nchars == 0);
22815 eassert (start >= 0 && end > start);
22816
22817 s->for_overlaps = overlaps;
22818 glyph = s->row->glyphs[s->area] + start;
22819 last = s->row->glyphs[s->area] + end;
22820 voffset = glyph->voffset;
22821 s->padding_p = glyph->padding_p;
22822 glyph_not_available_p = glyph->glyph_not_available_p;
22823
22824 while (glyph < last
22825 && glyph->type == CHAR_GLYPH
22826 && glyph->voffset == voffset
22827 /* Same face id implies same font, nowadays. */
22828 && glyph->face_id == face_id
22829 && glyph->glyph_not_available_p == glyph_not_available_p)
22830 {
22831 int two_byte_p;
22832
22833 s->face = get_glyph_face_and_encoding (s->f, glyph,
22834 s->char2b + s->nchars,
22835 &two_byte_p);
22836 s->two_byte_p = two_byte_p;
22837 ++s->nchars;
22838 eassert (s->nchars <= end - start);
22839 s->width += glyph->pixel_width;
22840 if (glyph++->padding_p != s->padding_p)
22841 break;
22842 }
22843
22844 s->font = s->face->font;
22845
22846 /* If the specified font could not be loaded, use the frame's font,
22847 but record the fact that we couldn't load it in
22848 S->font_not_found_p so that we can draw rectangles for the
22849 characters of the glyph string. */
22850 if (s->font == NULL || glyph_not_available_p)
22851 {
22852 s->font_not_found_p = 1;
22853 s->font = FRAME_FONT (s->f);
22854 }
22855
22856 /* Adjust base line for subscript/superscript text. */
22857 s->ybase += voffset;
22858
22859 eassert (s->face && s->face->gc);
22860 return glyph - s->row->glyphs[s->area];
22861 }
22862
22863
22864 /* Fill glyph string S from image glyph S->first_glyph. */
22865
22866 static void
22867 fill_image_glyph_string (struct glyph_string *s)
22868 {
22869 eassert (s->first_glyph->type == IMAGE_GLYPH);
22870 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
22871 eassert (s->img);
22872 s->slice = s->first_glyph->slice.img;
22873 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
22874 s->font = s->face->font;
22875 s->width = s->first_glyph->pixel_width;
22876
22877 /* Adjust base line for subscript/superscript text. */
22878 s->ybase += s->first_glyph->voffset;
22879 }
22880
22881
22882 /* Fill glyph string S from a sequence of stretch glyphs.
22883
22884 START is the index of the first glyph to consider,
22885 END is the index of the last + 1.
22886
22887 Value is the index of the first glyph not in S. */
22888
22889 static int
22890 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
22891 {
22892 struct glyph *glyph, *last;
22893 int voffset, face_id;
22894
22895 eassert (s->first_glyph->type == STRETCH_GLYPH);
22896
22897 glyph = s->row->glyphs[s->area] + start;
22898 last = s->row->glyphs[s->area] + end;
22899 face_id = glyph->face_id;
22900 s->face = FACE_FROM_ID (s->f, face_id);
22901 s->font = s->face->font;
22902 s->width = glyph->pixel_width;
22903 s->nchars = 1;
22904 voffset = glyph->voffset;
22905
22906 for (++glyph;
22907 (glyph < last
22908 && glyph->type == STRETCH_GLYPH
22909 && glyph->voffset == voffset
22910 && glyph->face_id == face_id);
22911 ++glyph)
22912 s->width += glyph->pixel_width;
22913
22914 /* Adjust base line for subscript/superscript text. */
22915 s->ybase += voffset;
22916
22917 /* The case that face->gc == 0 is handled when drawing the glyph
22918 string by calling PREPARE_FACE_FOR_DISPLAY. */
22919 eassert (s->face);
22920 return glyph - s->row->glyphs[s->area];
22921 }
22922
22923 static struct font_metrics *
22924 get_per_char_metric (struct font *font, XChar2b *char2b)
22925 {
22926 static struct font_metrics metrics;
22927 unsigned code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
22928
22929 if (! font || code == FONT_INVALID_CODE)
22930 return NULL;
22931 font->driver->text_extents (font, &code, 1, &metrics);
22932 return &metrics;
22933 }
22934
22935 /* EXPORT for RIF:
22936 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22937 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22938 assumed to be zero. */
22939
22940 void
22941 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
22942 {
22943 *left = *right = 0;
22944
22945 if (glyph->type == CHAR_GLYPH)
22946 {
22947 struct face *face;
22948 XChar2b char2b;
22949 struct font_metrics *pcm;
22950
22951 face = get_glyph_face_and_encoding (f, glyph, &char2b, NULL);
22952 if (face->font && (pcm = get_per_char_metric (face->font, &char2b)))
22953 {
22954 if (pcm->rbearing > pcm->width)
22955 *right = pcm->rbearing - pcm->width;
22956 if (pcm->lbearing < 0)
22957 *left = -pcm->lbearing;
22958 }
22959 }
22960 else if (glyph->type == COMPOSITE_GLYPH)
22961 {
22962 if (! glyph->u.cmp.automatic)
22963 {
22964 struct composition *cmp = composition_table[glyph->u.cmp.id];
22965
22966 if (cmp->rbearing > cmp->pixel_width)
22967 *right = cmp->rbearing - cmp->pixel_width;
22968 if (cmp->lbearing < 0)
22969 *left = - cmp->lbearing;
22970 }
22971 else
22972 {
22973 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
22974 struct font_metrics metrics;
22975
22976 composition_gstring_width (gstring, glyph->slice.cmp.from,
22977 glyph->slice.cmp.to + 1, &metrics);
22978 if (metrics.rbearing > metrics.width)
22979 *right = metrics.rbearing - metrics.width;
22980 if (metrics.lbearing < 0)
22981 *left = - metrics.lbearing;
22982 }
22983 }
22984 }
22985
22986
22987 /* Return the index of the first glyph preceding glyph string S that
22988 is overwritten by S because of S's left overhang. Value is -1
22989 if no glyphs are overwritten. */
22990
22991 static int
22992 left_overwritten (struct glyph_string *s)
22993 {
22994 int k;
22995
22996 if (s->left_overhang)
22997 {
22998 int x = 0, i;
22999 struct glyph *glyphs = s->row->glyphs[s->area];
23000 int first = s->first_glyph - glyphs;
23001
23002 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
23003 x -= glyphs[i].pixel_width;
23004
23005 k = i + 1;
23006 }
23007 else
23008 k = -1;
23009
23010 return k;
23011 }
23012
23013
23014 /* Return the index of the first glyph preceding glyph string S that
23015 is overwriting S because of its right overhang. Value is -1 if no
23016 glyph in front of S overwrites S. */
23017
23018 static int
23019 left_overwriting (struct glyph_string *s)
23020 {
23021 int i, k, x;
23022 struct glyph *glyphs = s->row->glyphs[s->area];
23023 int first = s->first_glyph - glyphs;
23024
23025 k = -1;
23026 x = 0;
23027 for (i = first - 1; i >= 0; --i)
23028 {
23029 int left, right;
23030 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
23031 if (x + right > 0)
23032 k = i;
23033 x -= glyphs[i].pixel_width;
23034 }
23035
23036 return k;
23037 }
23038
23039
23040 /* Return the index of the last glyph following glyph string S that is
23041 overwritten by S because of S's right overhang. Value is -1 if
23042 no such glyph is found. */
23043
23044 static int
23045 right_overwritten (struct glyph_string *s)
23046 {
23047 int k = -1;
23048
23049 if (s->right_overhang)
23050 {
23051 int x = 0, i;
23052 struct glyph *glyphs = s->row->glyphs[s->area];
23053 int first = (s->first_glyph - glyphs) + (s->cmp ? 1 : s->nchars);
23054 int end = s->row->used[s->area];
23055
23056 for (i = first; i < end && s->right_overhang > x; ++i)
23057 x += glyphs[i].pixel_width;
23058
23059 k = i;
23060 }
23061
23062 return k;
23063 }
23064
23065
23066 /* Return the index of the last glyph following glyph string S that
23067 overwrites S because of its left overhang. Value is negative
23068 if no such glyph is found. */
23069
23070 static int
23071 right_overwriting (struct glyph_string *s)
23072 {
23073 int i, k, x;
23074 int end = s->row->used[s->area];
23075 struct glyph *glyphs = s->row->glyphs[s->area];
23076 int first = (s->first_glyph - glyphs) + (s->cmp ? 1 : s->nchars);
23077
23078 k = -1;
23079 x = 0;
23080 for (i = first; i < end; ++i)
23081 {
23082 int left, right;
23083 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
23084 if (x - left < 0)
23085 k = i;
23086 x += glyphs[i].pixel_width;
23087 }
23088
23089 return k;
23090 }
23091
23092
23093 /* Set background width of glyph string S. START is the index of the
23094 first glyph following S. LAST_X is the right-most x-position + 1
23095 in the drawing area. */
23096
23097 static inline void
23098 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
23099 {
23100 /* If the face of this glyph string has to be drawn to the end of
23101 the drawing area, set S->extends_to_end_of_line_p. */
23102
23103 if (start == s->row->used[s->area]
23104 && s->area == TEXT_AREA
23105 && ((s->row->fill_line_p
23106 && (s->hl == DRAW_NORMAL_TEXT
23107 || s->hl == DRAW_IMAGE_RAISED
23108 || s->hl == DRAW_IMAGE_SUNKEN))
23109 || s->hl == DRAW_MOUSE_FACE))
23110 s->extends_to_end_of_line_p = 1;
23111
23112 /* If S extends its face to the end of the line, set its
23113 background_width to the distance to the right edge of the drawing
23114 area. */
23115 if (s->extends_to_end_of_line_p)
23116 s->background_width = last_x - s->x + 1;
23117 else
23118 s->background_width = s->width;
23119 }
23120
23121
23122 /* Compute overhangs and x-positions for glyph string S and its
23123 predecessors, or successors. X is the starting x-position for S.
23124 BACKWARD_P non-zero means process predecessors. */
23125
23126 static void
23127 compute_overhangs_and_x (struct glyph_string *s, int x, int backward_p)
23128 {
23129 if (backward_p)
23130 {
23131 while (s)
23132 {
23133 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
23134 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
23135 x -= s->width;
23136 s->x = x;
23137 s = s->prev;
23138 }
23139 }
23140 else
23141 {
23142 while (s)
23143 {
23144 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
23145 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
23146 s->x = x;
23147 x += s->width;
23148 s = s->next;
23149 }
23150 }
23151 }
23152
23153
23154
23155 /* The following macros are only called from draw_glyphs below.
23156 They reference the following parameters of that function directly:
23157 `w', `row', `area', and `overlap_p'
23158 as well as the following local variables:
23159 `s', `f', and `hdc' (in W32) */
23160
23161 #ifdef HAVE_NTGUI
23162 /* On W32, silently add local `hdc' variable to argument list of
23163 init_glyph_string. */
23164 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23165 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23166 #else
23167 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23168 init_glyph_string (s, char2b, w, row, area, start, hl)
23169 #endif
23170
23171 /* Add a glyph string for a stretch glyph to the list of strings
23172 between HEAD and TAIL. START is the index of the stretch glyph in
23173 row area AREA of glyph row ROW. END is the index of the last glyph
23174 in that glyph row area. X is the current output position assigned
23175 to the new glyph string constructed. HL overrides that face of the
23176 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23177 is the right-most x-position of the drawing area. */
23178
23179 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23180 and below -- keep them on one line. */
23181 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23182 do \
23183 { \
23184 s = alloca (sizeof *s); \
23185 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23186 START = fill_stretch_glyph_string (s, START, END); \
23187 append_glyph_string (&HEAD, &TAIL, s); \
23188 s->x = (X); \
23189 } \
23190 while (0)
23191
23192
23193 /* Add a glyph string for an image glyph to the list of strings
23194 between HEAD and TAIL. START is the index of the image glyph in
23195 row area AREA of glyph row ROW. END is the index of the last glyph
23196 in that glyph row area. X is the current output position assigned
23197 to the new glyph string constructed. HL overrides that face of the
23198 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23199 is the right-most x-position of the drawing area. */
23200
23201 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23202 do \
23203 { \
23204 s = alloca (sizeof *s); \
23205 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23206 fill_image_glyph_string (s); \
23207 append_glyph_string (&HEAD, &TAIL, s); \
23208 ++START; \
23209 s->x = (X); \
23210 } \
23211 while (0)
23212
23213
23214 /* Add a glyph string for a sequence of character glyphs to the list
23215 of strings between HEAD and TAIL. START is the index of the first
23216 glyph in row area AREA of glyph row ROW that is part of the new
23217 glyph string. END is the index of the last glyph in that glyph row
23218 area. X is the current output position assigned to the new glyph
23219 string constructed. HL overrides that face of the glyph; e.g. it
23220 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23221 right-most x-position of the drawing area. */
23222
23223 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23224 do \
23225 { \
23226 int face_id; \
23227 XChar2b *char2b; \
23228 \
23229 face_id = (row)->glyphs[area][START].face_id; \
23230 \
23231 s = alloca (sizeof *s); \
23232 char2b = alloca ((END - START) * sizeof *char2b); \
23233 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23234 append_glyph_string (&HEAD, &TAIL, s); \
23235 s->x = (X); \
23236 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23237 } \
23238 while (0)
23239
23240
23241 /* Add a glyph string for a composite sequence to the list of strings
23242 between HEAD and TAIL. START is the index of the first glyph in
23243 row area AREA of glyph row ROW that is part of the new glyph
23244 string. END is the index of the last glyph in that glyph row area.
23245 X is the current output position assigned to the new glyph string
23246 constructed. HL overrides that face of the glyph; e.g. it is
23247 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23248 x-position of the drawing area. */
23249
23250 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23251 do { \
23252 int face_id = (row)->glyphs[area][START].face_id; \
23253 struct face *base_face = FACE_FROM_ID (f, face_id); \
23254 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23255 struct composition *cmp = composition_table[cmp_id]; \
23256 XChar2b *char2b; \
23257 struct glyph_string *first_s = NULL; \
23258 int n; \
23259 \
23260 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23261 \
23262 /* Make glyph_strings for each glyph sequence that is drawable by \
23263 the same face, and append them to HEAD/TAIL. */ \
23264 for (n = 0; n < cmp->glyph_len;) \
23265 { \
23266 s = alloca (sizeof *s); \
23267 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23268 append_glyph_string (&(HEAD), &(TAIL), s); \
23269 s->cmp = cmp; \
23270 s->cmp_from = n; \
23271 s->x = (X); \
23272 if (n == 0) \
23273 first_s = s; \
23274 n = fill_composite_glyph_string (s, base_face, overlaps); \
23275 } \
23276 \
23277 ++START; \
23278 s = first_s; \
23279 } while (0)
23280
23281
23282 /* Add a glyph string for a glyph-string sequence to the list of strings
23283 between HEAD and TAIL. */
23284
23285 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23286 do { \
23287 int face_id; \
23288 XChar2b *char2b; \
23289 Lisp_Object gstring; \
23290 \
23291 face_id = (row)->glyphs[area][START].face_id; \
23292 gstring = (composition_gstring_from_id \
23293 ((row)->glyphs[area][START].u.cmp.id)); \
23294 s = alloca (sizeof *s); \
23295 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23296 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23297 append_glyph_string (&(HEAD), &(TAIL), s); \
23298 s->x = (X); \
23299 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23300 } while (0)
23301
23302
23303 /* Add a glyph string for a sequence of glyphless character's glyphs
23304 to the list of strings between HEAD and TAIL. The meanings of
23305 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23306
23307 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23308 do \
23309 { \
23310 int face_id; \
23311 \
23312 face_id = (row)->glyphs[area][START].face_id; \
23313 \
23314 s = alloca (sizeof *s); \
23315 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23316 append_glyph_string (&HEAD, &TAIL, s); \
23317 s->x = (X); \
23318 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23319 overlaps); \
23320 } \
23321 while (0)
23322
23323
23324 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23325 of AREA of glyph row ROW on window W between indices START and END.
23326 HL overrides the face for drawing glyph strings, e.g. it is
23327 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23328 x-positions of the drawing area.
23329
23330 This is an ugly monster macro construct because we must use alloca
23331 to allocate glyph strings (because draw_glyphs can be called
23332 asynchronously). */
23333
23334 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23335 do \
23336 { \
23337 HEAD = TAIL = NULL; \
23338 while (START < END) \
23339 { \
23340 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23341 switch (first_glyph->type) \
23342 { \
23343 case CHAR_GLYPH: \
23344 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23345 HL, X, LAST_X); \
23346 break; \
23347 \
23348 case COMPOSITE_GLYPH: \
23349 if (first_glyph->u.cmp.automatic) \
23350 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23351 HL, X, LAST_X); \
23352 else \
23353 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23354 HL, X, LAST_X); \
23355 break; \
23356 \
23357 case STRETCH_GLYPH: \
23358 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23359 HL, X, LAST_X); \
23360 break; \
23361 \
23362 case IMAGE_GLYPH: \
23363 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23364 HL, X, LAST_X); \
23365 break; \
23366 \
23367 case GLYPHLESS_GLYPH: \
23368 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23369 HL, X, LAST_X); \
23370 break; \
23371 \
23372 default: \
23373 emacs_abort (); \
23374 } \
23375 \
23376 if (s) \
23377 { \
23378 set_glyph_string_background_width (s, START, LAST_X); \
23379 (X) += s->width; \
23380 } \
23381 } \
23382 } while (0)
23383
23384
23385 /* Draw glyphs between START and END in AREA of ROW on window W,
23386 starting at x-position X. X is relative to AREA in W. HL is a
23387 face-override with the following meaning:
23388
23389 DRAW_NORMAL_TEXT draw normally
23390 DRAW_CURSOR draw in cursor face
23391 DRAW_MOUSE_FACE draw in mouse face.
23392 DRAW_INVERSE_VIDEO draw in mode line face
23393 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23394 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23395
23396 If OVERLAPS is non-zero, draw only the foreground of characters and
23397 clip to the physical height of ROW. Non-zero value also defines
23398 the overlapping part to be drawn:
23399
23400 OVERLAPS_PRED overlap with preceding rows
23401 OVERLAPS_SUCC overlap with succeeding rows
23402 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23403 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23404
23405 Value is the x-position reached, relative to AREA of W. */
23406
23407 static int
23408 draw_glyphs (struct window *w, int x, struct glyph_row *row,
23409 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
23410 enum draw_glyphs_face hl, int overlaps)
23411 {
23412 struct glyph_string *head, *tail;
23413 struct glyph_string *s;
23414 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
23415 int i, j, x_reached, last_x, area_left = 0;
23416 struct frame *f = XFRAME (WINDOW_FRAME (w));
23417 DECLARE_HDC (hdc);
23418
23419 ALLOCATE_HDC (hdc, f);
23420
23421 /* Let's rather be paranoid than getting a SEGV. */
23422 end = min (end, row->used[area]);
23423 start = max (0, start);
23424 start = min (end, start);
23425
23426 /* Translate X to frame coordinates. Set last_x to the right
23427 end of the drawing area. */
23428 if (row->full_width_p)
23429 {
23430 /* X is relative to the left edge of W, without scroll bars
23431 or fringes. */
23432 area_left = WINDOW_LEFT_EDGE_X (w);
23433 last_x = WINDOW_LEFT_EDGE_X (w) + WINDOW_TOTAL_WIDTH (w);
23434 }
23435 else
23436 {
23437 area_left = window_box_left (w, area);
23438 last_x = area_left + window_box_width (w, area);
23439 }
23440 x += area_left;
23441
23442 /* Build a doubly-linked list of glyph_string structures between
23443 head and tail from what we have to draw. Note that the macro
23444 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23445 the reason we use a separate variable `i'. */
23446 i = start;
23447 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
23448 if (tail)
23449 x_reached = tail->x + tail->background_width;
23450 else
23451 x_reached = x;
23452
23453 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23454 the row, redraw some glyphs in front or following the glyph
23455 strings built above. */
23456 if (head && !overlaps && row->contains_overlapping_glyphs_p)
23457 {
23458 struct glyph_string *h, *t;
23459 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
23460 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
23461 int check_mouse_face = 0;
23462 int dummy_x = 0;
23463
23464 /* If mouse highlighting is on, we may need to draw adjacent
23465 glyphs using mouse-face highlighting. */
23466 if (area == TEXT_AREA && row->mouse_face_p)
23467 {
23468 struct glyph_row *mouse_beg_row, *mouse_end_row;
23469
23470 mouse_beg_row = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
23471 mouse_end_row = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
23472
23473 if (row >= mouse_beg_row && row <= mouse_end_row)
23474 {
23475 check_mouse_face = 1;
23476 mouse_beg_col = (row == mouse_beg_row)
23477 ? hlinfo->mouse_face_beg_col : 0;
23478 mouse_end_col = (row == mouse_end_row)
23479 ? hlinfo->mouse_face_end_col
23480 : row->used[TEXT_AREA];
23481 }
23482 }
23483
23484 /* Compute overhangs for all glyph strings. */
23485 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
23486 for (s = head; s; s = s->next)
23487 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
23488
23489 /* Prepend glyph strings for glyphs in front of the first glyph
23490 string that are overwritten because of the first glyph
23491 string's left overhang. The background of all strings
23492 prepended must be drawn because the first glyph string
23493 draws over it. */
23494 i = left_overwritten (head);
23495 if (i >= 0)
23496 {
23497 enum draw_glyphs_face overlap_hl;
23498
23499 /* If this row contains mouse highlighting, attempt to draw
23500 the overlapped glyphs with the correct highlight. This
23501 code fails if the overlap encompasses more than one glyph
23502 and mouse-highlight spans only some of these glyphs.
23503 However, making it work perfectly involves a lot more
23504 code, and I don't know if the pathological case occurs in
23505 practice, so we'll stick to this for now. --- cyd */
23506 if (check_mouse_face
23507 && mouse_beg_col < start && mouse_end_col > i)
23508 overlap_hl = DRAW_MOUSE_FACE;
23509 else
23510 overlap_hl = DRAW_NORMAL_TEXT;
23511
23512 j = i;
23513 BUILD_GLYPH_STRINGS (j, start, h, t,
23514 overlap_hl, dummy_x, last_x);
23515 start = i;
23516 compute_overhangs_and_x (t, head->x, 1);
23517 prepend_glyph_string_lists (&head, &tail, h, t);
23518 clip_head = head;
23519 }
23520
23521 /* Prepend glyph strings for glyphs in front of the first glyph
23522 string that overwrite that glyph string because of their
23523 right overhang. For these strings, only the foreground must
23524 be drawn, because it draws over the glyph string at `head'.
23525 The background must not be drawn because this would overwrite
23526 right overhangs of preceding glyphs for which no glyph
23527 strings exist. */
23528 i = left_overwriting (head);
23529 if (i >= 0)
23530 {
23531 enum draw_glyphs_face overlap_hl;
23532
23533 if (check_mouse_face
23534 && mouse_beg_col < start && mouse_end_col > i)
23535 overlap_hl = DRAW_MOUSE_FACE;
23536 else
23537 overlap_hl = DRAW_NORMAL_TEXT;
23538
23539 clip_head = head;
23540 BUILD_GLYPH_STRINGS (i, start, h, t,
23541 overlap_hl, dummy_x, last_x);
23542 for (s = h; s; s = s->next)
23543 s->background_filled_p = 1;
23544 compute_overhangs_and_x (t, head->x, 1);
23545 prepend_glyph_string_lists (&head, &tail, h, t);
23546 }
23547
23548 /* Append glyphs strings for glyphs following the last glyph
23549 string tail that are overwritten by tail. The background of
23550 these strings has to be drawn because tail's foreground draws
23551 over it. */
23552 i = right_overwritten (tail);
23553 if (i >= 0)
23554 {
23555 enum draw_glyphs_face overlap_hl;
23556
23557 if (check_mouse_face
23558 && mouse_beg_col < i && mouse_end_col > end)
23559 overlap_hl = DRAW_MOUSE_FACE;
23560 else
23561 overlap_hl = DRAW_NORMAL_TEXT;
23562
23563 BUILD_GLYPH_STRINGS (end, i, h, t,
23564 overlap_hl, x, last_x);
23565 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23566 we don't have `end = i;' here. */
23567 compute_overhangs_and_x (h, tail->x + tail->width, 0);
23568 append_glyph_string_lists (&head, &tail, h, t);
23569 clip_tail = tail;
23570 }
23571
23572 /* Append glyph strings for glyphs following the last glyph
23573 string tail that overwrite tail. The foreground of such
23574 glyphs has to be drawn because it writes into the background
23575 of tail. The background must not be drawn because it could
23576 paint over the foreground of following glyphs. */
23577 i = right_overwriting (tail);
23578 if (i >= 0)
23579 {
23580 enum draw_glyphs_face overlap_hl;
23581 if (check_mouse_face
23582 && mouse_beg_col < i && mouse_end_col > end)
23583 overlap_hl = DRAW_MOUSE_FACE;
23584 else
23585 overlap_hl = DRAW_NORMAL_TEXT;
23586
23587 clip_tail = tail;
23588 i++; /* We must include the Ith glyph. */
23589 BUILD_GLYPH_STRINGS (end, i, h, t,
23590 overlap_hl, x, last_x);
23591 for (s = h; s; s = s->next)
23592 s->background_filled_p = 1;
23593 compute_overhangs_and_x (h, tail->x + tail->width, 0);
23594 append_glyph_string_lists (&head, &tail, h, t);
23595 }
23596 if (clip_head || clip_tail)
23597 for (s = head; s; s = s->next)
23598 {
23599 s->clip_head = clip_head;
23600 s->clip_tail = clip_tail;
23601 }
23602 }
23603
23604 /* Draw all strings. */
23605 for (s = head; s; s = s->next)
23606 FRAME_RIF (f)->draw_glyph_string (s);
23607
23608 #ifndef HAVE_NS
23609 /* When focus a sole frame and move horizontally, this sets on_p to 0
23610 causing a failure to erase prev cursor position. */
23611 if (area == TEXT_AREA
23612 && !row->full_width_p
23613 /* When drawing overlapping rows, only the glyph strings'
23614 foreground is drawn, which doesn't erase a cursor
23615 completely. */
23616 && !overlaps)
23617 {
23618 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
23619 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
23620 : (tail ? tail->x + tail->background_width : x));
23621 x0 -= area_left;
23622 x1 -= area_left;
23623
23624 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
23625 row->y, MATRIX_ROW_BOTTOM_Y (row));
23626 }
23627 #endif
23628
23629 /* Value is the x-position up to which drawn, relative to AREA of W.
23630 This doesn't include parts drawn because of overhangs. */
23631 if (row->full_width_p)
23632 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
23633 else
23634 x_reached -= area_left;
23635
23636 RELEASE_HDC (hdc, f);
23637
23638 return x_reached;
23639 }
23640
23641 /* Expand row matrix if too narrow. Don't expand if area
23642 is not present. */
23643
23644 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23645 { \
23646 if (!fonts_changed_p \
23647 && (it->glyph_row->glyphs[area] \
23648 < it->glyph_row->glyphs[area + 1])) \
23649 { \
23650 it->w->ncols_scale_factor++; \
23651 fonts_changed_p = 1; \
23652 } \
23653 }
23654
23655 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23656 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23657
23658 static inline void
23659 append_glyph (struct it *it)
23660 {
23661 struct glyph *glyph;
23662 enum glyph_row_area area = it->area;
23663
23664 eassert (it->glyph_row);
23665 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
23666
23667 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
23668 if (glyph < it->glyph_row->glyphs[area + 1])
23669 {
23670 /* If the glyph row is reversed, we need to prepend the glyph
23671 rather than append it. */
23672 if (it->glyph_row->reversed_p && area == TEXT_AREA)
23673 {
23674 struct glyph *g;
23675
23676 /* Make room for the additional glyph. */
23677 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
23678 g[1] = *g;
23679 glyph = it->glyph_row->glyphs[area];
23680 }
23681 glyph->charpos = CHARPOS (it->position);
23682 glyph->object = it->object;
23683 if (it->pixel_width > 0)
23684 {
23685 glyph->pixel_width = it->pixel_width;
23686 glyph->padding_p = 0;
23687 }
23688 else
23689 {
23690 /* Assure at least 1-pixel width. Otherwise, cursor can't
23691 be displayed correctly. */
23692 glyph->pixel_width = 1;
23693 glyph->padding_p = 1;
23694 }
23695 glyph->ascent = it->ascent;
23696 glyph->descent = it->descent;
23697 glyph->voffset = it->voffset;
23698 glyph->type = CHAR_GLYPH;
23699 glyph->avoid_cursor_p = it->avoid_cursor_p;
23700 glyph->multibyte_p = it->multibyte_p;
23701 glyph->left_box_line_p = it->start_of_box_run_p;
23702 glyph->right_box_line_p = it->end_of_box_run_p;
23703 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
23704 || it->phys_descent > it->descent);
23705 glyph->glyph_not_available_p = it->glyph_not_available_p;
23706 glyph->face_id = it->face_id;
23707 glyph->u.ch = it->char_to_display;
23708 glyph->slice.img = null_glyph_slice;
23709 glyph->font_type = FONT_TYPE_UNKNOWN;
23710 if (it->bidi_p)
23711 {
23712 glyph->resolved_level = it->bidi_it.resolved_level;
23713 if ((it->bidi_it.type & 7) != it->bidi_it.type)
23714 emacs_abort ();
23715 glyph->bidi_type = it->bidi_it.type;
23716 }
23717 else
23718 {
23719 glyph->resolved_level = 0;
23720 glyph->bidi_type = UNKNOWN_BT;
23721 }
23722 ++it->glyph_row->used[area];
23723 }
23724 else
23725 IT_EXPAND_MATRIX_WIDTH (it, area);
23726 }
23727
23728 /* Store one glyph for the composition IT->cmp_it.id in
23729 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23730 non-null. */
23731
23732 static inline void
23733 append_composite_glyph (struct it *it)
23734 {
23735 struct glyph *glyph;
23736 enum glyph_row_area area = it->area;
23737
23738 eassert (it->glyph_row);
23739
23740 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
23741 if (glyph < it->glyph_row->glyphs[area + 1])
23742 {
23743 /* If the glyph row is reversed, we need to prepend the glyph
23744 rather than append it. */
23745 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
23746 {
23747 struct glyph *g;
23748
23749 /* Make room for the new glyph. */
23750 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
23751 g[1] = *g;
23752 glyph = it->glyph_row->glyphs[it->area];
23753 }
23754 glyph->charpos = it->cmp_it.charpos;
23755 glyph->object = it->object;
23756 glyph->pixel_width = it->pixel_width;
23757 glyph->ascent = it->ascent;
23758 glyph->descent = it->descent;
23759 glyph->voffset = it->voffset;
23760 glyph->type = COMPOSITE_GLYPH;
23761 if (it->cmp_it.ch < 0)
23762 {
23763 glyph->u.cmp.automatic = 0;
23764 glyph->u.cmp.id = it->cmp_it.id;
23765 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
23766 }
23767 else
23768 {
23769 glyph->u.cmp.automatic = 1;
23770 glyph->u.cmp.id = it->cmp_it.id;
23771 glyph->slice.cmp.from = it->cmp_it.from;
23772 glyph->slice.cmp.to = it->cmp_it.to - 1;
23773 }
23774 glyph->avoid_cursor_p = it->avoid_cursor_p;
23775 glyph->multibyte_p = it->multibyte_p;
23776 glyph->left_box_line_p = it->start_of_box_run_p;
23777 glyph->right_box_line_p = it->end_of_box_run_p;
23778 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
23779 || it->phys_descent > it->descent);
23780 glyph->padding_p = 0;
23781 glyph->glyph_not_available_p = 0;
23782 glyph->face_id = it->face_id;
23783 glyph->font_type = FONT_TYPE_UNKNOWN;
23784 if (it->bidi_p)
23785 {
23786 glyph->resolved_level = it->bidi_it.resolved_level;
23787 if ((it->bidi_it.type & 7) != it->bidi_it.type)
23788 emacs_abort ();
23789 glyph->bidi_type = it->bidi_it.type;
23790 }
23791 ++it->glyph_row->used[area];
23792 }
23793 else
23794 IT_EXPAND_MATRIX_WIDTH (it, area);
23795 }
23796
23797
23798 /* Change IT->ascent and IT->height according to the setting of
23799 IT->voffset. */
23800
23801 static inline void
23802 take_vertical_position_into_account (struct it *it)
23803 {
23804 if (it->voffset)
23805 {
23806 if (it->voffset < 0)
23807 /* Increase the ascent so that we can display the text higher
23808 in the line. */
23809 it->ascent -= it->voffset;
23810 else
23811 /* Increase the descent so that we can display the text lower
23812 in the line. */
23813 it->descent += it->voffset;
23814 }
23815 }
23816
23817
23818 /* Produce glyphs/get display metrics for the image IT is loaded with.
23819 See the description of struct display_iterator in dispextern.h for
23820 an overview of struct display_iterator. */
23821
23822 static void
23823 produce_image_glyph (struct it *it)
23824 {
23825 struct image *img;
23826 struct face *face;
23827 int glyph_ascent, crop;
23828 struct glyph_slice slice;
23829
23830 eassert (it->what == IT_IMAGE);
23831
23832 face = FACE_FROM_ID (it->f, it->face_id);
23833 eassert (face);
23834 /* Make sure X resources of the face is loaded. */
23835 PREPARE_FACE_FOR_DISPLAY (it->f, face);
23836
23837 if (it->image_id < 0)
23838 {
23839 /* Fringe bitmap. */
23840 it->ascent = it->phys_ascent = 0;
23841 it->descent = it->phys_descent = 0;
23842 it->pixel_width = 0;
23843 it->nglyphs = 0;
23844 return;
23845 }
23846
23847 img = IMAGE_FROM_ID (it->f, it->image_id);
23848 eassert (img);
23849 /* Make sure X resources of the image is loaded. */
23850 prepare_image_for_display (it->f, img);
23851
23852 slice.x = slice.y = 0;
23853 slice.width = img->width;
23854 slice.height = img->height;
23855
23856 if (INTEGERP (it->slice.x))
23857 slice.x = XINT (it->slice.x);
23858 else if (FLOATP (it->slice.x))
23859 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
23860
23861 if (INTEGERP (it->slice.y))
23862 slice.y = XINT (it->slice.y);
23863 else if (FLOATP (it->slice.y))
23864 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
23865
23866 if (INTEGERP (it->slice.width))
23867 slice.width = XINT (it->slice.width);
23868 else if (FLOATP (it->slice.width))
23869 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
23870
23871 if (INTEGERP (it->slice.height))
23872 slice.height = XINT (it->slice.height);
23873 else if (FLOATP (it->slice.height))
23874 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
23875
23876 if (slice.x >= img->width)
23877 slice.x = img->width;
23878 if (slice.y >= img->height)
23879 slice.y = img->height;
23880 if (slice.x + slice.width >= img->width)
23881 slice.width = img->width - slice.x;
23882 if (slice.y + slice.height > img->height)
23883 slice.height = img->height - slice.y;
23884
23885 if (slice.width == 0 || slice.height == 0)
23886 return;
23887
23888 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
23889
23890 it->descent = slice.height - glyph_ascent;
23891 if (slice.y == 0)
23892 it->descent += img->vmargin;
23893 if (slice.y + slice.height == img->height)
23894 it->descent += img->vmargin;
23895 it->phys_descent = it->descent;
23896
23897 it->pixel_width = slice.width;
23898 if (slice.x == 0)
23899 it->pixel_width += img->hmargin;
23900 if (slice.x + slice.width == img->width)
23901 it->pixel_width += img->hmargin;
23902
23903 /* It's quite possible for images to have an ascent greater than
23904 their height, so don't get confused in that case. */
23905 if (it->descent < 0)
23906 it->descent = 0;
23907
23908 it->nglyphs = 1;
23909
23910 if (face->box != FACE_NO_BOX)
23911 {
23912 if (face->box_line_width > 0)
23913 {
23914 if (slice.y == 0)
23915 it->ascent += face->box_line_width;
23916 if (slice.y + slice.height == img->height)
23917 it->descent += face->box_line_width;
23918 }
23919
23920 if (it->start_of_box_run_p && slice.x == 0)
23921 it->pixel_width += eabs (face->box_line_width);
23922 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
23923 it->pixel_width += eabs (face->box_line_width);
23924 }
23925
23926 take_vertical_position_into_account (it);
23927
23928 /* Automatically crop wide image glyphs at right edge so we can
23929 draw the cursor on same display row. */
23930 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
23931 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
23932 {
23933 it->pixel_width -= crop;
23934 slice.width -= crop;
23935 }
23936
23937 if (it->glyph_row)
23938 {
23939 struct glyph *glyph;
23940 enum glyph_row_area area = it->area;
23941
23942 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
23943 if (glyph < it->glyph_row->glyphs[area + 1])
23944 {
23945 glyph->charpos = CHARPOS (it->position);
23946 glyph->object = it->object;
23947 glyph->pixel_width = it->pixel_width;
23948 glyph->ascent = glyph_ascent;
23949 glyph->descent = it->descent;
23950 glyph->voffset = it->voffset;
23951 glyph->type = IMAGE_GLYPH;
23952 glyph->avoid_cursor_p = it->avoid_cursor_p;
23953 glyph->multibyte_p = it->multibyte_p;
23954 glyph->left_box_line_p = it->start_of_box_run_p;
23955 glyph->right_box_line_p = it->end_of_box_run_p;
23956 glyph->overlaps_vertically_p = 0;
23957 glyph->padding_p = 0;
23958 glyph->glyph_not_available_p = 0;
23959 glyph->face_id = it->face_id;
23960 glyph->u.img_id = img->id;
23961 glyph->slice.img = slice;
23962 glyph->font_type = FONT_TYPE_UNKNOWN;
23963 if (it->bidi_p)
23964 {
23965 glyph->resolved_level = it->bidi_it.resolved_level;
23966 if ((it->bidi_it.type & 7) != it->bidi_it.type)
23967 emacs_abort ();
23968 glyph->bidi_type = it->bidi_it.type;
23969 }
23970 ++it->glyph_row->used[area];
23971 }
23972 else
23973 IT_EXPAND_MATRIX_WIDTH (it, area);
23974 }
23975 }
23976
23977
23978 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23979 of the glyph, WIDTH and HEIGHT are the width and height of the
23980 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23981
23982 static void
23983 append_stretch_glyph (struct it *it, Lisp_Object object,
23984 int width, int height, int ascent)
23985 {
23986 struct glyph *glyph;
23987 enum glyph_row_area area = it->area;
23988
23989 eassert (ascent >= 0 && ascent <= height);
23990
23991 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
23992 if (glyph < it->glyph_row->glyphs[area + 1])
23993 {
23994 /* If the glyph row is reversed, we need to prepend the glyph
23995 rather than append it. */
23996 if (it->glyph_row->reversed_p && area == TEXT_AREA)
23997 {
23998 struct glyph *g;
23999
24000 /* Make room for the additional glyph. */
24001 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
24002 g[1] = *g;
24003 glyph = it->glyph_row->glyphs[area];
24004 }
24005 glyph->charpos = CHARPOS (it->position);
24006 glyph->object = object;
24007 glyph->pixel_width = width;
24008 glyph->ascent = ascent;
24009 glyph->descent = height - ascent;
24010 glyph->voffset = it->voffset;
24011 glyph->type = STRETCH_GLYPH;
24012 glyph->avoid_cursor_p = it->avoid_cursor_p;
24013 glyph->multibyte_p = it->multibyte_p;
24014 glyph->left_box_line_p = it->start_of_box_run_p;
24015 glyph->right_box_line_p = it->end_of_box_run_p;
24016 glyph->overlaps_vertically_p = 0;
24017 glyph->padding_p = 0;
24018 glyph->glyph_not_available_p = 0;
24019 glyph->face_id = it->face_id;
24020 glyph->u.stretch.ascent = ascent;
24021 glyph->u.stretch.height = height;
24022 glyph->slice.img = null_glyph_slice;
24023 glyph->font_type = FONT_TYPE_UNKNOWN;
24024 if (it->bidi_p)
24025 {
24026 glyph->resolved_level = it->bidi_it.resolved_level;
24027 if ((it->bidi_it.type & 7) != it->bidi_it.type)
24028 emacs_abort ();
24029 glyph->bidi_type = it->bidi_it.type;
24030 }
24031 else
24032 {
24033 glyph->resolved_level = 0;
24034 glyph->bidi_type = UNKNOWN_BT;
24035 }
24036 ++it->glyph_row->used[area];
24037 }
24038 else
24039 IT_EXPAND_MATRIX_WIDTH (it, area);
24040 }
24041
24042 #endif /* HAVE_WINDOW_SYSTEM */
24043
24044 /* Produce a stretch glyph for iterator IT. IT->object is the value
24045 of the glyph property displayed. The value must be a list
24046 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24047 being recognized:
24048
24049 1. `:width WIDTH' specifies that the space should be WIDTH *
24050 canonical char width wide. WIDTH may be an integer or floating
24051 point number.
24052
24053 2. `:relative-width FACTOR' specifies that the width of the stretch
24054 should be computed from the width of the first character having the
24055 `glyph' property, and should be FACTOR times that width.
24056
24057 3. `:align-to HPOS' specifies that the space should be wide enough
24058 to reach HPOS, a value in canonical character units.
24059
24060 Exactly one of the above pairs must be present.
24061
24062 4. `:height HEIGHT' specifies that the height of the stretch produced
24063 should be HEIGHT, measured in canonical character units.
24064
24065 5. `:relative-height FACTOR' specifies that the height of the
24066 stretch should be FACTOR times the height of the characters having
24067 the glyph property.
24068
24069 Either none or exactly one of 4 or 5 must be present.
24070
24071 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24072 of the stretch should be used for the ascent of the stretch.
24073 ASCENT must be in the range 0 <= ASCENT <= 100. */
24074
24075 void
24076 produce_stretch_glyph (struct it *it)
24077 {
24078 /* (space :width WIDTH :height HEIGHT ...) */
24079 Lisp_Object prop, plist;
24080 int width = 0, height = 0, align_to = -1;
24081 int zero_width_ok_p = 0;
24082 int ascent = 0;
24083 double tem;
24084 struct face *face = NULL;
24085 struct font *font = NULL;
24086
24087 #ifdef HAVE_WINDOW_SYSTEM
24088 int zero_height_ok_p = 0;
24089
24090 if (FRAME_WINDOW_P (it->f))
24091 {
24092 face = FACE_FROM_ID (it->f, it->face_id);
24093 font = face->font ? face->font : FRAME_FONT (it->f);
24094 PREPARE_FACE_FOR_DISPLAY (it->f, face);
24095 }
24096 #endif
24097
24098 /* List should start with `space'. */
24099 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
24100 plist = XCDR (it->object);
24101
24102 /* Compute the width of the stretch. */
24103 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
24104 && calc_pixel_width_or_height (&tem, it, prop, font, 1, 0))
24105 {
24106 /* Absolute width `:width WIDTH' specified and valid. */
24107 zero_width_ok_p = 1;
24108 width = (int)tem;
24109 }
24110 #ifdef HAVE_WINDOW_SYSTEM
24111 else if (FRAME_WINDOW_P (it->f)
24112 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
24113 {
24114 /* Relative width `:relative-width FACTOR' specified and valid.
24115 Compute the width of the characters having the `glyph'
24116 property. */
24117 struct it it2;
24118 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
24119
24120 it2 = *it;
24121 if (it->multibyte_p)
24122 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
24123 else
24124 {
24125 it2.c = it2.char_to_display = *p, it2.len = 1;
24126 if (! ASCII_CHAR_P (it2.c))
24127 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
24128 }
24129
24130 it2.glyph_row = NULL;
24131 it2.what = IT_CHARACTER;
24132 x_produce_glyphs (&it2);
24133 width = NUMVAL (prop) * it2.pixel_width;
24134 }
24135 #endif /* HAVE_WINDOW_SYSTEM */
24136 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
24137 && calc_pixel_width_or_height (&tem, it, prop, font, 1, &align_to))
24138 {
24139 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
24140 align_to = (align_to < 0
24141 ? 0
24142 : align_to - window_box_left_offset (it->w, TEXT_AREA));
24143 else if (align_to < 0)
24144 align_to = window_box_left_offset (it->w, TEXT_AREA);
24145 width = max (0, (int)tem + align_to - it->current_x);
24146 zero_width_ok_p = 1;
24147 }
24148 else
24149 /* Nothing specified -> width defaults to canonical char width. */
24150 width = FRAME_COLUMN_WIDTH (it->f);
24151
24152 if (width <= 0 && (width < 0 || !zero_width_ok_p))
24153 width = 1;
24154
24155 #ifdef HAVE_WINDOW_SYSTEM
24156 /* Compute height. */
24157 if (FRAME_WINDOW_P (it->f))
24158 {
24159 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
24160 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
24161 {
24162 height = (int)tem;
24163 zero_height_ok_p = 1;
24164 }
24165 else if (prop = Fplist_get (plist, QCrelative_height),
24166 NUMVAL (prop) > 0)
24167 height = FONT_HEIGHT (font) * NUMVAL (prop);
24168 else
24169 height = FONT_HEIGHT (font);
24170
24171 if (height <= 0 && (height < 0 || !zero_height_ok_p))
24172 height = 1;
24173
24174 /* Compute percentage of height used for ascent. If
24175 `:ascent ASCENT' is present and valid, use that. Otherwise,
24176 derive the ascent from the font in use. */
24177 if (prop = Fplist_get (plist, QCascent),
24178 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
24179 ascent = height * NUMVAL (prop) / 100.0;
24180 else if (!NILP (prop)
24181 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
24182 ascent = min (max (0, (int)tem), height);
24183 else
24184 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
24185 }
24186 else
24187 #endif /* HAVE_WINDOW_SYSTEM */
24188 height = 1;
24189
24190 if (width > 0 && it->line_wrap != TRUNCATE
24191 && it->current_x + width > it->last_visible_x)
24192 {
24193 width = it->last_visible_x - it->current_x;
24194 #ifdef HAVE_WINDOW_SYSTEM
24195 /* Subtract one more pixel from the stretch width, but only on
24196 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24197 width -= FRAME_WINDOW_P (it->f);
24198 #endif
24199 }
24200
24201 if (width > 0 && height > 0 && it->glyph_row)
24202 {
24203 Lisp_Object o_object = it->object;
24204 Lisp_Object object = it->stack[it->sp - 1].string;
24205 int n = width;
24206
24207 if (!STRINGP (object))
24208 object = it->w->buffer;
24209 #ifdef HAVE_WINDOW_SYSTEM
24210 if (FRAME_WINDOW_P (it->f))
24211 append_stretch_glyph (it, object, width, height, ascent);
24212 else
24213 #endif
24214 {
24215 it->object = object;
24216 it->char_to_display = ' ';
24217 it->pixel_width = it->len = 1;
24218 while (n--)
24219 tty_append_glyph (it);
24220 it->object = o_object;
24221 }
24222 }
24223
24224 it->pixel_width = width;
24225 #ifdef HAVE_WINDOW_SYSTEM
24226 if (FRAME_WINDOW_P (it->f))
24227 {
24228 it->ascent = it->phys_ascent = ascent;
24229 it->descent = it->phys_descent = height - it->ascent;
24230 it->nglyphs = width > 0 && height > 0 ? 1 : 0;
24231 take_vertical_position_into_account (it);
24232 }
24233 else
24234 #endif
24235 it->nglyphs = width;
24236 }
24237
24238 /* Get information about special display element WHAT in an
24239 environment described by IT. WHAT is one of IT_TRUNCATION or
24240 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24241 non-null glyph_row member. This function ensures that fields like
24242 face_id, c, len of IT are left untouched. */
24243
24244 static void
24245 produce_special_glyphs (struct it *it, enum display_element_type what)
24246 {
24247 struct it temp_it;
24248 Lisp_Object gc;
24249 GLYPH glyph;
24250
24251 temp_it = *it;
24252 temp_it.object = make_number (0);
24253 memset (&temp_it.current, 0, sizeof temp_it.current);
24254
24255 if (what == IT_CONTINUATION)
24256 {
24257 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24258 if (it->bidi_it.paragraph_dir == R2L)
24259 SET_GLYPH_FROM_CHAR (glyph, '/');
24260 else
24261 SET_GLYPH_FROM_CHAR (glyph, '\\');
24262 if (it->dp
24263 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
24264 {
24265 /* FIXME: Should we mirror GC for R2L lines? */
24266 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
24267 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
24268 }
24269 }
24270 else if (what == IT_TRUNCATION)
24271 {
24272 /* Truncation glyph. */
24273 SET_GLYPH_FROM_CHAR (glyph, '$');
24274 if (it->dp
24275 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
24276 {
24277 /* FIXME: Should we mirror GC for R2L lines? */
24278 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
24279 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
24280 }
24281 }
24282 else
24283 emacs_abort ();
24284
24285 #ifdef HAVE_WINDOW_SYSTEM
24286 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24287 is turned off, we precede the truncation/continuation glyphs by a
24288 stretch glyph whose width is computed such that these special
24289 glyphs are aligned at the window margin, even when very different
24290 fonts are used in different glyph rows. */
24291 if (FRAME_WINDOW_P (temp_it.f)
24292 /* init_iterator calls this with it->glyph_row == NULL, and it
24293 wants only the pixel width of the truncation/continuation
24294 glyphs. */
24295 && temp_it.glyph_row
24296 /* insert_left_trunc_glyphs calls us at the beginning of the
24297 row, and it has its own calculation of the stretch glyph
24298 width. */
24299 && temp_it.glyph_row->used[TEXT_AREA] > 0
24300 && (temp_it.glyph_row->reversed_p
24301 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
24302 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
24303 {
24304 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
24305
24306 if (stretch_width > 0)
24307 {
24308 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
24309 struct font *font =
24310 face->font ? face->font : FRAME_FONT (temp_it.f);
24311 int stretch_ascent =
24312 (((temp_it.ascent + temp_it.descent)
24313 * FONT_BASE (font)) / FONT_HEIGHT (font));
24314
24315 append_stretch_glyph (&temp_it, make_number (0), stretch_width,
24316 temp_it.ascent + temp_it.descent,
24317 stretch_ascent);
24318 }
24319 }
24320 #endif
24321
24322 temp_it.dp = NULL;
24323 temp_it.what = IT_CHARACTER;
24324 temp_it.len = 1;
24325 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
24326 temp_it.face_id = GLYPH_FACE (glyph);
24327 temp_it.len = CHAR_BYTES (temp_it.c);
24328
24329 PRODUCE_GLYPHS (&temp_it);
24330 it->pixel_width = temp_it.pixel_width;
24331 it->nglyphs = temp_it.pixel_width;
24332 }
24333
24334 #ifdef HAVE_WINDOW_SYSTEM
24335
24336 /* Calculate line-height and line-spacing properties.
24337 An integer value specifies explicit pixel value.
24338 A float value specifies relative value to current face height.
24339 A cons (float . face-name) specifies relative value to
24340 height of specified face font.
24341
24342 Returns height in pixels, or nil. */
24343
24344
24345 static Lisp_Object
24346 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
24347 int boff, int override)
24348 {
24349 Lisp_Object face_name = Qnil;
24350 int ascent, descent, height;
24351
24352 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
24353 return val;
24354
24355 if (CONSP (val))
24356 {
24357 face_name = XCAR (val);
24358 val = XCDR (val);
24359 if (!NUMBERP (val))
24360 val = make_number (1);
24361 if (NILP (face_name))
24362 {
24363 height = it->ascent + it->descent;
24364 goto scale;
24365 }
24366 }
24367
24368 if (NILP (face_name))
24369 {
24370 font = FRAME_FONT (it->f);
24371 boff = FRAME_BASELINE_OFFSET (it->f);
24372 }
24373 else if (EQ (face_name, Qt))
24374 {
24375 override = 0;
24376 }
24377 else
24378 {
24379 int face_id;
24380 struct face *face;
24381
24382 face_id = lookup_named_face (it->f, face_name, 0);
24383 if (face_id < 0)
24384 return make_number (-1);
24385
24386 face = FACE_FROM_ID (it->f, face_id);
24387 font = face->font;
24388 if (font == NULL)
24389 return make_number (-1);
24390 boff = font->baseline_offset;
24391 if (font->vertical_centering)
24392 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
24393 }
24394
24395 ascent = FONT_BASE (font) + boff;
24396 descent = FONT_DESCENT (font) - boff;
24397
24398 if (override)
24399 {
24400 it->override_ascent = ascent;
24401 it->override_descent = descent;
24402 it->override_boff = boff;
24403 }
24404
24405 height = ascent + descent;
24406
24407 scale:
24408 if (FLOATP (val))
24409 height = (int)(XFLOAT_DATA (val) * height);
24410 else if (INTEGERP (val))
24411 height *= XINT (val);
24412
24413 return make_number (height);
24414 }
24415
24416
24417 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24418 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24419 and only if this is for a character for which no font was found.
24420
24421 If the display method (it->glyphless_method) is
24422 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24423 length of the acronym or the hexadecimal string, UPPER_XOFF and
24424 UPPER_YOFF are pixel offsets for the upper part of the string,
24425 LOWER_XOFF and LOWER_YOFF are for the lower part.
24426
24427 For the other display methods, LEN through LOWER_YOFF are zero. */
24428
24429 static void
24430 append_glyphless_glyph (struct it *it, int face_id, int for_no_font, int len,
24431 short upper_xoff, short upper_yoff,
24432 short lower_xoff, short lower_yoff)
24433 {
24434 struct glyph *glyph;
24435 enum glyph_row_area area = it->area;
24436
24437 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
24438 if (glyph < it->glyph_row->glyphs[area + 1])
24439 {
24440 /* If the glyph row is reversed, we need to prepend the glyph
24441 rather than append it. */
24442 if (it->glyph_row->reversed_p && area == TEXT_AREA)
24443 {
24444 struct glyph *g;
24445
24446 /* Make room for the additional glyph. */
24447 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
24448 g[1] = *g;
24449 glyph = it->glyph_row->glyphs[area];
24450 }
24451 glyph->charpos = CHARPOS (it->position);
24452 glyph->object = it->object;
24453 glyph->pixel_width = it->pixel_width;
24454 glyph->ascent = it->ascent;
24455 glyph->descent = it->descent;
24456 glyph->voffset = it->voffset;
24457 glyph->type = GLYPHLESS_GLYPH;
24458 glyph->u.glyphless.method = it->glyphless_method;
24459 glyph->u.glyphless.for_no_font = for_no_font;
24460 glyph->u.glyphless.len = len;
24461 glyph->u.glyphless.ch = it->c;
24462 glyph->slice.glyphless.upper_xoff = upper_xoff;
24463 glyph->slice.glyphless.upper_yoff = upper_yoff;
24464 glyph->slice.glyphless.lower_xoff = lower_xoff;
24465 glyph->slice.glyphless.lower_yoff = lower_yoff;
24466 glyph->avoid_cursor_p = it->avoid_cursor_p;
24467 glyph->multibyte_p = it->multibyte_p;
24468 glyph->left_box_line_p = it->start_of_box_run_p;
24469 glyph->right_box_line_p = it->end_of_box_run_p;
24470 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
24471 || it->phys_descent > it->descent);
24472 glyph->padding_p = 0;
24473 glyph->glyph_not_available_p = 0;
24474 glyph->face_id = face_id;
24475 glyph->font_type = FONT_TYPE_UNKNOWN;
24476 if (it->bidi_p)
24477 {
24478 glyph->resolved_level = it->bidi_it.resolved_level;
24479 if ((it->bidi_it.type & 7) != it->bidi_it.type)
24480 emacs_abort ();
24481 glyph->bidi_type = it->bidi_it.type;
24482 }
24483 ++it->glyph_row->used[area];
24484 }
24485 else
24486 IT_EXPAND_MATRIX_WIDTH (it, area);
24487 }
24488
24489
24490 /* Produce a glyph for a glyphless character for iterator IT.
24491 IT->glyphless_method specifies which method to use for displaying
24492 the character. See the description of enum
24493 glyphless_display_method in dispextern.h for the detail.
24494
24495 FOR_NO_FONT is nonzero if and only if this is for a character for
24496 which no font was found. ACRONYM, if non-nil, is an acronym string
24497 for the character. */
24498
24499 static void
24500 produce_glyphless_glyph (struct it *it, int for_no_font, Lisp_Object acronym)
24501 {
24502 int face_id;
24503 struct face *face;
24504 struct font *font;
24505 int base_width, base_height, width, height;
24506 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
24507 int len;
24508
24509 /* Get the metrics of the base font. We always refer to the current
24510 ASCII face. */
24511 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
24512 font = face->font ? face->font : FRAME_FONT (it->f);
24513 it->ascent = FONT_BASE (font) + font->baseline_offset;
24514 it->descent = FONT_DESCENT (font) - font->baseline_offset;
24515 base_height = it->ascent + it->descent;
24516 base_width = font->average_width;
24517
24518 /* Get a face ID for the glyph by utilizing a cache (the same way as
24519 done for `escape-glyph' in get_next_display_element). */
24520 if (it->f == last_glyphless_glyph_frame
24521 && it->face_id == last_glyphless_glyph_face_id)
24522 {
24523 face_id = last_glyphless_glyph_merged_face_id;
24524 }
24525 else
24526 {
24527 /* Merge the `glyphless-char' face into the current face. */
24528 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
24529 last_glyphless_glyph_frame = it->f;
24530 last_glyphless_glyph_face_id = it->face_id;
24531 last_glyphless_glyph_merged_face_id = face_id;
24532 }
24533
24534 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
24535 {
24536 it->pixel_width = THIN_SPACE_WIDTH;
24537 len = 0;
24538 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
24539 }
24540 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
24541 {
24542 width = CHAR_WIDTH (it->c);
24543 if (width == 0)
24544 width = 1;
24545 else if (width > 4)
24546 width = 4;
24547 it->pixel_width = base_width * width;
24548 len = 0;
24549 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
24550 }
24551 else
24552 {
24553 char buf[7];
24554 const char *str;
24555 unsigned int code[6];
24556 int upper_len;
24557 int ascent, descent;
24558 struct font_metrics metrics_upper, metrics_lower;
24559
24560 face = FACE_FROM_ID (it->f, face_id);
24561 font = face->font ? face->font : FRAME_FONT (it->f);
24562 PREPARE_FACE_FOR_DISPLAY (it->f, face);
24563
24564 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
24565 {
24566 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
24567 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
24568 if (CONSP (acronym))
24569 acronym = XCAR (acronym);
24570 str = STRINGP (acronym) ? SSDATA (acronym) : "";
24571 }
24572 else
24573 {
24574 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
24575 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c);
24576 str = buf;
24577 }
24578 for (len = 0; str[len] && ASCII_BYTE_P (str[len]) && len < 6; len++)
24579 code[len] = font->driver->encode_char (font, str[len]);
24580 upper_len = (len + 1) / 2;
24581 font->driver->text_extents (font, code, upper_len,
24582 &metrics_upper);
24583 font->driver->text_extents (font, code + upper_len, len - upper_len,
24584 &metrics_lower);
24585
24586
24587
24588 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24589 width = max (metrics_upper.width, metrics_lower.width) + 4;
24590 upper_xoff = upper_yoff = 2; /* the typical case */
24591 if (base_width >= width)
24592 {
24593 /* Align the upper to the left, the lower to the right. */
24594 it->pixel_width = base_width;
24595 lower_xoff = base_width - 2 - metrics_lower.width;
24596 }
24597 else
24598 {
24599 /* Center the shorter one. */
24600 it->pixel_width = width;
24601 if (metrics_upper.width >= metrics_lower.width)
24602 lower_xoff = (width - metrics_lower.width) / 2;
24603 else
24604 {
24605 /* FIXME: This code doesn't look right. It formerly was
24606 missing the "lower_xoff = 0;", which couldn't have
24607 been right since it left lower_xoff uninitialized. */
24608 lower_xoff = 0;
24609 upper_xoff = (width - metrics_upper.width) / 2;
24610 }
24611 }
24612
24613 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24614 top, bottom, and between upper and lower strings. */
24615 height = (metrics_upper.ascent + metrics_upper.descent
24616 + metrics_lower.ascent + metrics_lower.descent) + 5;
24617 /* Center vertically.
24618 H:base_height, D:base_descent
24619 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24620
24621 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24622 descent = D - H/2 + h/2;
24623 lower_yoff = descent - 2 - ld;
24624 upper_yoff = lower_yoff - la - 1 - ud; */
24625 ascent = - (it->descent - (base_height + height + 1) / 2);
24626 descent = it->descent - (base_height - height) / 2;
24627 lower_yoff = descent - 2 - metrics_lower.descent;
24628 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
24629 - metrics_upper.descent);
24630 /* Don't make the height shorter than the base height. */
24631 if (height > base_height)
24632 {
24633 it->ascent = ascent;
24634 it->descent = descent;
24635 }
24636 }
24637
24638 it->phys_ascent = it->ascent;
24639 it->phys_descent = it->descent;
24640 if (it->glyph_row)
24641 append_glyphless_glyph (it, face_id, for_no_font, len,
24642 upper_xoff, upper_yoff,
24643 lower_xoff, lower_yoff);
24644 it->nglyphs = 1;
24645 take_vertical_position_into_account (it);
24646 }
24647
24648
24649 /* RIF:
24650 Produce glyphs/get display metrics for the display element IT is
24651 loaded with. See the description of struct it in dispextern.h
24652 for an overview of struct it. */
24653
24654 void
24655 x_produce_glyphs (struct it *it)
24656 {
24657 int extra_line_spacing = it->extra_line_spacing;
24658
24659 it->glyph_not_available_p = 0;
24660
24661 if (it->what == IT_CHARACTER)
24662 {
24663 XChar2b char2b;
24664 struct face *face = FACE_FROM_ID (it->f, it->face_id);
24665 struct font *font = face->font;
24666 struct font_metrics *pcm = NULL;
24667 int boff; /* baseline offset */
24668
24669 if (font == NULL)
24670 {
24671 /* When no suitable font is found, display this character by
24672 the method specified in the first extra slot of
24673 Vglyphless_char_display. */
24674 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
24675
24676 eassert (it->what == IT_GLYPHLESS);
24677 produce_glyphless_glyph (it, 1, STRINGP (acronym) ? acronym : Qnil);
24678 goto done;
24679 }
24680
24681 boff = font->baseline_offset;
24682 if (font->vertical_centering)
24683 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
24684
24685 if (it->char_to_display != '\n' && it->char_to_display != '\t')
24686 {
24687 int stretched_p;
24688
24689 it->nglyphs = 1;
24690
24691 if (it->override_ascent >= 0)
24692 {
24693 it->ascent = it->override_ascent;
24694 it->descent = it->override_descent;
24695 boff = it->override_boff;
24696 }
24697 else
24698 {
24699 it->ascent = FONT_BASE (font) + boff;
24700 it->descent = FONT_DESCENT (font) - boff;
24701 }
24702
24703 if (get_char_glyph_code (it->char_to_display, font, &char2b))
24704 {
24705 pcm = get_per_char_metric (font, &char2b);
24706 if (pcm->width == 0
24707 && pcm->rbearing == 0 && pcm->lbearing == 0)
24708 pcm = NULL;
24709 }
24710
24711 if (pcm)
24712 {
24713 it->phys_ascent = pcm->ascent + boff;
24714 it->phys_descent = pcm->descent - boff;
24715 it->pixel_width = pcm->width;
24716 }
24717 else
24718 {
24719 it->glyph_not_available_p = 1;
24720 it->phys_ascent = it->ascent;
24721 it->phys_descent = it->descent;
24722 it->pixel_width = font->space_width;
24723 }
24724
24725 if (it->constrain_row_ascent_descent_p)
24726 {
24727 if (it->descent > it->max_descent)
24728 {
24729 it->ascent += it->descent - it->max_descent;
24730 it->descent = it->max_descent;
24731 }
24732 if (it->ascent > it->max_ascent)
24733 {
24734 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
24735 it->ascent = it->max_ascent;
24736 }
24737 it->phys_ascent = min (it->phys_ascent, it->ascent);
24738 it->phys_descent = min (it->phys_descent, it->descent);
24739 extra_line_spacing = 0;
24740 }
24741
24742 /* If this is a space inside a region of text with
24743 `space-width' property, change its width. */
24744 stretched_p = it->char_to_display == ' ' && !NILP (it->space_width);
24745 if (stretched_p)
24746 it->pixel_width *= XFLOATINT (it->space_width);
24747
24748 /* If face has a box, add the box thickness to the character
24749 height. If character has a box line to the left and/or
24750 right, add the box line width to the character's width. */
24751 if (face->box != FACE_NO_BOX)
24752 {
24753 int thick = face->box_line_width;
24754
24755 if (thick > 0)
24756 {
24757 it->ascent += thick;
24758 it->descent += thick;
24759 }
24760 else
24761 thick = -thick;
24762
24763 if (it->start_of_box_run_p)
24764 it->pixel_width += thick;
24765 if (it->end_of_box_run_p)
24766 it->pixel_width += thick;
24767 }
24768
24769 /* If face has an overline, add the height of the overline
24770 (1 pixel) and a 1 pixel margin to the character height. */
24771 if (face->overline_p)
24772 it->ascent += overline_margin;
24773
24774 if (it->constrain_row_ascent_descent_p)
24775 {
24776 if (it->ascent > it->max_ascent)
24777 it->ascent = it->max_ascent;
24778 if (it->descent > it->max_descent)
24779 it->descent = it->max_descent;
24780 }
24781
24782 take_vertical_position_into_account (it);
24783
24784 /* If we have to actually produce glyphs, do it. */
24785 if (it->glyph_row)
24786 {
24787 if (stretched_p)
24788 {
24789 /* Translate a space with a `space-width' property
24790 into a stretch glyph. */
24791 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
24792 / FONT_HEIGHT (font));
24793 append_stretch_glyph (it, it->object, it->pixel_width,
24794 it->ascent + it->descent, ascent);
24795 }
24796 else
24797 append_glyph (it);
24798
24799 /* If characters with lbearing or rbearing are displayed
24800 in this line, record that fact in a flag of the
24801 glyph row. This is used to optimize X output code. */
24802 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
24803 it->glyph_row->contains_overlapping_glyphs_p = 1;
24804 }
24805 if (! stretched_p && it->pixel_width == 0)
24806 /* We assure that all visible glyphs have at least 1-pixel
24807 width. */
24808 it->pixel_width = 1;
24809 }
24810 else if (it->char_to_display == '\n')
24811 {
24812 /* A newline has no width, but we need the height of the
24813 line. But if previous part of the line sets a height,
24814 don't increase that height */
24815
24816 Lisp_Object height;
24817 Lisp_Object total_height = Qnil;
24818
24819 it->override_ascent = -1;
24820 it->pixel_width = 0;
24821 it->nglyphs = 0;
24822
24823 height = get_it_property (it, Qline_height);
24824 /* Split (line-height total-height) list */
24825 if (CONSP (height)
24826 && CONSP (XCDR (height))
24827 && NILP (XCDR (XCDR (height))))
24828 {
24829 total_height = XCAR (XCDR (height));
24830 height = XCAR (height);
24831 }
24832 height = calc_line_height_property (it, height, font, boff, 1);
24833
24834 if (it->override_ascent >= 0)
24835 {
24836 it->ascent = it->override_ascent;
24837 it->descent = it->override_descent;
24838 boff = it->override_boff;
24839 }
24840 else
24841 {
24842 it->ascent = FONT_BASE (font) + boff;
24843 it->descent = FONT_DESCENT (font) - boff;
24844 }
24845
24846 if (EQ (height, Qt))
24847 {
24848 if (it->descent > it->max_descent)
24849 {
24850 it->ascent += it->descent - it->max_descent;
24851 it->descent = it->max_descent;
24852 }
24853 if (it->ascent > it->max_ascent)
24854 {
24855 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
24856 it->ascent = it->max_ascent;
24857 }
24858 it->phys_ascent = min (it->phys_ascent, it->ascent);
24859 it->phys_descent = min (it->phys_descent, it->descent);
24860 it->constrain_row_ascent_descent_p = 1;
24861 extra_line_spacing = 0;
24862 }
24863 else
24864 {
24865 Lisp_Object spacing;
24866
24867 it->phys_ascent = it->ascent;
24868 it->phys_descent = it->descent;
24869
24870 if ((it->max_ascent > 0 || it->max_descent > 0)
24871 && face->box != FACE_NO_BOX
24872 && face->box_line_width > 0)
24873 {
24874 it->ascent += face->box_line_width;
24875 it->descent += face->box_line_width;
24876 }
24877 if (!NILP (height)
24878 && XINT (height) > it->ascent + it->descent)
24879 it->ascent = XINT (height) - it->descent;
24880
24881 if (!NILP (total_height))
24882 spacing = calc_line_height_property (it, total_height, font, boff, 0);
24883 else
24884 {
24885 spacing = get_it_property (it, Qline_spacing);
24886 spacing = calc_line_height_property (it, spacing, font, boff, 0);
24887 }
24888 if (INTEGERP (spacing))
24889 {
24890 extra_line_spacing = XINT (spacing);
24891 if (!NILP (total_height))
24892 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
24893 }
24894 }
24895 }
24896 else /* i.e. (it->char_to_display == '\t') */
24897 {
24898 if (font->space_width > 0)
24899 {
24900 int tab_width = it->tab_width * font->space_width;
24901 int x = it->current_x + it->continuation_lines_width;
24902 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
24903
24904 /* If the distance from the current position to the next tab
24905 stop is less than a space character width, use the
24906 tab stop after that. */
24907 if (next_tab_x - x < font->space_width)
24908 next_tab_x += tab_width;
24909
24910 it->pixel_width = next_tab_x - x;
24911 it->nglyphs = 1;
24912 it->ascent = it->phys_ascent = FONT_BASE (font) + boff;
24913 it->descent = it->phys_descent = FONT_DESCENT (font) - boff;
24914
24915 if (it->glyph_row)
24916 {
24917 append_stretch_glyph (it, it->object, it->pixel_width,
24918 it->ascent + it->descent, it->ascent);
24919 }
24920 }
24921 else
24922 {
24923 it->pixel_width = 0;
24924 it->nglyphs = 1;
24925 }
24926 }
24927 }
24928 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
24929 {
24930 /* A static composition.
24931
24932 Note: A composition is represented as one glyph in the
24933 glyph matrix. There are no padding glyphs.
24934
24935 Important note: pixel_width, ascent, and descent are the
24936 values of what is drawn by draw_glyphs (i.e. the values of
24937 the overall glyphs composed). */
24938 struct face *face = FACE_FROM_ID (it->f, it->face_id);
24939 int boff; /* baseline offset */
24940 struct composition *cmp = composition_table[it->cmp_it.id];
24941 int glyph_len = cmp->glyph_len;
24942 struct font *font = face->font;
24943
24944 it->nglyphs = 1;
24945
24946 /* If we have not yet calculated pixel size data of glyphs of
24947 the composition for the current face font, calculate them
24948 now. Theoretically, we have to check all fonts for the
24949 glyphs, but that requires much time and memory space. So,
24950 here we check only the font of the first glyph. This may
24951 lead to incorrect display, but it's very rare, and C-l
24952 (recenter-top-bottom) can correct the display anyway. */
24953 if (! cmp->font || cmp->font != font)
24954 {
24955 /* Ascent and descent of the font of the first character
24956 of this composition (adjusted by baseline offset).
24957 Ascent and descent of overall glyphs should not be less
24958 than these, respectively. */
24959 int font_ascent, font_descent, font_height;
24960 /* Bounding box of the overall glyphs. */
24961 int leftmost, rightmost, lowest, highest;
24962 int lbearing, rbearing;
24963 int i, width, ascent, descent;
24964 int left_padded = 0, right_padded = 0;
24965 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24966 XChar2b char2b;
24967 struct font_metrics *pcm;
24968 int font_not_found_p;
24969 ptrdiff_t pos;
24970
24971 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
24972 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
24973 break;
24974 if (glyph_len < cmp->glyph_len)
24975 right_padded = 1;
24976 for (i = 0; i < glyph_len; i++)
24977 {
24978 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
24979 break;
24980 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
24981 }
24982 if (i > 0)
24983 left_padded = 1;
24984
24985 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
24986 : IT_CHARPOS (*it));
24987 /* If no suitable font is found, use the default font. */
24988 font_not_found_p = font == NULL;
24989 if (font_not_found_p)
24990 {
24991 face = face->ascii_face;
24992 font = face->font;
24993 }
24994 boff = font->baseline_offset;
24995 if (font->vertical_centering)
24996 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
24997 font_ascent = FONT_BASE (font) + boff;
24998 font_descent = FONT_DESCENT (font) - boff;
24999 font_height = FONT_HEIGHT (font);
25000
25001 cmp->font = font;
25002
25003 pcm = NULL;
25004 if (! font_not_found_p)
25005 {
25006 get_char_face_and_encoding (it->f, c, it->face_id,
25007 &char2b, 0);
25008 pcm = get_per_char_metric (font, &char2b);
25009 }
25010
25011 /* Initialize the bounding box. */
25012 if (pcm)
25013 {
25014 width = cmp->glyph_len > 0 ? pcm->width : 0;
25015 ascent = pcm->ascent;
25016 descent = pcm->descent;
25017 lbearing = pcm->lbearing;
25018 rbearing = pcm->rbearing;
25019 }
25020 else
25021 {
25022 width = cmp->glyph_len > 0 ? font->space_width : 0;
25023 ascent = FONT_BASE (font);
25024 descent = FONT_DESCENT (font);
25025 lbearing = 0;
25026 rbearing = width;
25027 }
25028
25029 rightmost = width;
25030 leftmost = 0;
25031 lowest = - descent + boff;
25032 highest = ascent + boff;
25033
25034 if (! font_not_found_p
25035 && font->default_ascent
25036 && CHAR_TABLE_P (Vuse_default_ascent)
25037 && !NILP (Faref (Vuse_default_ascent,
25038 make_number (it->char_to_display))))
25039 highest = font->default_ascent + boff;
25040
25041 /* Draw the first glyph at the normal position. It may be
25042 shifted to right later if some other glyphs are drawn
25043 at the left. */
25044 cmp->offsets[i * 2] = 0;
25045 cmp->offsets[i * 2 + 1] = boff;
25046 cmp->lbearing = lbearing;
25047 cmp->rbearing = rbearing;
25048
25049 /* Set cmp->offsets for the remaining glyphs. */
25050 for (i++; i < glyph_len; i++)
25051 {
25052 int left, right, btm, top;
25053 int ch = COMPOSITION_GLYPH (cmp, i);
25054 int face_id;
25055 struct face *this_face;
25056
25057 if (ch == '\t')
25058 ch = ' ';
25059 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
25060 this_face = FACE_FROM_ID (it->f, face_id);
25061 font = this_face->font;
25062
25063 if (font == NULL)
25064 pcm = NULL;
25065 else
25066 {
25067 get_char_face_and_encoding (it->f, ch, face_id,
25068 &char2b, 0);
25069 pcm = get_per_char_metric (font, &char2b);
25070 }
25071 if (! pcm)
25072 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
25073 else
25074 {
25075 width = pcm->width;
25076 ascent = pcm->ascent;
25077 descent = pcm->descent;
25078 lbearing = pcm->lbearing;
25079 rbearing = pcm->rbearing;
25080 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
25081 {
25082 /* Relative composition with or without
25083 alternate chars. */
25084 left = (leftmost + rightmost - width) / 2;
25085 btm = - descent + boff;
25086 if (font->relative_compose
25087 && (! CHAR_TABLE_P (Vignore_relative_composition)
25088 || NILP (Faref (Vignore_relative_composition,
25089 make_number (ch)))))
25090 {
25091
25092 if (- descent >= font->relative_compose)
25093 /* One extra pixel between two glyphs. */
25094 btm = highest + 1;
25095 else if (ascent <= 0)
25096 /* One extra pixel between two glyphs. */
25097 btm = lowest - 1 - ascent - descent;
25098 }
25099 }
25100 else
25101 {
25102 /* A composition rule is specified by an integer
25103 value that encodes global and new reference
25104 points (GREF and NREF). GREF and NREF are
25105 specified by numbers as below:
25106
25107 0---1---2 -- ascent
25108 | |
25109 | |
25110 | |
25111 9--10--11 -- center
25112 | |
25113 ---3---4---5--- baseline
25114 | |
25115 6---7---8 -- descent
25116 */
25117 int rule = COMPOSITION_RULE (cmp, i);
25118 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
25119
25120 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
25121 grefx = gref % 3, nrefx = nref % 3;
25122 grefy = gref / 3, nrefy = nref / 3;
25123 if (xoff)
25124 xoff = font_height * (xoff - 128) / 256;
25125 if (yoff)
25126 yoff = font_height * (yoff - 128) / 256;
25127
25128 left = (leftmost
25129 + grefx * (rightmost - leftmost) / 2
25130 - nrefx * width / 2
25131 + xoff);
25132
25133 btm = ((grefy == 0 ? highest
25134 : grefy == 1 ? 0
25135 : grefy == 2 ? lowest
25136 : (highest + lowest) / 2)
25137 - (nrefy == 0 ? ascent + descent
25138 : nrefy == 1 ? descent - boff
25139 : nrefy == 2 ? 0
25140 : (ascent + descent) / 2)
25141 + yoff);
25142 }
25143
25144 cmp->offsets[i * 2] = left;
25145 cmp->offsets[i * 2 + 1] = btm + descent;
25146
25147 /* Update the bounding box of the overall glyphs. */
25148 if (width > 0)
25149 {
25150 right = left + width;
25151 if (left < leftmost)
25152 leftmost = left;
25153 if (right > rightmost)
25154 rightmost = right;
25155 }
25156 top = btm + descent + ascent;
25157 if (top > highest)
25158 highest = top;
25159 if (btm < lowest)
25160 lowest = btm;
25161
25162 if (cmp->lbearing > left + lbearing)
25163 cmp->lbearing = left + lbearing;
25164 if (cmp->rbearing < left + rbearing)
25165 cmp->rbearing = left + rbearing;
25166 }
25167 }
25168
25169 /* If there are glyphs whose x-offsets are negative,
25170 shift all glyphs to the right and make all x-offsets
25171 non-negative. */
25172 if (leftmost < 0)
25173 {
25174 for (i = 0; i < cmp->glyph_len; i++)
25175 cmp->offsets[i * 2] -= leftmost;
25176 rightmost -= leftmost;
25177 cmp->lbearing -= leftmost;
25178 cmp->rbearing -= leftmost;
25179 }
25180
25181 if (left_padded && cmp->lbearing < 0)
25182 {
25183 for (i = 0; i < cmp->glyph_len; i++)
25184 cmp->offsets[i * 2] -= cmp->lbearing;
25185 rightmost -= cmp->lbearing;
25186 cmp->rbearing -= cmp->lbearing;
25187 cmp->lbearing = 0;
25188 }
25189 if (right_padded && rightmost < cmp->rbearing)
25190 {
25191 rightmost = cmp->rbearing;
25192 }
25193
25194 cmp->pixel_width = rightmost;
25195 cmp->ascent = highest;
25196 cmp->descent = - lowest;
25197 if (cmp->ascent < font_ascent)
25198 cmp->ascent = font_ascent;
25199 if (cmp->descent < font_descent)
25200 cmp->descent = font_descent;
25201 }
25202
25203 if (it->glyph_row
25204 && (cmp->lbearing < 0
25205 || cmp->rbearing > cmp->pixel_width))
25206 it->glyph_row->contains_overlapping_glyphs_p = 1;
25207
25208 it->pixel_width = cmp->pixel_width;
25209 it->ascent = it->phys_ascent = cmp->ascent;
25210 it->descent = it->phys_descent = cmp->descent;
25211 if (face->box != FACE_NO_BOX)
25212 {
25213 int thick = face->box_line_width;
25214
25215 if (thick > 0)
25216 {
25217 it->ascent += thick;
25218 it->descent += thick;
25219 }
25220 else
25221 thick = - thick;
25222
25223 if (it->start_of_box_run_p)
25224 it->pixel_width += thick;
25225 if (it->end_of_box_run_p)
25226 it->pixel_width += thick;
25227 }
25228
25229 /* If face has an overline, add the height of the overline
25230 (1 pixel) and a 1 pixel margin to the character height. */
25231 if (face->overline_p)
25232 it->ascent += overline_margin;
25233
25234 take_vertical_position_into_account (it);
25235 if (it->ascent < 0)
25236 it->ascent = 0;
25237 if (it->descent < 0)
25238 it->descent = 0;
25239
25240 if (it->glyph_row && cmp->glyph_len > 0)
25241 append_composite_glyph (it);
25242 }
25243 else if (it->what == IT_COMPOSITION)
25244 {
25245 /* A dynamic (automatic) composition. */
25246 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25247 Lisp_Object gstring;
25248 struct font_metrics metrics;
25249
25250 it->nglyphs = 1;
25251
25252 gstring = composition_gstring_from_id (it->cmp_it.id);
25253 it->pixel_width
25254 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
25255 &metrics);
25256 if (it->glyph_row
25257 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
25258 it->glyph_row->contains_overlapping_glyphs_p = 1;
25259 it->ascent = it->phys_ascent = metrics.ascent;
25260 it->descent = it->phys_descent = metrics.descent;
25261 if (face->box != FACE_NO_BOX)
25262 {
25263 int thick = face->box_line_width;
25264
25265 if (thick > 0)
25266 {
25267 it->ascent += thick;
25268 it->descent += thick;
25269 }
25270 else
25271 thick = - thick;
25272
25273 if (it->start_of_box_run_p)
25274 it->pixel_width += thick;
25275 if (it->end_of_box_run_p)
25276 it->pixel_width += thick;
25277 }
25278 /* If face has an overline, add the height of the overline
25279 (1 pixel) and a 1 pixel margin to the character height. */
25280 if (face->overline_p)
25281 it->ascent += overline_margin;
25282 take_vertical_position_into_account (it);
25283 if (it->ascent < 0)
25284 it->ascent = 0;
25285 if (it->descent < 0)
25286 it->descent = 0;
25287
25288 if (it->glyph_row)
25289 append_composite_glyph (it);
25290 }
25291 else if (it->what == IT_GLYPHLESS)
25292 produce_glyphless_glyph (it, 0, Qnil);
25293 else if (it->what == IT_IMAGE)
25294 produce_image_glyph (it);
25295 else if (it->what == IT_STRETCH)
25296 produce_stretch_glyph (it);
25297
25298 done:
25299 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25300 because this isn't true for images with `:ascent 100'. */
25301 eassert (it->ascent >= 0 && it->descent >= 0);
25302 if (it->area == TEXT_AREA)
25303 it->current_x += it->pixel_width;
25304
25305 if (extra_line_spacing > 0)
25306 {
25307 it->descent += extra_line_spacing;
25308 if (extra_line_spacing > it->max_extra_line_spacing)
25309 it->max_extra_line_spacing = extra_line_spacing;
25310 }
25311
25312 it->max_ascent = max (it->max_ascent, it->ascent);
25313 it->max_descent = max (it->max_descent, it->descent);
25314 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
25315 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
25316 }
25317
25318 /* EXPORT for RIF:
25319 Output LEN glyphs starting at START at the nominal cursor position.
25320 Advance the nominal cursor over the text. The global variable
25321 updated_window contains the window being updated, updated_row is
25322 the glyph row being updated, and updated_area is the area of that
25323 row being updated. */
25324
25325 void
25326 x_write_glyphs (struct glyph *start, int len)
25327 {
25328 int x, hpos, chpos = updated_window->phys_cursor.hpos;
25329
25330 eassert (updated_window && updated_row);
25331 /* When the window is hscrolled, cursor hpos can legitimately be out
25332 of bounds, but we draw the cursor at the corresponding window
25333 margin in that case. */
25334 if (!updated_row->reversed_p && chpos < 0)
25335 chpos = 0;
25336 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
25337 chpos = updated_row->used[TEXT_AREA] - 1;
25338
25339 BLOCK_INPUT;
25340
25341 /* Write glyphs. */
25342
25343 hpos = start - updated_row->glyphs[updated_area];
25344 x = draw_glyphs (updated_window, output_cursor.x,
25345 updated_row, updated_area,
25346 hpos, hpos + len,
25347 DRAW_NORMAL_TEXT, 0);
25348
25349 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25350 if (updated_area == TEXT_AREA
25351 && updated_window->phys_cursor_on_p
25352 && updated_window->phys_cursor.vpos == output_cursor.vpos
25353 && chpos >= hpos
25354 && chpos < hpos + len)
25355 updated_window->phys_cursor_on_p = 0;
25356
25357 UNBLOCK_INPUT;
25358
25359 /* Advance the output cursor. */
25360 output_cursor.hpos += len;
25361 output_cursor.x = x;
25362 }
25363
25364
25365 /* EXPORT for RIF:
25366 Insert LEN glyphs from START at the nominal cursor position. */
25367
25368 void
25369 x_insert_glyphs (struct glyph *start, int len)
25370 {
25371 struct frame *f;
25372 struct window *w;
25373 int line_height, shift_by_width, shifted_region_width;
25374 struct glyph_row *row;
25375 struct glyph *glyph;
25376 int frame_x, frame_y;
25377 ptrdiff_t hpos;
25378
25379 eassert (updated_window && updated_row);
25380 BLOCK_INPUT;
25381 w = updated_window;
25382 f = XFRAME (WINDOW_FRAME (w));
25383
25384 /* Get the height of the line we are in. */
25385 row = updated_row;
25386 line_height = row->height;
25387
25388 /* Get the width of the glyphs to insert. */
25389 shift_by_width = 0;
25390 for (glyph = start; glyph < start + len; ++glyph)
25391 shift_by_width += glyph->pixel_width;
25392
25393 /* Get the width of the region to shift right. */
25394 shifted_region_width = (window_box_width (w, updated_area)
25395 - output_cursor.x
25396 - shift_by_width);
25397
25398 /* Shift right. */
25399 frame_x = window_box_left (w, updated_area) + output_cursor.x;
25400 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, output_cursor.y);
25401
25402 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
25403 line_height, shift_by_width);
25404
25405 /* Write the glyphs. */
25406 hpos = start - row->glyphs[updated_area];
25407 draw_glyphs (w, output_cursor.x, row, updated_area,
25408 hpos, hpos + len,
25409 DRAW_NORMAL_TEXT, 0);
25410
25411 /* Advance the output cursor. */
25412 output_cursor.hpos += len;
25413 output_cursor.x += shift_by_width;
25414 UNBLOCK_INPUT;
25415 }
25416
25417
25418 /* EXPORT for RIF:
25419 Erase the current text line from the nominal cursor position
25420 (inclusive) to pixel column TO_X (exclusive). The idea is that
25421 everything from TO_X onward is already erased.
25422
25423 TO_X is a pixel position relative to updated_area of
25424 updated_window. TO_X == -1 means clear to the end of this area. */
25425
25426 void
25427 x_clear_end_of_line (int to_x)
25428 {
25429 struct frame *f;
25430 struct window *w = updated_window;
25431 int max_x, min_y, max_y;
25432 int from_x, from_y, to_y;
25433
25434 eassert (updated_window && updated_row);
25435 f = XFRAME (w->frame);
25436
25437 if (updated_row->full_width_p)
25438 max_x = WINDOW_TOTAL_WIDTH (w);
25439 else
25440 max_x = window_box_width (w, updated_area);
25441 max_y = window_text_bottom_y (w);
25442
25443 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25444 of window. For TO_X > 0, truncate to end of drawing area. */
25445 if (to_x == 0)
25446 return;
25447 else if (to_x < 0)
25448 to_x = max_x;
25449 else
25450 to_x = min (to_x, max_x);
25451
25452 to_y = min (max_y, output_cursor.y + updated_row->height);
25453
25454 /* Notice if the cursor will be cleared by this operation. */
25455 if (!updated_row->full_width_p)
25456 notice_overwritten_cursor (w, updated_area,
25457 output_cursor.x, -1,
25458 updated_row->y,
25459 MATRIX_ROW_BOTTOM_Y (updated_row));
25460
25461 from_x = output_cursor.x;
25462
25463 /* Translate to frame coordinates. */
25464 if (updated_row->full_width_p)
25465 {
25466 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
25467 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
25468 }
25469 else
25470 {
25471 int area_left = window_box_left (w, updated_area);
25472 from_x += area_left;
25473 to_x += area_left;
25474 }
25475
25476 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
25477 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, output_cursor.y));
25478 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
25479
25480 /* Prevent inadvertently clearing to end of the X window. */
25481 if (to_x > from_x && to_y > from_y)
25482 {
25483 BLOCK_INPUT;
25484 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
25485 to_x - from_x, to_y - from_y);
25486 UNBLOCK_INPUT;
25487 }
25488 }
25489
25490 #endif /* HAVE_WINDOW_SYSTEM */
25491
25492
25493 \f
25494 /***********************************************************************
25495 Cursor types
25496 ***********************************************************************/
25497
25498 /* Value is the internal representation of the specified cursor type
25499 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25500 of the bar cursor. */
25501
25502 static enum text_cursor_kinds
25503 get_specified_cursor_type (Lisp_Object arg, int *width)
25504 {
25505 enum text_cursor_kinds type;
25506
25507 if (NILP (arg))
25508 return NO_CURSOR;
25509
25510 if (EQ (arg, Qbox))
25511 return FILLED_BOX_CURSOR;
25512
25513 if (EQ (arg, Qhollow))
25514 return HOLLOW_BOX_CURSOR;
25515
25516 if (EQ (arg, Qbar))
25517 {
25518 *width = 2;
25519 return BAR_CURSOR;
25520 }
25521
25522 if (CONSP (arg)
25523 && EQ (XCAR (arg), Qbar)
25524 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
25525 {
25526 *width = XINT (XCDR (arg));
25527 return BAR_CURSOR;
25528 }
25529
25530 if (EQ (arg, Qhbar))
25531 {
25532 *width = 2;
25533 return HBAR_CURSOR;
25534 }
25535
25536 if (CONSP (arg)
25537 && EQ (XCAR (arg), Qhbar)
25538 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
25539 {
25540 *width = XINT (XCDR (arg));
25541 return HBAR_CURSOR;
25542 }
25543
25544 /* Treat anything unknown as "hollow box cursor".
25545 It was bad to signal an error; people have trouble fixing
25546 .Xdefaults with Emacs, when it has something bad in it. */
25547 type = HOLLOW_BOX_CURSOR;
25548
25549 return type;
25550 }
25551
25552 /* Set the default cursor types for specified frame. */
25553 void
25554 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
25555 {
25556 int width = 1;
25557 Lisp_Object tem;
25558
25559 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
25560 FRAME_CURSOR_WIDTH (f) = width;
25561
25562 /* By default, set up the blink-off state depending on the on-state. */
25563
25564 tem = Fassoc (arg, Vblink_cursor_alist);
25565 if (!NILP (tem))
25566 {
25567 FRAME_BLINK_OFF_CURSOR (f)
25568 = get_specified_cursor_type (XCDR (tem), &width);
25569 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
25570 }
25571 else
25572 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
25573 }
25574
25575
25576 #ifdef HAVE_WINDOW_SYSTEM
25577
25578 /* Return the cursor we want to be displayed in window W. Return
25579 width of bar/hbar cursor through WIDTH arg. Return with
25580 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25581 (i.e. if the `system caret' should track this cursor).
25582
25583 In a mini-buffer window, we want the cursor only to appear if we
25584 are reading input from this window. For the selected window, we
25585 want the cursor type given by the frame parameter or buffer local
25586 setting of cursor-type. If explicitly marked off, draw no cursor.
25587 In all other cases, we want a hollow box cursor. */
25588
25589 static enum text_cursor_kinds
25590 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
25591 int *active_cursor)
25592 {
25593 struct frame *f = XFRAME (w->frame);
25594 struct buffer *b = XBUFFER (w->buffer);
25595 int cursor_type = DEFAULT_CURSOR;
25596 Lisp_Object alt_cursor;
25597 int non_selected = 0;
25598
25599 *active_cursor = 1;
25600
25601 /* Echo area */
25602 if (cursor_in_echo_area
25603 && FRAME_HAS_MINIBUF_P (f)
25604 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
25605 {
25606 if (w == XWINDOW (echo_area_window))
25607 {
25608 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
25609 {
25610 *width = FRAME_CURSOR_WIDTH (f);
25611 return FRAME_DESIRED_CURSOR (f);
25612 }
25613 else
25614 return get_specified_cursor_type (BVAR (b, cursor_type), width);
25615 }
25616
25617 *active_cursor = 0;
25618 non_selected = 1;
25619 }
25620
25621 /* Detect a nonselected window or nonselected frame. */
25622 else if (w != XWINDOW (f->selected_window)
25623 || f != FRAME_X_DISPLAY_INFO (f)->x_highlight_frame)
25624 {
25625 *active_cursor = 0;
25626
25627 if (MINI_WINDOW_P (w) && minibuf_level == 0)
25628 return NO_CURSOR;
25629
25630 non_selected = 1;
25631 }
25632
25633 /* Never display a cursor in a window in which cursor-type is nil. */
25634 if (NILP (BVAR (b, cursor_type)))
25635 return NO_CURSOR;
25636
25637 /* Get the normal cursor type for this window. */
25638 if (EQ (BVAR (b, cursor_type), Qt))
25639 {
25640 cursor_type = FRAME_DESIRED_CURSOR (f);
25641 *width = FRAME_CURSOR_WIDTH (f);
25642 }
25643 else
25644 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
25645
25646 /* Use cursor-in-non-selected-windows instead
25647 for non-selected window or frame. */
25648 if (non_selected)
25649 {
25650 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
25651 if (!EQ (Qt, alt_cursor))
25652 return get_specified_cursor_type (alt_cursor, width);
25653 /* t means modify the normal cursor type. */
25654 if (cursor_type == FILLED_BOX_CURSOR)
25655 cursor_type = HOLLOW_BOX_CURSOR;
25656 else if (cursor_type == BAR_CURSOR && *width > 1)
25657 --*width;
25658 return cursor_type;
25659 }
25660
25661 /* Use normal cursor if not blinked off. */
25662 if (!w->cursor_off_p)
25663 {
25664 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
25665 {
25666 if (cursor_type == FILLED_BOX_CURSOR)
25667 {
25668 /* Using a block cursor on large images can be very annoying.
25669 So use a hollow cursor for "large" images.
25670 If image is not transparent (no mask), also use hollow cursor. */
25671 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
25672 if (img != NULL && IMAGEP (img->spec))
25673 {
25674 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25675 where N = size of default frame font size.
25676 This should cover most of the "tiny" icons people may use. */
25677 if (!img->mask
25678 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
25679 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
25680 cursor_type = HOLLOW_BOX_CURSOR;
25681 }
25682 }
25683 else if (cursor_type != NO_CURSOR)
25684 {
25685 /* Display current only supports BOX and HOLLOW cursors for images.
25686 So for now, unconditionally use a HOLLOW cursor when cursor is
25687 not a solid box cursor. */
25688 cursor_type = HOLLOW_BOX_CURSOR;
25689 }
25690 }
25691 return cursor_type;
25692 }
25693
25694 /* Cursor is blinked off, so determine how to "toggle" it. */
25695
25696 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25697 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
25698 return get_specified_cursor_type (XCDR (alt_cursor), width);
25699
25700 /* Then see if frame has specified a specific blink off cursor type. */
25701 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
25702 {
25703 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
25704 return FRAME_BLINK_OFF_CURSOR (f);
25705 }
25706
25707 #if 0
25708 /* Some people liked having a permanently visible blinking cursor,
25709 while others had very strong opinions against it. So it was
25710 decided to remove it. KFS 2003-09-03 */
25711
25712 /* Finally perform built-in cursor blinking:
25713 filled box <-> hollow box
25714 wide [h]bar <-> narrow [h]bar
25715 narrow [h]bar <-> no cursor
25716 other type <-> no cursor */
25717
25718 if (cursor_type == FILLED_BOX_CURSOR)
25719 return HOLLOW_BOX_CURSOR;
25720
25721 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
25722 {
25723 *width = 1;
25724 return cursor_type;
25725 }
25726 #endif
25727
25728 return NO_CURSOR;
25729 }
25730
25731
25732 /* Notice when the text cursor of window W has been completely
25733 overwritten by a drawing operation that outputs glyphs in AREA
25734 starting at X0 and ending at X1 in the line starting at Y0 and
25735 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25736 the rest of the line after X0 has been written. Y coordinates
25737 are window-relative. */
25738
25739 static void
25740 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
25741 int x0, int x1, int y0, int y1)
25742 {
25743 int cx0, cx1, cy0, cy1;
25744 struct glyph_row *row;
25745
25746 if (!w->phys_cursor_on_p)
25747 return;
25748 if (area != TEXT_AREA)
25749 return;
25750
25751 if (w->phys_cursor.vpos < 0
25752 || w->phys_cursor.vpos >= w->current_matrix->nrows
25753 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
25754 !(row->enabled_p && row->displays_text_p)))
25755 return;
25756
25757 if (row->cursor_in_fringe_p)
25758 {
25759 row->cursor_in_fringe_p = 0;
25760 draw_fringe_bitmap (w, row, row->reversed_p);
25761 w->phys_cursor_on_p = 0;
25762 return;
25763 }
25764
25765 cx0 = w->phys_cursor.x;
25766 cx1 = cx0 + w->phys_cursor_width;
25767 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
25768 return;
25769
25770 /* The cursor image will be completely removed from the
25771 screen if the output area intersects the cursor area in
25772 y-direction. When we draw in [y0 y1[, and some part of
25773 the cursor is at y < y0, that part must have been drawn
25774 before. When scrolling, the cursor is erased before
25775 actually scrolling, so we don't come here. When not
25776 scrolling, the rows above the old cursor row must have
25777 changed, and in this case these rows must have written
25778 over the cursor image.
25779
25780 Likewise if part of the cursor is below y1, with the
25781 exception of the cursor being in the first blank row at
25782 the buffer and window end because update_text_area
25783 doesn't draw that row. (Except when it does, but
25784 that's handled in update_text_area.) */
25785
25786 cy0 = w->phys_cursor.y;
25787 cy1 = cy0 + w->phys_cursor_height;
25788 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
25789 return;
25790
25791 w->phys_cursor_on_p = 0;
25792 }
25793
25794 #endif /* HAVE_WINDOW_SYSTEM */
25795
25796 \f
25797 /************************************************************************
25798 Mouse Face
25799 ************************************************************************/
25800
25801 #ifdef HAVE_WINDOW_SYSTEM
25802
25803 /* EXPORT for RIF:
25804 Fix the display of area AREA of overlapping row ROW in window W
25805 with respect to the overlapping part OVERLAPS. */
25806
25807 void
25808 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
25809 enum glyph_row_area area, int overlaps)
25810 {
25811 int i, x;
25812
25813 BLOCK_INPUT;
25814
25815 x = 0;
25816 for (i = 0; i < row->used[area];)
25817 {
25818 if (row->glyphs[area][i].overlaps_vertically_p)
25819 {
25820 int start = i, start_x = x;
25821
25822 do
25823 {
25824 x += row->glyphs[area][i].pixel_width;
25825 ++i;
25826 }
25827 while (i < row->used[area]
25828 && row->glyphs[area][i].overlaps_vertically_p);
25829
25830 draw_glyphs (w, start_x, row, area,
25831 start, i,
25832 DRAW_NORMAL_TEXT, overlaps);
25833 }
25834 else
25835 {
25836 x += row->glyphs[area][i].pixel_width;
25837 ++i;
25838 }
25839 }
25840
25841 UNBLOCK_INPUT;
25842 }
25843
25844
25845 /* EXPORT:
25846 Draw the cursor glyph of window W in glyph row ROW. See the
25847 comment of draw_glyphs for the meaning of HL. */
25848
25849 void
25850 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
25851 enum draw_glyphs_face hl)
25852 {
25853 /* If cursor hpos is out of bounds, don't draw garbage. This can
25854 happen in mini-buffer windows when switching between echo area
25855 glyphs and mini-buffer. */
25856 if ((row->reversed_p
25857 ? (w->phys_cursor.hpos >= 0)
25858 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
25859 {
25860 int on_p = w->phys_cursor_on_p;
25861 int x1;
25862 int hpos = w->phys_cursor.hpos;
25863
25864 /* When the window is hscrolled, cursor hpos can legitimately be
25865 out of bounds, but we draw the cursor at the corresponding
25866 window margin in that case. */
25867 if (!row->reversed_p && hpos < 0)
25868 hpos = 0;
25869 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
25870 hpos = row->used[TEXT_AREA] - 1;
25871
25872 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
25873 hl, 0);
25874 w->phys_cursor_on_p = on_p;
25875
25876 if (hl == DRAW_CURSOR)
25877 w->phys_cursor_width = x1 - w->phys_cursor.x;
25878 /* When we erase the cursor, and ROW is overlapped by other
25879 rows, make sure that these overlapping parts of other rows
25880 are redrawn. */
25881 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
25882 {
25883 w->phys_cursor_width = x1 - w->phys_cursor.x;
25884
25885 if (row > w->current_matrix->rows
25886 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
25887 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
25888 OVERLAPS_ERASED_CURSOR);
25889
25890 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
25891 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
25892 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
25893 OVERLAPS_ERASED_CURSOR);
25894 }
25895 }
25896 }
25897
25898
25899 /* EXPORT:
25900 Erase the image of a cursor of window W from the screen. */
25901
25902 void
25903 erase_phys_cursor (struct window *w)
25904 {
25905 struct frame *f = XFRAME (w->frame);
25906 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
25907 int hpos = w->phys_cursor.hpos;
25908 int vpos = w->phys_cursor.vpos;
25909 int mouse_face_here_p = 0;
25910 struct glyph_matrix *active_glyphs = w->current_matrix;
25911 struct glyph_row *cursor_row;
25912 struct glyph *cursor_glyph;
25913 enum draw_glyphs_face hl;
25914
25915 /* No cursor displayed or row invalidated => nothing to do on the
25916 screen. */
25917 if (w->phys_cursor_type == NO_CURSOR)
25918 goto mark_cursor_off;
25919
25920 /* VPOS >= active_glyphs->nrows means that window has been resized.
25921 Don't bother to erase the cursor. */
25922 if (vpos >= active_glyphs->nrows)
25923 goto mark_cursor_off;
25924
25925 /* If row containing cursor is marked invalid, there is nothing we
25926 can do. */
25927 cursor_row = MATRIX_ROW (active_glyphs, vpos);
25928 if (!cursor_row->enabled_p)
25929 goto mark_cursor_off;
25930
25931 /* If line spacing is > 0, old cursor may only be partially visible in
25932 window after split-window. So adjust visible height. */
25933 cursor_row->visible_height = min (cursor_row->visible_height,
25934 window_text_bottom_y (w) - cursor_row->y);
25935
25936 /* If row is completely invisible, don't attempt to delete a cursor which
25937 isn't there. This can happen if cursor is at top of a window, and
25938 we switch to a buffer with a header line in that window. */
25939 if (cursor_row->visible_height <= 0)
25940 goto mark_cursor_off;
25941
25942 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25943 if (cursor_row->cursor_in_fringe_p)
25944 {
25945 cursor_row->cursor_in_fringe_p = 0;
25946 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
25947 goto mark_cursor_off;
25948 }
25949
25950 /* This can happen when the new row is shorter than the old one.
25951 In this case, either draw_glyphs or clear_end_of_line
25952 should have cleared the cursor. Note that we wouldn't be
25953 able to erase the cursor in this case because we don't have a
25954 cursor glyph at hand. */
25955 if ((cursor_row->reversed_p
25956 ? (w->phys_cursor.hpos < 0)
25957 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
25958 goto mark_cursor_off;
25959
25960 /* When the window is hscrolled, cursor hpos can legitimately be out
25961 of bounds, but we draw the cursor at the corresponding window
25962 margin in that case. */
25963 if (!cursor_row->reversed_p && hpos < 0)
25964 hpos = 0;
25965 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
25966 hpos = cursor_row->used[TEXT_AREA] - 1;
25967
25968 /* If the cursor is in the mouse face area, redisplay that when
25969 we clear the cursor. */
25970 if (! NILP (hlinfo->mouse_face_window)
25971 && coords_in_mouse_face_p (w, hpos, vpos)
25972 /* Don't redraw the cursor's spot in mouse face if it is at the
25973 end of a line (on a newline). The cursor appears there, but
25974 mouse highlighting does not. */
25975 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
25976 mouse_face_here_p = 1;
25977
25978 /* Maybe clear the display under the cursor. */
25979 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
25980 {
25981 int x, y, left_x;
25982 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
25983 int width;
25984
25985 cursor_glyph = get_phys_cursor_glyph (w);
25986 if (cursor_glyph == NULL)
25987 goto mark_cursor_off;
25988
25989 width = cursor_glyph->pixel_width;
25990 left_x = window_box_left_offset (w, TEXT_AREA);
25991 x = w->phys_cursor.x;
25992 if (x < left_x)
25993 width -= left_x - x;
25994 width = min (width, window_box_width (w, TEXT_AREA) - x);
25995 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
25996 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, max (x, left_x));
25997
25998 if (width > 0)
25999 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
26000 }
26001
26002 /* Erase the cursor by redrawing the character underneath it. */
26003 if (mouse_face_here_p)
26004 hl = DRAW_MOUSE_FACE;
26005 else
26006 hl = DRAW_NORMAL_TEXT;
26007 draw_phys_cursor_glyph (w, cursor_row, hl);
26008
26009 mark_cursor_off:
26010 w->phys_cursor_on_p = 0;
26011 w->phys_cursor_type = NO_CURSOR;
26012 }
26013
26014
26015 /* EXPORT:
26016 Display or clear cursor of window W. If ON is zero, clear the
26017 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26018 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26019
26020 void
26021 display_and_set_cursor (struct window *w, int on,
26022 int hpos, int vpos, int x, int y)
26023 {
26024 struct frame *f = XFRAME (w->frame);
26025 int new_cursor_type;
26026 int new_cursor_width;
26027 int active_cursor;
26028 struct glyph_row *glyph_row;
26029 struct glyph *glyph;
26030
26031 /* This is pointless on invisible frames, and dangerous on garbaged
26032 windows and frames; in the latter case, the frame or window may
26033 be in the midst of changing its size, and x and y may be off the
26034 window. */
26035 if (! FRAME_VISIBLE_P (f)
26036 || FRAME_GARBAGED_P (f)
26037 || vpos >= w->current_matrix->nrows
26038 || hpos >= w->current_matrix->matrix_w)
26039 return;
26040
26041 /* If cursor is off and we want it off, return quickly. */
26042 if (!on && !w->phys_cursor_on_p)
26043 return;
26044
26045 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
26046 /* If cursor row is not enabled, we don't really know where to
26047 display the cursor. */
26048 if (!glyph_row->enabled_p)
26049 {
26050 w->phys_cursor_on_p = 0;
26051 return;
26052 }
26053
26054 glyph = NULL;
26055 if (!glyph_row->exact_window_width_line_p
26056 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
26057 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
26058
26059 eassert (interrupt_input_blocked);
26060
26061 /* Set new_cursor_type to the cursor we want to be displayed. */
26062 new_cursor_type = get_window_cursor_type (w, glyph,
26063 &new_cursor_width, &active_cursor);
26064
26065 /* If cursor is currently being shown and we don't want it to be or
26066 it is in the wrong place, or the cursor type is not what we want,
26067 erase it. */
26068 if (w->phys_cursor_on_p
26069 && (!on
26070 || w->phys_cursor.x != x
26071 || w->phys_cursor.y != y
26072 || new_cursor_type != w->phys_cursor_type
26073 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
26074 && new_cursor_width != w->phys_cursor_width)))
26075 erase_phys_cursor (w);
26076
26077 /* Don't check phys_cursor_on_p here because that flag is only set
26078 to zero in some cases where we know that the cursor has been
26079 completely erased, to avoid the extra work of erasing the cursor
26080 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26081 still not be visible, or it has only been partly erased. */
26082 if (on)
26083 {
26084 w->phys_cursor_ascent = glyph_row->ascent;
26085 w->phys_cursor_height = glyph_row->height;
26086
26087 /* Set phys_cursor_.* before x_draw_.* is called because some
26088 of them may need the information. */
26089 w->phys_cursor.x = x;
26090 w->phys_cursor.y = glyph_row->y;
26091 w->phys_cursor.hpos = hpos;
26092 w->phys_cursor.vpos = vpos;
26093 }
26094
26095 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
26096 new_cursor_type, new_cursor_width,
26097 on, active_cursor);
26098 }
26099
26100
26101 /* Switch the display of W's cursor on or off, according to the value
26102 of ON. */
26103
26104 static void
26105 update_window_cursor (struct window *w, int on)
26106 {
26107 /* Don't update cursor in windows whose frame is in the process
26108 of being deleted. */
26109 if (w->current_matrix)
26110 {
26111 int hpos = w->phys_cursor.hpos;
26112 int vpos = w->phys_cursor.vpos;
26113 struct glyph_row *row;
26114
26115 if (vpos >= w->current_matrix->nrows
26116 || hpos >= w->current_matrix->matrix_w)
26117 return;
26118
26119 row = MATRIX_ROW (w->current_matrix, vpos);
26120
26121 /* When the window is hscrolled, cursor hpos can legitimately be
26122 out of bounds, but we draw the cursor at the corresponding
26123 window margin in that case. */
26124 if (!row->reversed_p && hpos < 0)
26125 hpos = 0;
26126 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
26127 hpos = row->used[TEXT_AREA] - 1;
26128
26129 BLOCK_INPUT;
26130 display_and_set_cursor (w, on, hpos, vpos,
26131 w->phys_cursor.x, w->phys_cursor.y);
26132 UNBLOCK_INPUT;
26133 }
26134 }
26135
26136
26137 /* Call update_window_cursor with parameter ON_P on all leaf windows
26138 in the window tree rooted at W. */
26139
26140 static void
26141 update_cursor_in_window_tree (struct window *w, int on_p)
26142 {
26143 while (w)
26144 {
26145 if (!NILP (w->hchild))
26146 update_cursor_in_window_tree (XWINDOW (w->hchild), on_p);
26147 else if (!NILP (w->vchild))
26148 update_cursor_in_window_tree (XWINDOW (w->vchild), on_p);
26149 else
26150 update_window_cursor (w, on_p);
26151
26152 w = NILP (w->next) ? 0 : XWINDOW (w->next);
26153 }
26154 }
26155
26156
26157 /* EXPORT:
26158 Display the cursor on window W, or clear it, according to ON_P.
26159 Don't change the cursor's position. */
26160
26161 void
26162 x_update_cursor (struct frame *f, int on_p)
26163 {
26164 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
26165 }
26166
26167
26168 /* EXPORT:
26169 Clear the cursor of window W to background color, and mark the
26170 cursor as not shown. This is used when the text where the cursor
26171 is about to be rewritten. */
26172
26173 void
26174 x_clear_cursor (struct window *w)
26175 {
26176 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
26177 update_window_cursor (w, 0);
26178 }
26179
26180 #endif /* HAVE_WINDOW_SYSTEM */
26181
26182 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26183 and MSDOS. */
26184 static void
26185 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
26186 int start_hpos, int end_hpos,
26187 enum draw_glyphs_face draw)
26188 {
26189 #ifdef HAVE_WINDOW_SYSTEM
26190 if (FRAME_WINDOW_P (XFRAME (w->frame)))
26191 {
26192 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
26193 return;
26194 }
26195 #endif
26196 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26197 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
26198 #endif
26199 }
26200
26201 /* Display the active region described by mouse_face_* according to DRAW. */
26202
26203 static void
26204 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
26205 {
26206 struct window *w = XWINDOW (hlinfo->mouse_face_window);
26207 struct frame *f = XFRAME (WINDOW_FRAME (w));
26208
26209 if (/* If window is in the process of being destroyed, don't bother
26210 to do anything. */
26211 w->current_matrix != NULL
26212 /* Don't update mouse highlight if hidden */
26213 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
26214 /* Recognize when we are called to operate on rows that don't exist
26215 anymore. This can happen when a window is split. */
26216 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
26217 {
26218 int phys_cursor_on_p = w->phys_cursor_on_p;
26219 struct glyph_row *row, *first, *last;
26220
26221 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
26222 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
26223
26224 for (row = first; row <= last && row->enabled_p; ++row)
26225 {
26226 int start_hpos, end_hpos, start_x;
26227
26228 /* For all but the first row, the highlight starts at column 0. */
26229 if (row == first)
26230 {
26231 /* R2L rows have BEG and END in reversed order, but the
26232 screen drawing geometry is always left to right. So
26233 we need to mirror the beginning and end of the
26234 highlighted area in R2L rows. */
26235 if (!row->reversed_p)
26236 {
26237 start_hpos = hlinfo->mouse_face_beg_col;
26238 start_x = hlinfo->mouse_face_beg_x;
26239 }
26240 else if (row == last)
26241 {
26242 start_hpos = hlinfo->mouse_face_end_col;
26243 start_x = hlinfo->mouse_face_end_x;
26244 }
26245 else
26246 {
26247 start_hpos = 0;
26248 start_x = 0;
26249 }
26250 }
26251 else if (row->reversed_p && row == last)
26252 {
26253 start_hpos = hlinfo->mouse_face_end_col;
26254 start_x = hlinfo->mouse_face_end_x;
26255 }
26256 else
26257 {
26258 start_hpos = 0;
26259 start_x = 0;
26260 }
26261
26262 if (row == last)
26263 {
26264 if (!row->reversed_p)
26265 end_hpos = hlinfo->mouse_face_end_col;
26266 else if (row == first)
26267 end_hpos = hlinfo->mouse_face_beg_col;
26268 else
26269 {
26270 end_hpos = row->used[TEXT_AREA];
26271 if (draw == DRAW_NORMAL_TEXT)
26272 row->fill_line_p = 1; /* Clear to end of line */
26273 }
26274 }
26275 else if (row->reversed_p && row == first)
26276 end_hpos = hlinfo->mouse_face_beg_col;
26277 else
26278 {
26279 end_hpos = row->used[TEXT_AREA];
26280 if (draw == DRAW_NORMAL_TEXT)
26281 row->fill_line_p = 1; /* Clear to end of line */
26282 }
26283
26284 if (end_hpos > start_hpos)
26285 {
26286 draw_row_with_mouse_face (w, start_x, row,
26287 start_hpos, end_hpos, draw);
26288
26289 row->mouse_face_p
26290 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
26291 }
26292 }
26293
26294 #ifdef HAVE_WINDOW_SYSTEM
26295 /* When we've written over the cursor, arrange for it to
26296 be displayed again. */
26297 if (FRAME_WINDOW_P (f)
26298 && phys_cursor_on_p && !w->phys_cursor_on_p)
26299 {
26300 int hpos = w->phys_cursor.hpos;
26301
26302 /* When the window is hscrolled, cursor hpos can legitimately be
26303 out of bounds, but we draw the cursor at the corresponding
26304 window margin in that case. */
26305 if (!row->reversed_p && hpos < 0)
26306 hpos = 0;
26307 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
26308 hpos = row->used[TEXT_AREA] - 1;
26309
26310 BLOCK_INPUT;
26311 display_and_set_cursor (w, 1, hpos, w->phys_cursor.vpos,
26312 w->phys_cursor.x, w->phys_cursor.y);
26313 UNBLOCK_INPUT;
26314 }
26315 #endif /* HAVE_WINDOW_SYSTEM */
26316 }
26317
26318 #ifdef HAVE_WINDOW_SYSTEM
26319 /* Change the mouse cursor. */
26320 if (FRAME_WINDOW_P (f))
26321 {
26322 if (draw == DRAW_NORMAL_TEXT
26323 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
26324 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
26325 else if (draw == DRAW_MOUSE_FACE)
26326 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
26327 else
26328 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
26329 }
26330 #endif /* HAVE_WINDOW_SYSTEM */
26331 }
26332
26333 /* EXPORT:
26334 Clear out the mouse-highlighted active region.
26335 Redraw it un-highlighted first. Value is non-zero if mouse
26336 face was actually drawn unhighlighted. */
26337
26338 int
26339 clear_mouse_face (Mouse_HLInfo *hlinfo)
26340 {
26341 int cleared = 0;
26342
26343 if (!hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window))
26344 {
26345 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
26346 cleared = 1;
26347 }
26348
26349 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
26350 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
26351 hlinfo->mouse_face_window = Qnil;
26352 hlinfo->mouse_face_overlay = Qnil;
26353 return cleared;
26354 }
26355
26356 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26357 within the mouse face on that window. */
26358 static int
26359 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
26360 {
26361 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
26362
26363 /* Quickly resolve the easy cases. */
26364 if (!(WINDOWP (hlinfo->mouse_face_window)
26365 && XWINDOW (hlinfo->mouse_face_window) == w))
26366 return 0;
26367 if (vpos < hlinfo->mouse_face_beg_row
26368 || vpos > hlinfo->mouse_face_end_row)
26369 return 0;
26370 if (vpos > hlinfo->mouse_face_beg_row
26371 && vpos < hlinfo->mouse_face_end_row)
26372 return 1;
26373
26374 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
26375 {
26376 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
26377 {
26378 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
26379 return 1;
26380 }
26381 else if ((vpos == hlinfo->mouse_face_beg_row
26382 && hpos >= hlinfo->mouse_face_beg_col)
26383 || (vpos == hlinfo->mouse_face_end_row
26384 && hpos < hlinfo->mouse_face_end_col))
26385 return 1;
26386 }
26387 else
26388 {
26389 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
26390 {
26391 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
26392 return 1;
26393 }
26394 else if ((vpos == hlinfo->mouse_face_beg_row
26395 && hpos <= hlinfo->mouse_face_beg_col)
26396 || (vpos == hlinfo->mouse_face_end_row
26397 && hpos > hlinfo->mouse_face_end_col))
26398 return 1;
26399 }
26400 return 0;
26401 }
26402
26403
26404 /* EXPORT:
26405 Non-zero if physical cursor of window W is within mouse face. */
26406
26407 int
26408 cursor_in_mouse_face_p (struct window *w)
26409 {
26410 int hpos = w->phys_cursor.hpos;
26411 int vpos = w->phys_cursor.vpos;
26412 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
26413
26414 /* When the window is hscrolled, cursor hpos can legitimately be out
26415 of bounds, but we draw the cursor at the corresponding window
26416 margin in that case. */
26417 if (!row->reversed_p && hpos < 0)
26418 hpos = 0;
26419 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
26420 hpos = row->used[TEXT_AREA] - 1;
26421
26422 return coords_in_mouse_face_p (w, hpos, vpos);
26423 }
26424
26425
26426 \f
26427 /* Find the glyph rows START_ROW and END_ROW of window W that display
26428 characters between buffer positions START_CHARPOS and END_CHARPOS
26429 (excluding END_CHARPOS). DISP_STRING is a display string that
26430 covers these buffer positions. This is similar to
26431 row_containing_pos, but is more accurate when bidi reordering makes
26432 buffer positions change non-linearly with glyph rows. */
26433 static void
26434 rows_from_pos_range (struct window *w,
26435 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
26436 Lisp_Object disp_string,
26437 struct glyph_row **start, struct glyph_row **end)
26438 {
26439 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
26440 int last_y = window_text_bottom_y (w);
26441 struct glyph_row *row;
26442
26443 *start = NULL;
26444 *end = NULL;
26445
26446 while (!first->enabled_p
26447 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
26448 first++;
26449
26450 /* Find the START row. */
26451 for (row = first;
26452 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
26453 row++)
26454 {
26455 /* A row can potentially be the START row if the range of the
26456 characters it displays intersects the range
26457 [START_CHARPOS..END_CHARPOS). */
26458 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
26459 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
26460 /* See the commentary in row_containing_pos, for the
26461 explanation of the complicated way to check whether
26462 some position is beyond the end of the characters
26463 displayed by a row. */
26464 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
26465 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
26466 && !row->ends_at_zv_p
26467 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
26468 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
26469 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
26470 && !row->ends_at_zv_p
26471 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
26472 {
26473 /* Found a candidate row. Now make sure at least one of the
26474 glyphs it displays has a charpos from the range
26475 [START_CHARPOS..END_CHARPOS).
26476
26477 This is not obvious because bidi reordering could make
26478 buffer positions of a row be 1,2,3,102,101,100, and if we
26479 want to highlight characters in [50..60), we don't want
26480 this row, even though [50..60) does intersect [1..103),
26481 the range of character positions given by the row's start
26482 and end positions. */
26483 struct glyph *g = row->glyphs[TEXT_AREA];
26484 struct glyph *e = g + row->used[TEXT_AREA];
26485
26486 while (g < e)
26487 {
26488 if (((BUFFERP (g->object) || INTEGERP (g->object))
26489 && start_charpos <= g->charpos && g->charpos < end_charpos)
26490 /* A glyph that comes from DISP_STRING is by
26491 definition to be highlighted. */
26492 || EQ (g->object, disp_string))
26493 *start = row;
26494 g++;
26495 }
26496 if (*start)
26497 break;
26498 }
26499 }
26500
26501 /* Find the END row. */
26502 if (!*start
26503 /* If the last row is partially visible, start looking for END
26504 from that row, instead of starting from FIRST. */
26505 && !(row->enabled_p
26506 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
26507 row = first;
26508 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
26509 {
26510 struct glyph_row *next = row + 1;
26511 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
26512
26513 if (!next->enabled_p
26514 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
26515 /* The first row >= START whose range of displayed characters
26516 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26517 is the row END + 1. */
26518 || (start_charpos < next_start
26519 && end_charpos < next_start)
26520 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
26521 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
26522 && !next->ends_at_zv_p
26523 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
26524 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
26525 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
26526 && !next->ends_at_zv_p
26527 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
26528 {
26529 *end = row;
26530 break;
26531 }
26532 else
26533 {
26534 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26535 but none of the characters it displays are in the range, it is
26536 also END + 1. */
26537 struct glyph *g = next->glyphs[TEXT_AREA];
26538 struct glyph *s = g;
26539 struct glyph *e = g + next->used[TEXT_AREA];
26540
26541 while (g < e)
26542 {
26543 if (((BUFFERP (g->object) || INTEGERP (g->object))
26544 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
26545 /* If the buffer position of the first glyph in
26546 the row is equal to END_CHARPOS, it means
26547 the last character to be highlighted is the
26548 newline of ROW, and we must consider NEXT as
26549 END, not END+1. */
26550 || (((!next->reversed_p && g == s)
26551 || (next->reversed_p && g == e - 1))
26552 && (g->charpos == end_charpos
26553 /* Special case for when NEXT is an
26554 empty line at ZV. */
26555 || (g->charpos == -1
26556 && !row->ends_at_zv_p
26557 && next_start == end_charpos)))))
26558 /* A glyph that comes from DISP_STRING is by
26559 definition to be highlighted. */
26560 || EQ (g->object, disp_string))
26561 break;
26562 g++;
26563 }
26564 if (g == e)
26565 {
26566 *end = row;
26567 break;
26568 }
26569 /* The first row that ends at ZV must be the last to be
26570 highlighted. */
26571 else if (next->ends_at_zv_p)
26572 {
26573 *end = next;
26574 break;
26575 }
26576 }
26577 }
26578 }
26579
26580 /* This function sets the mouse_face_* elements of HLINFO, assuming
26581 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26582 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26583 for the overlay or run of text properties specifying the mouse
26584 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26585 before-string and after-string that must also be highlighted.
26586 DISP_STRING, if non-nil, is a display string that may cover some
26587 or all of the highlighted text. */
26588
26589 static void
26590 mouse_face_from_buffer_pos (Lisp_Object window,
26591 Mouse_HLInfo *hlinfo,
26592 ptrdiff_t mouse_charpos,
26593 ptrdiff_t start_charpos,
26594 ptrdiff_t end_charpos,
26595 Lisp_Object before_string,
26596 Lisp_Object after_string,
26597 Lisp_Object disp_string)
26598 {
26599 struct window *w = XWINDOW (window);
26600 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
26601 struct glyph_row *r1, *r2;
26602 struct glyph *glyph, *end;
26603 ptrdiff_t ignore, pos;
26604 int x;
26605
26606 eassert (NILP (disp_string) || STRINGP (disp_string));
26607 eassert (NILP (before_string) || STRINGP (before_string));
26608 eassert (NILP (after_string) || STRINGP (after_string));
26609
26610 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26611 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
26612 if (r1 == NULL)
26613 r1 = MATRIX_ROW (w->current_matrix, XFASTINT (w->window_end_vpos));
26614 /* If the before-string or display-string contains newlines,
26615 rows_from_pos_range skips to its last row. Move back. */
26616 if (!NILP (before_string) || !NILP (disp_string))
26617 {
26618 struct glyph_row *prev;
26619 while ((prev = r1 - 1, prev >= first)
26620 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
26621 && prev->used[TEXT_AREA] > 0)
26622 {
26623 struct glyph *beg = prev->glyphs[TEXT_AREA];
26624 glyph = beg + prev->used[TEXT_AREA];
26625 while (--glyph >= beg && INTEGERP (glyph->object));
26626 if (glyph < beg
26627 || !(EQ (glyph->object, before_string)
26628 || EQ (glyph->object, disp_string)))
26629 break;
26630 r1 = prev;
26631 }
26632 }
26633 if (r2 == NULL)
26634 {
26635 r2 = MATRIX_ROW (w->current_matrix, XFASTINT (w->window_end_vpos));
26636 hlinfo->mouse_face_past_end = 1;
26637 }
26638 else if (!NILP (after_string))
26639 {
26640 /* If the after-string has newlines, advance to its last row. */
26641 struct glyph_row *next;
26642 struct glyph_row *last
26643 = MATRIX_ROW (w->current_matrix, XFASTINT (w->window_end_vpos));
26644
26645 for (next = r2 + 1;
26646 next <= last
26647 && next->used[TEXT_AREA] > 0
26648 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
26649 ++next)
26650 r2 = next;
26651 }
26652 /* The rest of the display engine assumes that mouse_face_beg_row is
26653 either above mouse_face_end_row or identical to it. But with
26654 bidi-reordered continued lines, the row for START_CHARPOS could
26655 be below the row for END_CHARPOS. If so, swap the rows and store
26656 them in correct order. */
26657 if (r1->y > r2->y)
26658 {
26659 struct glyph_row *tem = r2;
26660
26661 r2 = r1;
26662 r1 = tem;
26663 }
26664
26665 hlinfo->mouse_face_beg_y = r1->y;
26666 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
26667 hlinfo->mouse_face_end_y = r2->y;
26668 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
26669
26670 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26671 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26672 could be anywhere in the row and in any order. The strategy
26673 below is to find the leftmost and the rightmost glyph that
26674 belongs to either of these 3 strings, or whose position is
26675 between START_CHARPOS and END_CHARPOS, and highlight all the
26676 glyphs between those two. This may cover more than just the text
26677 between START_CHARPOS and END_CHARPOS if the range of characters
26678 strides the bidi level boundary, e.g. if the beginning is in R2L
26679 text while the end is in L2R text or vice versa. */
26680 if (!r1->reversed_p)
26681 {
26682 /* This row is in a left to right paragraph. Scan it left to
26683 right. */
26684 glyph = r1->glyphs[TEXT_AREA];
26685 end = glyph + r1->used[TEXT_AREA];
26686 x = r1->x;
26687
26688 /* Skip truncation glyphs at the start of the glyph row. */
26689 if (r1->displays_text_p)
26690 for (; glyph < end
26691 && INTEGERP (glyph->object)
26692 && glyph->charpos < 0;
26693 ++glyph)
26694 x += glyph->pixel_width;
26695
26696 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26697 or DISP_STRING, and the first glyph from buffer whose
26698 position is between START_CHARPOS and END_CHARPOS. */
26699 for (; glyph < end
26700 && !INTEGERP (glyph->object)
26701 && !EQ (glyph->object, disp_string)
26702 && !(BUFFERP (glyph->object)
26703 && (glyph->charpos >= start_charpos
26704 && glyph->charpos < end_charpos));
26705 ++glyph)
26706 {
26707 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26708 are present at buffer positions between START_CHARPOS and
26709 END_CHARPOS, or if they come from an overlay. */
26710 if (EQ (glyph->object, before_string))
26711 {
26712 pos = string_buffer_position (before_string,
26713 start_charpos);
26714 /* If pos == 0, it means before_string came from an
26715 overlay, not from a buffer position. */
26716 if (!pos || (pos >= start_charpos && pos < end_charpos))
26717 break;
26718 }
26719 else if (EQ (glyph->object, after_string))
26720 {
26721 pos = string_buffer_position (after_string, end_charpos);
26722 if (!pos || (pos >= start_charpos && pos < end_charpos))
26723 break;
26724 }
26725 x += glyph->pixel_width;
26726 }
26727 hlinfo->mouse_face_beg_x = x;
26728 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
26729 }
26730 else
26731 {
26732 /* This row is in a right to left paragraph. Scan it right to
26733 left. */
26734 struct glyph *g;
26735
26736 end = r1->glyphs[TEXT_AREA] - 1;
26737 glyph = end + r1->used[TEXT_AREA];
26738
26739 /* Skip truncation glyphs at the start of the glyph row. */
26740 if (r1->displays_text_p)
26741 for (; glyph > end
26742 && INTEGERP (glyph->object)
26743 && glyph->charpos < 0;
26744 --glyph)
26745 ;
26746
26747 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26748 or DISP_STRING, and the first glyph from buffer whose
26749 position is between START_CHARPOS and END_CHARPOS. */
26750 for (; glyph > end
26751 && !INTEGERP (glyph->object)
26752 && !EQ (glyph->object, disp_string)
26753 && !(BUFFERP (glyph->object)
26754 && (glyph->charpos >= start_charpos
26755 && glyph->charpos < end_charpos));
26756 --glyph)
26757 {
26758 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26759 are present at buffer positions between START_CHARPOS and
26760 END_CHARPOS, or if they come from an overlay. */
26761 if (EQ (glyph->object, before_string))
26762 {
26763 pos = string_buffer_position (before_string, start_charpos);
26764 /* If pos == 0, it means before_string came from an
26765 overlay, not from a buffer position. */
26766 if (!pos || (pos >= start_charpos && pos < end_charpos))
26767 break;
26768 }
26769 else if (EQ (glyph->object, after_string))
26770 {
26771 pos = string_buffer_position (after_string, end_charpos);
26772 if (!pos || (pos >= start_charpos && pos < end_charpos))
26773 break;
26774 }
26775 }
26776
26777 glyph++; /* first glyph to the right of the highlighted area */
26778 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
26779 x += g->pixel_width;
26780 hlinfo->mouse_face_beg_x = x;
26781 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
26782 }
26783
26784 /* If the highlight ends in a different row, compute GLYPH and END
26785 for the end row. Otherwise, reuse the values computed above for
26786 the row where the highlight begins. */
26787 if (r2 != r1)
26788 {
26789 if (!r2->reversed_p)
26790 {
26791 glyph = r2->glyphs[TEXT_AREA];
26792 end = glyph + r2->used[TEXT_AREA];
26793 x = r2->x;
26794 }
26795 else
26796 {
26797 end = r2->glyphs[TEXT_AREA] - 1;
26798 glyph = end + r2->used[TEXT_AREA];
26799 }
26800 }
26801
26802 if (!r2->reversed_p)
26803 {
26804 /* Skip truncation and continuation glyphs near the end of the
26805 row, and also blanks and stretch glyphs inserted by
26806 extend_face_to_end_of_line. */
26807 while (end > glyph
26808 && INTEGERP ((end - 1)->object))
26809 --end;
26810 /* Scan the rest of the glyph row from the end, looking for the
26811 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26812 DISP_STRING, or whose position is between START_CHARPOS
26813 and END_CHARPOS */
26814 for (--end;
26815 end > glyph
26816 && !INTEGERP (end->object)
26817 && !EQ (end->object, disp_string)
26818 && !(BUFFERP (end->object)
26819 && (end->charpos >= start_charpos
26820 && end->charpos < end_charpos));
26821 --end)
26822 {
26823 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26824 are present at buffer positions between START_CHARPOS and
26825 END_CHARPOS, or if they come from an overlay. */
26826 if (EQ (end->object, before_string))
26827 {
26828 pos = string_buffer_position (before_string, start_charpos);
26829 if (!pos || (pos >= start_charpos && pos < end_charpos))
26830 break;
26831 }
26832 else if (EQ (end->object, after_string))
26833 {
26834 pos = string_buffer_position (after_string, end_charpos);
26835 if (!pos || (pos >= start_charpos && pos < end_charpos))
26836 break;
26837 }
26838 }
26839 /* Find the X coordinate of the last glyph to be highlighted. */
26840 for (; glyph <= end; ++glyph)
26841 x += glyph->pixel_width;
26842
26843 hlinfo->mouse_face_end_x = x;
26844 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
26845 }
26846 else
26847 {
26848 /* Skip truncation and continuation glyphs near the end of the
26849 row, and also blanks and stretch glyphs inserted by
26850 extend_face_to_end_of_line. */
26851 x = r2->x;
26852 end++;
26853 while (end < glyph
26854 && INTEGERP (end->object))
26855 {
26856 x += end->pixel_width;
26857 ++end;
26858 }
26859 /* Scan the rest of the glyph row from the end, looking for the
26860 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26861 DISP_STRING, or whose position is between START_CHARPOS
26862 and END_CHARPOS */
26863 for ( ;
26864 end < glyph
26865 && !INTEGERP (end->object)
26866 && !EQ (end->object, disp_string)
26867 && !(BUFFERP (end->object)
26868 && (end->charpos >= start_charpos
26869 && end->charpos < end_charpos));
26870 ++end)
26871 {
26872 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26873 are present at buffer positions between START_CHARPOS and
26874 END_CHARPOS, or if they come from an overlay. */
26875 if (EQ (end->object, before_string))
26876 {
26877 pos = string_buffer_position (before_string, start_charpos);
26878 if (!pos || (pos >= start_charpos && pos < end_charpos))
26879 break;
26880 }
26881 else if (EQ (end->object, after_string))
26882 {
26883 pos = string_buffer_position (after_string, end_charpos);
26884 if (!pos || (pos >= start_charpos && pos < end_charpos))
26885 break;
26886 }
26887 x += end->pixel_width;
26888 }
26889 /* If we exited the above loop because we arrived at the last
26890 glyph of the row, and its buffer position is still not in
26891 range, it means the last character in range is the preceding
26892 newline. Bump the end column and x values to get past the
26893 last glyph. */
26894 if (end == glyph
26895 && BUFFERP (end->object)
26896 && (end->charpos < start_charpos
26897 || end->charpos >= end_charpos))
26898 {
26899 x += end->pixel_width;
26900 ++end;
26901 }
26902 hlinfo->mouse_face_end_x = x;
26903 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
26904 }
26905
26906 hlinfo->mouse_face_window = window;
26907 hlinfo->mouse_face_face_id
26908 = face_at_buffer_position (w, mouse_charpos, 0, 0, &ignore,
26909 mouse_charpos + 1,
26910 !hlinfo->mouse_face_hidden, -1);
26911 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
26912 }
26913
26914 /* The following function is not used anymore (replaced with
26915 mouse_face_from_string_pos), but I leave it here for the time
26916 being, in case someone would. */
26917
26918 #if 0 /* not used */
26919
26920 /* Find the position of the glyph for position POS in OBJECT in
26921 window W's current matrix, and return in *X, *Y the pixel
26922 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26923
26924 RIGHT_P non-zero means return the position of the right edge of the
26925 glyph, RIGHT_P zero means return the left edge position.
26926
26927 If no glyph for POS exists in the matrix, return the position of
26928 the glyph with the next smaller position that is in the matrix, if
26929 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26930 exists in the matrix, return the position of the glyph with the
26931 next larger position in OBJECT.
26932
26933 Value is non-zero if a glyph was found. */
26934
26935 static int
26936 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
26937 int *hpos, int *vpos, int *x, int *y, int right_p)
26938 {
26939 int yb = window_text_bottom_y (w);
26940 struct glyph_row *r;
26941 struct glyph *best_glyph = NULL;
26942 struct glyph_row *best_row = NULL;
26943 int best_x = 0;
26944
26945 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
26946 r->enabled_p && r->y < yb;
26947 ++r)
26948 {
26949 struct glyph *g = r->glyphs[TEXT_AREA];
26950 struct glyph *e = g + r->used[TEXT_AREA];
26951 int gx;
26952
26953 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
26954 if (EQ (g->object, object))
26955 {
26956 if (g->charpos == pos)
26957 {
26958 best_glyph = g;
26959 best_x = gx;
26960 best_row = r;
26961 goto found;
26962 }
26963 else if (best_glyph == NULL
26964 || ((eabs (g->charpos - pos)
26965 < eabs (best_glyph->charpos - pos))
26966 && (right_p
26967 ? g->charpos < pos
26968 : g->charpos > pos)))
26969 {
26970 best_glyph = g;
26971 best_x = gx;
26972 best_row = r;
26973 }
26974 }
26975 }
26976
26977 found:
26978
26979 if (best_glyph)
26980 {
26981 *x = best_x;
26982 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
26983
26984 if (right_p)
26985 {
26986 *x += best_glyph->pixel_width;
26987 ++*hpos;
26988 }
26989
26990 *y = best_row->y;
26991 *vpos = best_row - w->current_matrix->rows;
26992 }
26993
26994 return best_glyph != NULL;
26995 }
26996 #endif /* not used */
26997
26998 /* Find the positions of the first and the last glyphs in window W's
26999 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
27000 (assumed to be a string), and return in HLINFO's mouse_face_*
27001 members the pixel and column/row coordinates of those glyphs. */
27002
27003 static void
27004 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
27005 Lisp_Object object,
27006 ptrdiff_t startpos, ptrdiff_t endpos)
27007 {
27008 int yb = window_text_bottom_y (w);
27009 struct glyph_row *r;
27010 struct glyph *g, *e;
27011 int gx;
27012 int found = 0;
27013
27014 /* Find the glyph row with at least one position in the range
27015 [STARTPOS..ENDPOS], and the first glyph in that row whose
27016 position belongs to that range. */
27017 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
27018 r->enabled_p && r->y < yb;
27019 ++r)
27020 {
27021 if (!r->reversed_p)
27022 {
27023 g = r->glyphs[TEXT_AREA];
27024 e = g + r->used[TEXT_AREA];
27025 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
27026 if (EQ (g->object, object)
27027 && startpos <= g->charpos && g->charpos <= endpos)
27028 {
27029 hlinfo->mouse_face_beg_row = r - w->current_matrix->rows;
27030 hlinfo->mouse_face_beg_y = r->y;
27031 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
27032 hlinfo->mouse_face_beg_x = gx;
27033 found = 1;
27034 break;
27035 }
27036 }
27037 else
27038 {
27039 struct glyph *g1;
27040
27041 e = r->glyphs[TEXT_AREA];
27042 g = e + r->used[TEXT_AREA];
27043 for ( ; g > e; --g)
27044 if (EQ ((g-1)->object, object)
27045 && startpos <= (g-1)->charpos && (g-1)->charpos <= endpos)
27046 {
27047 hlinfo->mouse_face_beg_row = r - w->current_matrix->rows;
27048 hlinfo->mouse_face_beg_y = r->y;
27049 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
27050 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
27051 gx += g1->pixel_width;
27052 hlinfo->mouse_face_beg_x = gx;
27053 found = 1;
27054 break;
27055 }
27056 }
27057 if (found)
27058 break;
27059 }
27060
27061 if (!found)
27062 return;
27063
27064 /* Starting with the next row, look for the first row which does NOT
27065 include any glyphs whose positions are in the range. */
27066 for (++r; r->enabled_p && r->y < yb; ++r)
27067 {
27068 g = r->glyphs[TEXT_AREA];
27069 e = g + r->used[TEXT_AREA];
27070 found = 0;
27071 for ( ; g < e; ++g)
27072 if (EQ (g->object, object)
27073 && startpos <= g->charpos && g->charpos <= endpos)
27074 {
27075 found = 1;
27076 break;
27077 }
27078 if (!found)
27079 break;
27080 }
27081
27082 /* The highlighted region ends on the previous row. */
27083 r--;
27084
27085 /* Set the end row and its vertical pixel coordinate. */
27086 hlinfo->mouse_face_end_row = r - w->current_matrix->rows;
27087 hlinfo->mouse_face_end_y = r->y;
27088
27089 /* Compute and set the end column and the end column's horizontal
27090 pixel coordinate. */
27091 if (!r->reversed_p)
27092 {
27093 g = r->glyphs[TEXT_AREA];
27094 e = g + r->used[TEXT_AREA];
27095 for ( ; e > g; --e)
27096 if (EQ ((e-1)->object, object)
27097 && startpos <= (e-1)->charpos && (e-1)->charpos <= endpos)
27098 break;
27099 hlinfo->mouse_face_end_col = e - g;
27100
27101 for (gx = r->x; g < e; ++g)
27102 gx += g->pixel_width;
27103 hlinfo->mouse_face_end_x = gx;
27104 }
27105 else
27106 {
27107 e = r->glyphs[TEXT_AREA];
27108 g = e + r->used[TEXT_AREA];
27109 for (gx = r->x ; e < g; ++e)
27110 {
27111 if (EQ (e->object, object)
27112 && startpos <= e->charpos && e->charpos <= endpos)
27113 break;
27114 gx += e->pixel_width;
27115 }
27116 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
27117 hlinfo->mouse_face_end_x = gx;
27118 }
27119 }
27120
27121 #ifdef HAVE_WINDOW_SYSTEM
27122
27123 /* See if position X, Y is within a hot-spot of an image. */
27124
27125 static int
27126 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
27127 {
27128 if (!CONSP (hot_spot))
27129 return 0;
27130
27131 if (EQ (XCAR (hot_spot), Qrect))
27132 {
27133 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27134 Lisp_Object rect = XCDR (hot_spot);
27135 Lisp_Object tem;
27136 if (!CONSP (rect))
27137 return 0;
27138 if (!CONSP (XCAR (rect)))
27139 return 0;
27140 if (!CONSP (XCDR (rect)))
27141 return 0;
27142 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
27143 return 0;
27144 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
27145 return 0;
27146 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
27147 return 0;
27148 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
27149 return 0;
27150 return 1;
27151 }
27152 else if (EQ (XCAR (hot_spot), Qcircle))
27153 {
27154 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27155 Lisp_Object circ = XCDR (hot_spot);
27156 Lisp_Object lr, lx0, ly0;
27157 if (CONSP (circ)
27158 && CONSP (XCAR (circ))
27159 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
27160 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
27161 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
27162 {
27163 double r = XFLOATINT (lr);
27164 double dx = XINT (lx0) - x;
27165 double dy = XINT (ly0) - y;
27166 return (dx * dx + dy * dy <= r * r);
27167 }
27168 }
27169 else if (EQ (XCAR (hot_spot), Qpoly))
27170 {
27171 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27172 if (VECTORP (XCDR (hot_spot)))
27173 {
27174 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
27175 Lisp_Object *poly = v->contents;
27176 ptrdiff_t n = v->header.size;
27177 ptrdiff_t i;
27178 int inside = 0;
27179 Lisp_Object lx, ly;
27180 int x0, y0;
27181
27182 /* Need an even number of coordinates, and at least 3 edges. */
27183 if (n < 6 || n & 1)
27184 return 0;
27185
27186 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27187 If count is odd, we are inside polygon. Pixels on edges
27188 may or may not be included depending on actual geometry of the
27189 polygon. */
27190 if ((lx = poly[n-2], !INTEGERP (lx))
27191 || (ly = poly[n-1], !INTEGERP (lx)))
27192 return 0;
27193 x0 = XINT (lx), y0 = XINT (ly);
27194 for (i = 0; i < n; i += 2)
27195 {
27196 int x1 = x0, y1 = y0;
27197 if ((lx = poly[i], !INTEGERP (lx))
27198 || (ly = poly[i+1], !INTEGERP (ly)))
27199 return 0;
27200 x0 = XINT (lx), y0 = XINT (ly);
27201
27202 /* Does this segment cross the X line? */
27203 if (x0 >= x)
27204 {
27205 if (x1 >= x)
27206 continue;
27207 }
27208 else if (x1 < x)
27209 continue;
27210 if (y > y0 && y > y1)
27211 continue;
27212 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
27213 inside = !inside;
27214 }
27215 return inside;
27216 }
27217 }
27218 return 0;
27219 }
27220
27221 Lisp_Object
27222 find_hot_spot (Lisp_Object map, int x, int y)
27223 {
27224 while (CONSP (map))
27225 {
27226 if (CONSP (XCAR (map))
27227 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
27228 return XCAR (map);
27229 map = XCDR (map);
27230 }
27231
27232 return Qnil;
27233 }
27234
27235 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
27236 3, 3, 0,
27237 doc: /* Lookup in image map MAP coordinates X and Y.
27238 An image map is an alist where each element has the format (AREA ID PLIST).
27239 An AREA is specified as either a rectangle, a circle, or a polygon:
27240 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27241 pixel coordinates of the upper left and bottom right corners.
27242 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27243 and the radius of the circle; r may be a float or integer.
27244 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27245 vector describes one corner in the polygon.
27246 Returns the alist element for the first matching AREA in MAP. */)
27247 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
27248 {
27249 if (NILP (map))
27250 return Qnil;
27251
27252 CHECK_NUMBER (x);
27253 CHECK_NUMBER (y);
27254
27255 return find_hot_spot (map,
27256 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
27257 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
27258 }
27259
27260
27261 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27262 static void
27263 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
27264 {
27265 /* Do not change cursor shape while dragging mouse. */
27266 if (!NILP (do_mouse_tracking))
27267 return;
27268
27269 if (!NILP (pointer))
27270 {
27271 if (EQ (pointer, Qarrow))
27272 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
27273 else if (EQ (pointer, Qhand))
27274 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
27275 else if (EQ (pointer, Qtext))
27276 cursor = FRAME_X_OUTPUT (f)->text_cursor;
27277 else if (EQ (pointer, intern ("hdrag")))
27278 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
27279 #ifdef HAVE_X_WINDOWS
27280 else if (EQ (pointer, intern ("vdrag")))
27281 cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
27282 #endif
27283 else if (EQ (pointer, intern ("hourglass")))
27284 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
27285 else if (EQ (pointer, Qmodeline))
27286 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
27287 else
27288 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
27289 }
27290
27291 if (cursor != No_Cursor)
27292 FRAME_RIF (f)->define_frame_cursor (f, cursor);
27293 }
27294
27295 #endif /* HAVE_WINDOW_SYSTEM */
27296
27297 /* Take proper action when mouse has moved to the mode or header line
27298 or marginal area AREA of window W, x-position X and y-position Y.
27299 X is relative to the start of the text display area of W, so the
27300 width of bitmap areas and scroll bars must be subtracted to get a
27301 position relative to the start of the mode line. */
27302
27303 static void
27304 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
27305 enum window_part area)
27306 {
27307 struct window *w = XWINDOW (window);
27308 struct frame *f = XFRAME (w->frame);
27309 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27310 #ifdef HAVE_WINDOW_SYSTEM
27311 Display_Info *dpyinfo;
27312 #endif
27313 Cursor cursor = No_Cursor;
27314 Lisp_Object pointer = Qnil;
27315 int dx, dy, width, height;
27316 ptrdiff_t charpos;
27317 Lisp_Object string, object = Qnil;
27318 Lisp_Object pos IF_LINT (= Qnil), help;
27319
27320 Lisp_Object mouse_face;
27321 int original_x_pixel = x;
27322 struct glyph * glyph = NULL, * row_start_glyph = NULL;
27323 struct glyph_row *row IF_LINT (= 0);
27324
27325 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
27326 {
27327 int x0;
27328 struct glyph *end;
27329
27330 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27331 returns them in row/column units! */
27332 string = mode_line_string (w, area, &x, &y, &charpos,
27333 &object, &dx, &dy, &width, &height);
27334
27335 row = (area == ON_MODE_LINE
27336 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
27337 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
27338
27339 /* Find the glyph under the mouse pointer. */
27340 if (row->mode_line_p && row->enabled_p)
27341 {
27342 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
27343 end = glyph + row->used[TEXT_AREA];
27344
27345 for (x0 = original_x_pixel;
27346 glyph < end && x0 >= glyph->pixel_width;
27347 ++glyph)
27348 x0 -= glyph->pixel_width;
27349
27350 if (glyph >= end)
27351 glyph = NULL;
27352 }
27353 }
27354 else
27355 {
27356 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
27357 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27358 returns them in row/column units! */
27359 string = marginal_area_string (w, area, &x, &y, &charpos,
27360 &object, &dx, &dy, &width, &height);
27361 }
27362
27363 help = Qnil;
27364
27365 #ifdef HAVE_WINDOW_SYSTEM
27366 if (IMAGEP (object))
27367 {
27368 Lisp_Object image_map, hotspot;
27369 if ((image_map = Fplist_get (XCDR (object), QCmap),
27370 !NILP (image_map))
27371 && (hotspot = find_hot_spot (image_map, dx, dy),
27372 CONSP (hotspot))
27373 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
27374 {
27375 Lisp_Object plist;
27376
27377 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27378 If so, we could look for mouse-enter, mouse-leave
27379 properties in PLIST (and do something...). */
27380 hotspot = XCDR (hotspot);
27381 if (CONSP (hotspot)
27382 && (plist = XCAR (hotspot), CONSP (plist)))
27383 {
27384 pointer = Fplist_get (plist, Qpointer);
27385 if (NILP (pointer))
27386 pointer = Qhand;
27387 help = Fplist_get (plist, Qhelp_echo);
27388 if (!NILP (help))
27389 {
27390 help_echo_string = help;
27391 XSETWINDOW (help_echo_window, w);
27392 help_echo_object = w->buffer;
27393 help_echo_pos = charpos;
27394 }
27395 }
27396 }
27397 if (NILP (pointer))
27398 pointer = Fplist_get (XCDR (object), QCpointer);
27399 }
27400 #endif /* HAVE_WINDOW_SYSTEM */
27401
27402 if (STRINGP (string))
27403 pos = make_number (charpos);
27404
27405 /* Set the help text and mouse pointer. If the mouse is on a part
27406 of the mode line without any text (e.g. past the right edge of
27407 the mode line text), use the default help text and pointer. */
27408 if (STRINGP (string) || area == ON_MODE_LINE)
27409 {
27410 /* Arrange to display the help by setting the global variables
27411 help_echo_string, help_echo_object, and help_echo_pos. */
27412 if (NILP (help))
27413 {
27414 if (STRINGP (string))
27415 help = Fget_text_property (pos, Qhelp_echo, string);
27416
27417 if (!NILP (help))
27418 {
27419 help_echo_string = help;
27420 XSETWINDOW (help_echo_window, w);
27421 help_echo_object = string;
27422 help_echo_pos = charpos;
27423 }
27424 else if (area == ON_MODE_LINE)
27425 {
27426 Lisp_Object default_help
27427 = buffer_local_value_1 (Qmode_line_default_help_echo,
27428 w->buffer);
27429
27430 if (STRINGP (default_help))
27431 {
27432 help_echo_string = default_help;
27433 XSETWINDOW (help_echo_window, w);
27434 help_echo_object = Qnil;
27435 help_echo_pos = -1;
27436 }
27437 }
27438 }
27439
27440 #ifdef HAVE_WINDOW_SYSTEM
27441 /* Change the mouse pointer according to what is under it. */
27442 if (FRAME_WINDOW_P (f))
27443 {
27444 dpyinfo = FRAME_X_DISPLAY_INFO (f);
27445 if (STRINGP (string))
27446 {
27447 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
27448
27449 if (NILP (pointer))
27450 pointer = Fget_text_property (pos, Qpointer, string);
27451
27452 /* Change the mouse pointer according to what is under X/Y. */
27453 if (NILP (pointer)
27454 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
27455 {
27456 Lisp_Object map;
27457 map = Fget_text_property (pos, Qlocal_map, string);
27458 if (!KEYMAPP (map))
27459 map = Fget_text_property (pos, Qkeymap, string);
27460 if (!KEYMAPP (map))
27461 cursor = dpyinfo->vertical_scroll_bar_cursor;
27462 }
27463 }
27464 else
27465 /* Default mode-line pointer. */
27466 cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
27467 }
27468 #endif
27469 }
27470
27471 /* Change the mouse face according to what is under X/Y. */
27472 if (STRINGP (string))
27473 {
27474 mouse_face = Fget_text_property (pos, Qmouse_face, string);
27475 if (!NILP (mouse_face)
27476 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
27477 && glyph)
27478 {
27479 Lisp_Object b, e;
27480
27481 struct glyph * tmp_glyph;
27482
27483 int gpos;
27484 int gseq_length;
27485 int total_pixel_width;
27486 ptrdiff_t begpos, endpos, ignore;
27487
27488 int vpos, hpos;
27489
27490 b = Fprevious_single_property_change (make_number (charpos + 1),
27491 Qmouse_face, string, Qnil);
27492 if (NILP (b))
27493 begpos = 0;
27494 else
27495 begpos = XINT (b);
27496
27497 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
27498 if (NILP (e))
27499 endpos = SCHARS (string);
27500 else
27501 endpos = XINT (e);
27502
27503 /* Calculate the glyph position GPOS of GLYPH in the
27504 displayed string, relative to the beginning of the
27505 highlighted part of the string.
27506
27507 Note: GPOS is different from CHARPOS. CHARPOS is the
27508 position of GLYPH in the internal string object. A mode
27509 line string format has structures which are converted to
27510 a flattened string by the Emacs Lisp interpreter. The
27511 internal string is an element of those structures. The
27512 displayed string is the flattened string. */
27513 tmp_glyph = row_start_glyph;
27514 while (tmp_glyph < glyph
27515 && (!(EQ (tmp_glyph->object, glyph->object)
27516 && begpos <= tmp_glyph->charpos
27517 && tmp_glyph->charpos < endpos)))
27518 tmp_glyph++;
27519 gpos = glyph - tmp_glyph;
27520
27521 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27522 the highlighted part of the displayed string to which
27523 GLYPH belongs. Note: GSEQ_LENGTH is different from
27524 SCHARS (STRING), because the latter returns the length of
27525 the internal string. */
27526 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
27527 tmp_glyph > glyph
27528 && (!(EQ (tmp_glyph->object, glyph->object)
27529 && begpos <= tmp_glyph->charpos
27530 && tmp_glyph->charpos < endpos));
27531 tmp_glyph--)
27532 ;
27533 gseq_length = gpos + (tmp_glyph - glyph) + 1;
27534
27535 /* Calculate the total pixel width of all the glyphs between
27536 the beginning of the highlighted area and GLYPH. */
27537 total_pixel_width = 0;
27538 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
27539 total_pixel_width += tmp_glyph->pixel_width;
27540
27541 /* Pre calculation of re-rendering position. Note: X is in
27542 column units here, after the call to mode_line_string or
27543 marginal_area_string. */
27544 hpos = x - gpos;
27545 vpos = (area == ON_MODE_LINE
27546 ? (w->current_matrix)->nrows - 1
27547 : 0);
27548
27549 /* If GLYPH's position is included in the region that is
27550 already drawn in mouse face, we have nothing to do. */
27551 if ( EQ (window, hlinfo->mouse_face_window)
27552 && (!row->reversed_p
27553 ? (hlinfo->mouse_face_beg_col <= hpos
27554 && hpos < hlinfo->mouse_face_end_col)
27555 /* In R2L rows we swap BEG and END, see below. */
27556 : (hlinfo->mouse_face_end_col <= hpos
27557 && hpos < hlinfo->mouse_face_beg_col))
27558 && hlinfo->mouse_face_beg_row == vpos )
27559 return;
27560
27561 if (clear_mouse_face (hlinfo))
27562 cursor = No_Cursor;
27563
27564 if (!row->reversed_p)
27565 {
27566 hlinfo->mouse_face_beg_col = hpos;
27567 hlinfo->mouse_face_beg_x = original_x_pixel
27568 - (total_pixel_width + dx);
27569 hlinfo->mouse_face_end_col = hpos + gseq_length;
27570 hlinfo->mouse_face_end_x = 0;
27571 }
27572 else
27573 {
27574 /* In R2L rows, show_mouse_face expects BEG and END
27575 coordinates to be swapped. */
27576 hlinfo->mouse_face_end_col = hpos;
27577 hlinfo->mouse_face_end_x = original_x_pixel
27578 - (total_pixel_width + dx);
27579 hlinfo->mouse_face_beg_col = hpos + gseq_length;
27580 hlinfo->mouse_face_beg_x = 0;
27581 }
27582
27583 hlinfo->mouse_face_beg_row = vpos;
27584 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
27585 hlinfo->mouse_face_beg_y = 0;
27586 hlinfo->mouse_face_end_y = 0;
27587 hlinfo->mouse_face_past_end = 0;
27588 hlinfo->mouse_face_window = window;
27589
27590 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
27591 charpos,
27592 0, 0, 0,
27593 &ignore,
27594 glyph->face_id,
27595 1);
27596 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
27597
27598 if (NILP (pointer))
27599 pointer = Qhand;
27600 }
27601 else if ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
27602 clear_mouse_face (hlinfo);
27603 }
27604 #ifdef HAVE_WINDOW_SYSTEM
27605 if (FRAME_WINDOW_P (f))
27606 define_frame_cursor1 (f, cursor, pointer);
27607 #endif
27608 }
27609
27610
27611 /* EXPORT:
27612 Take proper action when the mouse has moved to position X, Y on
27613 frame F as regards highlighting characters that have mouse-face
27614 properties. Also de-highlighting chars where the mouse was before.
27615 X and Y can be negative or out of range. */
27616
27617 void
27618 note_mouse_highlight (struct frame *f, int x, int y)
27619 {
27620 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27621 enum window_part part = ON_NOTHING;
27622 Lisp_Object window;
27623 struct window *w;
27624 Cursor cursor = No_Cursor;
27625 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
27626 struct buffer *b;
27627
27628 /* When a menu is active, don't highlight because this looks odd. */
27629 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27630 if (popup_activated ())
27631 return;
27632 #endif
27633
27634 if (NILP (Vmouse_highlight)
27635 || !f->glyphs_initialized_p
27636 || f->pointer_invisible)
27637 return;
27638
27639 hlinfo->mouse_face_mouse_x = x;
27640 hlinfo->mouse_face_mouse_y = y;
27641 hlinfo->mouse_face_mouse_frame = f;
27642
27643 if (hlinfo->mouse_face_defer)
27644 return;
27645
27646 if (gc_in_progress)
27647 {
27648 hlinfo->mouse_face_deferred_gc = 1;
27649 return;
27650 }
27651
27652 /* Which window is that in? */
27653 window = window_from_coordinates (f, x, y, &part, 1);
27654
27655 /* If displaying active text in another window, clear that. */
27656 if (! EQ (window, hlinfo->mouse_face_window)
27657 /* Also clear if we move out of text area in same window. */
27658 || (!NILP (hlinfo->mouse_face_window)
27659 && !NILP (window)
27660 && part != ON_TEXT
27661 && part != ON_MODE_LINE
27662 && part != ON_HEADER_LINE))
27663 clear_mouse_face (hlinfo);
27664
27665 /* Not on a window -> return. */
27666 if (!WINDOWP (window))
27667 return;
27668
27669 /* Reset help_echo_string. It will get recomputed below. */
27670 help_echo_string = Qnil;
27671
27672 /* Convert to window-relative pixel coordinates. */
27673 w = XWINDOW (window);
27674 frame_to_window_pixel_xy (w, &x, &y);
27675
27676 #ifdef HAVE_WINDOW_SYSTEM
27677 /* Handle tool-bar window differently since it doesn't display a
27678 buffer. */
27679 if (EQ (window, f->tool_bar_window))
27680 {
27681 note_tool_bar_highlight (f, x, y);
27682 return;
27683 }
27684 #endif
27685
27686 /* Mouse is on the mode, header line or margin? */
27687 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
27688 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
27689 {
27690 note_mode_line_or_margin_highlight (window, x, y, part);
27691 return;
27692 }
27693
27694 #ifdef HAVE_WINDOW_SYSTEM
27695 if (part == ON_VERTICAL_BORDER)
27696 {
27697 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
27698 help_echo_string = build_string ("drag-mouse-1: resize");
27699 }
27700 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
27701 || part == ON_SCROLL_BAR)
27702 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
27703 else
27704 cursor = FRAME_X_OUTPUT (f)->text_cursor;
27705 #endif
27706
27707 /* Are we in a window whose display is up to date?
27708 And verify the buffer's text has not changed. */
27709 b = XBUFFER (w->buffer);
27710 if (part == ON_TEXT
27711 && EQ (w->window_end_valid, w->buffer)
27712 && w->last_modified == BUF_MODIFF (b)
27713 && w->last_overlay_modified == BUF_OVERLAY_MODIFF (b))
27714 {
27715 int hpos, vpos, dx, dy, area = LAST_AREA;
27716 ptrdiff_t pos;
27717 struct glyph *glyph;
27718 Lisp_Object object;
27719 Lisp_Object mouse_face = Qnil, position;
27720 Lisp_Object *overlay_vec = NULL;
27721 ptrdiff_t i, noverlays;
27722 struct buffer *obuf;
27723 ptrdiff_t obegv, ozv;
27724 int same_region;
27725
27726 /* Find the glyph under X/Y. */
27727 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
27728
27729 #ifdef HAVE_WINDOW_SYSTEM
27730 /* Look for :pointer property on image. */
27731 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27732 {
27733 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27734 if (img != NULL && IMAGEP (img->spec))
27735 {
27736 Lisp_Object image_map, hotspot;
27737 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
27738 !NILP (image_map))
27739 && (hotspot = find_hot_spot (image_map,
27740 glyph->slice.img.x + dx,
27741 glyph->slice.img.y + dy),
27742 CONSP (hotspot))
27743 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
27744 {
27745 Lisp_Object plist;
27746
27747 /* Could check XCAR (hotspot) to see if we enter/leave
27748 this hot-spot.
27749 If so, we could look for mouse-enter, mouse-leave
27750 properties in PLIST (and do something...). */
27751 hotspot = XCDR (hotspot);
27752 if (CONSP (hotspot)
27753 && (plist = XCAR (hotspot), CONSP (plist)))
27754 {
27755 pointer = Fplist_get (plist, Qpointer);
27756 if (NILP (pointer))
27757 pointer = Qhand;
27758 help_echo_string = Fplist_get (plist, Qhelp_echo);
27759 if (!NILP (help_echo_string))
27760 {
27761 help_echo_window = window;
27762 help_echo_object = glyph->object;
27763 help_echo_pos = glyph->charpos;
27764 }
27765 }
27766 }
27767 if (NILP (pointer))
27768 pointer = Fplist_get (XCDR (img->spec), QCpointer);
27769 }
27770 }
27771 #endif /* HAVE_WINDOW_SYSTEM */
27772
27773 /* Clear mouse face if X/Y not over text. */
27774 if (glyph == NULL
27775 || area != TEXT_AREA
27776 || !MATRIX_ROW (w->current_matrix, vpos)->displays_text_p
27777 /* Glyph's OBJECT is an integer for glyphs inserted by the
27778 display engine for its internal purposes, like truncation
27779 and continuation glyphs and blanks beyond the end of
27780 line's text on text terminals. If we are over such a
27781 glyph, we are not over any text. */
27782 || INTEGERP (glyph->object)
27783 /* R2L rows have a stretch glyph at their front, which
27784 stands for no text, whereas L2R rows have no glyphs at
27785 all beyond the end of text. Treat such stretch glyphs
27786 like we do with NULL glyphs in L2R rows. */
27787 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
27788 && glyph == MATRIX_ROW (w->current_matrix, vpos)->glyphs[TEXT_AREA]
27789 && glyph->type == STRETCH_GLYPH
27790 && glyph->avoid_cursor_p))
27791 {
27792 if (clear_mouse_face (hlinfo))
27793 cursor = No_Cursor;
27794 #ifdef HAVE_WINDOW_SYSTEM
27795 if (FRAME_WINDOW_P (f) && NILP (pointer))
27796 {
27797 if (area != TEXT_AREA)
27798 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
27799 else
27800 pointer = Vvoid_text_area_pointer;
27801 }
27802 #endif
27803 goto set_cursor;
27804 }
27805
27806 pos = glyph->charpos;
27807 object = glyph->object;
27808 if (!STRINGP (object) && !BUFFERP (object))
27809 goto set_cursor;
27810
27811 /* If we get an out-of-range value, return now; avoid an error. */
27812 if (BUFFERP (object) && pos > BUF_Z (b))
27813 goto set_cursor;
27814
27815 /* Make the window's buffer temporarily current for
27816 overlays_at and compute_char_face. */
27817 obuf = current_buffer;
27818 current_buffer = b;
27819 obegv = BEGV;
27820 ozv = ZV;
27821 BEGV = BEG;
27822 ZV = Z;
27823
27824 /* Is this char mouse-active or does it have help-echo? */
27825 position = make_number (pos);
27826
27827 if (BUFFERP (object))
27828 {
27829 /* Put all the overlays we want in a vector in overlay_vec. */
27830 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, 0);
27831 /* Sort overlays into increasing priority order. */
27832 noverlays = sort_overlays (overlay_vec, noverlays, w);
27833 }
27834 else
27835 noverlays = 0;
27836
27837 same_region = coords_in_mouse_face_p (w, hpos, vpos);
27838
27839 if (same_region)
27840 cursor = No_Cursor;
27841
27842 /* Check mouse-face highlighting. */
27843 if (! same_region
27844 /* If there exists an overlay with mouse-face overlapping
27845 the one we are currently highlighting, we have to
27846 check if we enter the overlapping overlay, and then
27847 highlight only that. */
27848 || (OVERLAYP (hlinfo->mouse_face_overlay)
27849 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
27850 {
27851 /* Find the highest priority overlay with a mouse-face. */
27852 Lisp_Object overlay = Qnil;
27853 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
27854 {
27855 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
27856 if (!NILP (mouse_face))
27857 overlay = overlay_vec[i];
27858 }
27859
27860 /* If we're highlighting the same overlay as before, there's
27861 no need to do that again. */
27862 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
27863 goto check_help_echo;
27864 hlinfo->mouse_face_overlay = overlay;
27865
27866 /* Clear the display of the old active region, if any. */
27867 if (clear_mouse_face (hlinfo))
27868 cursor = No_Cursor;
27869
27870 /* If no overlay applies, get a text property. */
27871 if (NILP (overlay))
27872 mouse_face = Fget_text_property (position, Qmouse_face, object);
27873
27874 /* Next, compute the bounds of the mouse highlighting and
27875 display it. */
27876 if (!NILP (mouse_face) && STRINGP (object))
27877 {
27878 /* The mouse-highlighting comes from a display string
27879 with a mouse-face. */
27880 Lisp_Object s, e;
27881 ptrdiff_t ignore;
27882
27883 s = Fprevious_single_property_change
27884 (make_number (pos + 1), Qmouse_face, object, Qnil);
27885 e = Fnext_single_property_change
27886 (position, Qmouse_face, object, Qnil);
27887 if (NILP (s))
27888 s = make_number (0);
27889 if (NILP (e))
27890 e = make_number (SCHARS (object) - 1);
27891 mouse_face_from_string_pos (w, hlinfo, object,
27892 XINT (s), XINT (e));
27893 hlinfo->mouse_face_past_end = 0;
27894 hlinfo->mouse_face_window = window;
27895 hlinfo->mouse_face_face_id
27896 = face_at_string_position (w, object, pos, 0, 0, 0, &ignore,
27897 glyph->face_id, 1);
27898 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
27899 cursor = No_Cursor;
27900 }
27901 else
27902 {
27903 /* The mouse-highlighting, if any, comes from an overlay
27904 or text property in the buffer. */
27905 Lisp_Object buffer IF_LINT (= Qnil);
27906 Lisp_Object disp_string IF_LINT (= Qnil);
27907
27908 if (STRINGP (object))
27909 {
27910 /* If we are on a display string with no mouse-face,
27911 check if the text under it has one. */
27912 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
27913 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
27914 pos = string_buffer_position (object, start);
27915 if (pos > 0)
27916 {
27917 mouse_face = get_char_property_and_overlay
27918 (make_number (pos), Qmouse_face, w->buffer, &overlay);
27919 buffer = w->buffer;
27920 disp_string = object;
27921 }
27922 }
27923 else
27924 {
27925 buffer = object;
27926 disp_string = Qnil;
27927 }
27928
27929 if (!NILP (mouse_face))
27930 {
27931 Lisp_Object before, after;
27932 Lisp_Object before_string, after_string;
27933 /* To correctly find the limits of mouse highlight
27934 in a bidi-reordered buffer, we must not use the
27935 optimization of limiting the search in
27936 previous-single-property-change and
27937 next-single-property-change, because
27938 rows_from_pos_range needs the real start and end
27939 positions to DTRT in this case. That's because
27940 the first row visible in a window does not
27941 necessarily display the character whose position
27942 is the smallest. */
27943 Lisp_Object lim1 =
27944 NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
27945 ? Fmarker_position (w->start)
27946 : Qnil;
27947 Lisp_Object lim2 =
27948 NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
27949 ? make_number (BUF_Z (XBUFFER (buffer))
27950 - XFASTINT (w->window_end_pos))
27951 : Qnil;
27952
27953 if (NILP (overlay))
27954 {
27955 /* Handle the text property case. */
27956 before = Fprevious_single_property_change
27957 (make_number (pos + 1), Qmouse_face, buffer, lim1);
27958 after = Fnext_single_property_change
27959 (make_number (pos), Qmouse_face, buffer, lim2);
27960 before_string = after_string = Qnil;
27961 }
27962 else
27963 {
27964 /* Handle the overlay case. */
27965 before = Foverlay_start (overlay);
27966 after = Foverlay_end (overlay);
27967 before_string = Foverlay_get (overlay, Qbefore_string);
27968 after_string = Foverlay_get (overlay, Qafter_string);
27969
27970 if (!STRINGP (before_string)) before_string = Qnil;
27971 if (!STRINGP (after_string)) after_string = Qnil;
27972 }
27973
27974 mouse_face_from_buffer_pos (window, hlinfo, pos,
27975 NILP (before)
27976 ? 1
27977 : XFASTINT (before),
27978 NILP (after)
27979 ? BUF_Z (XBUFFER (buffer))
27980 : XFASTINT (after),
27981 before_string, after_string,
27982 disp_string);
27983 cursor = No_Cursor;
27984 }
27985 }
27986 }
27987
27988 check_help_echo:
27989
27990 /* Look for a `help-echo' property. */
27991 if (NILP (help_echo_string)) {
27992 Lisp_Object help, overlay;
27993
27994 /* Check overlays first. */
27995 help = overlay = Qnil;
27996 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
27997 {
27998 overlay = overlay_vec[i];
27999 help = Foverlay_get (overlay, Qhelp_echo);
28000 }
28001
28002 if (!NILP (help))
28003 {
28004 help_echo_string = help;
28005 help_echo_window = window;
28006 help_echo_object = overlay;
28007 help_echo_pos = pos;
28008 }
28009 else
28010 {
28011 Lisp_Object obj = glyph->object;
28012 ptrdiff_t charpos = glyph->charpos;
28013
28014 /* Try text properties. */
28015 if (STRINGP (obj)
28016 && charpos >= 0
28017 && charpos < SCHARS (obj))
28018 {
28019 help = Fget_text_property (make_number (charpos),
28020 Qhelp_echo, obj);
28021 if (NILP (help))
28022 {
28023 /* If the string itself doesn't specify a help-echo,
28024 see if the buffer text ``under'' it does. */
28025 struct glyph_row *r
28026 = MATRIX_ROW (w->current_matrix, vpos);
28027 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
28028 ptrdiff_t p = string_buffer_position (obj, start);
28029 if (p > 0)
28030 {
28031 help = Fget_char_property (make_number (p),
28032 Qhelp_echo, w->buffer);
28033 if (!NILP (help))
28034 {
28035 charpos = p;
28036 obj = w->buffer;
28037 }
28038 }
28039 }
28040 }
28041 else if (BUFFERP (obj)
28042 && charpos >= BEGV
28043 && charpos < ZV)
28044 help = Fget_text_property (make_number (charpos), Qhelp_echo,
28045 obj);
28046
28047 if (!NILP (help))
28048 {
28049 help_echo_string = help;
28050 help_echo_window = window;
28051 help_echo_object = obj;
28052 help_echo_pos = charpos;
28053 }
28054 }
28055 }
28056
28057 #ifdef HAVE_WINDOW_SYSTEM
28058 /* Look for a `pointer' property. */
28059 if (FRAME_WINDOW_P (f) && NILP (pointer))
28060 {
28061 /* Check overlays first. */
28062 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
28063 pointer = Foverlay_get (overlay_vec[i], Qpointer);
28064
28065 if (NILP (pointer))
28066 {
28067 Lisp_Object obj = glyph->object;
28068 ptrdiff_t charpos = glyph->charpos;
28069
28070 /* Try text properties. */
28071 if (STRINGP (obj)
28072 && charpos >= 0
28073 && charpos < SCHARS (obj))
28074 {
28075 pointer = Fget_text_property (make_number (charpos),
28076 Qpointer, obj);
28077 if (NILP (pointer))
28078 {
28079 /* If the string itself doesn't specify a pointer,
28080 see if the buffer text ``under'' it does. */
28081 struct glyph_row *r
28082 = MATRIX_ROW (w->current_matrix, vpos);
28083 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
28084 ptrdiff_t p = string_buffer_position (obj, start);
28085 if (p > 0)
28086 pointer = Fget_char_property (make_number (p),
28087 Qpointer, w->buffer);
28088 }
28089 }
28090 else if (BUFFERP (obj)
28091 && charpos >= BEGV
28092 && charpos < ZV)
28093 pointer = Fget_text_property (make_number (charpos),
28094 Qpointer, obj);
28095 }
28096 }
28097 #endif /* HAVE_WINDOW_SYSTEM */
28098
28099 BEGV = obegv;
28100 ZV = ozv;
28101 current_buffer = obuf;
28102 }
28103
28104 set_cursor:
28105
28106 #ifdef HAVE_WINDOW_SYSTEM
28107 if (FRAME_WINDOW_P (f))
28108 define_frame_cursor1 (f, cursor, pointer);
28109 #else
28110 /* This is here to prevent a compiler error, about "label at end of
28111 compound statement". */
28112 return;
28113 #endif
28114 }
28115
28116
28117 /* EXPORT for RIF:
28118 Clear any mouse-face on window W. This function is part of the
28119 redisplay interface, and is called from try_window_id and similar
28120 functions to ensure the mouse-highlight is off. */
28121
28122 void
28123 x_clear_window_mouse_face (struct window *w)
28124 {
28125 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
28126 Lisp_Object window;
28127
28128 BLOCK_INPUT;
28129 XSETWINDOW (window, w);
28130 if (EQ (window, hlinfo->mouse_face_window))
28131 clear_mouse_face (hlinfo);
28132 UNBLOCK_INPUT;
28133 }
28134
28135
28136 /* EXPORT:
28137 Just discard the mouse face information for frame F, if any.
28138 This is used when the size of F is changed. */
28139
28140 void
28141 cancel_mouse_face (struct frame *f)
28142 {
28143 Lisp_Object window;
28144 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28145
28146 window = hlinfo->mouse_face_window;
28147 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
28148 {
28149 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
28150 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
28151 hlinfo->mouse_face_window = Qnil;
28152 }
28153 }
28154
28155
28156 \f
28157 /***********************************************************************
28158 Exposure Events
28159 ***********************************************************************/
28160
28161 #ifdef HAVE_WINDOW_SYSTEM
28162
28163 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28164 which intersects rectangle R. R is in window-relative coordinates. */
28165
28166 static void
28167 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
28168 enum glyph_row_area area)
28169 {
28170 struct glyph *first = row->glyphs[area];
28171 struct glyph *end = row->glyphs[area] + row->used[area];
28172 struct glyph *last;
28173 int first_x, start_x, x;
28174
28175 if (area == TEXT_AREA && row->fill_line_p)
28176 /* If row extends face to end of line write the whole line. */
28177 draw_glyphs (w, 0, row, area,
28178 0, row->used[area],
28179 DRAW_NORMAL_TEXT, 0);
28180 else
28181 {
28182 /* Set START_X to the window-relative start position for drawing glyphs of
28183 AREA. The first glyph of the text area can be partially visible.
28184 The first glyphs of other areas cannot. */
28185 start_x = window_box_left_offset (w, area);
28186 x = start_x;
28187 if (area == TEXT_AREA)
28188 x += row->x;
28189
28190 /* Find the first glyph that must be redrawn. */
28191 while (first < end
28192 && x + first->pixel_width < r->x)
28193 {
28194 x += first->pixel_width;
28195 ++first;
28196 }
28197
28198 /* Find the last one. */
28199 last = first;
28200 first_x = x;
28201 while (last < end
28202 && x < r->x + r->width)
28203 {
28204 x += last->pixel_width;
28205 ++last;
28206 }
28207
28208 /* Repaint. */
28209 if (last > first)
28210 draw_glyphs (w, first_x - start_x, row, area,
28211 first - row->glyphs[area], last - row->glyphs[area],
28212 DRAW_NORMAL_TEXT, 0);
28213 }
28214 }
28215
28216
28217 /* Redraw the parts of the glyph row ROW on window W intersecting
28218 rectangle R. R is in window-relative coordinates. Value is
28219 non-zero if mouse-face was overwritten. */
28220
28221 static int
28222 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
28223 {
28224 eassert (row->enabled_p);
28225
28226 if (row->mode_line_p || w->pseudo_window_p)
28227 draw_glyphs (w, 0, row, TEXT_AREA,
28228 0, row->used[TEXT_AREA],
28229 DRAW_NORMAL_TEXT, 0);
28230 else
28231 {
28232 if (row->used[LEFT_MARGIN_AREA])
28233 expose_area (w, row, r, LEFT_MARGIN_AREA);
28234 if (row->used[TEXT_AREA])
28235 expose_area (w, row, r, TEXT_AREA);
28236 if (row->used[RIGHT_MARGIN_AREA])
28237 expose_area (w, row, r, RIGHT_MARGIN_AREA);
28238 draw_row_fringe_bitmaps (w, row);
28239 }
28240
28241 return row->mouse_face_p;
28242 }
28243
28244
28245 /* Redraw those parts of glyphs rows during expose event handling that
28246 overlap other rows. Redrawing of an exposed line writes over parts
28247 of lines overlapping that exposed line; this function fixes that.
28248
28249 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28250 row in W's current matrix that is exposed and overlaps other rows.
28251 LAST_OVERLAPPING_ROW is the last such row. */
28252
28253 static void
28254 expose_overlaps (struct window *w,
28255 struct glyph_row *first_overlapping_row,
28256 struct glyph_row *last_overlapping_row,
28257 XRectangle *r)
28258 {
28259 struct glyph_row *row;
28260
28261 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
28262 if (row->overlapping_p)
28263 {
28264 eassert (row->enabled_p && !row->mode_line_p);
28265
28266 row->clip = r;
28267 if (row->used[LEFT_MARGIN_AREA])
28268 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
28269
28270 if (row->used[TEXT_AREA])
28271 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
28272
28273 if (row->used[RIGHT_MARGIN_AREA])
28274 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
28275 row->clip = NULL;
28276 }
28277 }
28278
28279
28280 /* Return non-zero if W's cursor intersects rectangle R. */
28281
28282 static int
28283 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
28284 {
28285 XRectangle cr, result;
28286 struct glyph *cursor_glyph;
28287 struct glyph_row *row;
28288
28289 if (w->phys_cursor.vpos >= 0
28290 && w->phys_cursor.vpos < w->current_matrix->nrows
28291 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
28292 row->enabled_p)
28293 && row->cursor_in_fringe_p)
28294 {
28295 /* Cursor is in the fringe. */
28296 cr.x = window_box_right_offset (w,
28297 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
28298 ? RIGHT_MARGIN_AREA
28299 : TEXT_AREA));
28300 cr.y = row->y;
28301 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
28302 cr.height = row->height;
28303 return x_intersect_rectangles (&cr, r, &result);
28304 }
28305
28306 cursor_glyph = get_phys_cursor_glyph (w);
28307 if (cursor_glyph)
28308 {
28309 /* r is relative to W's box, but w->phys_cursor.x is relative
28310 to left edge of W's TEXT area. Adjust it. */
28311 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
28312 cr.y = w->phys_cursor.y;
28313 cr.width = cursor_glyph->pixel_width;
28314 cr.height = w->phys_cursor_height;
28315 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28316 I assume the effect is the same -- and this is portable. */
28317 return x_intersect_rectangles (&cr, r, &result);
28318 }
28319 /* If we don't understand the format, pretend we're not in the hot-spot. */
28320 return 0;
28321 }
28322
28323
28324 /* EXPORT:
28325 Draw a vertical window border to the right of window W if W doesn't
28326 have vertical scroll bars. */
28327
28328 void
28329 x_draw_vertical_border (struct window *w)
28330 {
28331 struct frame *f = XFRAME (WINDOW_FRAME (w));
28332
28333 /* We could do better, if we knew what type of scroll-bar the adjacent
28334 windows (on either side) have... But we don't :-(
28335 However, I think this works ok. ++KFS 2003-04-25 */
28336
28337 /* Redraw borders between horizontally adjacent windows. Don't
28338 do it for frames with vertical scroll bars because either the
28339 right scroll bar of a window, or the left scroll bar of its
28340 neighbor will suffice as a border. */
28341 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w->frame)))
28342 return;
28343
28344 if (!WINDOW_RIGHTMOST_P (w)
28345 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
28346 {
28347 int x0, x1, y0, y1;
28348
28349 window_box_edges (w, -1, &x0, &y0, &x1, &y1);
28350 y1 -= 1;
28351
28352 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
28353 x1 -= 1;
28354
28355 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
28356 }
28357 else if (!WINDOW_LEFTMOST_P (w)
28358 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
28359 {
28360 int x0, x1, y0, y1;
28361
28362 window_box_edges (w, -1, &x0, &y0, &x1, &y1);
28363 y1 -= 1;
28364
28365 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
28366 x0 -= 1;
28367
28368 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
28369 }
28370 }
28371
28372
28373 /* Redraw the part of window W intersection rectangle FR. Pixel
28374 coordinates in FR are frame-relative. Call this function with
28375 input blocked. Value is non-zero if the exposure overwrites
28376 mouse-face. */
28377
28378 static int
28379 expose_window (struct window *w, XRectangle *fr)
28380 {
28381 struct frame *f = XFRAME (w->frame);
28382 XRectangle wr, r;
28383 int mouse_face_overwritten_p = 0;
28384
28385 /* If window is not yet fully initialized, do nothing. This can
28386 happen when toolkit scroll bars are used and a window is split.
28387 Reconfiguring the scroll bar will generate an expose for a newly
28388 created window. */
28389 if (w->current_matrix == NULL)
28390 return 0;
28391
28392 /* When we're currently updating the window, display and current
28393 matrix usually don't agree. Arrange for a thorough display
28394 later. */
28395 if (w == updated_window)
28396 {
28397 SET_FRAME_GARBAGED (f);
28398 return 0;
28399 }
28400
28401 /* Frame-relative pixel rectangle of W. */
28402 wr.x = WINDOW_LEFT_EDGE_X (w);
28403 wr.y = WINDOW_TOP_EDGE_Y (w);
28404 wr.width = WINDOW_TOTAL_WIDTH (w);
28405 wr.height = WINDOW_TOTAL_HEIGHT (w);
28406
28407 if (x_intersect_rectangles (fr, &wr, &r))
28408 {
28409 int yb = window_text_bottom_y (w);
28410 struct glyph_row *row;
28411 int cursor_cleared_p, phys_cursor_on_p;
28412 struct glyph_row *first_overlapping_row, *last_overlapping_row;
28413
28414 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
28415 r.x, r.y, r.width, r.height));
28416
28417 /* Convert to window coordinates. */
28418 r.x -= WINDOW_LEFT_EDGE_X (w);
28419 r.y -= WINDOW_TOP_EDGE_Y (w);
28420
28421 /* Turn off the cursor. */
28422 if (!w->pseudo_window_p
28423 && phys_cursor_in_rect_p (w, &r))
28424 {
28425 x_clear_cursor (w);
28426 cursor_cleared_p = 1;
28427 }
28428 else
28429 cursor_cleared_p = 0;
28430
28431 /* If the row containing the cursor extends face to end of line,
28432 then expose_area might overwrite the cursor outside the
28433 rectangle and thus notice_overwritten_cursor might clear
28434 w->phys_cursor_on_p. We remember the original value and
28435 check later if it is changed. */
28436 phys_cursor_on_p = w->phys_cursor_on_p;
28437
28438 /* Update lines intersecting rectangle R. */
28439 first_overlapping_row = last_overlapping_row = NULL;
28440 for (row = w->current_matrix->rows;
28441 row->enabled_p;
28442 ++row)
28443 {
28444 int y0 = row->y;
28445 int y1 = MATRIX_ROW_BOTTOM_Y (row);
28446
28447 if ((y0 >= r.y && y0 < r.y + r.height)
28448 || (y1 > r.y && y1 < r.y + r.height)
28449 || (r.y >= y0 && r.y < y1)
28450 || (r.y + r.height > y0 && r.y + r.height < y1))
28451 {
28452 /* A header line may be overlapping, but there is no need
28453 to fix overlapping areas for them. KFS 2005-02-12 */
28454 if (row->overlapping_p && !row->mode_line_p)
28455 {
28456 if (first_overlapping_row == NULL)
28457 first_overlapping_row = row;
28458 last_overlapping_row = row;
28459 }
28460
28461 row->clip = fr;
28462 if (expose_line (w, row, &r))
28463 mouse_face_overwritten_p = 1;
28464 row->clip = NULL;
28465 }
28466 else if (row->overlapping_p)
28467 {
28468 /* We must redraw a row overlapping the exposed area. */
28469 if (y0 < r.y
28470 ? y0 + row->phys_height > r.y
28471 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
28472 {
28473 if (first_overlapping_row == NULL)
28474 first_overlapping_row = row;
28475 last_overlapping_row = row;
28476 }
28477 }
28478
28479 if (y1 >= yb)
28480 break;
28481 }
28482
28483 /* Display the mode line if there is one. */
28484 if (WINDOW_WANTS_MODELINE_P (w)
28485 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
28486 row->enabled_p)
28487 && row->y < r.y + r.height)
28488 {
28489 if (expose_line (w, row, &r))
28490 mouse_face_overwritten_p = 1;
28491 }
28492
28493 if (!w->pseudo_window_p)
28494 {
28495 /* Fix the display of overlapping rows. */
28496 if (first_overlapping_row)
28497 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
28498 fr);
28499
28500 /* Draw border between windows. */
28501 x_draw_vertical_border (w);
28502
28503 /* Turn the cursor on again. */
28504 if (cursor_cleared_p
28505 || (phys_cursor_on_p && !w->phys_cursor_on_p))
28506 update_window_cursor (w, 1);
28507 }
28508 }
28509
28510 return mouse_face_overwritten_p;
28511 }
28512
28513
28514
28515 /* Redraw (parts) of all windows in the window tree rooted at W that
28516 intersect R. R contains frame pixel coordinates. Value is
28517 non-zero if the exposure overwrites mouse-face. */
28518
28519 static int
28520 expose_window_tree (struct window *w, XRectangle *r)
28521 {
28522 struct frame *f = XFRAME (w->frame);
28523 int mouse_face_overwritten_p = 0;
28524
28525 while (w && !FRAME_GARBAGED_P (f))
28526 {
28527 if (!NILP (w->hchild))
28528 mouse_face_overwritten_p
28529 |= expose_window_tree (XWINDOW (w->hchild), r);
28530 else if (!NILP (w->vchild))
28531 mouse_face_overwritten_p
28532 |= expose_window_tree (XWINDOW (w->vchild), r);
28533 else
28534 mouse_face_overwritten_p |= expose_window (w, r);
28535
28536 w = NILP (w->next) ? NULL : XWINDOW (w->next);
28537 }
28538
28539 return mouse_face_overwritten_p;
28540 }
28541
28542
28543 /* EXPORT:
28544 Redisplay an exposed area of frame F. X and Y are the upper-left
28545 corner of the exposed rectangle. W and H are width and height of
28546 the exposed area. All are pixel values. W or H zero means redraw
28547 the entire frame. */
28548
28549 void
28550 expose_frame (struct frame *f, int x, int y, int w, int h)
28551 {
28552 XRectangle r;
28553 int mouse_face_overwritten_p = 0;
28554
28555 TRACE ((stderr, "expose_frame "));
28556
28557 /* No need to redraw if frame will be redrawn soon. */
28558 if (FRAME_GARBAGED_P (f))
28559 {
28560 TRACE ((stderr, " garbaged\n"));
28561 return;
28562 }
28563
28564 /* If basic faces haven't been realized yet, there is no point in
28565 trying to redraw anything. This can happen when we get an expose
28566 event while Emacs is starting, e.g. by moving another window. */
28567 if (FRAME_FACE_CACHE (f) == NULL
28568 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
28569 {
28570 TRACE ((stderr, " no faces\n"));
28571 return;
28572 }
28573
28574 if (w == 0 || h == 0)
28575 {
28576 r.x = r.y = 0;
28577 r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f);
28578 r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f);
28579 }
28580 else
28581 {
28582 r.x = x;
28583 r.y = y;
28584 r.width = w;
28585 r.height = h;
28586 }
28587
28588 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
28589 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
28590
28591 if (WINDOWP (f->tool_bar_window))
28592 mouse_face_overwritten_p
28593 |= expose_window (XWINDOW (f->tool_bar_window), &r);
28594
28595 #ifdef HAVE_X_WINDOWS
28596 #ifndef MSDOS
28597 #ifndef USE_X_TOOLKIT
28598 if (WINDOWP (f->menu_bar_window))
28599 mouse_face_overwritten_p
28600 |= expose_window (XWINDOW (f->menu_bar_window), &r);
28601 #endif /* not USE_X_TOOLKIT */
28602 #endif
28603 #endif
28604
28605 /* Some window managers support a focus-follows-mouse style with
28606 delayed raising of frames. Imagine a partially obscured frame,
28607 and moving the mouse into partially obscured mouse-face on that
28608 frame. The visible part of the mouse-face will be highlighted,
28609 then the WM raises the obscured frame. With at least one WM, KDE
28610 2.1, Emacs is not getting any event for the raising of the frame
28611 (even tried with SubstructureRedirectMask), only Expose events.
28612 These expose events will draw text normally, i.e. not
28613 highlighted. Which means we must redo the highlight here.
28614 Subsume it under ``we love X''. --gerd 2001-08-15 */
28615 /* Included in Windows version because Windows most likely does not
28616 do the right thing if any third party tool offers
28617 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28618 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
28619 {
28620 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28621 if (f == hlinfo->mouse_face_mouse_frame)
28622 {
28623 int mouse_x = hlinfo->mouse_face_mouse_x;
28624 int mouse_y = hlinfo->mouse_face_mouse_y;
28625 clear_mouse_face (hlinfo);
28626 note_mouse_highlight (f, mouse_x, mouse_y);
28627 }
28628 }
28629 }
28630
28631
28632 /* EXPORT:
28633 Determine the intersection of two rectangles R1 and R2. Return
28634 the intersection in *RESULT. Value is non-zero if RESULT is not
28635 empty. */
28636
28637 int
28638 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
28639 {
28640 XRectangle *left, *right;
28641 XRectangle *upper, *lower;
28642 int intersection_p = 0;
28643
28644 /* Rearrange so that R1 is the left-most rectangle. */
28645 if (r1->x < r2->x)
28646 left = r1, right = r2;
28647 else
28648 left = r2, right = r1;
28649
28650 /* X0 of the intersection is right.x0, if this is inside R1,
28651 otherwise there is no intersection. */
28652 if (right->x <= left->x + left->width)
28653 {
28654 result->x = right->x;
28655
28656 /* The right end of the intersection is the minimum of
28657 the right ends of left and right. */
28658 result->width = (min (left->x + left->width, right->x + right->width)
28659 - result->x);
28660
28661 /* Same game for Y. */
28662 if (r1->y < r2->y)
28663 upper = r1, lower = r2;
28664 else
28665 upper = r2, lower = r1;
28666
28667 /* The upper end of the intersection is lower.y0, if this is inside
28668 of upper. Otherwise, there is no intersection. */
28669 if (lower->y <= upper->y + upper->height)
28670 {
28671 result->y = lower->y;
28672
28673 /* The lower end of the intersection is the minimum of the lower
28674 ends of upper and lower. */
28675 result->height = (min (lower->y + lower->height,
28676 upper->y + upper->height)
28677 - result->y);
28678 intersection_p = 1;
28679 }
28680 }
28681
28682 return intersection_p;
28683 }
28684
28685 #endif /* HAVE_WINDOW_SYSTEM */
28686
28687 \f
28688 /***********************************************************************
28689 Initialization
28690 ***********************************************************************/
28691
28692 void
28693 syms_of_xdisp (void)
28694 {
28695 Vwith_echo_area_save_vector = Qnil;
28696 staticpro (&Vwith_echo_area_save_vector);
28697
28698 Vmessage_stack = Qnil;
28699 staticpro (&Vmessage_stack);
28700
28701 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
28702
28703 message_dolog_marker1 = Fmake_marker ();
28704 staticpro (&message_dolog_marker1);
28705 message_dolog_marker2 = Fmake_marker ();
28706 staticpro (&message_dolog_marker2);
28707 message_dolog_marker3 = Fmake_marker ();
28708 staticpro (&message_dolog_marker3);
28709
28710 #ifdef GLYPH_DEBUG
28711 defsubr (&Sdump_frame_glyph_matrix);
28712 defsubr (&Sdump_glyph_matrix);
28713 defsubr (&Sdump_glyph_row);
28714 defsubr (&Sdump_tool_bar_row);
28715 defsubr (&Strace_redisplay);
28716 defsubr (&Strace_to_stderr);
28717 #endif
28718 #ifdef HAVE_WINDOW_SYSTEM
28719 defsubr (&Stool_bar_lines_needed);
28720 defsubr (&Slookup_image_map);
28721 #endif
28722 defsubr (&Sformat_mode_line);
28723 defsubr (&Sinvisible_p);
28724 defsubr (&Scurrent_bidi_paragraph_direction);
28725
28726 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
28727 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
28728 DEFSYM (Qoverriding_local_map, "overriding-local-map");
28729 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
28730 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
28731 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
28732 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
28733 DEFSYM (Qeval, "eval");
28734 DEFSYM (QCdata, ":data");
28735 DEFSYM (Qdisplay, "display");
28736 DEFSYM (Qspace_width, "space-width");
28737 DEFSYM (Qraise, "raise");
28738 DEFSYM (Qslice, "slice");
28739 DEFSYM (Qspace, "space");
28740 DEFSYM (Qmargin, "margin");
28741 DEFSYM (Qpointer, "pointer");
28742 DEFSYM (Qleft_margin, "left-margin");
28743 DEFSYM (Qright_margin, "right-margin");
28744 DEFSYM (Qcenter, "center");
28745 DEFSYM (Qline_height, "line-height");
28746 DEFSYM (QCalign_to, ":align-to");
28747 DEFSYM (QCrelative_width, ":relative-width");
28748 DEFSYM (QCrelative_height, ":relative-height");
28749 DEFSYM (QCeval, ":eval");
28750 DEFSYM (QCpropertize, ":propertize");
28751 DEFSYM (QCfile, ":file");
28752 DEFSYM (Qfontified, "fontified");
28753 DEFSYM (Qfontification_functions, "fontification-functions");
28754 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
28755 DEFSYM (Qescape_glyph, "escape-glyph");
28756 DEFSYM (Qnobreak_space, "nobreak-space");
28757 DEFSYM (Qimage, "image");
28758 DEFSYM (Qtext, "text");
28759 DEFSYM (Qboth, "both");
28760 DEFSYM (Qboth_horiz, "both-horiz");
28761 DEFSYM (Qtext_image_horiz, "text-image-horiz");
28762 DEFSYM (QCmap, ":map");
28763 DEFSYM (QCpointer, ":pointer");
28764 DEFSYM (Qrect, "rect");
28765 DEFSYM (Qcircle, "circle");
28766 DEFSYM (Qpoly, "poly");
28767 DEFSYM (Qmessage_truncate_lines, "message-truncate-lines");
28768 DEFSYM (Qgrow_only, "grow-only");
28769 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
28770 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
28771 DEFSYM (Qposition, "position");
28772 DEFSYM (Qbuffer_position, "buffer-position");
28773 DEFSYM (Qobject, "object");
28774 DEFSYM (Qbar, "bar");
28775 DEFSYM (Qhbar, "hbar");
28776 DEFSYM (Qbox, "box");
28777 DEFSYM (Qhollow, "hollow");
28778 DEFSYM (Qhand, "hand");
28779 DEFSYM (Qarrow, "arrow");
28780 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
28781
28782 list_of_error = Fcons (Fcons (intern_c_string ("error"),
28783 Fcons (intern_c_string ("void-variable"), Qnil)),
28784 Qnil);
28785 staticpro (&list_of_error);
28786
28787 DEFSYM (Qlast_arrow_position, "last-arrow-position");
28788 DEFSYM (Qlast_arrow_string, "last-arrow-string");
28789 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
28790 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
28791
28792 echo_buffer[0] = echo_buffer[1] = Qnil;
28793 staticpro (&echo_buffer[0]);
28794 staticpro (&echo_buffer[1]);
28795
28796 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
28797 staticpro (&echo_area_buffer[0]);
28798 staticpro (&echo_area_buffer[1]);
28799
28800 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
28801 staticpro (&Vmessages_buffer_name);
28802
28803 mode_line_proptrans_alist = Qnil;
28804 staticpro (&mode_line_proptrans_alist);
28805 mode_line_string_list = Qnil;
28806 staticpro (&mode_line_string_list);
28807 mode_line_string_face = Qnil;
28808 staticpro (&mode_line_string_face);
28809 mode_line_string_face_prop = Qnil;
28810 staticpro (&mode_line_string_face_prop);
28811 Vmode_line_unwind_vector = Qnil;
28812 staticpro (&Vmode_line_unwind_vector);
28813
28814 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
28815
28816 help_echo_string = Qnil;
28817 staticpro (&help_echo_string);
28818 help_echo_object = Qnil;
28819 staticpro (&help_echo_object);
28820 help_echo_window = Qnil;
28821 staticpro (&help_echo_window);
28822 previous_help_echo_string = Qnil;
28823 staticpro (&previous_help_echo_string);
28824 help_echo_pos = -1;
28825
28826 DEFSYM (Qright_to_left, "right-to-left");
28827 DEFSYM (Qleft_to_right, "left-to-right");
28828
28829 #ifdef HAVE_WINDOW_SYSTEM
28830 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
28831 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
28832 For example, if a block cursor is over a tab, it will be drawn as
28833 wide as that tab on the display. */);
28834 x_stretch_cursor_p = 0;
28835 #endif
28836
28837 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
28838 doc: /* Non-nil means highlight trailing whitespace.
28839 The face used for trailing whitespace is `trailing-whitespace'. */);
28840 Vshow_trailing_whitespace = Qnil;
28841
28842 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
28843 doc: /* Control highlighting of non-ASCII space and hyphen chars.
28844 If the value is t, Emacs highlights non-ASCII chars which have the
28845 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28846 or `escape-glyph' face respectively.
28847
28848 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28849 U+2011 (non-breaking hyphen) are affected.
28850
28851 Any other non-nil value means to display these characters as a escape
28852 glyph followed by an ordinary space or hyphen.
28853
28854 A value of nil means no special handling of these characters. */);
28855 Vnobreak_char_display = Qt;
28856
28857 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
28858 doc: /* The pointer shape to show in void text areas.
28859 A value of nil means to show the text pointer. Other options are `arrow',
28860 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28861 Vvoid_text_area_pointer = Qarrow;
28862
28863 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
28864 doc: /* Non-nil means don't actually do any redisplay.
28865 This is used for internal purposes. */);
28866 Vinhibit_redisplay = Qnil;
28867
28868 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
28869 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28870 Vglobal_mode_string = Qnil;
28871
28872 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
28873 doc: /* Marker for where to display an arrow on top of the buffer text.
28874 This must be the beginning of a line in order to work.
28875 See also `overlay-arrow-string'. */);
28876 Voverlay_arrow_position = Qnil;
28877
28878 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
28879 doc: /* String to display as an arrow in non-window frames.
28880 See also `overlay-arrow-position'. */);
28881 Voverlay_arrow_string = build_pure_c_string ("=>");
28882
28883 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
28884 doc: /* List of variables (symbols) which hold markers for overlay arrows.
28885 The symbols on this list are examined during redisplay to determine
28886 where to display overlay arrows. */);
28887 Voverlay_arrow_variable_list
28888 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil);
28889
28890 DEFVAR_INT ("scroll-step", emacs_scroll_step,
28891 doc: /* The number of lines to try scrolling a window by when point moves out.
28892 If that fails to bring point back on frame, point is centered instead.
28893 If this is zero, point is always centered after it moves off frame.
28894 If you want scrolling to always be a line at a time, you should set
28895 `scroll-conservatively' to a large value rather than set this to 1. */);
28896
28897 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
28898 doc: /* Scroll up to this many lines, to bring point back on screen.
28899 If point moves off-screen, redisplay will scroll by up to
28900 `scroll-conservatively' lines in order to bring point just barely
28901 onto the screen again. If that cannot be done, then redisplay
28902 recenters point as usual.
28903
28904 If the value is greater than 100, redisplay will never recenter point,
28905 but will always scroll just enough text to bring point into view, even
28906 if you move far away.
28907
28908 A value of zero means always recenter point if it moves off screen. */);
28909 scroll_conservatively = 0;
28910
28911 DEFVAR_INT ("scroll-margin", scroll_margin,
28912 doc: /* Number of lines of margin at the top and bottom of a window.
28913 Recenter the window whenever point gets within this many lines
28914 of the top or bottom of the window. */);
28915 scroll_margin = 0;
28916
28917 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
28918 doc: /* Pixels per inch value for non-window system displays.
28919 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28920 Vdisplay_pixels_per_inch = make_float (72.0);
28921
28922 #ifdef GLYPH_DEBUG
28923 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
28924 #endif
28925
28926 DEFVAR_LISP ("truncate-partial-width-windows",
28927 Vtruncate_partial_width_windows,
28928 doc: /* Non-nil means truncate lines in windows narrower than the frame.
28929 For an integer value, truncate lines in each window narrower than the
28930 full frame width, provided the window width is less than that integer;
28931 otherwise, respect the value of `truncate-lines'.
28932
28933 For any other non-nil value, truncate lines in all windows that do
28934 not span the full frame width.
28935
28936 A value of nil means to respect the value of `truncate-lines'.
28937
28938 If `word-wrap' is enabled, you might want to reduce this. */);
28939 Vtruncate_partial_width_windows = make_number (50);
28940
28941 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video,
28942 doc: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28943 Any other value means to use the appropriate face, `mode-line',
28944 `header-line', or `menu' respectively. */);
28945 mode_line_inverse_video = 1;
28946
28947 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
28948 doc: /* Maximum buffer size for which line number should be displayed.
28949 If the buffer is bigger than this, the line number does not appear
28950 in the mode line. A value of nil means no limit. */);
28951 Vline_number_display_limit = Qnil;
28952
28953 DEFVAR_INT ("line-number-display-limit-width",
28954 line_number_display_limit_width,
28955 doc: /* Maximum line width (in characters) for line number display.
28956 If the average length of the lines near point is bigger than this, then the
28957 line number may be omitted from the mode line. */);
28958 line_number_display_limit_width = 200;
28959
28960 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
28961 doc: /* Non-nil means highlight region even in nonselected windows. */);
28962 highlight_nonselected_windows = 0;
28963
28964 DEFVAR_BOOL ("multiple-frames", multiple_frames,
28965 doc: /* Non-nil if more than one frame is visible on this display.
28966 Minibuffer-only frames don't count, but iconified frames do.
28967 This variable is not guaranteed to be accurate except while processing
28968 `frame-title-format' and `icon-title-format'. */);
28969
28970 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
28971 doc: /* Template for displaying the title bar of visible frames.
28972 \(Assuming the window manager supports this feature.)
28973
28974 This variable has the same structure as `mode-line-format', except that
28975 the %c and %l constructs are ignored. It is used only on frames for
28976 which no explicit name has been set \(see `modify-frame-parameters'). */);
28977
28978 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
28979 doc: /* Template for displaying the title bar of an iconified frame.
28980 \(Assuming the window manager supports this feature.)
28981 This variable has the same structure as `mode-line-format' (which see),
28982 and is used only on frames for which no explicit name has been set
28983 \(see `modify-frame-parameters'). */);
28984 Vicon_title_format
28985 = Vframe_title_format
28986 = listn (CONSTYPE_PURE, 3,
28987 intern_c_string ("multiple-frames"),
28988 build_pure_c_string ("%b"),
28989 listn (CONSTYPE_PURE, 4,
28990 empty_unibyte_string,
28991 intern_c_string ("invocation-name"),
28992 build_pure_c_string ("@"),
28993 intern_c_string ("system-name")));
28994
28995 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
28996 doc: /* Maximum number of lines to keep in the message log buffer.
28997 If nil, disable message logging. If t, log messages but don't truncate
28998 the buffer when it becomes large. */);
28999 Vmessage_log_max = make_number (100);
29000
29001 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
29002 doc: /* Functions called before redisplay, if window sizes have changed.
29003 The value should be a list of functions that take one argument.
29004 Just before redisplay, for each frame, if any of its windows have changed
29005 size since the last redisplay, or have been split or deleted,
29006 all the functions in the list are called, with the frame as argument. */);
29007 Vwindow_size_change_functions = Qnil;
29008
29009 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
29010 doc: /* List of functions to call before redisplaying a window with scrolling.
29011 Each function is called with two arguments, the window and its new
29012 display-start position. Note that these functions are also called by
29013 `set-window-buffer'. Also note that the value of `window-end' is not
29014 valid when these functions are called.
29015
29016 Warning: Do not use this feature to alter the way the window
29017 is scrolled. It is not designed for that, and such use probably won't
29018 work. */);
29019 Vwindow_scroll_functions = Qnil;
29020
29021 DEFVAR_LISP ("window-text-change-functions",
29022 Vwindow_text_change_functions,
29023 doc: /* Functions to call in redisplay when text in the window might change. */);
29024 Vwindow_text_change_functions = Qnil;
29025
29026 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
29027 doc: /* Functions called when redisplay of a window reaches the end trigger.
29028 Each function is called with two arguments, the window and the end trigger value.
29029 See `set-window-redisplay-end-trigger'. */);
29030 Vredisplay_end_trigger_functions = Qnil;
29031
29032 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
29033 doc: /* Non-nil means autoselect window with mouse pointer.
29034 If nil, do not autoselect windows.
29035 A positive number means delay autoselection by that many seconds: a
29036 window is autoselected only after the mouse has remained in that
29037 window for the duration of the delay.
29038 A negative number has a similar effect, but causes windows to be
29039 autoselected only after the mouse has stopped moving. \(Because of
29040 the way Emacs compares mouse events, you will occasionally wait twice
29041 that time before the window gets selected.\)
29042 Any other value means to autoselect window instantaneously when the
29043 mouse pointer enters it.
29044
29045 Autoselection selects the minibuffer only if it is active, and never
29046 unselects the minibuffer if it is active.
29047
29048 When customizing this variable make sure that the actual value of
29049 `focus-follows-mouse' matches the behavior of your window manager. */);
29050 Vmouse_autoselect_window = Qnil;
29051
29052 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
29053 doc: /* Non-nil means automatically resize tool-bars.
29054 This dynamically changes the tool-bar's height to the minimum height
29055 that is needed to make all tool-bar items visible.
29056 If value is `grow-only', the tool-bar's height is only increased
29057 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29058 Vauto_resize_tool_bars = Qt;
29059
29060 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
29061 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29062 auto_raise_tool_bar_buttons_p = 1;
29063
29064 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
29065 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29066 make_cursor_line_fully_visible_p = 1;
29067
29068 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
29069 doc: /* Border below tool-bar in pixels.
29070 If an integer, use it as the height of the border.
29071 If it is one of `internal-border-width' or `border-width', use the
29072 value of the corresponding frame parameter.
29073 Otherwise, no border is added below the tool-bar. */);
29074 Vtool_bar_border = Qinternal_border_width;
29075
29076 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
29077 doc: /* Margin around tool-bar buttons in pixels.
29078 If an integer, use that for both horizontal and vertical margins.
29079 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29080 HORZ specifying the horizontal margin, and VERT specifying the
29081 vertical margin. */);
29082 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
29083
29084 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
29085 doc: /* Relief thickness of tool-bar buttons. */);
29086 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
29087
29088 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
29089 doc: /* Tool bar style to use.
29090 It can be one of
29091 image - show images only
29092 text - show text only
29093 both - show both, text below image
29094 both-horiz - show text to the right of the image
29095 text-image-horiz - show text to the left of the image
29096 any other - use system default or image if no system default.
29097
29098 This variable only affects the GTK+ toolkit version of Emacs. */);
29099 Vtool_bar_style = Qnil;
29100
29101 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
29102 doc: /* Maximum number of characters a label can have to be shown.
29103 The tool bar style must also show labels for this to have any effect, see
29104 `tool-bar-style'. */);
29105 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
29106
29107 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
29108 doc: /* List of functions to call to fontify regions of text.
29109 Each function is called with one argument POS. Functions must
29110 fontify a region starting at POS in the current buffer, and give
29111 fontified regions the property `fontified'. */);
29112 Vfontification_functions = Qnil;
29113 Fmake_variable_buffer_local (Qfontification_functions);
29114
29115 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29116 unibyte_display_via_language_environment,
29117 doc: /* Non-nil means display unibyte text according to language environment.
29118 Specifically, this means that raw bytes in the range 160-255 decimal
29119 are displayed by converting them to the equivalent multibyte characters
29120 according to the current language environment. As a result, they are
29121 displayed according to the current fontset.
29122
29123 Note that this variable affects only how these bytes are displayed,
29124 but does not change the fact they are interpreted as raw bytes. */);
29125 unibyte_display_via_language_environment = 0;
29126
29127 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
29128 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29129 If a float, it specifies a fraction of the mini-window frame's height.
29130 If an integer, it specifies a number of lines. */);
29131 Vmax_mini_window_height = make_float (0.25);
29132
29133 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
29134 doc: /* How to resize mini-windows (the minibuffer and the echo area).
29135 A value of nil means don't automatically resize mini-windows.
29136 A value of t means resize them to fit the text displayed in them.
29137 A value of `grow-only', the default, means let mini-windows grow only;
29138 they return to their normal size when the minibuffer is closed, or the
29139 echo area becomes empty. */);
29140 Vresize_mini_windows = Qgrow_only;
29141
29142 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
29143 doc: /* Alist specifying how to blink the cursor off.
29144 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29145 `cursor-type' frame-parameter or variable equals ON-STATE,
29146 comparing using `equal', Emacs uses OFF-STATE to specify
29147 how to blink it off. ON-STATE and OFF-STATE are values for
29148 the `cursor-type' frame parameter.
29149
29150 If a frame's ON-STATE has no entry in this list,
29151 the frame's other specifications determine how to blink the cursor off. */);
29152 Vblink_cursor_alist = Qnil;
29153
29154 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
29155 doc: /* Allow or disallow automatic horizontal scrolling of windows.
29156 If non-nil, windows are automatically scrolled horizontally to make
29157 point visible. */);
29158 automatic_hscrolling_p = 1;
29159 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
29160
29161 DEFVAR_INT ("hscroll-margin", hscroll_margin,
29162 doc: /* How many columns away from the window edge point is allowed to get
29163 before automatic hscrolling will horizontally scroll the window. */);
29164 hscroll_margin = 5;
29165
29166 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
29167 doc: /* How many columns to scroll the window when point gets too close to the edge.
29168 When point is less than `hscroll-margin' columns from the window
29169 edge, automatic hscrolling will scroll the window by the amount of columns
29170 determined by this variable. If its value is a positive integer, scroll that
29171 many columns. If it's a positive floating-point number, it specifies the
29172 fraction of the window's width to scroll. If it's nil or zero, point will be
29173 centered horizontally after the scroll. Any other value, including negative
29174 numbers, are treated as if the value were zero.
29175
29176 Automatic hscrolling always moves point outside the scroll margin, so if
29177 point was more than scroll step columns inside the margin, the window will
29178 scroll more than the value given by the scroll step.
29179
29180 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29181 and `scroll-right' overrides this variable's effect. */);
29182 Vhscroll_step = make_number (0);
29183
29184 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
29185 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
29186 Bind this around calls to `message' to let it take effect. */);
29187 message_truncate_lines = 0;
29188
29189 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
29190 doc: /* Normal hook run to update the menu bar definitions.
29191 Redisplay runs this hook before it redisplays the menu bar.
29192 This is used to update submenus such as Buffers,
29193 whose contents depend on various data. */);
29194 Vmenu_bar_update_hook = Qnil;
29195
29196 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
29197 doc: /* Frame for which we are updating a menu.
29198 The enable predicate for a menu binding should check this variable. */);
29199 Vmenu_updating_frame = Qnil;
29200
29201 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
29202 doc: /* Non-nil means don't update menu bars. Internal use only. */);
29203 inhibit_menubar_update = 0;
29204
29205 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
29206 doc: /* Prefix prepended to all continuation lines at display time.
29207 The value may be a string, an image, or a stretch-glyph; it is
29208 interpreted in the same way as the value of a `display' text property.
29209
29210 This variable is overridden by any `wrap-prefix' text or overlay
29211 property.
29212
29213 To add a prefix to non-continuation lines, use `line-prefix'. */);
29214 Vwrap_prefix = Qnil;
29215 DEFSYM (Qwrap_prefix, "wrap-prefix");
29216 Fmake_variable_buffer_local (Qwrap_prefix);
29217
29218 DEFVAR_LISP ("line-prefix", Vline_prefix,
29219 doc: /* Prefix prepended to all non-continuation lines at display time.
29220 The value may be a string, an image, or a stretch-glyph; it is
29221 interpreted in the same way as the value of a `display' text property.
29222
29223 This variable is overridden by any `line-prefix' text or overlay
29224 property.
29225
29226 To add a prefix to continuation lines, use `wrap-prefix'. */);
29227 Vline_prefix = Qnil;
29228 DEFSYM (Qline_prefix, "line-prefix");
29229 Fmake_variable_buffer_local (Qline_prefix);
29230
29231 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
29232 doc: /* Non-nil means don't eval Lisp during redisplay. */);
29233 inhibit_eval_during_redisplay = 0;
29234
29235 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
29236 doc: /* Non-nil means don't free realized faces. Internal use only. */);
29237 inhibit_free_realized_faces = 0;
29238
29239 #ifdef GLYPH_DEBUG
29240 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
29241 doc: /* Inhibit try_window_id display optimization. */);
29242 inhibit_try_window_id = 0;
29243
29244 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
29245 doc: /* Inhibit try_window_reusing display optimization. */);
29246 inhibit_try_window_reusing = 0;
29247
29248 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
29249 doc: /* Inhibit try_cursor_movement display optimization. */);
29250 inhibit_try_cursor_movement = 0;
29251 #endif /* GLYPH_DEBUG */
29252
29253 DEFVAR_INT ("overline-margin", overline_margin,
29254 doc: /* Space between overline and text, in pixels.
29255 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29256 margin to the character height. */);
29257 overline_margin = 2;
29258
29259 DEFVAR_INT ("underline-minimum-offset",
29260 underline_minimum_offset,
29261 doc: /* Minimum distance between baseline and underline.
29262 This can improve legibility of underlined text at small font sizes,
29263 particularly when using variable `x-use-underline-position-properties'
29264 with fonts that specify an UNDERLINE_POSITION relatively close to the
29265 baseline. The default value is 1. */);
29266 underline_minimum_offset = 1;
29267
29268 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
29269 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29270 This feature only works when on a window system that can change
29271 cursor shapes. */);
29272 display_hourglass_p = 1;
29273
29274 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
29275 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29276 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
29277
29278 hourglass_atimer = NULL;
29279 hourglass_shown_p = 0;
29280
29281 DEFSYM (Qglyphless_char, "glyphless-char");
29282 DEFSYM (Qhex_code, "hex-code");
29283 DEFSYM (Qempty_box, "empty-box");
29284 DEFSYM (Qthin_space, "thin-space");
29285 DEFSYM (Qzero_width, "zero-width");
29286
29287 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
29288 /* Intern this now in case it isn't already done.
29289 Setting this variable twice is harmless.
29290 But don't staticpro it here--that is done in alloc.c. */
29291 Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
29292 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
29293
29294 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
29295 doc: /* Char-table defining glyphless characters.
29296 Each element, if non-nil, should be one of the following:
29297 an ASCII acronym string: display this string in a box
29298 `hex-code': display the hexadecimal code of a character in a box
29299 `empty-box': display as an empty box
29300 `thin-space': display as 1-pixel width space
29301 `zero-width': don't display
29302 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29303 display method for graphical terminals and text terminals respectively.
29304 GRAPHICAL and TEXT should each have one of the values listed above.
29305
29306 The char-table has one extra slot to control the display of a character for
29307 which no font is found. This slot only takes effect on graphical terminals.
29308 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29309 `thin-space'. The default is `empty-box'. */);
29310 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
29311 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
29312 Qempty_box);
29313
29314 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
29315 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
29316 Vdebug_on_message = Qnil;
29317
29318 DEFVAR_LISP ("inhibit-debug-on-message", Vinhibit_debug_on_message,
29319 doc: /* If non-nil, inhibit `debug-on-message' from entering the debugger. */);
29320 Vinhibit_debug_on_message = Qnil;
29321 DEFSYM(Qinhibit_debug_on_message, "inhibit-debug-on-message");
29322 }
29323
29324
29325 /* Initialize this module when Emacs starts. */
29326
29327 void
29328 init_xdisp (void)
29329 {
29330 current_header_line_height = current_mode_line_height = -1;
29331
29332 CHARPOS (this_line_start_pos) = 0;
29333
29334 if (!noninteractive)
29335 {
29336 struct window *m = XWINDOW (minibuf_window);
29337 Lisp_Object frame = m->frame;
29338 struct frame *f = XFRAME (frame);
29339 Lisp_Object root = FRAME_ROOT_WINDOW (f);
29340 struct window *r = XWINDOW (root);
29341 int i;
29342
29343 echo_area_window = minibuf_window;
29344
29345 wset_top_line (r, make_number (FRAME_TOP_MARGIN (f)));
29346 wset_total_lines
29347 (r, make_number (FRAME_LINES (f) - 1 - FRAME_TOP_MARGIN (f)));
29348 wset_total_cols (r, make_number (FRAME_COLS (f)));
29349 wset_top_line (m, make_number (FRAME_LINES (f) - 1));
29350 wset_total_lines (m, make_number (1));
29351 wset_total_cols (m, make_number (FRAME_COLS (f)));
29352
29353 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
29354 scratch_glyph_row.glyphs[TEXT_AREA + 1]
29355 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
29356
29357 /* The default ellipsis glyphs `...'. */
29358 for (i = 0; i < 3; ++i)
29359 default_invis_vector[i] = make_number ('.');
29360 }
29361
29362 {
29363 /* Allocate the buffer for frame titles.
29364 Also used for `format-mode-line'. */
29365 int size = 100;
29366 mode_line_noprop_buf = xmalloc (size);
29367 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
29368 mode_line_noprop_ptr = mode_line_noprop_buf;
29369 mode_line_target = MODE_LINE_DISPLAY;
29370 }
29371
29372 help_echo_showing_p = 0;
29373 }
29374
29375 /* Since w32 does not support atimers, it defines its own implementation of
29376 the following three functions in w32fns.c. */
29377 #ifndef WINDOWSNT
29378
29379 /* Platform-independent portion of hourglass implementation. */
29380
29381 /* Cancel a currently active hourglass timer, and start a new one. */
29382 void
29383 start_hourglass (void)
29384 {
29385 #if defined (HAVE_WINDOW_SYSTEM)
29386 EMACS_TIME delay;
29387
29388 cancel_hourglass ();
29389
29390 if (INTEGERP (Vhourglass_delay)
29391 && XINT (Vhourglass_delay) > 0)
29392 delay = make_emacs_time (min (XINT (Vhourglass_delay),
29393 TYPE_MAXIMUM (time_t)),
29394 0);
29395 else if (FLOATP (Vhourglass_delay)
29396 && XFLOAT_DATA (Vhourglass_delay) > 0)
29397 delay = EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay));
29398 else
29399 delay = make_emacs_time (DEFAULT_HOURGLASS_DELAY, 0);
29400
29401 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
29402 show_hourglass, NULL);
29403 #endif
29404 }
29405
29406
29407 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29408 shown. */
29409 void
29410 cancel_hourglass (void)
29411 {
29412 #if defined (HAVE_WINDOW_SYSTEM)
29413 if (hourglass_atimer)
29414 {
29415 cancel_atimer (hourglass_atimer);
29416 hourglass_atimer = NULL;
29417 }
29418
29419 if (hourglass_shown_p)
29420 hide_hourglass ();
29421 #endif
29422 }
29423 #endif /* ! WINDOWSNT */