1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1994, 1995, 1996 Board of Trustees, University of Illinois.
3 Copyright (C) 1995 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1996 Ben Wing.
5 Copyright (C) 1995 Sun Microsystems, Inc.
6 Copyright (C) 1996 Chuck Thompson.
8 This file is part of XEmacs.
10 XEmacs is free software; you can redistribute it and/or modify it
11 under the terms of the GNU General Public License as published by the
12 Free Software Foundation; either version 2, or (at your option) any
15 XEmacs is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 You should have received a copy of the GNU General Public License
21 along with XEmacs; see the file COPYING. If not, write to
22 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
25 /* Synched up with: Not in FSF. */
27 /* Author: Chuck Thompson */
29 /* Fixed up by Ben Wing for Mule */
31 /* This file has been Mule-ized. */
33 /*****************************************************************************
34 The Golden Rules of Redisplay
36 First: It Is Better To Be Correct Than Fast
37 Second: Thou Shalt Not Run Elisp From Within Redisplay
38 Third: It Is Better To Be Fast Than Not To Be
39 ****************************************************************************/
59 #include "redisplay.h"
62 #include "line-number.h"
64 #include "file-coding.h"
68 #include "console-tty.h"
70 #include <unistd.h> /* for isatty() */
74 /* Note: We have to be careful throughout this code to properly handle
75 and differentiate between Bufbytes and Emchars.
77 Since strings are generally composed of Bufbytes, I've taken the tack
78 that any contiguous set of Bufbytes is called a "string", while
79 any contiguous set of Emchars is called an "array". */
81 /* Return value to indicate a failure by an add_*_rune routine to add
82 a rune, but no propagation information needs to be returned. */
83 #define ADD_FAILED (prop_block_dynarr *) 1
85 #define BEGIN_GLYPHS 0
88 #define RIGHT_GLYPHS 3
90 #define VERTICAL_CLIP(w, display) \
91 ((WINDOW_TTY_P (w) | (!display && scroll_on_clipped_lines)) \
95 /* The following structures are completely private to redisplay.c so
96 we put them here instead of in a header file, for modularity. */
98 /* NOTE: Bytinds not Bufpos's in this structure. */
100 typedef struct position_redisplay_data_type
102 /* This information is normally filled in by the create_*_block
103 routines and is used by the add_*_rune routines. */
105 /* if we are working with strings rather than buffers we need a
106 handle to the string */
109 struct display_block *db;
110 struct display_line *dl;
111 Emchar ch; /* Character that is to be added. This is
112 used to communicate this information to
113 add_emchar_rune(). */
114 Lisp_Object last_charset; /* The charset of the previous character.
115 Used to optimize some lookups -- we
116 only have to do some things when
117 the charset changes. */
118 face_index last_findex; /* The face index of the previous character.
119 Needed to ensure the validity of the
120 last_charset optimization. */
122 int last_char_width; /* The width of the previous character. */
123 int font_is_bogus; /* If true, it means we couldn't instantiate
124 the font for this charset, so we substitute
125 ~'s from the ASCII charset. */
130 int blank_width; /* Width of the blank that is to be added.
131 This is used to communicate this information
134 This is also used rather cheesily to
135 communicate the width of the eol-cursor-size
136 blank that exists at the end of the line.
137 add_emchar_rune() is called cheesily with
138 the non-printing char '\n', which is stuck
139 in the output routines with its width being
141 Bytind bi_cursor_bufpos;/* This stores the buffer position of the cursor. */
142 unsigned int cursor_type :3;
143 int cursor_x; /* rune block cursor is at */
144 int start_col; /* Number of character columns (each column has
145 a width of the default char width) that still
146 need to be skipped. This is used for horizontal
147 scrolling, where a certain number of columns
148 (those off the left side of the screen) need
149 to be skipped before anything is displayed. */
150 Bytind bi_start_col_enabled;
151 int start_col_xoffset; /* Number of pixels that still need to
152 be skipped. This is used for
153 horizontal scrolling of glyphs, where we want
154 to be able to scroll over part of the glyph. */
156 int hscroll_glyph_width_adjust; /* how much the width of the hscroll
157 glyph differs from space_width (w).
158 0 if no hscroll glyph was used,
159 i.e. the window is not scrolled
160 horizontally. Used in tab
163 /* Information about the face the text should be displayed in and
164 any begin-glyphs and end-glyphs. */
165 struct extent_fragment *ef;
168 /* The height of a pixmap may either be predetermined if the user
169 has set a baseline value, or it may be dependent on whatever the
170 line ascent and descent values end up being, based just on font
171 information. In the first case we can immediately update the
172 values, thus their inclusion here. In the last case we cannot
173 determine the actual contribution to the line height until we
174 have finished laying out all text on the line. Thus we propagate
175 the max height of such pixmaps and do a final calculation after
176 all text has been added to the line. */
179 int max_pixmap_height;
181 Lisp_Object result_str; /* String where we put the result of
182 generating a formatted string in the modeline. */
183 int is_modeline; /* Non-zero if we're generating the modeline. */
184 Charcount modeline_charpos; /* Number of chars used in result_str so far;
185 corresponds to bytepos. */
186 Bytecount bytepos; /* Number of bytes used in result_str so far.
187 We don't actually copy the bytes into result_str
188 until the end because we don't know how big the
189 string is going to be until then. */
200 /* Data that should be propagated to the next line. Either a single
201 Emchar or a string of Bufbyte's.
203 The actual data that is propagated ends up as a Dynarr of these
206 #### It's unclean that both Emchars and Bufbytes are here.
209 typedef struct prop_block prop_block;
219 Bytecount len; /* length of the string. */
225 Bytind bi_cursor_bufpos; /* NOTE: is in Bytinds */
226 unsigned int cursor_type :3;
239 Dynarr_declare (prop_block);
243 static Charcount generate_fstring_runes (struct window *w, pos_data *data,
244 Charcount pos, Charcount min_pos,
245 Charcount max_pos, Lisp_Object elt,
246 int depth, int max_pixsize,
247 face_index findex, int type,
249 Lisp_Object cur_ext);
250 static prop_block_dynarr *add_glyph_rune (pos_data *data,
251 struct glyph_block *gb,
252 int pos_type, int allow_cursor,
253 struct glyph_cachel *cachel);
254 static Bytind create_text_block (struct window *w, struct display_line *dl,
255 Bytind bi_start_pos, prop_block_dynarr **prop,
257 static int create_overlay_glyph_block (struct window *w,
258 struct display_line *dl);
259 static void create_left_glyph_block (struct window *w,
260 struct display_line *dl,
262 static void create_right_glyph_block (struct window *w,
263 struct display_line *dl);
264 static void redisplay_windows (Lisp_Object window, int skip_selected);
265 static void decode_mode_spec (struct window *w, Emchar spec, int type);
266 static void free_display_line (struct display_line *dl);
267 static void update_line_start_cache (struct window *w, Bufpos from, Bufpos to,
268 Bufpos point, int no_regen);
269 static int point_visible (struct window *w, Bufpos point, int type);
271 /* This used to be 10 but 30 seems to give much better performance. */
272 #define INIT_MAX_PREEMPTS 30
273 static int max_preempts;
275 #define REDISPLAY_PREEMPTION_CHECK \
278 (!disable_preemption && \
279 ((preemption_count < max_preempts) || !NILP (Vexecuting_macro)) && \
280 (!INTERACTIVE || detect_input_pending ()))))
283 * Redisplay global variables.
286 /* We need a third set of display structures for the cursor motion
287 routines. We used to just give each window a third set. However,
288 we always fully regenerate the structures when needed so there
289 isn't any reason we need more than a single set. */
290 display_line_dynarr *cmotion_display_lines;
292 /* We store the extents that we need to generate in a Dynarr and then
293 frob them all on at the end of generating the string. We do it
294 this way rather than adding them as we generate the string because
295 we don't store the text into the resulting string until we're done
296 (to avoid having to resize the string multiple times), and we don't
297 want to go around adding extents to a string when the extents might
298 stretch off the end of the string. */
299 static EXTENT_dynarr *formatted_string_extent_dynarr;
300 static Bytecount_dynarr *formatted_string_extent_start_dynarr;
301 static Bytecount_dynarr *formatted_string_extent_end_dynarr;
304 /* #### probably temporary */
305 int cache_adjustment;
307 /* This holds a string representing the text corresponding to a single
309 static Bufbyte_dynarr *mode_spec_bufbyte_string;
311 int in_display; /* 1 if in redisplay. */
313 int disable_preemption; /* Used for debugging redisplay and for
316 /* We only allow max_preempts preemptions before we force a redisplay. */
317 static int preemption_count;
319 /* Minimum pixel height of clipped bottom display line. */
322 /* Minimum visible pixel width of clipped glyphs at right margin. */
325 /* Nonzero means reading single-character input with prompt
326 so put cursor on minibuffer after the prompt. */
327 int cursor_in_echo_area;
328 Lisp_Object Qcursor_in_echo_area;
330 /* Nonzero means truncate lines in all windows less wide than the frame */
331 int truncate_partial_width_windows;
333 /* non-nil if a buffer has changed since the last time redisplay completed */
335 int buffers_changed_set;
337 /* non-nil if hscroll has changed somewhere or a buffer has been
338 narrowed or widened */
340 int clip_changed_set;
342 /* non-nil if any extent has changed since the last time redisplay completed */
344 int extents_changed_set;
346 /* non-nil if any face has changed since the last time redisplay completed */
349 /* Nonzero means some frames have been marked as garbaged */
352 /* non-zero if any of the builtin display glyphs (continuation,
353 hscroll, control-arrow, etc) is in need of updating
356 int glyphs_changed_set;
358 /* non-zero if any subwindow has been deleted. */
359 int subwindows_changed;
360 int subwindows_changed_set;
362 /* non-zero if any displayed subwindow is in need of updating
364 int subwindows_state_changed;
365 int subwindows_state_changed_set;
367 /* This variable is 1 if the icon has to be updated.
368 It is set to 1 when `frame-icon-glyph' changes. */
370 int icon_changed_set;
372 /* This variable is 1 if the menubar widget has to be updated.
373 It is set to 1 by set-menubar-dirty-flag and cleared when the widget
376 int menubar_changed_set;
378 /* true iff we should redraw the modelines on the next redisplay */
379 int modeline_changed;
380 int modeline_changed_set;
382 /* non-nil if point has changed in some buffer since the last time
383 redisplay completed */
385 int point_changed_set;
387 /* non-nil if some frame has changed its size */
390 /* non-nil if some device has signaled that it wants to change size */
391 int asynch_device_change_pending;
393 /* non-nil if any toolbar has changed */
395 int toolbar_changed_set;
397 /* non-nil if any gutter has changed */
399 int gutter_changed_set;
401 /* non-nil if any window has changed since the last time redisplay completed */
404 /* non-nil if any frame's window structure has changed since the last
405 time redisplay completed */
406 int windows_structure_changed;
408 /* If non-nil, use vertical bar cursor. */
409 Lisp_Object Vbar_cursor;
410 Lisp_Object Qbar_cursor;
412 Lisp_Object Vvisible_bell; /* If true and the terminal will support it
413 then the frame will flash instead of
414 beeping when an error occurs */
416 /* Nonzero means no need to redraw the entire frame on resuming
417 a suspended Emacs. This is useful on terminals with multiple pages,
418 where one page is used for Emacs and another for all else. */
419 int no_redraw_on_reenter;
421 Lisp_Object Vwindow_system; /* nil or a symbol naming the window system
422 under which emacs is running
423 ('x is the only current possibility) */
424 Lisp_Object Vinitial_window_system;
426 Lisp_Object Vglobal_mode_string;
428 /* The number of lines scroll a window by when point leaves the window; if
429 it is <=0 then point is centered in the window */
432 /* Scroll up to this many lines, to bring point back on screen. */
433 int scroll_conservatively;
435 /* Marker for where to display an arrow on top of the buffer text. */
436 Lisp_Object Voverlay_arrow_position;
437 /* String to display for the arrow. */
438 Lisp_Object Voverlay_arrow_string;
440 Lisp_Object Vwindow_size_change_functions;
441 Lisp_Object Vwindow_scroll_functions;
442 Lisp_Object Qredisplay_end_trigger_functions, Vredisplay_end_trigger_functions;
444 Lisp_Object Qbuffer_list_changed_hook, Vbuffer_list_changed_hook;
447 #define INHIBIT_REDISPLAY_HOOKS /* #### Until we've thought about
449 #ifndef INHIBIT_REDISPLAY_HOOKS
450 /* #### Chuck says: I think this needs more thought.
451 Think about this for 19.14. */
452 Lisp_Object Vpre_redisplay_hook, Vpost_redisplay_hook;
453 Lisp_Object Qpre_redisplay_hook, Qpost_redisplay_hook;
454 #endif /* INHIBIT_REDISPLAY_HOOKS */
456 static int last_display_warning_tick, display_warning_tick;
457 Lisp_Object Qdisplay_warning_buffer;
458 int inhibit_warning_display;
460 Lisp_Object Vleft_margin_width, Vright_margin_width;
461 Lisp_Object Vminimum_line_ascent, Vminimum_line_descent;
462 Lisp_Object Vuse_left_overflow, Vuse_right_overflow;
463 Lisp_Object Vtext_cursor_visible_p;
465 int column_number_start_at_one;
467 Lisp_Object Qtop_bottom;
469 #define WINDOW_SCROLLED(w) \
470 (w->hscroll > 0 || w->left_xoffset)
473 /***************************************************************************/
475 /* low-level interfaces onto device routines */
477 /***************************************************************************/
480 redisplay_text_width_charc_string (struct window *w, int findex,
481 Charc *str, Charcount len)
483 Charset_ID charsets[NUM_LEADING_BYTES];
486 find_charsets_in_charc_string (charsets, str, len);
487 XSETWINDOW (window, w);
488 ensure_face_cachel_complete (WINDOW_FACE_CACHEL (w, findex), window,
490 return DEVMETH (XDEVICE (FRAME_DEVICE (XFRAME (WINDOW_FRAME (w)))),
491 text_width, (XFRAME (WINDOW_FRAME (w)),
492 WINDOW_FACE_CACHEL (w, findex), str, len));
495 static Charc_dynarr *rtw_charc_dynarr;
498 redisplay_text_width_string (struct window *w, int findex,
499 Bufbyte *nonreloc, Lisp_Object reloc,
500 Bytecount offset, Bytecount len)
502 if (!rtw_charc_dynarr)
503 rtw_charc_dynarr = Dynarr_new (Charc);
504 Dynarr_reset (rtw_charc_dynarr);
506 fixup_internal_substring (nonreloc, reloc, offset, &len);
508 nonreloc = XSTRING_DATA (reloc);
509 convert_bufbyte_string_into_charc_dynarr (nonreloc, len, rtw_charc_dynarr);
510 return redisplay_text_width_charc_string
511 (w, findex, Dynarr_atp (rtw_charc_dynarr, 0),
512 Dynarr_length (rtw_charc_dynarr));
516 redisplay_frame_text_width_string (struct frame *f, Lisp_Object face,
517 Bufbyte *nonreloc, Lisp_Object reloc,
518 Bytecount offset, Bytecount len)
520 Charset_ID charsets[NUM_LEADING_BYTES];
522 struct face_cachel cachel;
524 if (!rtw_charc_dynarr)
525 rtw_charc_dynarr = Dynarr_new (Charc);
526 Dynarr_reset (rtw_charc_dynarr);
528 fixup_internal_substring (nonreloc, reloc, offset, &len);
530 nonreloc = XSTRING_DATA (reloc);
531 convert_bufbyte_string_into_charc_dynarr (nonreloc, len, rtw_charc_dynarr);
532 find_charsets_in_bufbyte_string (charsets, nonreloc, len);
533 reset_face_cachel (&cachel);
535 XSETFRAME (frame, f);
536 ensure_face_cachel_complete (&cachel, frame, charsets);
537 return DEVMETH (XDEVICE (FRAME_DEVICE (f)),
538 text_width, (f, &cachel, Dynarr_atp (rtw_charc_dynarr, 0),
539 Dynarr_length (rtw_charc_dynarr)));
542 /* Return the display block from DL of the given TYPE. A display line
543 can have only one display block of each possible type. If DL does
544 not have a block of type TYPE, one will be created and added to DL. */
546 struct display_block *
547 get_display_block_from_line (struct display_line *dl, enum display_type type)
550 struct display_block db;
552 /* Check if this display line already has a block of the desired type and
554 if (dl->display_blocks)
556 for (elt = 0; elt < Dynarr_length (dl->display_blocks); elt++)
558 if (Dynarr_at (dl->display_blocks, elt).type == type)
559 return Dynarr_atp (dl->display_blocks, elt);
562 /* There isn't an active block of the desired type, but there
563 might still be allocated blocks we need to reuse. */
564 if (elt < Dynarr_largest (dl->display_blocks))
566 struct display_block *dbp = Dynarr_atp (dl->display_blocks, elt);
568 /* 'add' the block to the list */
569 Dynarr_increment (dl->display_blocks);
571 /* initialize and return */
578 /* This line doesn't have any display blocks, so initialize the display
580 dl->display_blocks = Dynarr_new (display_block);
583 /* The line doesn't have a block of the desired type so go ahead and create
584 one and add it to the line. */
587 db.runes = Dynarr_new (rune);
588 Dynarr_add (dl->display_blocks, db);
590 /* Return the newly added display block. */
591 elt = Dynarr_length (dl->display_blocks) - 1;
593 return Dynarr_atp (dl->display_blocks, elt);
597 tab_char_width (struct window *w)
599 struct buffer *b = XBUFFER (w->buffer);
600 int char_tab_width = XINT (b->tab_width);
602 if (char_tab_width <= 0 || char_tab_width > 1000) char_tab_width = 8;
604 return char_tab_width;
608 space_width (struct window *w)
610 /* While tabs are traditional composed of spaces, for variable-width
611 fonts the space character tends to give too narrow a value. So
612 we use 'n' instead. Except that we don't. We use the default
613 character width for the default face. If this is actually
614 defined by the font then it is probably the best thing to
615 actually use. If it isn't, we have assumed it is 'n' and have
616 already calculated its width. Thus we can avoid a call to
617 XTextWidth on X frames by just querying the default width. */
618 return XFONT_INSTANCE
619 (WINDOW_FACE_CACHEL_FONT (w, DEFAULT_INDEX, Vcharset_ascii))->width;
623 tab_pix_width (struct window *w)
625 return space_width (w) * tab_char_width (w);
628 /* Given a pixel position in a window, return the pixel location of
629 the next tabstop. Tabs are calculated from the left window edge in
630 terms of spaces displayed in the default face. Formerly the space
631 width was determined using the currently active face. That method
632 leads to tabstops which do not line up. */
635 next_tab_position (struct window *w, int start_pixpos, int left_pixpos)
637 int n_pos = left_pixpos;
638 int pix_tab_width = tab_pix_width (w);
640 /* Adjust n_pos for any hscrolling which has happened. */
641 if (WINDOW_SCROLLED (w))
642 n_pos -= space_width (w) * (w->hscroll - 1) + w->left_xoffset;
644 while (n_pos <= start_pixpos)
645 n_pos += pix_tab_width;
650 /* For the given window, calculate the outside and margin boundaries for a
651 display line. The whitespace boundaries must be calculated by the text
655 calculate_display_line_boundaries (struct window *w, int modeline)
657 layout_bounds bounds;
659 /* Set the outermost boundaries which are the boundaries of the
660 window itself minus the gutters (and minus the scrollbars if this
661 is for the modeline). */
664 bounds.left_out = WINDOW_TEXT_LEFT (w);
665 bounds.right_out = WINDOW_TEXT_RIGHT (w);
669 bounds.left_out = WINDOW_MODELINE_LEFT (w);
670 bounds.right_out = WINDOW_MODELINE_RIGHT (w);
673 /* The inner boundaries mark where the glyph margins are located. */
674 bounds.left_in = bounds.left_out + window_left_margin_width (w);
675 bounds.right_in = bounds.right_out - window_right_margin_width (w);
677 /* We cannot fully calculate the whitespace boundaries as they
678 depend on the contents of the line being displayed. */
679 bounds.left_white = bounds.left_in;
680 bounds.right_white = bounds.right_in;
685 /* Given a display line and a starting position, ensure that the
686 contents of the display line accurately represent the visual
687 representation of the buffer contents starting from the given
688 position when displayed in the given window. The display line ends
689 when the contents of the line reach the right boundary of the given
693 generate_display_line (struct window *w, struct display_line *dl, int bounds,
694 Bufpos start_pos, prop_block_dynarr **prop,
699 struct buffer *b = XBUFFER (WINDOW_BUFFER (w));
701 /* If our caller hasn't already set the boundaries, then do so now. */
703 dl->bounds = calculate_display_line_boundaries (w, 0);
705 /* Reset what this line is using. */
706 if (dl->display_blocks)
707 Dynarr_reset (dl->display_blocks);
710 Dynarr_free (dl->left_glyphs);
713 if (dl->right_glyphs)
715 Dynarr_free (dl->right_glyphs);
716 dl->right_glyphs = 0;
719 /* We aren't generating a modeline at the moment. */
722 /* Create a display block for the text region of the line. */
724 /* #### urk urk urk!!! Chuck fix this shit! */
725 Bytind hacked_up_bytind =
726 create_text_block (w, dl, bufpos_to_bytind (b, start_pos),
728 if (hacked_up_bytind > BI_BUF_ZV (b))
729 ret_bufpos = BUF_ZV (b) + 1;
731 ret_bufpos = bytind_to_bufpos (b, hacked_up_bytind);
733 dl->bufpos = start_pos;
734 if (dl->end_bufpos < dl->bufpos)
735 dl->end_bufpos = dl->bufpos;
737 if (MARKERP (Voverlay_arrow_position)
738 && EQ (w->buffer, Fmarker_buffer (Voverlay_arrow_position))
739 && start_pos == marker_position (Voverlay_arrow_position)
740 && (STRINGP (Voverlay_arrow_string)
741 || GLYPHP (Voverlay_arrow_string)))
743 overlay_width = create_overlay_glyph_block (w, dl);
748 /* If there are left glyphs associated with any character in the
749 text block, then create a display block to handle them. */
750 if (dl->left_glyphs != NULL && Dynarr_length (dl->left_glyphs))
751 create_left_glyph_block (w, dl, overlay_width);
753 /* If there are right glyphs associated with any character in the
754 text block, then create a display block to handle them. */
755 if (dl->right_glyphs != NULL && Dynarr_length (dl->right_glyphs))
756 create_right_glyph_block (w, dl);
758 /* In the future additional types of display blocks may be generated
761 w->last_redisplay_pos = ret_bufpos;
766 /* Adds an hscroll glyph to a display block. If this is called, then
767 the block had better be empty.
769 Yes, there are multiple places where this function is called but
770 that is the way it has to be. Each calling function has to deal
771 with bi_start_col_enabled a little differently depending on the
772 object being worked with. */
774 static prop_block_dynarr *
775 add_hscroll_rune (pos_data *data)
777 struct glyph_block gb;
778 prop_block_dynarr *retval;
779 Bytind bi_old_cursor_bufpos = data->bi_cursor_bufpos;
780 unsigned int old_cursor_type = data->cursor_type;
781 Bytind bi_old_bufpos = data->bi_bufpos;
783 if (data->cursor_type == CURSOR_ON
784 && data->bi_cursor_bufpos >= data->bi_start_col_enabled
785 && data->bi_cursor_bufpos <= data->bi_bufpos)
787 data->bi_cursor_bufpos = data->bi_start_col_enabled;
791 data->cursor_type = NO_CURSOR;
794 data->bi_endpos = data->bi_bufpos;
795 data->bi_bufpos = data->bi_start_col_enabled;
798 gb.glyph = Vhscroll_glyph;
800 int oldpixpos = data->pixpos;
801 retval = add_glyph_rune (data, &gb, BEGIN_GLYPHS, 0,
802 GLYPH_CACHEL (XWINDOW (data->window),
803 HSCROLL_GLYPH_INDEX));
804 data->hscroll_glyph_width_adjust =
805 data->pixpos - oldpixpos - space_width (XWINDOW (data->window));
808 data->bi_cursor_bufpos = bi_old_cursor_bufpos;
809 data->cursor_type = old_cursor_type;
810 data->bi_bufpos = bi_old_bufpos;
812 data->bi_start_col_enabled = 0;
816 /* Adds a character rune to a display block. If there is not enough
817 room to fit the rune on the display block (as determined by the
818 MAX_PIXPOS) then it adds nothing and returns ADD_FAILED. */
820 static prop_block_dynarr *
821 add_emchar_rune (pos_data *data)
823 struct rune rb, *crb;
835 if (data->bi_start_col_enabled)
837 return add_hscroll_rune (data);
840 if (data->ch == '\n')
842 char_glyph = ASCII_TO_CHARC ('\n');
843 data->font_is_bogus = 0;
844 /* Cheesy end-of-line pseudo-character. */
845 width = data->blank_width;
851 char_glyph = CHAR_TO_CHARC (data->ch);
852 charset = CHARC_CHARSET (char_glyph);
853 if (!EQ (charset, data->last_charset) ||
854 data->findex != data->last_findex)
856 /* OK, we need to do things the hard way. */
857 struct window *w = XWINDOW (data->window);
858 struct face_cachel *cachel = WINDOW_FACE_CACHEL (w, data->findex);
859 Lisp_Object font_instance =
860 ensure_face_cachel_contains_charset (cachel, data->window,
862 Lisp_Font_Instance *fi;
864 if (EQ (font_instance, Vthe_null_font_instance))
866 font_instance = FACE_CACHEL_FONT (cachel, Vcharset_ascii);
867 data->font_is_bogus = 1;
870 data->font_is_bogus = 0;
872 fi = XFONT_INSTANCE (font_instance);
873 if (!fi->proportional_p)
874 /* sweetness and light. */
875 data->last_char_width = fi->width;
877 data->last_char_width = -1;
878 data->new_ascent = max (data->new_ascent, (int) fi->ascent);
879 data->new_descent = max (data->new_descent, (int) fi->descent);
880 data->last_charset = charset;
881 data->last_findex = data->findex;
884 width = data->last_char_width;
887 /* bummer. Proportional fonts. */
888 width = redisplay_text_width_charc_string (XWINDOW (data->window),
894 if (data->max_pixpos != -1 && (data->pixpos + width > data->max_pixpos))
899 if (Dynarr_length (data->db->runes) < Dynarr_largest (data->db->runes))
901 crb = Dynarr_atp (data->db->runes, Dynarr_length (data->db->runes));
910 crb->findex = data->findex;
911 crb->xpos = data->pixpos;
915 if (NILP (data->string))
917 bytind_to_bufpos (XBUFFER (WINDOW_BUFFER (XWINDOW (data->window))),
921 bytecount_to_charcount (XSTRING_DATA (data->string),
924 else if (data->is_modeline)
925 crb->bufpos = data->modeline_charpos;
927 /* Text but not in buffer */
929 crb->type = RUNE_CHAR;
930 crb->object.cglyph = data->font_is_bogus
931 ? ASCII_TO_CHARC ('~')
935 if (data->cursor_type == CURSOR_ON)
937 if (data->bi_bufpos == data->bi_cursor_bufpos)
939 crb->cursor_type = CURSOR_ON;
940 data->cursor_x = Dynarr_length (data->db->runes);
943 crb->cursor_type = CURSOR_OFF;
945 else if (data->cursor_type == NEXT_CURSOR)
947 crb->cursor_type = CURSOR_ON;
948 data->cursor_x = Dynarr_length (data->db->runes);
949 data->cursor_type = NO_CURSOR;
951 else if (data->cursor_type == IGNORE_CURSOR)
952 crb->cursor_type = IGNORE_CURSOR;
954 crb->cursor_type = CURSOR_OFF;
957 Dynarr_add (data->db->runes, *crb);
959 Dynarr_increment (data->db->runes);
961 data->pixpos += width;
966 /* Given a string C_STRING of length C_LENGTH, call add_emchar_rune
967 for each character in the string. Propagate any left-over data
968 unless NO_PROP is non-zero. */
970 static prop_block_dynarr *
971 add_bufbyte_string_runes (pos_data *data, Bufbyte *c_string,
972 Bytecount c_length, int no_prop)
974 Bufbyte *pos, *end = c_string + c_length;
975 prop_block_dynarr *prop;
977 /* #### This function is too simplistic. It needs to do the same
978 sort of character interpretation (display-table lookup,
979 ctl-arrow checking), etc. that create_text_block() does.
980 The functionality to do this in that routine needs to be
983 for (pos = c_string; pos < end;)
985 data->ch = charptr_emchar (pos);
987 prop = add_emchar_rune (data);
995 struct prop_block pb;
996 Bytecount len = end - pos;
997 prop = Dynarr_new (prop_block);
999 pb.type = PROP_STRING;
1000 pb.data.p_string.str = xnew_array (Bufbyte, len);
1001 strncpy ((char *) pb.data.p_string.str, (char *) pos, len);
1002 pb.data.p_string.len = len;
1004 Dynarr_add (prop, pb);
1009 assert (pos <= end);
1015 /* Add a single rune of the specified width. The area covered by this
1016 rune will be displayed in the foreground color of the associated
1019 static prop_block_dynarr *
1020 add_blank_rune (pos_data *data, struct window *w, int char_tab_width)
1024 /* If data->start_col is not 0 then this call to add_blank_rune must have
1025 been to add it as a tab. */
1026 if (data->start_col)
1028 /* assert (w != NULL) */
1029 prop_block_dynarr *retval;
1031 /* If we have still not fully scrolled horizontally, subtract
1032 the width of this tab and return. */
1033 if (char_tab_width < data->start_col)
1035 data->start_col -= char_tab_width;
1038 else if (char_tab_width == data->start_col)
1039 data->blank_width = 0;
1042 int spcwid = space_width (w);
1044 if (spcwid >= data->blank_width)
1045 data->blank_width = 0;
1047 data->blank_width -= spcwid;
1050 data->start_col = 0;
1051 retval = add_hscroll_rune (data);
1053 /* Could be caused by the handling of the hscroll rune. */
1054 if (retval != NULL || !data->blank_width)
1058 /* Blank runes are always calculated to fit. */
1059 assert (data->pixpos + data->blank_width <= data->max_pixpos);
1061 rb.findex = data->findex;
1062 rb.xpos = data->pixpos;
1063 rb.width = data->blank_width;
1064 if (data->bi_bufpos)
1066 bytind_to_bufpos (XBUFFER (WINDOW_BUFFER (XWINDOW (data->window))),
1069 /* #### and this is really correct too? */
1072 rb.type = RUNE_BLANK;
1074 if (data->cursor_type == CURSOR_ON)
1076 if (data->bi_bufpos == data->bi_cursor_bufpos)
1078 rb.cursor_type = CURSOR_ON;
1079 data->cursor_x = Dynarr_length (data->db->runes);
1082 rb.cursor_type = CURSOR_OFF;
1084 else if (data->cursor_type == NEXT_CURSOR)
1086 rb.cursor_type = CURSOR_ON;
1087 data->cursor_x = Dynarr_length (data->db->runes);
1088 data->cursor_type = NO_CURSOR;
1091 rb.cursor_type = CURSOR_OFF;
1093 Dynarr_add (data->db->runes, rb);
1094 data->pixpos += data->blank_width;
1099 /* Add runes representing a character in octal. */
1101 #define ADD_NEXT_OCTAL_RUNE_CHAR do \
1103 if (add_failed || (add_failed = add_emchar_rune (data))) \
1105 struct prop_block pb; \
1107 prop = Dynarr_new (prop_block); \
1109 pb.type = PROP_CHAR; \
1110 pb.data.p_char.ch = data->ch; \
1111 pb.data.p_char.cursor_type = data->cursor_type; \
1112 Dynarr_add (prop, pb); \
1116 static prop_block_dynarr *
1117 add_octal_runes (pos_data *data)
1119 prop_block_dynarr *prop, *add_failed;
1120 Emchar orig_char = data->ch;
1121 unsigned int orig_cursor_type = data->cursor_type;
1127 if (data->start_col)
1130 if (!data->start_col)
1132 if (data->bi_start_col_enabled)
1134 add_failed = add_hscroll_rune (data);
1138 struct glyph_block gb;
1139 struct window *w = XWINDOW (data->window);
1142 gb.glyph = Voctal_escape_glyph;
1144 add_glyph_rune (data, &gb, BEGIN_GLYPHS, 1,
1145 GLYPH_CACHEL (w, OCT_ESC_GLYPH_INDEX));
1149 /* We only propagate information if the glyph was partially
1154 data->cursor_type = IGNORE_CURSOR;
1156 if (data->ch >= 0x100)
1158 /* If the character is an extended Mule character, it could have
1159 up to 19 bits. For the moment, we treat it as a seven-digit
1160 octal number. This is not that pretty, but whatever. */
1161 data->ch = (7 & (orig_char >> 18)) + '0';
1162 ADD_NEXT_OCTAL_RUNE_CHAR;
1164 data->ch = (7 & (orig_char >> 15)) + '0';
1165 ADD_NEXT_OCTAL_RUNE_CHAR;
1167 data->ch = (7 & (orig_char >> 12)) + '0';
1168 ADD_NEXT_OCTAL_RUNE_CHAR;
1170 data->ch = (7 & (orig_char >> 9)) + '0';
1171 ADD_NEXT_OCTAL_RUNE_CHAR;
1174 data->ch = (7 & (orig_char >> 6)) + '0';
1175 ADD_NEXT_OCTAL_RUNE_CHAR;
1177 data->ch = (7 & (orig_char >> 3)) + '0';
1178 ADD_NEXT_OCTAL_RUNE_CHAR;
1180 data->ch = (7 & orig_char) + '0';
1181 ADD_NEXT_OCTAL_RUNE_CHAR;
1183 data->cursor_type = orig_cursor_type;
1187 #undef ADD_NEXT_OCTAL_RUNE_CHAR
1189 /* Add runes representing a control character to a display block. */
1191 static prop_block_dynarr *
1192 add_control_char_runes (pos_data *data, struct buffer *b)
1194 if (!NILP (b->ctl_arrow))
1196 prop_block_dynarr *prop;
1197 Emchar orig_char = data->ch;
1198 unsigned int old_cursor_type = data->cursor_type;
1203 if (data->start_col)
1206 if (!data->start_col)
1208 if (data->bi_start_col_enabled)
1210 prop_block_dynarr *retval;
1212 retval = add_hscroll_rune (data);
1218 struct glyph_block gb;
1219 struct window *w = XWINDOW (data->window);
1222 gb.glyph = Vcontrol_arrow_glyph;
1224 /* We only propagate information if the glyph was partially
1226 if (add_glyph_rune (data, &gb, BEGIN_GLYPHS, 1,
1227 GLYPH_CACHEL (w, CONTROL_GLYPH_INDEX)))
1232 if (orig_char == 0177)
1235 data->ch = orig_char ^ 0100;
1236 data->cursor_type = IGNORE_CURSOR;
1238 if (add_emchar_rune (data))
1240 struct prop_block pb;
1242 prop = Dynarr_new (prop_block);
1244 pb.type = PROP_CHAR;
1245 pb.data.p_char.ch = data->ch;
1246 pb.data.p_char.cursor_type = data->cursor_type;
1247 Dynarr_add (prop, pb);
1250 data->cursor_type = old_cursor_type;
1255 return add_octal_runes (data);
1259 static prop_block_dynarr *
1260 add_disp_table_entry_runes_1 (pos_data *data, Lisp_Object entry)
1262 prop_block_dynarr *prop = NULL;
1264 if (STRINGP (entry))
1266 prop = add_bufbyte_string_runes (data,
1267 XSTRING_DATA (entry),
1268 XSTRING_LENGTH (entry),
1271 else if (GLYPHP (entry))
1273 if (data->start_col)
1276 if (!data->start_col && data->bi_start_col_enabled)
1278 prop = add_hscroll_rune (data);
1282 struct glyph_block gb;
1286 prop = add_glyph_rune (data, &gb, BEGIN_GLYPHS, 0, 0);
1289 else if (CHAR_OR_CHAR_INTP (entry))
1291 data->ch = XCHAR_OR_CHAR_INT (entry);
1292 prop = add_emchar_rune (data);
1294 else if (CONSP (entry))
1296 if (EQ (XCAR (entry), Qformat)
1297 && CONSP (XCDR (entry))
1298 && STRINGP (XCAR (XCDR (entry))))
1300 Lisp_Object format = XCAR (XCDR (entry));
1301 Bytind len = XSTRING_LENGTH (format);
1302 Bufbyte *src = XSTRING_DATA (format), *end = src + len;
1303 Bufbyte *result = alloca_array (Bufbyte, len);
1304 Bufbyte *dst = result;
1308 Emchar c = charptr_emchar (src);
1310 if (c != '%' || src == end)
1311 dst += set_charptr_emchar (dst, c);
1314 c = charptr_emchar (src);
1319 dst += long_to_string_base ((char *)dst, data->ch, 16);
1322 dst += set_charptr_emchar (dst, '%');
1324 /* #### unimplemented */
1328 prop = add_bufbyte_string_runes (data, result, dst - result, 0);
1332 /* Else blow it off because someone added a bad entry and we don't
1333 have any safe way of signaling an error. */
1337 /* Given a display table entry, call the appropriate functions to
1338 display each element of the entry. */
1340 static prop_block_dynarr *
1341 add_disp_table_entry_runes (pos_data *data, Lisp_Object entry)
1343 prop_block_dynarr *prop = NULL;
1344 if (VECTORP (entry))
1346 Lisp_Vector *de = XVECTOR (entry);
1347 EMACS_INT len = vector_length (de);
1350 for (elt = 0; elt < len; elt++)
1352 if (NILP (vector_data (de)[elt]))
1355 prop = add_disp_table_entry_runes_1 (data, vector_data (de)[elt]);
1356 /* Else blow it off because someone added a bad entry and we
1357 don't have any safe way of signaling an error. Hey, this
1358 comment sounds familiar. */
1360 /* #### Still need to add any remaining elements to the
1361 propagation information. */
1367 prop = add_disp_table_entry_runes_1 (data, entry);
1371 /* Add runes which were propagated from the previous line. */
1373 static prop_block_dynarr *
1374 add_propagation_runes (prop_block_dynarr **prop, pos_data *data)
1376 /* #### Remember to handle start_col parameter of data when the rest of
1377 this is finished. */
1378 /* #### Chuck -- I've redone this function a bit. It looked like the
1379 case of not all the propagation blocks being added was not handled
1381 /* #### Chuck -- I also think the double indirection of PROP is kind
1382 of bogus. A cleaner solution is just to check for
1383 Dynarr_length (prop) > 0. */
1384 /* #### This function also doesn't even pay attention to ADD_FAILED!
1385 This is seriously fucked! Seven ####'s in 130 lines -- is that a
1388 prop_block_dynarr *add_failed;
1389 Bytind bi_old_cursor_bufpos = data->bi_cursor_bufpos;
1390 unsigned int old_cursor_type = data->cursor_type;
1392 for (elt = 0; elt < Dynarr_length (*prop); elt++)
1394 struct prop_block *pb = Dynarr_atp (*prop, elt);
1399 data->ch = pb->data.p_char.ch;
1400 data->bi_cursor_bufpos = pb->data.p_char.bi_cursor_bufpos;
1401 data->cursor_type = pb->data.p_char.cursor_type;
1402 add_failed = add_emchar_rune (data);
1405 goto oops_no_more_space;
1408 if (pb->data.p_string.str)
1409 xfree (pb->data.p_string.str);
1410 /* #### bogus bogus -- this doesn't do anything!
1411 Should probably call add_bufbyte_string_runes(),
1412 once that function is fixed. */
1414 case PROP_MINIBUF_PROMPT:
1416 face_index old_findex = data->findex;
1417 Bytind bi_old_bufpos = data->bi_bufpos;
1419 data->findex = DEFAULT_INDEX;
1420 data->bi_bufpos = 0;
1421 data->cursor_type = NO_CURSOR;
1423 while (pb->data.p_string.len > 0)
1425 data->ch = charptr_emchar (pb->data.p_string.str);
1426 add_failed = add_emchar_rune (data);
1430 data->findex = old_findex;
1431 data->bi_bufpos = bi_old_bufpos;
1432 goto oops_no_more_space;
1436 /* Complicated equivalent of ptr++, len-- */
1437 Bufbyte *oldpos = pb->data.p_string.str;
1438 INC_CHARPTR (pb->data.p_string.str);
1439 pb->data.p_string.len -= pb->data.p_string.str - oldpos;
1443 data->findex = old_findex;
1444 /* ##### FIXME FIXME FIXME -- Upon successful return from
1445 this function, data->bi_bufpos is automatically incremented.
1446 However, we don't want that to happen if we were adding
1447 the minibuffer prompt. */
1449 struct buffer *buf =
1450 XBUFFER (WINDOW_BUFFER (XWINDOW (data->window)));
1451 /* #### Chuck fix this shit or I'm gonna scream! */
1452 if (bi_old_bufpos > BI_BUF_BEGV (buf))
1453 data->bi_bufpos = prev_bytind (buf, bi_old_bufpos);
1455 /* #### is this correct? Does anyone know?
1456 Does anyone care? Is this a cheesy hack or what? */
1457 data->bi_bufpos = BI_BUF_BEGV (buf) - 1;
1463 /* #### I think it's unnecessary and misleading to preserve
1464 the blank_width, as it implies that the value carries
1465 over from one rune to the next, which is wrong. */
1466 int old_width = data->blank_width;
1467 face_index old_findex = data->findex;
1469 data->findex = pb->data.p_blank.findex;
1470 data->blank_width = pb->data.p_blank.width;
1471 data->bi_cursor_bufpos = 0;
1472 data->cursor_type = IGNORE_CURSOR;
1474 if (data->pixpos + data->blank_width > data->max_pixpos)
1475 data->blank_width = data->max_pixpos - data->pixpos;
1477 /* We pass a bogus value of char_tab_width. It shouldn't
1478 matter because unless something is really screwed up
1479 this call won't cause that arg to be used. */
1480 add_failed = add_blank_rune (data, XWINDOW (data->window), 0);
1482 /* This can happen in the case where we have a tab which
1483 is wider than the window. */
1484 if (data->blank_width != pb->data.p_blank.width)
1486 pb->data.p_blank.width -= data->blank_width;
1487 add_failed = ADD_FAILED;
1490 data->findex = old_findex;
1491 data->blank_width = old_width;
1494 goto oops_no_more_space;
1504 data->bi_cursor_bufpos = bi_old_cursor_bufpos;
1505 data->cursor_type = old_cursor_type;
1506 if (elt < Dynarr_length (*prop))
1508 Dynarr_delete_many (*prop, 0, elt);
1513 Dynarr_free (*prop);
1518 /* Add 'text layout glyphs at position POS_TYPE that are contained to
1519 the display block, but add all other types to the appropriate list
1520 of the display line. They will be added later by different
1523 static prop_block_dynarr *
1524 add_glyph_rune (pos_data *data, struct glyph_block *gb, int pos_type,
1525 int allow_cursor, struct glyph_cachel *cachel)
1527 struct window *w = XWINDOW (data->window);
1529 /* If window faces changed, and glyph instance is text, then
1530 glyph sizes might have changed too */
1531 invalidate_glyph_geometry_maybe (gb->glyph, w);
1533 /* This makes sure the glyph is in the cachels.
1535 #### We do this to make sure the glyph is in the glyph cachels,
1536 so that the dirty flag can be reset after redisplay has
1537 finished. We should do this some other way, maybe by iterating
1538 over the window cache of subwindows. */
1539 get_glyph_cachel_index (w, gb->glyph);
1541 /* A nil extent indicates a special glyph (ex. truncator). */
1542 if (NILP (gb->extent)
1543 || (pos_type == BEGIN_GLYPHS &&
1544 extent_begin_glyph_layout (XEXTENT (gb->extent)) == GL_TEXT)
1545 || (pos_type == END_GLYPHS &&
1546 extent_end_glyph_layout (XEXTENT (gb->extent)) == GL_TEXT)
1547 || pos_type == LEFT_GLYPHS || pos_type == RIGHT_GLYPHS)
1552 int ascent, descent;
1553 Lisp_Object baseline;
1555 Lisp_Object instance;
1559 width = cachel->width;
1561 width = glyph_width (gb->glyph, data->window);
1566 if (data->start_col || data->start_col_xoffset)
1568 prop_block_dynarr *retval;
1569 int glyph_char_width = width / space_width (w);
1571 /* If we still have not fully scrolled horizontally after
1572 taking into account the width of the glyph, subtract its
1573 width and return. */
1574 if (glyph_char_width < data->start_col)
1576 data->start_col -= glyph_char_width;
1579 else if (glyph_char_width == data->start_col)
1583 xoffset = space_width (w) * data->start_col;
1586 /* #### Can this happen? */
1591 data->start_col = 0;
1592 retval = add_hscroll_rune (data);
1594 /* Could be caused by the handling of the hscroll rune. */
1595 if (retval != NULL || !width)
1601 if (data->pixpos + width > data->max_pixpos)
1603 /* If this is the first object we are attempting to add to
1604 the line then we ignore the horizontal_clip threshold.
1605 Otherwise we will loop until the bottom of the window
1606 continually failing to add this glyph because it is wider
1607 than the window. We could alternatively just completely
1608 ignore the glyph and proceed from there but I think that
1609 this is a better solution. */
1610 if (Dynarr_length (data->db->runes)
1611 && data->max_pixpos - data->pixpos < horizontal_clip)
1614 width = data->max_pixpos - data->pixpos;
1619 ascent = cachel->ascent;
1620 descent = cachel->descent;
1624 ascent = glyph_ascent (gb->glyph, data->window);
1625 descent = glyph_descent (gb->glyph, data->window);
1628 baseline = glyph_baseline (gb->glyph, data->window);
1630 if (glyph_contrib_p (gb->glyph, data->window))
1632 /* A pixmap that has not had a baseline explicitly set. Its
1633 contribution will be determined later. */
1634 if (NILP (baseline))
1636 int height = ascent + descent;
1637 data->max_pixmap_height = max (data->max_pixmap_height, height);
1640 /* A string so determine contribution normally. */
1641 else if (EQ (baseline, Qt))
1643 data->new_ascent = max (data->new_ascent, ascent);
1644 data->new_descent = max (data->new_descent, descent);
1647 /* A pixmap with an explicitly set baseline. We determine the
1648 contribution here. */
1649 else if (INTP (baseline))
1651 int height = ascent + descent;
1652 int pix_ascent, pix_descent;
1654 pix_ascent = height * XINT (baseline) / 100;
1655 pix_descent = height - pix_ascent;
1657 data->new_ascent = max (data->new_ascent, pix_ascent);
1658 data->new_descent = max (data->new_descent, pix_descent);
1661 /* Otherwise something is screwed up. */
1666 face = glyph_face (gb->glyph, data->window);
1668 findex = data->findex;
1670 findex = get_builtin_face_cache_index (w, face);
1672 instance = glyph_image_instance (gb->glyph, data->window,
1674 if (TEXT_IMAGE_INSTANCEP (instance))
1676 Lisp_Object string = XIMAGE_INSTANCE_TEXT_STRING (instance);
1677 face_index orig_findex = data->findex;
1678 Bytind orig_bufpos = data->bi_bufpos;
1679 Bytind orig_start_col_enabled = data->bi_start_col_enabled;
1681 data->findex = findex;
1682 data->bi_start_col_enabled = 0;
1684 data->bi_bufpos = 0;
1685 add_bufbyte_string_runes (data, XSTRING_DATA (string),
1686 XSTRING_LENGTH (string), 0);
1687 data->findex = orig_findex;
1688 data->bi_bufpos = orig_bufpos;
1689 data->bi_start_col_enabled = orig_start_col_enabled;
1694 rb.xpos = data->pixpos;
1696 rb.bufpos = 0; /* glyphs are never "at" anywhere */
1697 if (data->bi_endpos)
1698 /* #### is this necessary at all? */
1699 rb.endpos = bytind_to_bufpos (XBUFFER (WINDOW_BUFFER (w)),
1703 rb.type = RUNE_DGLYPH;
1704 rb.object.dglyph.glyph = gb->glyph;
1705 rb.object.dglyph.extent = gb->extent;
1706 rb.object.dglyph.xoffset = xoffset;
1710 rb.bufpos = bytind_to_bufpos (XBUFFER (WINDOW_BUFFER (w)),
1713 if (data->cursor_type == CURSOR_ON)
1715 if (data->bi_bufpos == data->bi_cursor_bufpos)
1717 rb.cursor_type = CURSOR_ON;
1718 data->cursor_x = Dynarr_length (data->db->runes);
1721 rb.cursor_type = CURSOR_OFF;
1723 else if (data->cursor_type == NEXT_CURSOR)
1725 rb.cursor_type = CURSOR_ON;
1726 data->cursor_x = Dynarr_length (data->db->runes);
1727 data->cursor_type = NO_CURSOR;
1729 else if (data->cursor_type == IGNORE_CURSOR)
1730 rb.cursor_type = IGNORE_CURSOR;
1731 else if (data->cursor_type == NO_CURSOR)
1732 rb.cursor_type = NO_CURSOR;
1734 rb.cursor_type = CURSOR_OFF;
1737 rb.cursor_type = CURSOR_OFF;
1739 Dynarr_add (data->db->runes, rb);
1740 data->pixpos += width;
1746 if (!NILP (glyph_face (gb->glyph, data->window)))
1748 get_builtin_face_cache_index (w, glyph_face (gb->glyph,
1751 gb->findex = data->findex;
1753 if (pos_type == BEGIN_GLYPHS)
1755 if (!data->dl->left_glyphs)
1756 data->dl->left_glyphs = Dynarr_new (glyph_block);
1757 Dynarr_add (data->dl->left_glyphs, *gb);
1760 else if (pos_type == END_GLYPHS)
1762 if (!data->dl->right_glyphs)
1763 data->dl->right_glyphs = Dynarr_new (glyph_block);
1764 Dynarr_add (data->dl->right_glyphs, *gb);
1768 abort (); /* there are no unknown types */
1771 return NULL; /* shut up compiler */
1774 /* Add all glyphs at position POS_TYPE that are contained in the given
1777 static prop_block_dynarr *
1778 add_glyph_runes (pos_data *data, int pos_type)
1780 /* #### This still needs to handle the start_col parameter. Duh, Chuck,
1781 why didn't you just modify add_glyph_rune in the first place? */
1783 glyph_block_dynarr *glyph_arr = (pos_type == BEGIN_GLYPHS
1784 ? data->ef->begin_glyphs
1785 : data->ef->end_glyphs);
1786 prop_block_dynarr *prop;
1788 for (elt = 0; elt < Dynarr_length (glyph_arr); elt++)
1790 prop = add_glyph_rune (data, Dynarr_atp (glyph_arr, elt), pos_type, 0,
1795 /* #### Add some propagation information. */
1800 Dynarr_reset (glyph_arr);
1805 /* Given a position for a buffer in a window, ensure that the given
1806 display line DL accurately represents the text on a line starting
1807 at the given position.
1809 NOTE NOTE NOTE NOTE: This function works with and returns Bytinds.
1810 You must do appropriate conversion. */
1813 create_text_block (struct window *w, struct display_line *dl,
1814 Bytind bi_start_pos, prop_block_dynarr **prop,
1817 struct frame *f = XFRAME (w->frame);
1818 struct buffer *b = XBUFFER (w->buffer);
1819 struct device *d = XDEVICE (f->device);
1823 /* Don't display anything in the minibuffer if this window is not on
1824 a selected frame. We consider all other windows to be active
1825 minibuffers as it simplifies the coding. */
1826 int active_minibuffer = (!MINI_WINDOW_P (w) ||
1827 (f == device_selected_frame (d)) ||
1828 is_surrogate_for_selected_frame (f));
1830 int truncate_win = window_truncation_on (w);
1831 int end_glyph_width;
1833 /* If the buffer's value of selective_display is an integer then
1834 only lines that start with less than selective_display columns of
1835 space will be displayed. If selective_display is t then all text
1836 after a ^M is invisible. */
1837 int selective = (INTP (b->selective_display)
1838 ? XINT (b->selective_display)
1839 : (!NILP (b->selective_display) ? -1 : 0));
1841 /* The variable ctl-arrow allows the user to specify what characters
1842 can actually be displayed and which octal should be used for.
1843 #### This variable should probably have some rethought done to
1846 #### It would also be really nice if you could specify that
1847 the characters come out in hex instead of in octal. Mule
1848 does that by adding a ctl-hexa variable similar to ctl-arrow,
1849 but that's bogus -- we need a more general solution. I
1850 think you need to extend the concept of display tables
1851 into a more general conversion mechanism. Ideally you
1852 could specify a Lisp function that converts characters,
1853 but this violates the Second Golden Rule and besides would
1854 make things way way way way slow.
1856 So instead, we extend the display-table concept, which was
1857 historically limited to 256-byte vectors, to one of the
1860 a) A 256-entry vector, for backward compatibility;
1861 b) char-table, mapping characters to values;
1862 c) range-table, mapping ranges of characters to values;
1863 d) a list of the above.
1865 The (d) option allows you to specify multiple display tables
1866 instead of just one. Each display table can specify conversions
1867 for some characters and leave others unchanged. The way the
1868 character gets displayed is determined by the first display table
1869 with a binding for that character. This way, you could call a
1870 function `enable-hex-display' that adds a hex display-table to
1871 the list of display tables for the current buffer.
1873 #### ...not yet implemented... Also, we extend the concept of
1874 "mapping" to include a printf-like spec. Thus you can make all
1875 extended characters show up as hex with a display table like
1878 #s(range-table data ((256 524288) (format "%x")))
1880 Since more than one display table is possible, you have
1881 great flexibility in mapping ranges of characters. */
1882 Emchar printable_min = (CHAR_OR_CHAR_INTP (b->ctl_arrow)
1883 ? XCHAR_OR_CHAR_INT (b->ctl_arrow)
1884 : ((EQ (b->ctl_arrow, Qt) || EQ (b->ctl_arrow, Qnil))
1887 Lisp_Object face_dt, window_dt;
1889 /* The text display block for this display line. */
1890 struct display_block *db = get_display_block_from_line (dl, TEXT);
1892 /* The first time through the main loop we need to force the glyph
1893 data to be updated. */
1896 /* Apparently the new extent_fragment_update returns an end position
1897 equal to the position passed in if there are no more runs to be
1899 int no_more_frags = 0;
1901 Lisp_Object synch_minibuffers_value =
1902 symbol_value_in_buffer (Qsynchronize_minibuffers, w->buffer);
1904 dl->used_prop_data = 0;
1906 dl->line_continuation = 0;
1909 data.ef = extent_fragment_new (w->buffer, f);
1911 /* These values are used by all of the rune addition routines. We add
1912 them to this structure for ease of passing. */
1914 XSETWINDOW (data.window, w);
1919 data.bi_bufpos = bi_start_pos;
1920 data.pixpos = dl->bounds.left_in;
1921 data.last_charset = Qunbound;
1922 data.last_findex = DEFAULT_INDEX;
1923 data.result_str = Qnil;
1925 /* Set the right boundary adjusting it to take into account any end
1926 glyph. Save the width of the end glyph for later use. */
1927 data.max_pixpos = dl->bounds.right_in;
1929 end_glyph_width = GLYPH_CACHEL_WIDTH (w, TRUN_GLYPH_INDEX);
1931 end_glyph_width = GLYPH_CACHEL_WIDTH (w, CONT_GLYPH_INDEX);
1932 data.max_pixpos -= end_glyph_width;
1934 if (cursor_in_echo_area && MINI_WINDOW_P (w) && echo_area_active (f))
1936 data.bi_cursor_bufpos = BI_BUF_ZV (b);
1937 data.cursor_type = CURSOR_ON;
1939 else if (MINI_WINDOW_P (w) && !active_minibuffer)
1940 data.cursor_type = NO_CURSOR;
1941 else if (w == XWINDOW (FRAME_SELECTED_WINDOW (f)) &&
1942 EQ(DEVICE_CONSOLE(d), Vselected_console) &&
1943 d == XDEVICE(CONSOLE_SELECTED_DEVICE(XCONSOLE(DEVICE_CONSOLE(d))))&&
1944 f == XFRAME(DEVICE_SELECTED_FRAME(d)))
1946 data.bi_cursor_bufpos = BI_BUF_PT (b);
1947 data.cursor_type = CURSOR_ON;
1949 else if (w == XWINDOW (FRAME_SELECTED_WINDOW (f)))
1951 data.bi_cursor_bufpos = bi_marker_position (w->pointm[type]);
1952 data.cursor_type = CURSOR_ON;
1955 data.cursor_type = NO_CURSOR;
1958 data.start_col = w->hscroll;
1959 data.start_col_xoffset = w->left_xoffset;
1960 data.bi_start_col_enabled = (w->hscroll ? bi_start_pos : 0);
1961 data.hscroll_glyph_width_adjust = 0;
1963 /* We regenerate the line from the very beginning. */
1964 Dynarr_reset (db->runes);
1966 /* Why is this less than or equal and not just less than? If the
1967 starting position is already equal to the maximum we can't add
1968 anything else, right? Wrong. We might still have a newline to
1969 add. A newline can use the room allocated for an end glyph since
1970 if we add it we know we aren't going to be adding any end
1973 /* #### Chuck -- I think this condition should be while (1).
1974 Otherwise if (e.g.) there is one begin-glyph and one end-glyph
1975 and the begin-glyph ends exactly at the end of the window, the
1976 end-glyph and text might not be displayed. while (1) ensures
1977 that the loop terminates only when either (a) there is
1978 propagation data or (b) the end-of-line or end-of-buffer is hit.
1980 #### Also I think you need to ensure that the operation
1981 "add begin glyphs; add end glyphs; add text" is atomic and
1982 can't get interrupted in the middle. If you run off the end
1983 of the line during that operation, then you keep accumulating
1984 propagation data until you're done. Otherwise, if the (e.g.)
1985 there's a begin glyph at a particular position and attempting
1986 to display that glyph results in window-end being hit and
1987 propagation data being generated, then the character at that
1988 position won't be displayed.
1990 #### See also the comment after the end of this loop, below.
1992 while (data.pixpos <= data.max_pixpos
1993 && (active_minibuffer || !NILP (synch_minibuffers_value)))
1995 /* #### This check probably should not be necessary. */
1996 if (data.bi_bufpos > BI_BUF_ZV (b))
1998 /* #### urk! More of this lossage! */
2003 /* If selective display was an integer and we aren't working on
2004 a continuation line then find the next line we are actually
2005 supposed to display. */
2007 && (data.bi_bufpos == BI_BUF_BEGV (b)
2008 || BUF_FETCH_CHAR (b, prev_bytind (b, data.bi_bufpos)) == '\n'))
2010 while (bi_spaces_at_point (b, data.bi_bufpos) >= selective)
2013 bi_find_next_newline_no_quit (b, data.bi_bufpos, 1);
2014 if (data.bi_bufpos >= BI_BUF_ZV (b))
2016 data.bi_bufpos = BI_BUF_ZV (b);
2022 /* Check for face changes. */
2023 if (initial || (!no_more_frags && data.bi_bufpos == data.ef->end))
2025 /* Now compute the face and begin/end-glyph information. */
2027 /* Remember that the extent-fragment routines deal in Bytind's. */
2028 extent_fragment_update (w, data.ef, data.bi_bufpos);
2030 get_display_tables (w, data.findex, &face_dt, &window_dt);
2032 if (data.bi_bufpos == data.ef->end)
2037 /* Determine what is next to be displayed. We first handle any
2038 glyphs returned by glyphs_at_bufpos. If there are no glyphs to
2039 display then we determine what to do based on the character at the
2040 current buffer position. */
2042 /* If the current position is covered by an invisible extent, do
2043 nothing (except maybe add some ellipses).
2045 #### The behavior of begin and end-glyphs at the edge of an
2046 invisible extent should be investigated further. This is
2047 fairly low priority though. */
2048 if (data.ef->invisible)
2050 /* #### Chuck, perhaps you could look at this code? I don't
2051 really know what I'm doing. */
2054 Dynarr_free (*prop);
2058 /* The extent fragment code only sets this when we should
2059 really display the ellipses. It makes sure the ellipses
2060 don't get displayed more than once in a row. */
2061 if (data.ef->invisible_ellipses)
2063 struct glyph_block gb;
2065 data.ef->invisible_ellipses_already_displayed = 1;
2066 data.ef->invisible_ellipses = 0;
2068 gb.glyph = Vinvisible_text_glyph;
2069 *prop = add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0,
2070 GLYPH_CACHEL (w, INVIS_GLYPH_INDEX));
2071 /* Perhaps they shouldn't propagate if the very next thing
2072 is to display a newline (for compatibility with
2073 selective-display-ellipses)? Maybe that's too
2079 /* If point is in an invisible region we place it on the
2080 next visible character. */
2081 if (data.cursor_type == CURSOR_ON
2082 && data.bi_bufpos == data.bi_cursor_bufpos)
2084 data.cursor_type = NEXT_CURSOR;
2087 /* #### What if we we're dealing with a display table? */
2091 if (data.bi_bufpos == BI_BUF_ZV (b))
2094 INC_BYTIND (b, data.bi_bufpos);
2097 /* If there is propagation data, then it represents the current
2098 buffer position being displayed. Add them and advance the
2099 position counter. This might also add the minibuffer
2103 dl->used_prop_data = 1;
2104 *prop = add_propagation_runes (prop, &data);
2107 goto done; /* gee, a really narrow window */
2108 else if (data.bi_bufpos == BI_BUF_ZV (b))
2110 else if (data.bi_bufpos < BI_BUF_BEGV (b))
2111 /* #### urk urk urk! Aborts are not very fun! Fix this please! */
2112 data.bi_bufpos = BI_BUF_BEGV (b);
2114 INC_BYTIND (b, data.bi_bufpos);
2117 /* If there are end glyphs, add them to the line. These are
2118 the end glyphs for the previous run of text. We add them
2119 here rather than doing them at the end of handling the
2120 previous run so that glyphs at the beginning and end of
2121 a line are handled correctly. */
2122 else if (Dynarr_length (data.ef->end_glyphs) > 0)
2124 *prop = add_glyph_runes (&data, END_GLYPHS);
2129 /* If there are begin glyphs, add them to the line. */
2130 else if (Dynarr_length (data.ef->begin_glyphs) > 0)
2132 *prop = add_glyph_runes (&data, BEGIN_GLYPHS);
2137 /* If at end-of-buffer, we've already processed begin and
2138 end-glyphs at this point and there's no text to process,
2140 else if (data.bi_bufpos == BI_BUF_ZV (b))
2145 Lisp_Object entry = Qnil;
2146 /* Get the character at the current buffer position. */
2147 data.ch = BI_BUF_FETCH_CHAR (b, data.bi_bufpos);
2148 if (!NILP (face_dt) || !NILP (window_dt))
2149 entry = display_table_entry (data.ch, face_dt, window_dt);
2151 /* If there is a display table entry for it, hand it off to
2152 add_disp_table_entry_runes and let it worry about it. */
2153 if (!NILP (entry) && !EQ (entry, make_char (data.ch)))
2155 *prop = add_disp_table_entry_runes (&data, entry);
2161 /* Check if we have hit a newline character. If so, add a marker
2162 to the line and end this loop. */
2163 else if (data.ch == '\n')
2165 /* We aren't going to be adding an end glyph so give its
2166 space back in order to make sure that the cursor can
2168 data.max_pixpos += end_glyph_width;
2171 && (bi_spaces_at_point
2172 (b, next_bytind (b, data.bi_bufpos))
2175 if (!NILP (b->selective_display_ellipses))
2177 struct glyph_block gb;
2180 gb.glyph = Vinvisible_text_glyph;
2181 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0,
2182 GLYPH_CACHEL (w, INVIS_GLYPH_INDEX));
2186 /* Cheesy, cheesy, cheesy. We mark the end of the
2187 line with a special "character rune" whose width
2188 is the EOL cursor width and whose character is
2189 the non-printing character '\n'. */
2190 data.blank_width = DEVMETH (d, eol_cursor_width, ());
2191 *prop = add_emchar_rune (&data);
2194 /* We need to set data.bi_bufpos to the start of the
2195 next visible region in order to make this line
2196 appear to contain all of the invisible area.
2197 Otherwise, the line cache won't work
2199 INC_BYTIND (b, data.bi_bufpos);
2200 while (bi_spaces_at_point (b, data.bi_bufpos) >= selective)
2203 bi_find_next_newline_no_quit (b, data.bi_bufpos, 1);
2204 if (data.bi_bufpos >= BI_BUF_ZV (b))
2206 data.bi_bufpos = BI_BUF_ZV (b);
2210 if (BI_BUF_FETCH_CHAR
2211 (b, prev_bytind (b, data.bi_bufpos)) == '\n')
2212 DEC_BYTIND (b, data.bi_bufpos);
2216 data.blank_width = DEVMETH (d, eol_cursor_width, ());
2217 *prop = add_emchar_rune (&data);
2223 /* If the current character is ^M, and selective display is
2224 enabled, then add the invisible-text-glyph if
2225 selective-display-ellipses is set. In any case, this
2227 else if (data.ch == (('M' & 037)) && selective == -1)
2229 Bytind bi_next_bufpos;
2231 /* Find the buffer position at the end of the line. */
2233 bi_find_next_newline_no_quit (b, data.bi_bufpos, 1);
2234 if (BI_BUF_FETCH_CHAR (b, prev_bytind (b, bi_next_bufpos))
2236 DEC_BYTIND (b, bi_next_bufpos);
2238 /* If the cursor is somewhere in the elided text make
2239 sure that the cursor gets drawn appropriately. */
2240 if (data.cursor_type == CURSOR_ON
2241 && (data.bi_cursor_bufpos >= data.bi_bufpos &&
2242 data.bi_cursor_bufpos < bi_next_bufpos))
2244 data.cursor_type = NEXT_CURSOR;
2247 /* We won't be adding a truncation or continuation glyph
2248 so give up the room allocated for them. */
2249 data.max_pixpos += end_glyph_width;
2251 if (!NILP (b->selective_display_ellipses))
2253 /* We don't propagate anything from the invisible
2254 text glyph if it fails to fit. This is
2256 struct glyph_block gb;
2259 gb.glyph = Vinvisible_text_glyph;
2260 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 1,
2261 GLYPH_CACHEL (w, INVIS_GLYPH_INDEX));
2264 /* Set the buffer position to the end of the line. We
2265 need to do this before potentially adding a newline
2266 so that the cursor flag will get set correctly (if
2268 data.bi_bufpos = bi_next_bufpos;
2270 if (NILP (b->selective_display_ellipses)
2271 || data.bi_cursor_bufpos == bi_next_bufpos)
2273 /* We have to at least add a newline character so
2274 that the cursor shows up properly. */
2276 data.blank_width = DEVMETH (d, eol_cursor_width, ());
2277 data.findex = DEFAULT_INDEX;
2279 data.start_col_xoffset = 0;
2280 data.bi_start_col_enabled = 0;
2282 add_emchar_rune (&data);
2285 /* This had better be a newline but doing it this way
2286 we'll see obvious incorrect results if it isn't. No
2287 need to abort here. */
2288 data.ch = BI_BUF_FETCH_CHAR (b, data.bi_bufpos);
2293 /* If the current character is considered to be printable, then
2295 else if (data.ch >= printable_min)
2297 *prop = add_emchar_rune (&data);
2302 /* If the current character is a tab, determine the next tab
2303 starting position and add a blank rune which extends from the
2304 current pixel position to that starting position. */
2305 else if (data.ch == '\t')
2307 int tab_start_pixpos = data.pixpos;
2312 if (data.start_col > 1)
2313 tab_start_pixpos -= (space_width (w) * (data.start_col - 1))
2314 + data.start_col_xoffset;
2317 next_tab_position (w, tab_start_pixpos,
2318 dl->bounds.left_in +
2319 data.hscroll_glyph_width_adjust);
2320 if (next_tab_start > data.max_pixpos)
2322 prop_width = next_tab_start - data.max_pixpos;
2323 next_tab_start = data.max_pixpos;
2325 data.blank_width = next_tab_start - data.pixpos;
2327 (next_tab_start - tab_start_pixpos) / space_width (w);
2329 *prop = add_blank_rune (&data, w, char_tab_width);
2331 /* add_blank_rune is only supposed to be called with
2332 sizes guaranteed to fit in the available space. */
2337 struct prop_block pb;
2338 *prop = Dynarr_new (prop_block);
2340 pb.type = PROP_BLANK;
2341 pb.data.p_blank.width = prop_width;
2342 pb.data.p_blank.findex = data.findex;
2343 Dynarr_add (*prop, pb);
2349 /* If character is a control character, pass it off to
2350 add_control_char_runes.
2352 The is_*() routines have undefined results on
2353 arguments outside of the range [-1, 255]. (This
2354 often bites people who carelessly use `char' instead
2355 of `unsigned char'.)
2357 else if (data.ch < 0x100 && iscntrl ((Bufbyte) data.ch))
2359 *prop = add_control_char_runes (&data, b);
2365 /* If the character is above the ASCII range and we have not
2366 already handled it, then print it as an octal number. */
2367 else if (data.ch >= 0200)
2369 *prop = add_octal_runes (&data);
2375 /* Assume the current character is considered to be printable,
2376 then just add it. */
2379 *prop = add_emchar_rune (&data);
2384 INC_BYTIND (b, data.bi_bufpos);
2390 /* Determine the starting point of the next line if we did not hit the
2391 end of the buffer. */
2392 if (data.bi_bufpos < BI_BUF_ZV (b)
2393 && (active_minibuffer || !NILP (synch_minibuffers_value)))
2395 /* #### This check is not correct. If the line terminated
2396 due to a begin-glyph or end-glyph hitting window-end, then
2397 data.ch will not point to the character at data.bi_bufpos. If
2398 you make the two changes mentioned at the top of this loop,
2399 you should be able to say '(if (*prop))'. That should also
2400 make it possible to eliminate the data.bi_bufpos < BI_BUF_ZV (b)
2403 /* The common case is that the line ended because we hit a newline.
2404 In that case, the next character is just the next buffer
2406 if (data.ch == '\n')
2408 /* If data.start_col_enabled is still true, then the window is
2409 scrolled far enough so that nothing on this line is visible.
2410 We need to stick a truncation glyph at the beginning of the
2411 line in that case unless the line is completely blank. */
2412 if (data.bi_start_col_enabled)
2414 if (data.cursor_type == CURSOR_ON)
2416 if (data.bi_cursor_bufpos >= bi_start_pos
2417 && data.bi_cursor_bufpos <= data.bi_bufpos)
2418 data.bi_cursor_bufpos = data.bi_bufpos;
2420 data.findex = DEFAULT_INDEX;
2422 data.bi_start_col_enabled = 0;
2424 if (data.bi_bufpos != bi_start_pos)
2426 struct glyph_block gb;
2429 gb.glyph = Vhscroll_glyph;
2430 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0,
2431 GLYPH_CACHEL (w, HSCROLL_GLYPH_INDEX));
2435 /* This duplicates code down below to add a newline to
2436 the end of an otherwise empty line.*/
2438 data.blank_width = DEVMETH (d, eol_cursor_width, ());
2440 add_emchar_rune (&data);
2444 INC_BYTIND (b, data.bi_bufpos);
2447 /* Otherwise we have a buffer line which cannot fit on one display
2451 struct glyph_block gb;
2452 struct glyph_cachel *cachel;
2454 /* If the line is to be truncated then we actually have to look
2455 for the next newline. We also add the end-of-line glyph which
2456 we know will fit because we adjusted the right border before
2457 we starting laying out the line. */
2458 data.max_pixpos += end_glyph_width;
2459 data.findex = DEFAULT_INDEX;
2466 /* Now find the start of the next line. */
2467 bi_pos = bi_find_next_newline_no_quit (b, data.bi_bufpos, 1);
2469 /* If the cursor is past the truncation line then we
2470 make it appear on the truncation glyph. If we've hit
2471 the end of the buffer then we also make the cursor
2472 appear unless eob is immediately preceded by a
2473 newline. In that case the cursor should actually
2474 appear on the next line. */
2475 if (data.cursor_type == CURSOR_ON
2476 && data.bi_cursor_bufpos >= data.bi_bufpos
2477 && (data.bi_cursor_bufpos < bi_pos ||
2478 (bi_pos == BI_BUF_ZV (b)
2479 && (bi_pos == BI_BUF_BEGV (b)
2480 || (BI_BUF_FETCH_CHAR (b, prev_bytind (b, bi_pos))
2482 data.bi_cursor_bufpos = bi_pos;
2484 data.cursor_type = NO_CURSOR;
2486 data.bi_bufpos = bi_pos;
2487 gb.glyph = Vtruncation_glyph;
2488 cachel = GLYPH_CACHEL (w, TRUN_GLYPH_INDEX);
2492 /* The cursor can never be on the continuation glyph. */
2493 data.cursor_type = NO_CURSOR;
2495 /* data.bi_bufpos is already at the start of the next line. */
2497 dl->line_continuation = 1;
2498 gb.glyph = Vcontinuation_glyph;
2499 cachel = GLYPH_CACHEL (w, CONT_GLYPH_INDEX);
2502 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0, cachel);
2504 if (truncate_win && data.bi_bufpos == BI_BUF_ZV (b)
2505 && BI_BUF_FETCH_CHAR (b, prev_bytind (b, BI_BUF_ZV (b))) != '\n')
2506 /* #### Damn this losing shit. */
2510 else if ((active_minibuffer || !NILP (synch_minibuffers_value))
2511 && (!echo_area_active (f) || data.bi_bufpos == BI_BUF_ZV (b)))
2513 /* We need to add a marker to the end of the line since there is no
2514 newline character in order for the cursor to get drawn. We label
2515 it as a newline so that it gets handled correctly by the
2516 whitespace routines below. */
2519 data.blank_width = DEVMETH (d, eol_cursor_width, ());
2520 data.findex = DEFAULT_INDEX;
2522 data.start_col_xoffset = 0;
2523 data.bi_start_col_enabled = 0;
2525 data.max_pixpos += data.blank_width;
2526 add_emchar_rune (&data);
2527 data.max_pixpos -= data.blank_width;
2529 /* #### urk! Chuck, this shit is bad news. Going around
2530 manipulating invalid positions is guaranteed to result in
2531 trouble sooner or later. */
2532 data.bi_bufpos = BI_BUF_ZV (b) + 1;
2535 /* Calculate left whitespace boundary. */
2539 /* Whitespace past a newline is considered right whitespace. */
2540 while (elt < Dynarr_length (db->runes))
2542 struct rune *rb = Dynarr_atp (db->runes, elt);
2544 if ((rb->type == RUNE_CHAR && CHARC_ASCII_EQ (rb->object.cglyph, ' '))
2545 || rb->type == RUNE_BLANK)
2547 dl->bounds.left_white += rb->width;
2551 elt = Dynarr_length (db->runes);
2555 /* Calculate right whitespace boundary. */
2557 int elt = Dynarr_length (db->runes) - 1;
2560 while (!done && elt >= 0)
2562 struct rune *rb = Dynarr_atp (db->runes, elt);
2564 if (!(rb->type == RUNE_CHAR && CHARC_IS_SPACE (rb->object.cglyph))
2565 && !rb->type == RUNE_BLANK)
2567 dl->bounds.right_white = rb->xpos + rb->width;
2575 /* The line is blank so everything is considered to be right
2578 dl->bounds.right_white = dl->bounds.left_in;
2581 /* Set the display blocks bounds. */
2582 db->start_pos = dl->bounds.left_in;
2583 if (Dynarr_length (db->runes))
2585 struct rune *rb = Dynarr_atp (db->runes, Dynarr_length (db->runes) - 1);
2587 db->end_pos = rb->xpos + rb->width;
2590 db->end_pos = dl->bounds.right_white;
2592 /* update line height parameters */
2593 if (!data.new_ascent && !data.new_descent)
2595 /* We've got a blank line so initialize these values from the default
2597 default_face_font_info (data.window, &data.new_ascent,
2598 &data.new_descent, 0, 0, 0);
2601 if (data.max_pixmap_height)
2603 int height = data.new_ascent + data.new_descent;
2604 int pix_ascent, pix_descent;
2606 pix_descent = data.max_pixmap_height * data.new_descent / height;
2607 pix_ascent = data.max_pixmap_height - pix_descent;
2609 data.new_ascent = max (data.new_ascent, pix_ascent);
2610 data.new_descent = max (data.new_descent, pix_descent);
2613 dl->ascent = data.new_ascent;
2614 dl->descent = data.new_descent;
2617 unsigned short ascent = (unsigned short) XINT (w->minimum_line_ascent);
2619 if (dl->ascent < ascent)
2620 dl->ascent = ascent;
2623 unsigned short descent = (unsigned short) XINT (w->minimum_line_descent);
2625 if (dl->descent < descent)
2626 dl->descent = descent;
2629 dl->cursor_elt = data.cursor_x;
2630 /* #### lossage lossage lossage! Fix this shit! */
2631 if (data.bi_bufpos > BI_BUF_ZV (b))
2632 dl->end_bufpos = BUF_ZV (b);
2634 dl->end_bufpos = bytind_to_bufpos (b, data.bi_bufpos) - 1;
2636 data.dl->num_chars = column_at_point (b, dl->end_bufpos, 0);
2638 /* This doesn't correctly take into account tabs and control
2639 characters but if the window isn't being truncated then this
2640 value isn't going to end up being used anyhow. */
2641 data.dl->num_chars = dl->end_bufpos - dl->bufpos;
2643 /* #### handle horizontally scrolled line with text none of which
2644 was actually laid out. */
2646 /* #### handle any remainder of overlay arrow */
2648 if (*prop == ADD_FAILED)
2651 if (truncate_win && *prop)
2653 Dynarr_free (*prop);
2657 extent_fragment_delete (data.ef);
2659 /* #### If we started at EOB, then make sure we return a value past
2660 it so that regenerate_window will exit properly. This is bogus.
2661 The main loop should get fixed so that it isn't necessary to call
2662 this function if we are already at EOB. */
2664 if (data.bi_bufpos == BI_BUF_ZV (b) && bi_start_pos == BI_BUF_ZV (b))
2665 return data.bi_bufpos + 1; /* Yuck! */
2667 return data.bi_bufpos;
2670 /* Display the overlay arrow at the beginning of the given line. */
2673 create_overlay_glyph_block (struct window *w, struct display_line *dl)
2675 struct frame *f = XFRAME (w->frame);
2676 struct device *d = XDEVICE (f->device);
2679 /* If Voverlay_arrow_string isn't valid then just fail silently. */
2680 if (!STRINGP (Voverlay_arrow_string) && !GLYPHP (Voverlay_arrow_string))
2686 XSETWINDOW (data.window, w);
2687 data.db = get_display_block_from_line (dl, OVERWRITE);
2689 data.pixpos = dl->bounds.left_in;
2690 data.max_pixpos = dl->bounds.right_in;
2691 data.cursor_type = NO_CURSOR;
2693 data.findex = DEFAULT_INDEX;
2694 data.last_charset = Qunbound;
2695 data.last_findex = DEFAULT_INDEX;
2696 data.result_str = Qnil;
2699 Dynarr_reset (data.db->runes);
2701 if (STRINGP (Voverlay_arrow_string))
2703 add_bufbyte_string_runes
2705 XSTRING_DATA (Voverlay_arrow_string),
2706 XSTRING_LENGTH (Voverlay_arrow_string),
2709 else if (GLYPHP (Voverlay_arrow_string))
2711 struct glyph_block gb;
2713 gb.glyph = Voverlay_arrow_string;
2715 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0, 0);
2718 if (data.max_pixmap_height)
2720 int height = data.new_ascent + data.new_descent;
2721 int pix_ascent, pix_descent;
2723 pix_descent = data.max_pixmap_height * data.new_descent / height;
2724 pix_ascent = data.max_pixmap_height - pix_descent;
2726 data.new_ascent = max (data.new_ascent, pix_ascent);
2727 data.new_descent = max (data.new_descent, pix_descent);
2730 dl->ascent = data.new_ascent;
2731 dl->descent = data.new_descent;
2733 data.db->start_pos = dl->bounds.left_in;
2734 data.db->end_pos = data.pixpos;
2736 return data.pixpos - dl->bounds.left_in;
2739 /* Add a type of glyph to a margin display block. */
2742 add_margin_runes (struct display_line *dl, struct display_block *db, int start,
2743 int count, enum glyph_layout layout, int side, Lisp_Object window)
2745 glyph_block_dynarr *gbd = (side == LEFT_GLYPHS
2747 : dl->right_glyphs);
2750 struct window *w = XWINDOW (window);
2751 struct frame *f = XFRAME (w->frame);
2752 struct device *d = XDEVICE (f->device);
2757 data.window = window;
2760 data.pixpos = start;
2761 data.cursor_type = NO_CURSOR;
2763 data.last_charset = Qunbound;
2764 data.last_findex = DEFAULT_INDEX;
2765 data.result_str = Qnil;
2767 data.new_ascent = dl->ascent;
2768 data.new_descent = dl->descent;
2770 if ((layout == GL_WHITESPACE && side == LEFT_GLYPHS)
2771 || (layout == GL_INSIDE_MARGIN && side == RIGHT_GLYPHS))
2774 elt = Dynarr_length (gbd) - 1;
2781 end = Dynarr_length (gbd);
2784 while (count && ((!reverse && elt < end) || (reverse && elt >= end)))
2786 struct glyph_block *gb = Dynarr_atp (gbd, elt);
2788 if (NILP (gb->extent))
2789 abort (); /* these should have been handled in add_glyph_rune */
2792 ((side == LEFT_GLYPHS &&
2793 extent_begin_glyph_layout (XEXTENT (gb->extent)) == layout)
2794 || (side == RIGHT_GLYPHS &&
2795 extent_end_glyph_layout (XEXTENT (gb->extent)) == layout)))
2797 data.findex = gb->findex;
2798 data.max_pixpos = data.pixpos + gb->width;
2799 add_glyph_rune (&data, gb, side, 0, NULL);
2804 (reverse ? elt-- : elt++);
2807 if (data.max_pixmap_height)
2809 int height = data.new_ascent + data.new_descent;
2810 int pix_ascent, pix_descent;
2812 pix_descent = data.max_pixmap_height * data.new_descent / height;
2813 pix_ascent = data.max_pixmap_height - pix_descent;
2814 data.new_ascent = max (data.new_ascent, pix_ascent);
2815 data.new_descent = max (data.new_descent, pix_descent);
2818 dl->ascent = data.new_ascent;
2819 dl->descent = data.new_descent;
2824 /* Add a blank to a margin display block. */
2827 add_margin_blank (struct display_line *dl, struct display_block *db,
2828 struct window *w, int xpos, int width, int side)
2832 rb.findex = (side == LEFT_GLYPHS
2833 ? get_builtin_face_cache_index (w, Vleft_margin_face)
2834 : get_builtin_face_cache_index (w, Vright_margin_face));
2839 rb.type = RUNE_BLANK;
2840 rb.cursor_type = CURSOR_OFF;
2842 Dynarr_add (db->runes, rb);
2845 /* Display glyphs in the left outside margin, left inside margin and
2846 left whitespace area. */
2849 create_left_glyph_block (struct window *w, struct display_line *dl,
2854 int use_overflow = (NILP (w->use_left_overflow) ? 0 : 1);
2856 int out_end, in_out_start, in_in_end, white_out_start, white_in_start;
2857 int out_cnt, in_out_cnt, in_in_cnt, white_out_cnt, white_in_cnt;
2858 int left_in_start = dl->bounds.left_in;
2859 int left_in_end = dl->bounds.left_in + overlay_width;
2861 struct display_block *odb, *idb;
2863 XSETWINDOW (window, w);
2865 /* We have to add the glyphs to the line in the order outside,
2866 inside, whitespace. However the precedence dictates that we
2867 determine how many will fit in the reverse order. */
2869 /* Determine how many whitespace glyphs we can display and where
2870 they should start. */
2871 white_in_start = dl->bounds.left_white;
2872 white_out_start = left_in_start;
2873 white_out_cnt = white_in_cnt = 0;
2876 while (elt < Dynarr_length (dl->left_glyphs))
2878 struct glyph_block *gb = Dynarr_atp (dl->left_glyphs, elt);
2880 if (NILP (gb->extent))
2881 abort (); /* these should have been handled in add_glyph_rune */
2883 if (extent_begin_glyph_layout (XEXTENT (gb->extent)) == GL_WHITESPACE)
2887 width = glyph_width (gb->glyph, window);
2889 if (white_in_start - width >= left_in_end)
2892 white_in_start -= width;
2896 else if (use_overflow
2897 && (white_out_start - width > dl->bounds.left_out))
2900 white_out_start -= width;
2911 /* Determine how many inside margin glyphs we can display and where
2912 they should start. The inside margin glyphs get whatever space
2913 is left after the whitespace glyphs have been displayed. These
2914 are tricky to calculate since if we decide to use the overflow
2915 area we basically have to start over. So for these we build up a
2916 list of just the inside margin glyphs and manipulate it to
2917 determine the needed info. */
2919 glyph_block_dynarr *ib;
2920 int avail_in, avail_out;
2923 int used_in, used_out;
2926 used_in = used_out = 0;
2927 ib = Dynarr_new (glyph_block);
2928 while (elt < Dynarr_length (dl->left_glyphs))
2930 struct glyph_block *gb = Dynarr_atp (dl->left_glyphs, elt);
2932 if (NILP (gb->extent))
2933 abort (); /* these should have been handled in add_glyph_rune */
2935 if (extent_begin_glyph_layout (XEXTENT (gb->extent)) ==
2938 gb->width = glyph_width (gb->glyph, window);
2939 used_in += gb->width;
2940 Dynarr_add (ib, *gb);
2950 avail_in = white_in_start - left_in_end;
2958 avail_out = white_out_start - dl->bounds.left_out;
2961 while (!done && marker < Dynarr_length (ib))
2963 int width = Dynarr_atp (ib, marker)->width;
2965 /* If everything now fits in the available inside margin
2966 space, we're done. */
2967 if (used_in <= avail_in)
2971 /* Otherwise see if we have room to move a glyph to the
2973 if (used_out + width <= avail_out)
2986 /* At this point we now know that everything from marker on goes in
2987 the inside margin and everything before it goes in the outside
2988 margin. The stuff going into the outside margin is guaranteed
2989 to fit, but we may have to trim some stuff from the inside. */
2991 in_in_end = left_in_end;
2992 in_out_start = white_out_start;
2993 in_out_cnt = in_in_cnt = 0;
2997 while (elt < Dynarr_length (dl->left_glyphs))
2999 struct glyph_block *gb = Dynarr_atp (dl->left_glyphs, elt);
3001 if (NILP (gb->extent))
3002 abort (); /* these should have been handled in add_glyph_rune */
3004 if (extent_begin_glyph_layout (XEXTENT (gb->extent)) ==
3007 int width = glyph_width (gb->glyph, window);
3012 in_out_start -= width;
3017 else if (in_in_end + width < white_in_start)
3032 /* Determine how many outside margin glyphs we can display. They
3033 always start at the left outside margin and can only use the
3034 outside margin space. */
3035 out_end = dl->bounds.left_out;
3039 while (elt < Dynarr_length (dl->left_glyphs))
3041 struct glyph_block *gb = Dynarr_atp (dl->left_glyphs, elt);
3043 if (NILP (gb->extent))
3044 abort (); /* these should have been handled in add_glyph_rune */
3046 if (extent_begin_glyph_layout (XEXTENT (gb->extent)) ==
3049 int width = glyph_width (gb->glyph, window);
3051 if (out_end + width <= in_out_start)
3065 /* Now that we know where everything goes, we add the glyphs as
3066 runes to the appropriate display blocks. */
3067 if (out_cnt || in_out_cnt || white_out_cnt)
3069 odb = get_display_block_from_line (dl, LEFT_OUTSIDE_MARGIN);
3070 odb->start_pos = dl->bounds.left_out;
3071 /* #### We should stop adding a blank to account for the space
3072 between the end of the glyphs and the margin and instead set
3073 this accordingly. */
3074 odb->end_pos = dl->bounds.left_in;
3075 Dynarr_reset (odb->runes);
3080 if (in_in_cnt || white_in_cnt)
3082 idb = get_display_block_from_line (dl, LEFT_INSIDE_MARGIN);
3083 idb->start_pos = dl->bounds.left_in;
3084 /* #### See above comment for odb->end_pos */
3085 idb->end_pos = dl->bounds.left_white;
3086 Dynarr_reset (idb->runes);
3091 /* First add the outside margin glyphs. */
3093 end_xpos = add_margin_runes (dl, odb, dl->bounds.left_out, out_cnt,
3094 GL_OUTSIDE_MARGIN, LEFT_GLYPHS, window);
3096 end_xpos = dl->bounds.left_out;
3098 /* There may be blank space between the outside margin glyphs and
3099 the inside margin glyphs. If so, add a blank. */
3100 if (in_out_cnt && (in_out_start - end_xpos))
3102 add_margin_blank (dl, odb, w, end_xpos, in_out_start - end_xpos,
3106 /* Next add the inside margin glyphs which are actually in the
3110 end_xpos = add_margin_runes (dl, odb, in_out_start, in_out_cnt,
3111 GL_INSIDE_MARGIN, LEFT_GLYPHS, window);
3114 /* If we didn't add any inside margin glyphs to the outside margin,
3115 but are adding whitespace glyphs, then we need to add a blank
3117 if (!in_out_cnt && white_out_cnt && (white_out_start - end_xpos))
3119 add_margin_blank (dl, odb, w, end_xpos, white_out_start - end_xpos,
3123 /* Next add the whitespace margin glyphs which are actually in the
3127 end_xpos = add_margin_runes (dl, odb, white_out_start, white_out_cnt,
3128 GL_WHITESPACE, LEFT_GLYPHS, window);
3131 /* We take care of clearing between the end of the glyphs and the
3132 start of the inside margin for lines which have glyphs. */
3133 if (odb && (left_in_start - end_xpos))
3135 add_margin_blank (dl, odb, w, end_xpos, left_in_start - end_xpos,
3139 /* Next add the inside margin glyphs which are actually in the
3143 end_xpos = add_margin_runes (dl, idb, left_in_end, in_in_cnt,
3144 GL_INSIDE_MARGIN, LEFT_GLYPHS, window);
3147 end_xpos = left_in_end;
3149 /* Make sure that the area between the end of the inside margin
3150 glyphs and the whitespace glyphs is cleared. */
3151 if (idb && (white_in_start - end_xpos > 0))
3153 add_margin_blank (dl, idb, w, end_xpos, white_in_start - end_xpos,
3157 /* Next add the whitespace margin glyphs which are actually in the
3161 add_margin_runes (dl, idb, white_in_start, white_in_cnt, GL_WHITESPACE,
3162 LEFT_GLYPHS, window);
3165 /* Whitespace glyphs always end right next to the text block so
3166 there is nothing we have to make sure is cleared after them. */
3169 /* Display glyphs in the right outside margin, right inside margin and
3170 right whitespace area. */
3173 create_right_glyph_block (struct window *w, struct display_line *dl)
3177 int use_overflow = (NILP (w->use_right_overflow) ? 0 : 1);
3179 int out_start, in_out_end, in_in_start, white_out_end, white_in_end;
3180 int out_cnt, in_out_cnt, in_in_cnt, white_out_cnt, white_in_cnt;
3182 struct display_block *odb, *idb;
3184 XSETWINDOW (window, w);
3186 /* We have to add the glyphs to the line in the order outside,
3187 inside, whitespace. However the precedence dictates that we
3188 determine how many will fit in the reverse order. */
3190 /* Determine how many whitespace glyphs we can display and where
3191 they should start. */
3192 white_in_end = dl->bounds.right_white;
3193 white_out_end = dl->bounds.right_in;
3194 white_out_cnt = white_in_cnt = 0;
3197 while (elt < Dynarr_length (dl->right_glyphs))
3199 struct glyph_block *gb = Dynarr_atp (dl->right_glyphs, elt);
3201 if (NILP (gb->extent))
3202 abort (); /* these should have been handled in add_glyph_rune */
3204 if (extent_end_glyph_layout (XEXTENT (gb->extent)) == GL_WHITESPACE)
3206 int width = glyph_width (gb->glyph, window);
3208 if (white_in_end + width <= dl->bounds.right_in)
3211 white_in_end += width;
3215 else if (use_overflow
3216 && (white_out_end + width <= dl->bounds.right_out))
3219 white_out_end += width;
3230 /* Determine how many inside margin glyphs we can display and where
3231 they should start. The inside margin glyphs get whatever space
3232 is left after the whitespace glyphs have been displayed. These
3233 are tricky to calculate since if we decide to use the overflow
3234 area we basically have to start over. So for these we build up a
3235 list of just the inside margin glyphs and manipulate it to
3236 determine the needed info. */
3238 glyph_block_dynarr *ib;
3239 int avail_in, avail_out;
3242 int used_in, used_out;
3245 used_in = used_out = 0;
3246 ib = Dynarr_new (glyph_block);
3247 while (elt < Dynarr_length (dl->right_glyphs))
3249 struct glyph_block *gb = Dynarr_atp (dl->right_glyphs, elt);
3251 if (NILP (gb->extent))
3252 abort (); /* these should have been handled in add_glyph_rune */
3254 if (extent_end_glyph_layout (XEXTENT (gb->extent)) == GL_INSIDE_MARGIN)
3256 gb->width = glyph_width (gb->glyph, window);
3257 used_in += gb->width;
3258 Dynarr_add (ib, *gb);
3267 avail_in = dl->bounds.right_in - white_in_end;
3272 avail_out = dl->bounds.right_out - white_out_end;
3275 while (!done && marker < Dynarr_length (ib))
3277 int width = Dynarr_atp (ib, marker)->width;
3279 /* If everything now fits in the available inside margin
3280 space, we're done. */
3281 if (used_in <= avail_in)
3285 /* Otherwise see if we have room to move a glyph to the
3287 if (used_out + width <= avail_out)
3300 /* At this point we now know that everything from marker on goes in
3301 the inside margin and everything before it goes in the outside
3302 margin. The stuff going into the outside margin is guaranteed
3303 to fit, but we may have to trim some stuff from the inside. */
3305 in_in_start = dl->bounds.right_in;
3306 in_out_end = dl->bounds.right_in;
3307 in_out_cnt = in_in_cnt = 0;
3311 while (elt < Dynarr_length (dl->right_glyphs))
3313 struct glyph_block *gb = Dynarr_atp (dl->right_glyphs, elt);
3315 if (NILP (gb->extent))
3316 abort (); /* these should have been handled in add_glyph_rune */
3318 if (extent_end_glyph_layout (XEXTENT (gb->extent)) == GL_INSIDE_MARGIN)
3320 int width = glyph_width (gb->glyph, window);
3325 in_out_end += width;
3330 else if (in_in_start - width >= white_in_end)
3333 in_in_start -= width;
3345 /* Determine how many outside margin glyphs we can display. They
3346 always start at the right outside margin and can only use the
3347 outside margin space. */
3348 out_start = dl->bounds.right_out;
3352 while (elt < Dynarr_length (dl->right_glyphs))
3354 struct glyph_block *gb = Dynarr_atp (dl->right_glyphs, elt);
3356 if (NILP (gb->extent))
3357 abort (); /* these should have been handled in add_glyph_rune */
3359 if (extent_end_glyph_layout (XEXTENT (gb->extent)) == GL_OUTSIDE_MARGIN)
3361 int width = glyph_width (gb->glyph, window);
3363 if (out_start - width >= in_out_end)
3377 /* Now that we now where everything goes, we add the glyphs as runes
3378 to the appropriate display blocks. */
3379 if (out_cnt || in_out_cnt || white_out_cnt)
3381 odb = get_display_block_from_line (dl, RIGHT_OUTSIDE_MARGIN);
3382 /* #### See comments before odb->start_pos init in
3383 create_left_glyph_block */
3384 odb->start_pos = dl->bounds.right_in;
3385 odb->end_pos = dl->bounds.right_out;
3386 Dynarr_reset (odb->runes);
3391 if (in_in_cnt || white_in_cnt)
3393 idb = get_display_block_from_line (dl, RIGHT_INSIDE_MARGIN);
3394 idb->start_pos = dl->bounds.right_white;
3395 /* #### See comments before odb->start_pos init in
3396 create_left_glyph_block */
3397 idb->end_pos = dl->bounds.right_in;
3398 Dynarr_reset (idb->runes);
3403 /* First add the whitespace margin glyphs which are actually in the
3407 end_xpos = add_margin_runes (dl, idb, dl->bounds.right_white,
3408 white_in_cnt, GL_WHITESPACE, RIGHT_GLYPHS,
3412 end_xpos = dl->bounds.right_white;
3414 /* Make sure that the area between the end of the whitespace glyphs
3415 and the inside margin glyphs is cleared. */
3416 if (in_in_cnt && (in_in_start - end_xpos))
3418 add_margin_blank (dl, idb, w, end_xpos, in_in_start - end_xpos,
3422 /* Next add the inside margin glyphs which are actually in the
3426 end_xpos = add_margin_runes (dl, idb, in_in_start, in_in_cnt,
3427 GL_INSIDE_MARGIN, RIGHT_GLYPHS, window);
3430 /* If we didn't add any inside margin glyphs then make sure the rest
3431 of the inside margin area gets cleared. */
3432 if (idb && (dl->bounds.right_in - end_xpos))
3434 add_margin_blank (dl, idb, w, end_xpos, dl->bounds.right_in - end_xpos,
3438 /* Next add any whitespace glyphs in the outside margin. */
3441 end_xpos = add_margin_runes (dl, odb, dl->bounds.right_in, white_out_cnt,
3442 GL_WHITESPACE, RIGHT_GLYPHS, window);
3445 end_xpos = dl->bounds.right_in;
3447 /* Next add any inside margin glyphs in the outside margin. */
3450 end_xpos = add_margin_runes (dl, odb, end_xpos, in_out_cnt,
3451 GL_INSIDE_MARGIN, RIGHT_GLYPHS, window);
3454 /* There may be space between any whitespace or inside margin glyphs
3455 in the outside margin and the actual outside margin glyphs. */
3456 if (odb && (out_start - end_xpos))
3458 add_margin_blank (dl, odb, w, end_xpos, out_start - end_xpos,
3462 /* Finally, add the outside margin glyphs. */
3465 add_margin_runes (dl, odb, out_start, out_cnt, GL_OUTSIDE_MARGIN,
3466 RIGHT_GLYPHS, window);
3471 /***************************************************************************/
3473 /* modeline routines */
3475 /***************************************************************************/
3477 /* This function is also used in frame.c by `generate_title_string' */
3479 generate_formatted_string_db (Lisp_Object format_str, Lisp_Object result_str,
3480 struct window *w, struct display_line *dl,
3481 struct display_block *db, face_index findex,
3482 int min_pixpos, int max_pixpos, int type)
3484 struct frame *f = XFRAME (w->frame);
3485 struct device *d = XDEVICE (f->device);
3489 Charcount offset = 0;
3495 data.findex = findex;
3496 data.pixpos = min_pixpos;
3497 data.max_pixpos = max_pixpos;
3498 data.cursor_type = NO_CURSOR;
3499 data.last_charset = Qunbound;
3500 data.last_findex = DEFAULT_INDEX;
3501 data.result_str = result_str;
3502 data.is_modeline = 1;
3504 XSETWINDOW (data.window, w);
3506 Dynarr_reset (formatted_string_extent_dynarr);
3507 Dynarr_reset (formatted_string_extent_start_dynarr);
3508 Dynarr_reset (formatted_string_extent_end_dynarr);
3510 /* result_str is nil when we're building a frame or icon title. Otherwise,
3511 we're building a modeline, so the offset starts at the modeline
3512 horizontal scrolling ammount */
3513 if (! NILP (result_str))
3514 offset = w->modeline_hscroll;
3515 generate_fstring_runes (w, &data, 0, 0, -1, format_str, 0,
3516 max_pixpos - min_pixpos, findex, type, &offset,
3519 if (Dynarr_length (db->runes))
3522 Dynarr_atp (db->runes, Dynarr_length (db->runes) - 1);
3523 c_pixpos = rb->xpos + rb->width;
3526 c_pixpos = min_pixpos;
3528 /* If we don't reach the right side of the window, add a blank rune
3529 to make up the difference. This usually only occurs if the
3530 modeline face is using a proportional width font or a fixed width
3531 font of a different size from the default face font. */
3533 if (c_pixpos < max_pixpos)
3535 data.pixpos = c_pixpos;
3536 data.blank_width = max_pixpos - data.pixpos;
3538 add_blank_rune (&data, NULL, 0);
3541 /* Now create the result string and frob the extents into it. */
3542 if (!NILP (result_str))
3547 struct buffer *buf = XBUFFER (WINDOW_BUFFER (w));
3549 in_modeline_generation = 1;
3551 detach_all_extents (result_str);
3552 resize_string (XSTRING (result_str), -1,
3553 data.bytepos - XSTRING_LENGTH (result_str));
3555 strdata = XSTRING_DATA (result_str);
3557 for (elt = 0, len = 0; elt < Dynarr_length (db->runes); elt++)
3559 if (Dynarr_atp (db->runes, elt)->type == RUNE_CHAR)
3561 len += (set_charptr_emchar
3563 CHARC_TO_CHAR (Dynarr_atp (db->runes,
3564 elt)->object.cglyph)));
3568 for (elt = 0; elt < Dynarr_length (formatted_string_extent_dynarr);
3571 Lisp_Object extent = Qnil;
3574 XSETEXTENT (extent, Dynarr_at (formatted_string_extent_dynarr, elt));
3575 child = Fgethash (extent, buf->modeline_extent_table, Qnil);
3578 child = Fmake_extent (Qnil, Qnil, result_str);
3579 Fputhash (extent, child, buf->modeline_extent_table);
3581 Fset_extent_parent (child, extent);
3582 set_extent_endpoints
3584 Dynarr_at (formatted_string_extent_start_dynarr, elt),
3585 Dynarr_at (formatted_string_extent_end_dynarr, elt),
3589 in_modeline_generation = 0;
3593 /* Ensure that the given display line DL accurately represents the
3594 modeline for the given window. */
3596 generate_modeline (struct window *w, struct display_line *dl, int type)
3598 struct buffer *b = XBUFFER (w->buffer);
3599 struct frame *f = XFRAME (w->frame);
3600 struct device *d = XDEVICE (f->device);
3602 /* Unlike display line and rune pointers, this one can't change underneath
3604 struct display_block *db = get_display_block_from_line (dl, TEXT);
3605 int max_pixpos, min_pixpos, ypos_adj;
3606 Lisp_Object font_inst;
3608 /* This will actually determine incorrect inside boundaries for the
3609 modeline since it ignores the margins. However being aware of this fact
3610 we never use those values anywhere so it doesn't matter. */
3611 dl->bounds = calculate_display_line_boundaries (w, 1);
3613 /* We are generating a modeline. */
3615 dl->cursor_elt = -1;
3617 /* Reset the runes on the modeline. */
3618 Dynarr_reset (db->runes);
3620 if (!WINDOW_HAS_MODELINE_P (w))
3624 /* If there is a horizontal scrollbar, don't add anything. */
3625 if (window_scrollbar_height (w))
3628 dl->ascent = DEVMETH (d, divider_height, ());
3630 /* The modeline is at the bottom of the gutters. */
3631 dl->ypos = WINDOW_BOTTOM (w);
3633 rb.findex = MODELINE_INDEX;
3634 rb.xpos = dl->bounds.left_out;
3635 rb.width = dl->bounds.right_out - dl->bounds.left_out;
3638 rb.type = RUNE_HLINE;
3639 rb.object.hline.thickness = 1;
3640 rb.object.hline.yoffset = 0;
3641 rb.cursor_type = NO_CURSOR;
3643 if (!EQ (Qzero, w->modeline_shadow_thickness)
3646 int shadow_thickness = MODELINE_SHADOW_THICKNESS (w);
3648 dl->ypos -= shadow_thickness;
3649 rb.xpos += shadow_thickness;
3650 rb.width -= 2 * shadow_thickness;
3653 Dynarr_add (db->runes, rb);
3657 /* !!#### not right; needs to compute the max height of
3659 font_inst = WINDOW_FACE_CACHEL_FONT (w, MODELINE_INDEX, Vcharset_ascii);
3661 dl->ascent = XFONT_INSTANCE (font_inst)->ascent;
3662 dl->descent = XFONT_INSTANCE (font_inst)->descent;
3664 min_pixpos = dl->bounds.left_out;
3665 max_pixpos = dl->bounds.right_out;
3667 if (!EQ (Qzero, w->modeline_shadow_thickness) && FRAME_WIN_P (f))
3669 int shadow_thickness = MODELINE_SHADOW_THICKNESS (w);
3671 ypos_adj = shadow_thickness;
3672 min_pixpos += shadow_thickness;
3673 max_pixpos -= shadow_thickness;
3678 generate_formatted_string_db (b->modeline_format,
3679 b->generated_modeline_string, w, dl, db,
3680 MODELINE_INDEX, min_pixpos, max_pixpos, type);
3682 /* The modeline is at the bottom of the gutters. We have to wait to
3683 set this until we've generated the modeline in order to account
3684 for any embedded faces. */
3685 dl->ypos = WINDOW_BOTTOM (w) - dl->descent - ypos_adj;
3689 add_string_to_fstring_db_runes (pos_data *data, const Bufbyte *str,
3690 Charcount pos, Charcount min_pos, Charcount max_pos)
3692 /* This function has been Mule-ized. */
3694 const Bufbyte *cur_pos = str;
3695 struct display_block *db = data->db;
3697 data->blank_width = space_width (XWINDOW (data->window));
3698 while (Dynarr_length (db->runes) < pos)
3699 add_blank_rune (data, NULL, 0);
3701 end = (Dynarr_length (db->runes) +
3702 bytecount_to_charcount (str, strlen ((const char *) str)));
3704 end = min (max_pos, end);
3706 while (pos < end && *cur_pos)
3708 const Bufbyte *old_cur_pos = cur_pos;
3711 data->ch = charptr_emchar (cur_pos);
3712 succeeded = (add_emchar_rune (data) != ADD_FAILED);
3713 INC_CHARPTR (cur_pos);
3717 data->modeline_charpos++;
3718 data->bytepos += cur_pos - old_cur_pos;
3722 while (Dynarr_length (db->runes) < min_pos &&
3723 (data->pixpos + data->blank_width <= data->max_pixpos))
3724 add_blank_rune (data, NULL, 0);
3726 return Dynarr_length (db->runes);
3729 /* #### Urk! Should also handle begin-glyphs and end-glyphs in
3730 modeline extents. */
3732 add_glyph_to_fstring_db_runes (pos_data *data, Lisp_Object glyph,
3733 Charcount pos, Charcount min_pos,
3734 Charcount max_pos, Lisp_Object extent)
3736 /* This function has been Mule-ized. */
3738 struct display_block *db = data->db;
3739 struct glyph_block gb;
3741 data->blank_width = space_width (XWINDOW (data->window));
3742 while (Dynarr_length (db->runes) < pos)
3743 add_blank_rune (data, NULL, 0);
3745 end = Dynarr_length (db->runes) + 1;
3747 end = min (max_pos, end);
3751 add_glyph_rune (data, &gb, BEGIN_GLYPHS, 0, 0);
3754 while (Dynarr_length (db->runes) < pos &&
3755 (data->pixpos + data->blank_width <= data->max_pixpos))
3756 add_blank_rune (data, NULL, 0);
3758 return Dynarr_length (db->runes);
3761 /* If max_pos is == -1, it is considered to be infinite. The same is
3762 true of max_pixsize. */
3763 #define SET_CURRENT_MODE_CHARS_PIXSIZE \
3764 if (Dynarr_length (data->db->runes)) \
3765 cur_pixsize = data->pixpos - Dynarr_atp (data->db->runes, 0)->xpos; \
3769 /* Note that this function does "positions" in terms of characters and
3770 not in terms of columns. This is necessary to make the formatting
3771 work correctly when proportional width fonts are used in the
3774 generate_fstring_runes (struct window *w, pos_data *data, Charcount pos,
3775 Charcount min_pos, Charcount max_pos,
3776 Lisp_Object elt, int depth, int max_pixsize,
3777 face_index findex, int type, Charcount *offset,
3778 Lisp_Object cur_ext)
3780 /* This function has been Mule-ized. */
3781 /* #### The other losing things in this function are:
3783 -- C zero-terminated-string lossage.
3784 -- Non-printable characters should be converted into something
3785 appropriate (e.g. ^F) instead of blindly being printed anyway.
3796 /* A string. Add to the display line and check for %-constructs
3799 Bufbyte *this = XSTRING_DATA (elt);
3801 while ((pos < max_pos || max_pos == -1) && *this)
3803 Bufbyte *last = this;
3805 while (*this && *this != '%')
3810 /* No %-construct */
3812 bytecount_to_charcount (last, this - last);
3814 if (size <= *offset)
3818 Charcount tmp_max = (max_pos == -1 ? pos + size - *offset :
3819 min (pos + size - *offset, max_pos));
3820 const Bufbyte *tmp_last = charptr_n_addr (last, *offset);
3822 pos = add_string_to_fstring_db_runes (data, tmp_last,
3827 else /* *this == '%' */
3829 Charcount spec_width = 0;
3831 this++; /* skip over '%' */
3833 /* We can't allow -ve args due to the "%-" construct.
3834 * Argument specifies minwidth but not maxwidth
3835 * (maxwidth can be specified by
3836 * (<negative-number> . <stuff>) modeline elements)
3838 while (isdigit (*this))
3840 spec_width = spec_width * 10 + (*this - '0');
3847 pos = generate_fstring_runes (w, data, pos, spec_width,
3848 max_pos, Vglobal_mode_string,
3849 depth, max_pixsize, findex,
3850 type, offset, cur_ext);
3852 else if (*this == '-')
3854 Charcount num_to_add;
3856 if (max_pixsize < 0)
3858 else if (max_pos != -1)
3859 num_to_add = max_pos - pos;
3865 SET_CURRENT_MODE_CHARS_PIXSIZE;
3868 redisplay_text_width_string (w, findex, &ch, Qnil, 0,
3871 num_to_add = (max_pixsize - cur_pixsize) / dash_pixsize;
3875 while (num_to_add--)
3876 pos = add_string_to_fstring_db_runes
3877 (data, (const Bufbyte *) "-", pos, pos, max_pos);
3879 else if (*this != 0)
3881 Emchar ch = charptr_emchar (this);
3885 decode_mode_spec (w, ch, type);
3887 str = Dynarr_atp (mode_spec_bufbyte_string, 0);
3888 size = bytecount_to_charcount
3889 /* Skip the null character added by `decode_mode_spec' */
3890 (str, Dynarr_length (mode_spec_bufbyte_string)) - 1;
3892 if (size <= *offset)
3896 const Bufbyte *tmp_str = charptr_n_addr (str, *offset);
3898 /* #### NOTE: I don't understand why a tmp_max is not
3899 computed and used here as in the plain string case
3901 pos = add_string_to_fstring_db_runes (data, tmp_str,
3908 /* NOT this++. There could be any sort of character at
3909 the current position. */
3913 if (max_pixsize > 0)
3916 SET_CURRENT_MODE_CHARS_PIXSIZE;
3918 if (cur_pixsize >= max_pixsize)
3923 else if (SYMBOLP (elt))
3925 /* A symbol: process the value of the symbol recursively
3926 as if it appeared here directly. */
3927 Lisp_Object tem = symbol_value_in_buffer (elt, w->buffer);
3929 if (!UNBOUNDP (tem))
3931 /* If value is a string, output that string literally:
3932 don't check for % within it. */
3935 Bufbyte *str = XSTRING_DATA (tem);
3936 Charcount size = XSTRING_CHAR_LENGTH (tem);
3938 if (size <= *offset)
3942 const Bufbyte *tmp_str = charptr_n_addr (str, *offset);
3944 /* #### NOTE: I don't understand why a tmp_max is not
3945 computed and used here as in the plain string case
3947 pos = add_string_to_fstring_db_runes (data, tmp_str, pos,
3952 /* Give up right away for nil or t. */
3953 else if (!EQ (tem, elt))
3960 else if (GENERIC_SPECIFIERP (elt))
3962 Lisp_Object window, tem;
3963 XSETWINDOW (window, w);
3964 tem = specifier_instance_no_quit (elt, Qunbound, window,
3965 ERROR_ME_NOT, 0, Qzero);
3966 if (!UNBOUNDP (tem))
3972 else if (CONSP (elt))
3974 /* A cons cell: four distinct cases.
3975 * - If first element is a string or a cons, process all the elements
3976 * and effectively concatenate them.
3977 * - If first element is a negative number, truncate displaying cdr to
3978 * at most that many characters. If positive, pad (with spaces)
3979 * to at least that many characters.
3980 * - If first element is another symbol, process the cadr or caddr
3981 * recursively according to whether the symbol's value is non-nil or
3983 * - If first element is an extent, process the cdr recursively
3984 * and handle the extent's face.
3987 Lisp_Object car, tem;
3996 tem = symbol_value_in_buffer (car, w->buffer);
3997 /* elt is now the cdr, and we know it is a cons cell.
3998 Use its car if CAR has a non-nil value. */
3999 if (!UNBOUNDP (tem))
4007 /* Symbol's value is nil (or symbol is unbound)
4008 * Get the cddr of the original list
4009 * and if possible find the caddr and use that.
4014 else if (!CONSP (elt))
4022 else if (INTP (car))
4024 Charcount lim = XINT (car);
4030 /* Negative int means reduce maximum width.
4031 * DO NOT change MIN_PIXPOS here!
4032 * (20 -10 . foo) should truncate foo to 10 col
4033 * and then pad to 20.
4036 max_pos = pos - lim;
4038 max_pos = min (max_pos, pos - lim);
4042 /* Padding specified. Don't let it be more than
4046 if (max_pos != -1 && lim > max_pos)
4048 /* If that's more padding than already wanted, queue it.
4049 * But don't reduce padding already specified even if
4050 * that is beyond the current truncation point.
4057 else if (STRINGP (car) || CONSP (car))
4061 /* LIMIT is to protect against circular lists. */
4062 while (CONSP (elt) && --limit > 0
4063 && (pos < max_pos || max_pos == -1))
4065 pos = generate_fstring_runes (w, data, pos, pos, max_pos,
4066 XCAR (elt), depth, max_pixsize,
4067 findex, type, offset, cur_ext);
4071 else if (EXTENTP (car))
4073 struct extent *ext = XEXTENT (car);
4075 if (EXTENT_LIVE_P (ext))
4077 face_index old_findex = data->findex;
4079 Lisp_Object font_inst;
4080 face_index new_findex;
4081 Bytecount start = data->bytepos;
4083 face = extent_face (ext);
4086 /* #### needs to merge faces, sigh */
4087 /* #### needs to handle list of faces */
4088 new_findex = get_builtin_face_cache_index (w, face);
4089 /* !!#### not right; needs to compute the max height of
4091 font_inst = WINDOW_FACE_CACHEL_FONT (w, new_findex,
4094 data->dl->ascent = max (data->dl->ascent,
4095 XFONT_INSTANCE (font_inst)->ascent);
4096 data->dl->descent = max (data->dl->descent,
4097 XFONT_INSTANCE (font_inst)->
4101 new_findex = old_findex;
4103 data->findex = new_findex;
4104 pos = generate_fstring_runes (w, data, pos, pos, max_pos,
4105 XCDR (elt), depth - 1,
4106 max_pixsize, new_findex, type,
4108 data->findex = old_findex;
4109 Dynarr_add (formatted_string_extent_dynarr, ext);
4110 Dynarr_add (formatted_string_extent_start_dynarr, start);
4111 Dynarr_add (formatted_string_extent_end_dynarr, data->bytepos);
4115 else if (GLYPHP (elt))
4117 /* Glyphs are considered as one character with respect to the modeline
4118 horizontal scrolling facility. -- dv */
4122 pos = add_glyph_to_fstring_db_runes (data, elt, pos, pos, max_pos,
4129 char *str = GETTEXT ("*invalid*");
4130 Charcount size = (Charcount) strlen (str); /* is this ok ?? -- dv */
4132 if (size <= *offset)
4136 const Bufbyte *tmp_str =
4137 charptr_n_addr ((const Bufbyte *) str, *offset);
4139 /* #### NOTE: I don't understand why a tmp_max is not computed and
4140 used here as in the plain string case above. -- dv */
4141 pos = add_string_to_fstring_db_runes (data, tmp_str, pos,
4150 add_string_to_fstring_db_runes (data, (const Bufbyte *) "", pos,
4157 /* Update just the modeline. Assumes the desired display structs. If
4158 they do not have a modeline block, it does nothing. */
4160 regenerate_modeline (struct window *w)
4162 display_line_dynarr *dla = window_display_lines (w, DESIRED_DISP);
4164 if (!Dynarr_length (dla) || !Dynarr_atp (dla, 0)->modeline)
4168 generate_modeline (w, Dynarr_atp (dla, 0), DESIRED_DISP);
4169 redisplay_update_line (w, 0, 0, 0);
4173 /* Make sure that modeline display line is present in the given
4174 display structs if the window has a modeline and update that
4175 line. Returns true if a modeline was needed. */
4177 ensure_modeline_generated (struct window *w, int type)
4181 /* minibuffer windows don't have modelines */
4182 if (MINI_WINDOW_P (w))
4184 /* windows which haven't had it turned off do */
4185 else if (WINDOW_HAS_MODELINE_P (w))
4187 /* windows which have it turned off don't have a divider if there is
4188 a horizontal scrollbar */
4189 else if (window_scrollbar_height (w))
4191 /* and in this case there is none */
4197 display_line_dynarr *dla;
4199 dla = window_display_lines (w, type);
4201 /* We don't care if there is a display line which is not
4202 currently a modeline because it is definitely going to become
4203 one if we have gotten to this point. */
4204 if (Dynarr_length (dla) == 0)
4206 if (Dynarr_largest (dla) > 0)
4208 struct display_line *mlp = Dynarr_atp (dla, 0);
4209 Dynarr_add (dla, *mlp);
4213 struct display_line modeline;
4215 Dynarr_add (dla, modeline);
4219 /* If we're adding a new place marker go ahead and generate the
4220 modeline so that it is available for use by
4221 window_modeline_height. */
4222 generate_modeline (w, Dynarr_atp (dla, 0), type);
4225 return need_modeline;
4228 /* #### Kludge or not a kludge. I tend towards the former. */
4230 real_current_modeline_height (struct window *w)
4232 Fset_marker (w->start[CMOTION_DISP], w->start[CURRENT_DISP], w->buffer);
4233 Fset_marker (w->pointm[CMOTION_DISP], w->pointm[CURRENT_DISP], w->buffer);
4235 if (ensure_modeline_generated (w, CMOTION_DISP))
4237 display_line_dynarr *dla = window_display_lines (w, CMOTION_DISP);
4239 if (Dynarr_length (dla))
4241 if (Dynarr_atp (dla, 0)->modeline)
4242 return (Dynarr_atp (dla, 0)->ascent +
4243 Dynarr_atp (dla, 0)->descent);
4250 /***************************************************************************/
4252 /* displayable string routines */
4254 /***************************************************************************/
4256 /* Given a position for a string in a window, ensure that the given
4257 display line DL accurately represents the text on a line starting
4258 at the given position.
4260 Yes, this is duplicating the code of create_text_block, but it
4261 looked just too hard to change create_text_block to handle strings
4262 *and* buffers. We already make a distinction between the two
4263 elsewhere in the code so I think unifying them would require a
4264 complete MULE rewrite. Besides, the other distinction is that these
4265 functions cover text that the user *cannot edit* so we can remove
4266 everything to do with cursors, minibuffers etc. Eventually the
4267 modeline routines should be modified to use this code as it copes
4268 with many more types of display situation. */
4271 create_string_text_block (struct window *w, Lisp_Object disp_string,
4272 struct display_line *dl,
4274 prop_block_dynarr **prop,
4275 face_index default_face)
4277 struct frame *f = XFRAME (w->frame);
4278 /* Note that a lot of the buffer controlled stuff has been left in
4279 because you might well want to make use of it (selective display
4280 etc), its just the buffer text that we do not use. However, it
4281 seems to be possible for buffer to be nil sometimes so protect
4282 against this case. */
4283 struct buffer *b = BUFFERP (w->buffer) ? XBUFFER (w->buffer) : 0;
4284 struct device *d = XDEVICE (f->device);
4285 Lisp_String* s = XSTRING (disp_string);
4287 /* we're working with these a lot so precalculate them */
4288 Bytecount slen = XSTRING_LENGTH (disp_string);
4289 Bytecount bi_string_zv = slen;
4290 Bytind bi_start_pos = charcount_to_bytecount (string_data (s), start_pos);
4294 int truncate_win = b ? window_truncation_on (w) : 0;
4295 int end_glyph_width = 0;
4297 /* we're going to ditch selective display for static text, its an
4298 FSF thing and invisble extents are the way to go
4299 here. Implementing it also relies on a number of buffer-specific
4300 functions that we don't have the luxury of being able to use
4303 /* The variable ctl-arrow allows the user to specify what characters
4304 can actually be displayed and which octal should be used for.
4305 #### This variable should probably have some rethought done to
4308 #### It would also be really nice if you could specify that
4309 the characters come out in hex instead of in octal. Mule
4310 does that by adding a ctl-hexa variable similar to ctl-arrow,
4311 but that's bogus -- we need a more general solution. I
4312 think you need to extend the concept of display tables
4313 into a more general conversion mechanism. Ideally you
4314 could specify a Lisp function that converts characters,
4315 but this violates the Second Golden Rule and besides would
4316 make things way way way way slow.
4318 So instead, we extend the display-table concept, which was
4319 historically limited to 256-byte vectors, to one of the
4322 a) A 256-entry vector, for backward compatibility;
4323 b) char-table, mapping characters to values;
4324 c) range-table, mapping ranges of characters to values;
4325 d) a list of the above.
4327 The (d) option allows you to specify multiple display tables
4328 instead of just one. Each display table can specify conversions
4329 for some characters and leave others unchanged. The way the
4330 character gets displayed is determined by the first display table
4331 with a binding for that character. This way, you could call a
4332 function `enable-hex-display' that adds a hex display-table to
4333 the list of display tables for the current buffer.
4335 #### ...not yet implemented... Also, we extend the concept of
4336 "mapping" to include a printf-like spec. Thus you can make all
4337 extended characters show up as hex with a display table like
4340 #s(range-table data ((256 524288) (format "%x")))
4342 Since more than one display table is possible, you have
4343 great flexibility in mapping ranges of characters. */
4344 Emchar printable_min = b ? (CHAR_OR_CHAR_INTP (b->ctl_arrow)
4345 ? XCHAR_OR_CHAR_INT (b->ctl_arrow)
4346 : ((EQ (b->ctl_arrow, Qt) || EQ (b->ctl_arrow, Qnil))
4347 ? 255 : 160)) : 255;
4349 Lisp_Object face_dt, window_dt;
4351 /* The text display block for this display line. */
4352 struct display_block *db = get_display_block_from_line (dl, TEXT);
4354 /* The first time through the main loop we need to force the glyph
4355 data to be updated. */
4358 /* Apparently the new extent_fragment_update returns an end position
4359 equal to the position passed in if there are no more runs to be
4361 int no_more_frags = 0;
4363 dl->used_prop_data = 0;
4365 dl->line_continuation = 0;
4367 /* set up faces to use for clearing areas, used by
4368 output_display_line */
4369 dl->default_findex = default_face;
4372 dl->left_margin_findex = default_face;
4373 dl->right_margin_findex = default_face;
4377 dl->left_margin_findex =
4378 get_builtin_face_cache_index (w, Vleft_margin_face);
4379 dl->right_margin_findex =
4380 get_builtin_face_cache_index (w, Vright_margin_face);
4384 data.ef = extent_fragment_new (disp_string, f);
4386 /* These values are used by all of the rune addition routines. We add
4387 them to this structure for ease of passing. */
4389 XSETWINDOW (data.window, w);
4393 data.bi_bufpos = bi_start_pos;
4394 data.pixpos = dl->bounds.left_in;
4395 data.last_charset = Qunbound;
4396 data.last_findex = default_face;
4397 data.result_str = Qnil;
4398 data.string = disp_string;
4400 /* Set the right boundary adjusting it to take into account any end
4401 glyph. Save the width of the end glyph for later use. */
4402 data.max_pixpos = dl->bounds.right_in;
4405 end_glyph_width = GLYPH_CACHEL_WIDTH (w, TRUN_GLYPH_INDEX);
4407 end_glyph_width = GLYPH_CACHEL_WIDTH (w, CONT_GLYPH_INDEX);
4409 data.max_pixpos -= end_glyph_width;
4411 data.cursor_type = NO_CURSOR;
4415 /* I don't think we want this, string areas should not scroll with
4417 data.start_col = w->hscroll;
4418 data.bi_start_col_enabled = (w->hscroll ? bi_start_pos : 0);
4420 data.bi_start_col_enabled = 0;
4421 data.hscroll_glyph_width_adjust = 0;
4423 /* We regenerate the line from the very beginning. */
4424 Dynarr_reset (db->runes);
4426 /* Why is this less than or equal and not just less than? If the
4427 starting position is already equal to the maximum we can't add
4428 anything else, right? Wrong. We might still have a newline to
4429 add. A newline can use the room allocated for an end glyph since
4430 if we add it we know we aren't going to be adding any end
4433 /* #### Chuck -- I think this condition should be while (1).
4434 Otherwise if (e.g.) there is one begin-glyph and one end-glyph
4435 and the begin-glyph ends exactly at the end of the window, the
4436 end-glyph and text might not be displayed. while (1) ensures
4437 that the loop terminates only when either (a) there is
4438 propagation data or (b) the end-of-line or end-of-buffer is hit.
4440 #### Also I think you need to ensure that the operation
4441 "add begin glyphs; add end glyphs; add text" is atomic and
4442 can't get interrupted in the middle. If you run off the end
4443 of the line during that operation, then you keep accumulating
4444 propagation data until you're done. Otherwise, if the (e.g.)
4445 there's a begin glyph at a particular position and attempting
4446 to display that glyph results in window-end being hit and
4447 propagation data being generated, then the character at that
4448 position won't be displayed.
4450 #### See also the comment after the end of this loop, below.
4452 while (data.pixpos <= data.max_pixpos)
4454 /* #### This check probably should not be necessary. */
4455 if (data.bi_bufpos > bi_string_zv)
4457 /* #### urk! More of this lossage! */
4462 /* Check for face changes. */
4463 if (initial || (!no_more_frags && data.bi_bufpos == data.ef->end))
4465 /* Now compute the face and begin/end-glyph information. */
4467 /* Remember that the extent-fragment routines deal in Bytind's. */
4468 extent_fragment_update (w, data.ef, data.bi_bufpos);
4469 /* This is somewhat cheesy but the alternative is to
4470 propagate default_face into extent_fragment_update. */
4471 if (data.findex == DEFAULT_INDEX)
4472 data.findex = default_face;
4474 get_display_tables (w, data.findex, &face_dt, &window_dt);
4476 if (data.bi_bufpos == data.ef->end)
4481 /* Determine what is next to be displayed. We first handle any
4482 glyphs returned by glyphs_at_bufpos. If there are no glyphs to
4483 display then we determine what to do based on the character at the
4484 current buffer position. */
4486 /* If the current position is covered by an invisible extent, do
4487 nothing (except maybe add some ellipses).
4489 #### The behavior of begin and end-glyphs at the edge of an
4490 invisible extent should be investigated further. This is
4491 fairly low priority though. */
4492 if (data.ef->invisible)
4494 /* #### Chuck, perhaps you could look at this code? I don't
4495 really know what I'm doing. */
4498 Dynarr_free (*prop);
4502 /* The extent fragment code only sets this when we should
4503 really display the ellipses. It makes sure the ellipses
4504 don't get displayed more than once in a row. */
4505 if (data.ef->invisible_ellipses)
4507 struct glyph_block gb;
4509 data.ef->invisible_ellipses_already_displayed = 1;
4510 data.ef->invisible_ellipses = 0;
4512 gb.glyph = Vinvisible_text_glyph;
4513 *prop = add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0,
4514 GLYPH_CACHEL (w, INVIS_GLYPH_INDEX));
4515 /* Perhaps they shouldn't propagate if the very next thing
4516 is to display a newline (for compatibility with
4517 selective-display-ellipses)? Maybe that's too
4523 /* #### What if we we're dealing with a display table? */
4527 if (data.bi_bufpos == bi_string_zv)
4530 INC_CHARBYTIND (string_data (s), data.bi_bufpos);
4533 /* If there is propagation data, then it represents the current
4534 buffer position being displayed. Add them and advance the
4535 position counter. This might also add the minibuffer
4539 dl->used_prop_data = 1;
4540 *prop = add_propagation_runes (prop, &data);
4543 goto done; /* gee, a really narrow window */
4544 else if (data.bi_bufpos == bi_string_zv)
4546 else if (data.bi_bufpos < 0)
4547 /* #### urk urk urk! Aborts are not very fun! Fix this please! */
4550 INC_CHARBYTIND (string_data (s), data.bi_bufpos);
4553 /* If there are end glyphs, add them to the line. These are
4554 the end glyphs for the previous run of text. We add them
4555 here rather than doing them at the end of handling the
4556 previous run so that glyphs at the beginning and end of
4557 a line are handled correctly. */
4558 else if (Dynarr_length (data.ef->end_glyphs) > 0)
4560 *prop = add_glyph_runes (&data, END_GLYPHS);
4565 /* If there are begin glyphs, add them to the line. */
4566 else if (Dynarr_length (data.ef->begin_glyphs) > 0)
4568 *prop = add_glyph_runes (&data, BEGIN_GLYPHS);
4573 /* If at end-of-buffer, we've already processed begin and
4574 end-glyphs at this point and there's no text to process,
4576 else if (data.bi_bufpos == bi_string_zv)
4581 Lisp_Object entry = Qnil;
4582 /* Get the character at the current buffer position. */
4583 data.ch = string_char (s, data.bi_bufpos);
4584 if (!NILP (face_dt) || !NILP (window_dt))
4585 entry = display_table_entry (data.ch, face_dt, window_dt);
4587 /* If there is a display table entry for it, hand it off to
4588 add_disp_table_entry_runes and let it worry about it. */
4589 if (!NILP (entry) && !EQ (entry, make_char (data.ch)))
4591 *prop = add_disp_table_entry_runes (&data, entry);
4597 /* Check if we have hit a newline character. If so, add a marker
4598 to the line and end this loop. */
4599 else if (data.ch == '\n')
4601 /* We aren't going to be adding an end glyph so give its
4602 space back in order to make sure that the cursor can
4604 data.max_pixpos += end_glyph_width;
4608 /* If the current character is considered to be printable, then
4610 else if (data.ch >= printable_min)
4612 *prop = add_emchar_rune (&data);
4617 /* If the current character is a tab, determine the next tab
4618 starting position and add a blank rune which extends from the
4619 current pixel position to that starting position. */
4620 else if (data.ch == '\t')
4622 int tab_start_pixpos = data.pixpos;
4627 if (data.start_col > 1)
4628 tab_start_pixpos -= (space_width (w) * (data.start_col - 1));
4631 next_tab_position (w, tab_start_pixpos,
4632 dl->bounds.left_in +
4633 data.hscroll_glyph_width_adjust);
4634 if (next_tab_start > data.max_pixpos)
4636 prop_width = next_tab_start - data.max_pixpos;
4637 next_tab_start = data.max_pixpos;
4639 data.blank_width = next_tab_start - data.pixpos;
4641 (next_tab_start - tab_start_pixpos) / space_width (w);
4643 *prop = add_blank_rune (&data, w, char_tab_width);
4645 /* add_blank_rune is only supposed to be called with
4646 sizes guaranteed to fit in the available space. */
4651 struct prop_block pb;
4652 *prop = Dynarr_new (prop_block);
4654 pb.type = PROP_BLANK;
4655 pb.data.p_blank.width = prop_width;
4656 pb.data.p_blank.findex = data.findex;
4657 Dynarr_add (*prop, pb);
4663 /* If character is a control character, pass it off to
4664 add_control_char_runes.
4666 The is_*() routines have undefined results on
4667 arguments outside of the range [-1, 255]. (This
4668 often bites people who carelessly use `char' instead
4669 of `unsigned char'.)
4671 else if (data.ch < 0x100 && iscntrl ((Bufbyte) data.ch))
4673 *prop = add_control_char_runes (&data, b);
4679 /* If the character is above the ASCII range and we have not
4680 already handled it, then print it as an octal number. */
4681 else if (data.ch >= 0200)
4683 *prop = add_octal_runes (&data);
4689 /* Assume the current character is considered to be printable,
4690 then just add it. */
4693 *prop = add_emchar_rune (&data);
4698 INC_CHARBYTIND (string_data (s), data.bi_bufpos);
4704 /* Determine the starting point of the next line if we did not hit the
4705 end of the buffer. */
4706 if (data.bi_bufpos < bi_string_zv)
4708 /* #### This check is not correct. If the line terminated
4709 due to a begin-glyph or end-glyph hitting window-end, then
4710 data.ch will not point to the character at data.bi_bufpos. If
4711 you make the two changes mentioned at the top of this loop,
4712 you should be able to say '(if (*prop))'. That should also
4713 make it possible to eliminate the data.bi_bufpos < BI_BUF_ZV (b)
4716 /* The common case is that the line ended because we hit a newline.
4717 In that case, the next character is just the next buffer
4719 if (data.ch == '\n')
4721 INC_CHARBYTIND (string_data (s), data.bi_bufpos);
4724 /* Otherwise we have a buffer line which cannot fit on one display
4728 struct glyph_block gb;
4729 struct glyph_cachel *cachel;
4731 /* If the line is to be truncated then we actually have to look
4732 for the next newline. We also add the end-of-line glyph which
4733 we know will fit because we adjusted the right border before
4734 we starting laying out the line. */
4735 data.max_pixpos += end_glyph_width;
4736 data.findex = default_face;
4743 /* Now find the start of the next line. */
4744 bi_pos = bi_find_next_emchar_in_string (s, '\n', data.bi_bufpos, 1);
4746 data.cursor_type = NO_CURSOR;
4747 data.bi_bufpos = bi_pos;
4748 gb.glyph = Vtruncation_glyph;
4749 cachel = GLYPH_CACHEL (w, TRUN_GLYPH_INDEX);
4753 /* The cursor can never be on the continuation glyph. */
4754 data.cursor_type = NO_CURSOR;
4756 /* data.bi_bufpos is already at the start of the next line. */
4758 dl->line_continuation = 1;
4759 gb.glyph = Vcontinuation_glyph;
4760 cachel = GLYPH_CACHEL (w, CONT_GLYPH_INDEX);
4763 if (end_glyph_width)
4764 add_glyph_rune (&data, &gb, BEGIN_GLYPHS, 0, cachel);
4766 if (truncate_win && data.bi_bufpos == bi_string_zv)
4768 const Bufbyte* endb = charptr_n_addr (string_data (s), bi_string_zv);
4770 if (charptr_emchar (endb) != '\n')
4772 /* #### Damn this losing shit. */
4778 else if (data.bi_bufpos == bi_string_zv)
4780 /* create_text_block () adds a bogus \n marker here which screws
4781 up subwindow display. Since we never have a cursor in the
4782 gutter we can safely ignore it. */
4784 /* Calculate left whitespace boundary. */
4788 /* Whitespace past a newline is considered right whitespace. */
4789 while (elt < Dynarr_length (db->runes))
4791 struct rune *rb = Dynarr_atp (db->runes, elt);
4793 if ((rb->type == RUNE_CHAR && CHARC_ASCII_EQ (rb->object.cglyph, ' '))
4794 || rb->type == RUNE_BLANK)
4796 dl->bounds.left_white += rb->width;
4800 elt = Dynarr_length (db->runes);
4804 /* Calculate right whitespace boundary. */
4806 int elt = Dynarr_length (db->runes) - 1;
4809 while (!done && elt >= 0)
4811 struct rune *rb = Dynarr_atp (db->runes, elt);
4813 if (!(rb->type == RUNE_CHAR && CHARC_IS_SPACE (rb->object.cglyph))
4814 && !rb->type == RUNE_BLANK)
4816 dl->bounds.right_white = rb->xpos + rb->width;
4824 /* The line is blank so everything is considered to be right
4827 dl->bounds.right_white = dl->bounds.left_in;
4830 /* Set the display blocks bounds. */
4831 db->start_pos = dl->bounds.left_in;
4832 if (Dynarr_length (db->runes))
4834 struct rune *rb = Dynarr_atp (db->runes, Dynarr_length (db->runes) - 1);
4836 db->end_pos = rb->xpos + rb->width;
4839 db->end_pos = dl->bounds.right_white;
4841 /* update line height parameters */
4842 if (!data.new_ascent && !data.new_descent)
4844 /* We've got a blank line so initialize these values from the default
4846 default_face_font_info (data.window, &data.new_ascent,
4847 &data.new_descent, 0, 0, 0);
4850 if (data.max_pixmap_height)
4852 int height = data.new_ascent + data.new_descent;
4853 int pix_ascent, pix_descent;
4855 pix_descent = data.max_pixmap_height * data.new_descent / height;
4856 pix_ascent = data.max_pixmap_height - pix_descent;
4858 data.new_ascent = max (data.new_ascent, pix_ascent);
4859 data.new_descent = max (data.new_descent, pix_descent);
4862 dl->ascent = data.new_ascent;
4863 dl->descent = data.new_descent;
4866 unsigned short ascent = (unsigned short) XINT (w->minimum_line_ascent);
4868 if (dl->ascent < ascent)
4869 dl->ascent = ascent;
4872 unsigned short descent = (unsigned short) XINT (w->minimum_line_descent);
4874 if (dl->descent < descent)
4875 dl->descent = descent;
4878 dl->cursor_elt = data.cursor_x;
4879 /* #### lossage lossage lossage! Fix this shit! */
4880 if (data.bi_bufpos > bi_string_zv)
4881 dl->end_bufpos = buffer_or_string_bytind_to_bufpos (disp_string, bi_string_zv);
4883 dl->end_bufpos = buffer_or_string_bytind_to_bufpos (disp_string, data.bi_bufpos) - 1;
4885 data.dl->num_chars =
4886 string_column_at_point (s, dl->end_bufpos, b ? XINT (b->tab_width) : 8);
4888 /* This doesn't correctly take into account tabs and control
4889 characters but if the window isn't being truncated then this
4890 value isn't going to end up being used anyhow. */
4891 data.dl->num_chars = dl->end_bufpos - dl->bufpos;
4893 /* #### handle horizontally scrolled line with text none of which
4894 was actually laid out. */
4896 /* #### handle any remainder of overlay arrow */
4898 if (*prop == ADD_FAILED)
4901 if (truncate_win && *prop)
4903 Dynarr_free (*prop);
4907 extent_fragment_delete (data.ef);
4909 /* #### If we started at EOB, then make sure we return a value past
4910 it so that regenerate_window will exit properly. This is bogus.
4911 The main loop should get fixed so that it isn't necessary to call
4912 this function if we are already at EOB. */
4914 if (data.bi_bufpos == bi_string_zv && bi_start_pos == bi_string_zv)
4915 return bytecount_to_charcount (string_data (s), data.bi_bufpos) + 1; /* Yuck! */
4917 return bytecount_to_charcount (string_data (s), data.bi_bufpos);
4920 /* Given a display line and a starting position, ensure that the
4921 contents of the display line accurately represent the visual
4922 representation of the buffer contents starting from the given
4923 position when displayed in the given window. The display line ends
4924 when the contents of the line reach the right boundary of the given
4927 This is very similar to generate_display_line but with the same
4928 limitations as create_string_text_block. I have taken the liberty
4929 of fixing the bytind stuff though.*/
4932 generate_string_display_line (struct window *w, Lisp_Object disp_string,
4933 struct display_line *dl,
4935 prop_block_dynarr **prop,
4936 face_index default_face)
4940 /* you must set bounds before calling this. */
4942 /* Reset what this line is using. */
4943 if (dl->display_blocks)
4944 Dynarr_reset (dl->display_blocks);
4945 if (dl->left_glyphs)
4947 Dynarr_free (dl->left_glyphs);
4948 dl->left_glyphs = 0;
4950 if (dl->right_glyphs)
4952 Dynarr_free (dl->right_glyphs);
4953 dl->right_glyphs = 0;
4956 /* We aren't generating a modeline at the moment. */
4959 /* Create a display block for the text region of the line. */
4960 ret_bufpos = create_string_text_block (w, disp_string, dl, start_pos,
4961 prop, default_face);
4962 dl->bufpos = start_pos;
4963 if (dl->end_bufpos < dl->bufpos)
4964 dl->end_bufpos = dl->bufpos;
4966 /* If there are left glyphs associated with any character in the
4967 text block, then create a display block to handle them. */
4968 if (dl->left_glyphs != NULL && Dynarr_length (dl->left_glyphs))
4969 create_left_glyph_block (w, dl, 0);
4971 /* If there are right glyphs associated with any character in the
4972 text block, then create a display block to handle them. */
4973 if (dl->right_glyphs != NULL && Dynarr_length (dl->right_glyphs))
4974 create_right_glyph_block (w, dl);
4979 /* This is ripped off from regenerate_window. All we want to do is
4980 loop through elements in the string creating display lines until we
4981 have covered the provided area. Simple really. */
4983 generate_displayable_area (struct window *w, Lisp_Object disp_string,
4984 int xpos, int ypos, int width, int height,
4985 display_line_dynarr* dla,
4987 face_index default_face)
4989 int yend = ypos + height;
4992 prop_block_dynarr *prop = 0;
4993 layout_bounds bounds;
4997 /* if there's nothing to do then do nothing. code after this assumes
4998 there is something to do. */
4999 if (NILP (disp_string))
5002 s_zv = XSTRING_CHAR_LENGTH (disp_string);
5004 bounds.left_out = xpos;
5005 bounds.right_out = xpos + width;
5006 /* The inner boundaries mark where the glyph margins are located. */
5007 bounds.left_in = bounds.left_out + window_left_margin_width (w);
5008 bounds.right_in = bounds.right_out - window_right_margin_width (w);
5009 /* We cannot fully calculate the whitespace boundaries as they
5010 depend on the contents of the line being displayed. */
5011 bounds.left_white = bounds.left_in;
5012 bounds.right_white = bounds.right_in;
5016 struct display_line dl;
5017 struct display_line *dlp;
5021 if (Dynarr_length (dla) < Dynarr_largest (dla))
5023 dlp = Dynarr_atp (dla, Dynarr_length (dla));
5034 dlp->bounds = bounds;
5036 next_pos = generate_string_display_line (w, disp_string, dlp, start_pos,
5037 &prop, default_face);
5038 /* we need to make sure that we continue along the line if there
5039 is more left to display otherwise we just end up redisplaying
5040 the same chunk over and over again. */
5041 if (next_pos == start_pos && next_pos < s_zv)
5044 start_pos = next_pos;
5046 dlp->ypos = ypos + dlp->ascent;
5047 ypos = dlp->ypos + dlp->descent;
5051 int visible_height = dlp->ascent + dlp->descent;
5053 dlp->clip = (ypos - yend);
5054 visible_height -= dlp->clip;
5056 if (visible_height < VERTICAL_CLIP (w, 1))
5059 free_display_line (dlp);
5066 Dynarr_add (dla, *dlp);
5068 /* #### This type of check needs to be done down in the
5069 generate_display_line call. */
5070 if (start_pos >= s_zv)
5079 /***************************************************************************/
5081 /* window-regeneration routines */
5083 /***************************************************************************/
5085 /* For a given window and starting position in the buffer it contains,
5086 ensure that the TYPE display lines accurately represent the
5087 presentation of the window. We pass the buffer instead of getting
5088 it from the window since redisplay_window may have temporarily
5089 changed it to the echo area buffer. */
5092 regenerate_window (struct window *w, Bufpos start_pos, Bufpos point, int type)
5094 struct frame *f = XFRAME (w->frame);
5095 struct buffer *b = XBUFFER (w->buffer);
5096 int ypos = WINDOW_TEXT_TOP (w);
5097 int yend; /* set farther down */
5098 int yclip = WINDOW_TEXT_TOP_CLIP (w);
5101 prop_block_dynarr *prop;
5102 layout_bounds bounds;
5103 display_line_dynarr *dla;
5106 /* The lines had better exist by this point. */
5107 if (!(dla = window_display_lines (w, type)))
5110 w->max_line_len = 0;
5112 /* Normally these get updated in redisplay_window but it is possible
5113 for this function to get called from some other points where that
5114 update may not have occurred. This acts as a safety check. */
5115 if (!Dynarr_length (w->face_cachels))
5116 reset_face_cachels (w);
5117 if (!Dynarr_length (w->glyph_cachels))
5118 reset_glyph_cachels (w);
5120 Fset_marker (w->start[type], make_int (start_pos), w->buffer);
5121 Fset_marker (w->pointm[type], make_int (point), w->buffer);
5122 w->last_point_x[type] = -1;
5123 w->last_point_y[type] = -1;
5125 /* Make sure a modeline is in the structs if needed. */
5126 need_modeline = ensure_modeline_generated (w, type);
5128 /* Wait until here to set this so that the structs have a modeline
5129 generated in the case where one didn't exist. */
5130 yend = WINDOW_TEXT_BOTTOM (w);
5132 bounds = calculate_display_line_boundaries (w, 0);
5134 /* 97/3/14 jhod: stuff added here to support pre-prompts (used for input systems) */
5135 if (MINI_WINDOW_P (w)
5136 && (!NILP (Vminibuf_prompt) || !NILP (Vminibuf_preprompt))
5137 && !echo_area_active (f)
5138 && start_pos == BUF_BEGV (b))
5140 struct prop_block pb;
5142 prop = Dynarr_new (prop_block);
5144 string = concat2(Vminibuf_preprompt, Vminibuf_prompt);
5145 pb.type = PROP_MINIBUF_PROMPT;
5146 pb.data.p_string.str = XSTRING_DATA(string);
5147 pb.data.p_string.len = XSTRING_LENGTH(string);
5148 Dynarr_add (prop, pb);
5153 /* When we are computing things for scrolling purposes, make
5154 sure at least one line is always generated */
5155 force = (type == CMOTION_DISP);
5157 /* Make sure this is set always */
5158 /* Note the conversion at end */
5159 w->window_end_pos[type] = start_pos;
5160 while (ypos < yend || force)
5162 struct display_line dl;
5163 struct display_line *dlp;
5166 if (Dynarr_length (dla) < Dynarr_largest (dla))
5168 dlp = Dynarr_atp (dla, Dynarr_length (dla));
5179 dlp->bounds = bounds;
5181 start_pos = generate_display_line (w, dlp, 1, start_pos, &prop, type);
5183 if (yclip > dlp->ascent)
5185 /* this should never happen, but if it does just display the
5190 dlp->ypos = (ypos + dlp->ascent) - yclip;
5191 ypos = dlp->ypos + dlp->descent;
5193 /* See if we've been asked to start midway through a line, for
5194 partial display line scrolling. */
5197 dlp->top_clip = yclip;
5205 int visible_height = dlp->ascent + dlp->descent;
5207 dlp->clip = (ypos - yend);
5208 /* Although this seems strange we could have a single very
5209 tall line visible for which we need to account for both
5210 the top clip and the bottom clip. */
5211 visible_height -= (dlp->clip + dlp->top_clip);
5213 if (visible_height < VERTICAL_CLIP (w, 1) && !force)
5216 free_display_line (dlp);
5223 if (dlp->cursor_elt != -1)
5225 /* #### This check is steaming crap. Have to get things
5226 fixed so when create_text_block hits EOB, we're done,
5228 if (w->last_point_x[type] == -1)
5230 w->last_point_x[type] = dlp->cursor_elt;
5231 w->last_point_y[type] = Dynarr_length (dla);
5235 /* #### This means that we've added a cursor at EOB
5236 twice. Yuck oh yuck. */
5237 struct display_block *db =
5238 get_display_block_from_line (dlp, TEXT);
5240 Dynarr_atp (db->runes, dlp->cursor_elt)->cursor_type = NO_CURSOR;
5241 dlp->cursor_elt = -1;
5245 if (dlp->num_chars > w->max_line_len)
5246 w->max_line_len = dlp->num_chars;
5248 Dynarr_add (dla, *dlp);
5250 /* #### This isn't right, but it is close enough for now. */
5251 w->window_end_pos[type] = start_pos;
5253 /* #### This type of check needs to be done down in the
5254 generate_display_line call. */
5255 if (start_pos > BUF_ZV (b))
5264 /* #### More not quite right, but close enough. */
5265 /* Ben sez: apparently window_end_pos[] is measured
5266 as the number of characters between the window end and the
5267 end of the buffer? This seems rather weirdo. What's
5268 the justification for this?
5270 JV sez: Because BUF_Z (b) would be a good initial value, however
5271 that can change. This representation allows initalizing with 0.
5273 w->window_end_pos[type] = BUF_Z (b) - w->window_end_pos[type];
5277 /* We know that this is the right thing to use because we put it
5278 there when we first started working in this function. */
5279 generate_modeline (w, Dynarr_atp (dla, 0), type);
5283 #define REGEN_INC_FIND_START_END \
5285 /* Determine start and end of lines. */ \
5286 if (!Dynarr_length (cdla)) \
5290 if (Dynarr_atp (cdla, 0)->modeline && Dynarr_atp (ddla, 0)->modeline) \
5294 else if (!Dynarr_atp (cdla, 0)->modeline \
5295 && !Dynarr_atp (ddla, 0)->modeline) \
5300 abort (); /* structs differ */ \
5302 dla_end = Dynarr_length (cdla) - 1; \
5305 start_pos = (Dynarr_atp (cdla, dla_start)->bufpos \
5306 + Dynarr_atp (cdla, dla_start)->offset); \
5307 /* If this isn't true, then startp has changed and we need to do a \
5309 if (startp != start_pos) \
5312 /* Point is outside the visible region so give up. */ \
5313 if (pointm < start_pos) \
5318 /* This attempts to incrementally update the display structures. It
5319 returns a boolean indicating success or failure. This function is
5320 very similar to regenerate_window_incrementally and is in fact only
5321 called from that function. However, because of the nature of the
5322 changes it deals with it sometimes makes different assumptions
5323 which can lead to success which are much more difficult to make
5324 when dealing with buffer changes. */
5327 regenerate_window_extents_only_changed (struct window *w, Bufpos startp,
5329 Charcount beg_unchanged,
5330 Charcount end_unchanged)
5332 struct buffer *b = XBUFFER (w->buffer);
5333 display_line_dynarr *cdla = window_display_lines (w, CURRENT_DISP);
5334 display_line_dynarr *ddla = window_display_lines (w, DESIRED_DISP);
5338 int first_line, last_line;
5340 /* Don't define this in the loop where it is used because we
5341 definitely want its value to survive between passes. */
5342 prop_block_dynarr *prop = NULL;
5344 /* If we don't have any buffer change recorded but the modiff flag has
5345 been incremented, then fail. I'm not sure of the exact circumstances
5346 under which this can happen, but I believe that it is probably a
5347 reasonable happening. */
5348 if (!point_visible (w, pointm, CURRENT_DISP)
5349 || XINT (w->last_modified[CURRENT_DISP]) < BUF_MODIFF (b))
5352 /* If the cursor is moved we attempt to update it. If we succeed we
5353 go ahead and proceed with the optimization attempt. */
5354 if (!EQ (Fmarker_buffer (w->last_point[CURRENT_DISP]), w->buffer)
5355 || pointm != marker_position (w->last_point[CURRENT_DISP]))
5357 struct frame *f = XFRAME (w->frame);
5358 struct device *d = XDEVICE (f->device);
5359 struct frame *sel_f = device_selected_frame (d);
5362 if (w->last_point_x[CURRENT_DISP] != -1
5363 && w->last_point_y[CURRENT_DISP] != -1)
5366 if (redisplay_move_cursor (w, pointm, WINDOW_TTY_P (w)))
5368 /* Always regenerate the modeline in case it is
5369 displaying the current line or column. */
5370 regenerate_modeline (w);
5374 else if (w != XWINDOW (FRAME_SELECTED_WINDOW (sel_f)))
5376 if (f->modeline_changed)
5377 regenerate_modeline (w);
5385 if (beg_unchanged == -1 && end_unchanged == -1)
5388 /* assert: There are no buffer modifications or they are all below the
5389 visible region. We assume that regenerate_window_incrementally has
5390 not called us unless this is true. */
5392 REGEN_INC_FIND_START_END;
5394 /* If the changed are starts before the visible area, give up. */
5395 if (beg_unchanged < startp)
5398 /* Find what display line the extent changes first affect. */
5400 while (line <= dla_end)
5402 struct display_line *dl = Dynarr_atp (cdla, line);
5403 Bufpos lstart = dl->bufpos + dl->offset;
5404 Bufpos lend = dl->end_bufpos + dl->offset;
5406 if (beg_unchanged >= lstart && beg_unchanged <= lend)
5412 /* If the changes are below the visible area then if point hasn't
5413 moved return success otherwise fail in order to be safe. */
5416 if (EQ (Fmarker_buffer (w->last_point[CURRENT_DISP]), w->buffer)
5417 && pointm == marker_position (w->last_point[CURRENT_DISP]))
5423 /* At this point we know what line the changes first affect. We now
5424 begin redrawing lines as long as we are still in the affected
5425 region and the line's size and positioning don't change.
5426 Otherwise we fail. If we fail we will have altered the desired
5427 structs which could lead to an assertion failure. However, if we
5428 fail the next thing that is going to happen is a full regen so we
5429 will actually end up being safe. */
5430 w->last_modified[DESIRED_DISP] = make_int (BUF_MODIFF (b));
5431 w->last_facechange[DESIRED_DISP] = make_int (BUF_FACECHANGE (b));
5432 Fset_marker (w->last_start[DESIRED_DISP], make_int (startp), w->buffer);
5433 Fset_marker (w->last_point[DESIRED_DISP], make_int (pointm), w->buffer);
5435 first_line = last_line = line;
5436 while (line <= dla_end)
5438 Bufpos old_start, old_end, new_start;
5439 struct display_line *cdl = Dynarr_atp (cdla, line);
5440 struct display_line *ddl = Dynarr_atp (ddla, line);
5441 struct display_block *db;
5444 assert (cdl->bufpos == ddl->bufpos);
5445 assert (cdl->end_bufpos == ddl->end_bufpos);
5446 assert (cdl->offset == ddl->offset);
5448 db = get_display_block_from_line (ddl, TEXT);
5449 initial_size = Dynarr_length (db->runes);
5450 old_start = ddl->bufpos + ddl->offset;
5451 old_end = ddl->end_bufpos + ddl->offset;
5453 /* If this is the first line being updated and it used
5454 propagation data, fail. Otherwise we'll be okay because
5455 we'll have the necessary propagation data. */
5456 if (line == first_line && ddl->used_prop_data)
5459 new_start = generate_display_line (w, ddl, 0, ddl->bufpos + ddl->offset,
5460 &prop, DESIRED_DISP);
5463 /* #### If there is propagated stuff the fail. We could
5464 probably actually deal with this if the line had propagated
5465 information when originally created by a full
5473 /* If any line position parameters have changed or a
5474 cursor has disappeared or disappeared, fail. */
5475 db = get_display_block_from_line (ddl, TEXT);
5476 if (cdl->ypos != ddl->ypos
5477 || cdl->ascent != ddl->ascent
5478 || cdl->descent != ddl->descent
5479 || cdl->top_clip != ddl->top_clip
5480 || (cdl->cursor_elt != -1 && ddl->cursor_elt == -1)
5481 || (cdl->cursor_elt == -1 && ddl->cursor_elt != -1)
5482 || old_start != ddl->bufpos
5483 || old_end != ddl->end_bufpos
5484 || initial_size != Dynarr_length (db->runes))
5489 if (ddl->cursor_elt != -1)
5491 w->last_point_x[DESIRED_DISP] = ddl->cursor_elt;
5492 w->last_point_y[DESIRED_DISP] = line;
5497 /* If the extent changes end on the line we just updated then
5498 we're done. Otherwise go on to the next line. */
5499 if (end_unchanged <= ddl->end_bufpos)
5505 redisplay_update_line (w, first_line, last_line, 1);
5509 /* Attempt to update the display data structures based on knowledge of
5510 the changed region in the buffer. Returns a boolean indicating
5511 success or failure. If this function returns a failure then a
5512 regenerate_window _must_ be performed next in order to maintain
5513 invariants located here. */
5516 regenerate_window_incrementally (struct window *w, Bufpos startp,
5519 struct buffer *b = XBUFFER (w->buffer);
5520 display_line_dynarr *cdla = window_display_lines (w, CURRENT_DISP);
5521 display_line_dynarr *ddla = window_display_lines (w, DESIRED_DISP);
5522 Charcount beg_unchanged, end_unchanged;
5523 Charcount extent_beg_unchanged, extent_end_unchanged;
5529 /* If this function is called, the current and desired structures
5530 had better be identical. If they are not, then that is a bug. */
5531 assert (Dynarr_length (cdla) == Dynarr_length (ddla));
5533 /* We don't handle minibuffer windows yet. The minibuffer prompt
5535 if (MINI_WINDOW_P (w))
5538 extent_beg_unchanged = BUF_EXTENT_BEGIN_UNCHANGED (b);
5539 extent_end_unchanged = (BUF_EXTENT_END_UNCHANGED (b) == -1
5541 : BUF_Z (b) - BUF_EXTENT_END_UNCHANGED (b));
5543 /* If nothing has changed in the buffer, then make sure point is ok
5545 if (BUF_BEGIN_UNCHANGED (b) == -1 && BUF_END_UNCHANGED (b) == -1)
5546 return regenerate_window_extents_only_changed (w, startp, pointm,
5547 extent_beg_unchanged,
5548 extent_end_unchanged);
5550 /* We can't deal with deleted newlines. */
5551 if (BUF_NEWLINE_WAS_DELETED (b))
5554 beg_unchanged = BUF_BEGIN_UNCHANGED (b);
5555 end_unchanged = (BUF_END_UNCHANGED (b) == -1
5557 : BUF_Z (b) - BUF_END_UNCHANGED (b));
5559 REGEN_INC_FIND_START_END;
5561 /* If the changed area starts before the visible area, give up. */
5562 if (beg_unchanged < startp)
5565 /* Find what display line the buffer changes first affect. */
5567 while (line <= dla_end)
5569 struct display_line *dl = Dynarr_atp (cdla, line);
5570 Bufpos lstart = dl->bufpos + dl->offset;
5571 Bufpos lend = dl->end_bufpos + dl->offset;
5573 if (beg_unchanged >= lstart && beg_unchanged <= lend)
5579 /* If the changes are below the visible area then if point hasn't
5580 moved return success otherwise fail in order to be safe. */
5582 return regenerate_window_extents_only_changed (w, startp, pointm,
5583 extent_beg_unchanged,
5584 extent_end_unchanged);
5586 /* At this point we know what line the changes first affect. We
5587 now redraw that line. If the changes are contained within it
5588 we are going to succeed and can update just that one line.
5589 Otherwise we fail. If we fail we will have altered the desired
5590 structs which could lead to an assertion failure. However, if
5591 we fail the next thing that is going to happen is a full regen
5592 so we will actually end up being safe. */
5595 prop_block_dynarr *prop = NULL;
5596 struct display_line *cdl = Dynarr_atp (cdla, line);
5597 struct display_line *ddl = Dynarr_atp (ddla, line);
5599 assert (cdl->bufpos == ddl->bufpos);
5600 assert (cdl->end_bufpos == ddl->end_bufpos);
5601 assert (cdl->offset == ddl->offset);
5603 /* If the line continues to next display line, fail. */
5604 if (ddl->line_continuation)
5607 /* If the line was generated using propagation data, fail. */
5608 if (ddl->used_prop_data)
5611 new_start = generate_display_line (w, ddl, 0, ddl->bufpos + ddl->offset,
5612 &prop, DESIRED_DISP);
5615 /* If there is propagated stuff then it is pretty much a
5616 guarantee that more than just the one line is affected. */
5623 /* If the line continues to next display line, fail. */
5624 if (ddl->line_continuation)
5627 /* If any line position parameters have changed or a
5628 cursor has disappeared or disappeared, fail. */
5629 if (cdl->ypos != ddl->ypos
5630 || cdl->ascent != ddl->ascent
5631 || cdl->descent != ddl->descent
5632 || cdl->top_clip != ddl->top_clip
5633 || (cdl->cursor_elt != -1 && ddl->cursor_elt == -1)
5634 || (cdl->cursor_elt == -1 && ddl->cursor_elt != -1))
5639 /* If the changed area also ends on this line, then we may be in
5640 business. Update everything and return success. */
5641 if (end_unchanged >= ddl->bufpos && end_unchanged <= ddl->end_bufpos)
5643 w->last_modified[DESIRED_DISP] = make_int (BUF_MODIFF (b));
5644 w->last_facechange[DESIRED_DISP] = make_int (BUF_FACECHANGE (b));
5645 Fset_marker (w->last_start[DESIRED_DISP], make_int (startp),
5647 Fset_marker (w->last_point[DESIRED_DISP], make_int (pointm),
5650 if (ddl->cursor_elt != -1)
5652 w->last_point_x[DESIRED_DISP] = ddl->cursor_elt;
5653 w->last_point_y[DESIRED_DISP] = line;
5656 redisplay_update_line (w, line, line, 1);
5657 regenerate_modeline (w);
5659 /* #### For now we just flush the cache until this has been
5660 tested. After that is done, this should correct the
5662 Dynarr_reset (w->line_start_cache);
5664 /* Adjust the extent changed boundaries to remove any
5665 overlap with the buffer changes since we've just
5666 successfully updated that area. */
5667 if (extent_beg_unchanged != -1
5668 && extent_beg_unchanged >= beg_unchanged
5669 && extent_beg_unchanged < end_unchanged)
5670 extent_beg_unchanged = end_unchanged;
5672 if (extent_end_unchanged != -1
5673 && extent_end_unchanged >= beg_unchanged
5674 && extent_end_unchanged < end_unchanged)
5675 extent_end_unchanged = beg_unchanged - 1;
5677 if (extent_end_unchanged <= extent_beg_unchanged)
5678 extent_beg_unchanged = extent_end_unchanged = -1;
5680 /* This could lead to odd results if it fails, but since the
5681 buffer changes update succeeded this probably will to.
5682 We already know that the extent changes start at or after
5683 the line because we checked before entering the loop. */
5684 if (extent_beg_unchanged != -1
5685 && extent_end_unchanged != -1
5686 && ((extent_beg_unchanged < ddl->bufpos)
5687 || (extent_end_unchanged > ddl->end_bufpos)))
5688 return regenerate_window_extents_only_changed (w, startp, pointm,
5689 extent_beg_unchanged,
5690 extent_end_unchanged);
5700 /* Given a window and a point, update the given display lines such
5701 that point is displayed in the middle of the window.
5702 Return the window's new start position. */
5705 regenerate_window_point_center (struct window *w, Bufpos point, int type)
5709 /* We need to make sure that the modeline is generated so that the
5710 window height can be calculated correctly. */
5711 ensure_modeline_generated (w, type);
5713 startp = start_with_line_at_pixpos (w, point, window_half_pixpos (w));
5714 regenerate_window (w, startp, point, type);
5715 Fset_marker (w->start[type], make_int (startp), w->buffer);
5720 /* Given a window and a set of display lines, return a boolean
5721 indicating whether the given point is contained within. */
5724 point_visible (struct window *w, Bufpos point, int type)
5726 struct buffer *b = XBUFFER (w->buffer);
5727 display_line_dynarr *dla = window_display_lines (w, type);
5730 if (Dynarr_length (dla) && Dynarr_atp (dla, 0)->modeline)
5735 if (Dynarr_length (dla) > first_line)
5738 struct display_line *dl = Dynarr_atp (dla, first_line);
5741 end = BUF_Z (b) - w->window_end_pos[type] - 1;
5743 if (point >= start && point <= end)
5745 if (!MINI_WINDOW_P (w) && scroll_on_clipped_lines)
5747 dl = Dynarr_atp (dla, Dynarr_length (dla) - 1);
5749 if (point >= (dl->bufpos + dl->offset)
5750 && point <= (dl->end_bufpos + dl->offset))
5765 /* Return pixel position the middle of the window, not including the
5766 modeline and any potential horizontal scrollbar. */
5769 window_half_pixpos (struct window *w)
5771 return WINDOW_TEXT_TOP (w) + (WINDOW_TEXT_HEIGHT (w) >> 1);
5774 /* Return the display line which is currently in the middle of the
5775 window W for display lines TYPE. */
5778 line_at_center (struct window *w, int type, Bufpos start, Bufpos point)
5780 display_line_dynarr *dla;
5783 int first_elt = (MINI_WINDOW_P (w) ? 0 : 1);
5785 if (type == CMOTION_DISP)
5786 regenerate_window (w, start, point, type);
5788 dla = window_display_lines (w, type);
5789 half = window_half_pixpos (w);
5791 for (elt = first_elt; elt < Dynarr_length (dla); elt++)
5793 struct display_line *dl = Dynarr_atp (dla, elt);
5794 int line_bot = dl->ypos + dl->descent;
5796 if (line_bot > half)
5800 /* We may not have a line at the middle if the end of the buffer is
5805 /* Return a value for point that would place it at the beginning of
5806 the line which is in the middle of the window. */
5809 point_at_center (struct window *w, int type, Bufpos start, Bufpos point)
5811 /* line_at_center will regenerate the display structures, if necessary. */
5812 int line = line_at_center (w, type, start, point);
5815 return BUF_ZV (XBUFFER (w->buffer));
5818 display_line_dynarr *dla = window_display_lines (w, type);
5819 struct display_line *dl = Dynarr_atp (dla, line);
5825 /* For a given window, ensure that the current visual representation
5829 redisplay_window (Lisp_Object window, int skip_selected)
5831 struct window *w = XWINDOW (window);
5832 struct frame *f = XFRAME (w->frame);
5833 struct device *d = XDEVICE (f->device);
5834 Lisp_Object old_buffer = w->buffer;
5835 Lisp_Object the_buffer = w->buffer;
5837 int echo_active = 0;
5842 int selected_in_its_frame;
5843 int selected_globally;
5844 int skip_output = 0;
5845 int truncation_changed;
5846 int inactive_minibuffer =
5847 (MINI_WINDOW_P (w) &&
5848 (f != device_selected_frame (d)) &&
5849 !is_surrogate_for_selected_frame (f));
5851 /* #### In the new world this function actually does a bunch of
5852 optimizations such as buffer-based scrolling, but none of that is
5855 /* If this is a combination window, do its children; that's all.
5856 The selected window is always a leaf so we don't check for
5857 skip_selected here. */
5858 if (!NILP (w->vchild))
5860 redisplay_windows (w->vchild, skip_selected);
5863 if (!NILP (w->hchild))
5865 redisplay_windows (w->hchild, skip_selected);
5869 /* Is this window the selected window on its frame? */
5870 selected_in_its_frame = (w == XWINDOW (FRAME_SELECTED_WINDOW (f)));
5872 selected_in_its_frame &&
5873 EQ(DEVICE_CONSOLE(d), Vselected_console) &&
5874 XDEVICE(CONSOLE_SELECTED_DEVICE(XCONSOLE(DEVICE_CONSOLE(d)))) == d &&
5875 XFRAME(DEVICE_SELECTED_FRAME(d)) == f;
5876 if (skip_selected && selected_in_its_frame)
5879 /* It is possible that the window is not fully initialized yet. */
5880 if (NILP (w->buffer))
5883 if (MINI_WINDOW_P (w) && echo_area_active (f))
5885 w->buffer = the_buffer = Vecho_area_buffer;
5889 b = XBUFFER (w->buffer);
5893 old_pointm = selected_globally
5895 : marker_position (w->pointm[CURRENT_DISP]);
5900 if (selected_globally)
5902 pointm = BUF_PT (b);
5906 pointm = marker_position (w->pointm[CURRENT_DISP]);
5908 if (pointm < BUF_BEGV (b))
5909 pointm = BUF_BEGV (b);
5910 else if (pointm > BUF_ZV (b))
5911 pointm = BUF_ZV (b);
5914 Fset_marker (w->pointm[DESIRED_DISP], make_int (pointm), the_buffer);
5916 /* If the buffer has changed we have to invalidate all of our face
5918 if ((!echo_active && b != window_display_buffer (w))
5919 || !Dynarr_length (w->face_cachels)
5920 || f->faces_changed)
5921 reset_face_cachels (w);
5923 mark_face_cachels_as_not_updated (w);
5925 /* Ditto the glyph cache elements, although we do *not* invalidate
5926 the cache purely because glyphs have changed - this is now
5927 handled by the dirty flag.*/
5928 if ((!echo_active && b != window_display_buffer (w))
5929 || !Dynarr_length (w->glyph_cachels) || f->faces_changed)
5930 reset_glyph_cachels (w);
5932 mark_glyph_cachels_as_not_updated (w);
5934 /* If the marker's buffer is not the window's buffer, then we need
5935 to find a new starting position. */
5936 if (!MINI_WINDOW_P (w)
5937 && !EQ (Fmarker_buffer (w->start[CURRENT_DISP]), w->buffer))
5939 startp = regenerate_window_point_center (w, pointm, DESIRED_DISP);
5941 goto regeneration_done;
5946 old_startp = marker_position (w->start[CURRENT_DISP]);
5951 startp = marker_position (w->start[CURRENT_DISP]);
5952 if (startp < BUF_BEGV (b))
5953 startp = BUF_BEGV (b);
5954 else if (startp > BUF_ZV (b))
5955 startp = BUF_ZV (b);
5957 Fset_marker (w->start[DESIRED_DISP], make_int (startp), the_buffer);
5959 truncation_changed = (find_window_mirror (w)->truncate_win !=
5960 window_truncation_on (w));
5962 /* If w->force_start is set, then some function set w->start and we
5963 should display from there and change point, if necessary, to
5964 ensure that it is visible. */
5965 if (w->force_start || inactive_minibuffer)
5968 w->last_modified[DESIRED_DISP] = Qzero;
5969 w->last_facechange[DESIRED_DISP] = Qzero;
5971 regenerate_window (w, startp, pointm, DESIRED_DISP);
5973 if (!point_visible (w, pointm, DESIRED_DISP) && !inactive_minibuffer)
5975 pointm = point_at_center (w, DESIRED_DISP, 0, 0);
5977 if (selected_globally)
5978 BUF_SET_PT (b, pointm);
5980 Fset_marker (w->pointm[DESIRED_DISP], make_int (pointm),
5983 /* #### BUFU amounts of overkill just to get the cursor
5984 location marked properly. FIX ME FIX ME FIX ME */
5985 regenerate_window (w, startp, pointm, DESIRED_DISP);
5988 goto regeneration_done;
5991 /* If nothing has changed since the last redisplay, then we just
5992 need to make sure that point is still visible. */
5993 if (XINT (w->last_modified[CURRENT_DISP]) >= BUF_MODIFF (b)
5994 && XINT (w->last_facechange[CURRENT_DISP]) >= BUF_FACECHANGE (b)
5996 /* This check is to make sure we restore the minibuffer after a
5997 temporary change to the echo area. */
5998 && !(MINI_WINDOW_P (w) && f->buffers_changed)
5999 && !f->frame_changed
6000 && !truncation_changed
6001 /* check whether start is really at the begining of a line GE */
6002 && (!w->start_at_line_beg || beginning_of_line_p (b, startp))
6005 /* Check if the cursor has actually moved. */
6006 if (EQ (Fmarker_buffer (w->last_point[CURRENT_DISP]), w->buffer)
6007 && pointm == marker_position (w->last_point[CURRENT_DISP])
6008 && selected_globally
6009 && !w->windows_changed
6011 && !f->extents_changed
6012 && !f->faces_changed
6013 && !f->glyphs_changed
6014 && !f->subwindows_changed
6015 /* && !f->subwindows_state_changed*/
6016 && !f->point_changed
6017 && !f->windows_structure_changed)
6019 /* If not, we're done. */
6020 if (f->modeline_changed)
6021 regenerate_modeline (w);
6024 goto regeneration_done;
6028 /* If the new point is visible in the redisplay structures,
6029 then let the output update routines handle it, otherwise
6030 do things the hard way. */
6031 if (!w->windows_changed
6033 && !f->extents_changed
6034 && !f->faces_changed
6035 && !f->glyphs_changed
6036 && !f->subwindows_changed
6037 /* && !f->subwindows_state_changed*/
6038 && !f->windows_structure_changed)
6040 if (point_visible (w, pointm, CURRENT_DISP)
6041 && w->last_point_x[CURRENT_DISP] != -1
6042 && w->last_point_y[CURRENT_DISP] != -1)
6044 if (redisplay_move_cursor (w, pointm, FRAME_TTY_P (f)))
6046 /* Always regenerate in case it is displaying
6047 the current line or column. */
6048 regenerate_modeline (w);
6051 goto regeneration_done;
6054 else if (!selected_in_its_frame && !f->point_changed)
6056 if (f->modeline_changed)
6057 regenerate_modeline (w);
6060 goto regeneration_done;
6064 /* If we weren't able to take the shortcut method, then use
6065 the brute force method. */
6066 regenerate_window (w, startp, pointm, DESIRED_DISP);
6068 if (point_visible (w, pointm, DESIRED_DISP))
6069 goto regeneration_done;
6073 /* Check if the starting point is no longer at the beginning of a
6074 line, in which case find a new starting point. We also recenter
6075 if our start position is equal to point-max. Otherwise we'll end
6076 up with a blank window. */
6077 else if (((w->start_at_line_beg || MINI_WINDOW_P (w))
6078 && !(startp == BUF_BEGV (b)
6079 || BUF_FETCH_CHAR (b, startp - 1) == '\n'))
6080 || (pointm == startp &&
6081 EQ (Fmarker_buffer (w->last_start[CURRENT_DISP]), w->buffer) &&
6082 startp < marker_position (w->last_start[CURRENT_DISP]))
6083 || (startp == BUF_ZV (b)))
6085 startp = regenerate_window_point_center (w, pointm, DESIRED_DISP);
6087 goto regeneration_done;
6089 /* See if we can update the data structures locally based on
6090 knowledge of what changed in the buffer. */
6091 else if (!w->windows_changed
6093 && !f->faces_changed
6094 && !f->glyphs_changed
6095 && !f->subwindows_changed
6096 /* && !f->subwindows_state_changed*/
6097 && !f->windows_structure_changed
6098 && !f->frame_changed
6099 && !truncation_changed
6101 && regenerate_window_incrementally (w, startp, pointm))
6103 if (f->modeline_changed
6104 || XINT (w->last_modified[CURRENT_DISP]) < BUF_MODIFF (b)
6105 || XINT (w->last_facechange[CURRENT_DISP]) < BUF_FACECHANGE (b))
6106 regenerate_modeline (w);
6109 goto regeneration_done;
6111 /* #### This is where a check for structure based scrolling would go. */
6112 /* If all else fails, try just regenerating and see what happens. */
6115 regenerate_window (w, startp, pointm, DESIRED_DISP);
6117 if (point_visible (w, pointm, DESIRED_DISP))
6118 goto regeneration_done;
6121 /* We still haven't gotten the window regenerated with point
6122 visible. Next we try scrolling a little and see if point comes
6123 back onto the screen. */
6124 if (scroll_step > 0)
6126 int scrolled = scroll_conservatively;
6127 for (; scrolled >= 0; scrolled -= scroll_step)
6129 startp = vmotion (w, startp,
6130 (pointm < startp) ? -scroll_step : scroll_step, 0);
6131 regenerate_window (w, startp, pointm, DESIRED_DISP);
6133 if (point_visible (w, pointm, DESIRED_DISP))
6134 goto regeneration_done;
6138 /* We still haven't managed to get the screen drawn with point on
6139 the screen, so just center it and be done with it. */
6140 startp = regenerate_window_point_center (w, pointm, DESIRED_DISP);
6145 /* If the window's frame is changed then reset the current display
6146 lines in order to force a full repaint. */
6147 if (f->frame_changed)
6149 display_line_dynarr *cla = window_display_lines (w, CURRENT_DISP);
6154 /* Must do this before calling redisplay_output_window because it
6155 sets some markers on the window. */
6158 w->buffer = old_buffer;
6159 Fset_marker (w->pointm[DESIRED_DISP], make_int (old_pointm), old_buffer);
6160 Fset_marker (w->start[DESIRED_DISP], make_int (old_startp), old_buffer);
6163 /* These also have to be set before calling redisplay_output_window
6164 since it sets the CURRENT_DISP values based on them. */
6165 w->last_modified[DESIRED_DISP] = make_int (BUF_MODIFF (b));
6166 w->last_facechange[DESIRED_DISP] = make_int (BUF_FACECHANGE (b));
6167 Fset_marker (w->last_start[DESIRED_DISP], make_int (startp), w->buffer);
6168 Fset_marker (w->last_point[DESIRED_DISP], make_int (pointm), w->buffer);
6172 Bufpos start = marker_position (w->start[DESIRED_DISP]);
6173 Bufpos end = (w->window_end_pos[DESIRED_DISP] == -1
6175 : BUF_Z (b) - w->window_end_pos[DESIRED_DISP] - 1);
6176 /* Don't pollute the cache if not sure if we are correct */
6177 if (w->start_at_line_beg)
6178 update_line_start_cache (w, start, end, pointm, 1);
6179 redisplay_output_window (w);
6181 * If we just displayed the echo area, the line start cache is
6182 * no longer valid, because the minibuffer window is associated
6183 * with the window now.
6186 w->line_cache_last_updated = make_int (-1);
6189 /* #### This should be dependent on face changes and will need to be
6190 somewhere else once tty updates occur on a per-frame basis. */
6191 mark_face_cachels_as_clean (w);
6193 /* The glyph cachels only get dirty if someone changed something.
6194 Since redisplay has now effectively ended we can reset the dirty
6195 flag since everything must be up-to-date. */
6197 mark_glyph_cachels_as_clean (w);
6199 w->windows_changed = 0;
6202 /* Call buffer_reset_changes for all buffers present in any window
6203 currently visible in all frames on all devices. #### There has to
6204 be a better way to do this. */
6207 reset_buffer_changes_mapfun (struct window *w, void *ignored_closure)
6209 buffer_reset_changes (XBUFFER (w->buffer));
6214 reset_buffer_changes (void)
6216 Lisp_Object frmcons, devcons, concons;
6218 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
6220 struct frame *f = XFRAME (XCAR (frmcons));
6222 if (FRAME_REPAINT_P (f))
6223 map_windows (f, reset_buffer_changes_mapfun, 0);
6227 /* Ensure that all windows underneath the given window in the window
6228 hierarchy are correctly displayed. */
6231 redisplay_windows (Lisp_Object window, int skip_selected)
6233 for (; !NILP (window) ; window = XWINDOW (window)->next)
6235 redisplay_window (window, skip_selected);
6240 call_redisplay_end_triggers (struct window *w, void *closure)
6242 Bufpos lrpos = w->last_redisplay_pos;
6243 w->last_redisplay_pos = 0;
6244 if (!NILP (w->buffer)
6245 && !NILP (w->redisplay_end_trigger)
6250 if (MARKERP (w->redisplay_end_trigger)
6251 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
6252 pos = marker_position (w->redisplay_end_trigger);
6253 else if (INTP (w->redisplay_end_trigger))
6254 pos = XINT (w->redisplay_end_trigger);
6257 w->redisplay_end_trigger = Qnil;
6264 XSETWINDOW (window, w);
6265 va_run_hook_with_args_in_buffer (XBUFFER (w->buffer),
6266 Qredisplay_end_trigger_functions,
6268 w->redisplay_end_trigger);
6269 w->redisplay_end_trigger = Qnil;
6276 /* Ensure that all windows on the given frame are correctly displayed. */
6279 redisplay_frame (struct frame *f, int preemption_check)
6281 struct device *d = XDEVICE (f->device);
6283 if (preemption_check)
6285 /* The preemption check itself takes a lot of time,
6286 so normally don't do it here. We do it if called
6287 from Lisp, though (`redisplay-frame'). */
6290 REDISPLAY_PREEMPTION_CHECK;
6295 if (!internal_equal (f->old_buffer_alist, f->buffer_alist, 0))
6299 f->old_buffer_alist = Freplace_list (f->old_buffer_alist,
6301 XSETFRAME (frame, f);
6302 va_run_hook_with_args (Qbuffer_list_changed_hook, 1, frame);
6305 /* Before we put a hold on frame size changes, attempt to process
6306 any which are already pending. */
6307 if (f->size_change_pending)
6308 change_frame_size (f, f->new_height, f->new_width, 0);
6310 /* If frame size might need to be changed, due to changed size
6311 of toolbars, scrollbars etc, change it now */
6312 if (f->size_slipped)
6314 adjust_frame_size (f);
6315 assert (!f->size_slipped);
6318 /* The menubar, toolbar, and icon updates must be done before
6319 hold_frame_size_changes is called and we are officially
6320 'in_display'. They may eval lisp code which may call Fsignal.
6321 If in_display is set Fsignal will abort. */
6323 #ifdef HAVE_MENUBARS
6324 /* Update the menubar. It is done first since it could change
6325 the menubar's visibility. This way we avoid having flashing
6326 caused by an Expose event generated by the visibility change
6328 update_frame_menubars (f);
6329 #endif /* HAVE_MENUBARS */
6330 #ifdef HAVE_TOOLBARS
6331 /* Update the toolbars. */
6332 update_frame_toolbars (f);
6333 #endif /* HAVE_TOOLBARS */
6334 /* Gutter update proper has to be done inside display when no frame
6335 size changes can occur, thus we separately update the gutter
6336 geometry here if it needs it. */
6337 update_frame_gutter_geometry (f);
6339 /* If we clear the frame we have to force its contents to be redrawn. */
6341 f->frame_changed = 1;
6343 /* Invalidate the subwindow cache. We use subwindows_changed here to
6344 cause subwindows to get instantiated. This is because
6345 subwindows_state_changed is less strict - dealing with things
6346 like the clicked state of button. We have to do this before
6347 redisplaying the gutters as subwindows get unmapped in the
6349 if (f->frame_changed || f->subwindows_changed)
6351 /* we have to do this so the gutter gets regenerated. */
6352 reset_gutter_display_lines (f);
6355 hold_frame_size_changes ();
6357 /* ----------------- BEGIN CRITICAL REDISPLAY SECTION ---------------- */
6358 /* Within this section, we are defenseless and assume that the
6359 following cannot happen:
6361 1) garbage collection
6362 2) Lisp code evaluation
6363 3) frame size changes
6365 We ensure (3) by calling hold_frame_size_changes(), which
6366 will cause any pending frame size changes to get put on hold
6367 till after the end of the critical section. (1) follows
6368 automatically if (2) is met. #### Unfortunately, there are
6369 some places where Lisp code can be called within this section.
6370 We need to remove them.
6372 If Fsignal() is called during this critical section, we
6375 If garbage collection is called during this critical section,
6376 we simply return. #### We should abort instead.
6378 #### If a frame-size change does occur we should probably
6379 actually be preempting redisplay. */
6381 MAYBE_DEVMETH (d, frame_output_begin, (f));
6383 /* We can now update the gutters, safe in the knowledge that our
6384 efforts won't get undone. */
6386 /* This can call lisp, but redisplay is protected by binding
6387 inhibit_quit. More importantly the code involving display lines
6388 *assumes* that GC will not happen and so does not GCPRO
6389 anything. Since we use this code the whole time with the gutters
6390 we cannot allow GC to happen when manipulating the gutters. */
6391 update_frame_gutters (f);
6393 /* Erase the frame before outputting its contents. */
6396 MAYBE_DEVMETH (d, clear_frame, (f));
6399 /* Do the selected window first. */
6400 redisplay_window (FRAME_SELECTED_WINDOW (f), 0);
6402 /* Then do the rest. */
6403 redisplay_windows (f->root_window, 1);
6405 MAYBE_DEVMETH (d, frame_output_end, (f));
6407 update_frame_title (f);
6409 CLASS_RESET_CHANGED_FLAGS (f);
6410 f->window_face_cache_reset = 0;
6411 f->echo_area_garbaged = 0;
6414 if (!f->size_change_pending)
6415 f->size_changed = 0;
6417 /* ----------------- END CRITICAL REDISPLAY SECTION ---------------- */
6419 /* Allow frame size changes to occur again.
6421 #### what happens if changes to other frames happen? */
6422 unhold_one_frame_size_changes (f);
6424 map_windows (f, call_redisplay_end_triggers, 0);
6428 /* Ensure that all frames on the given device are correctly displayed.
6429 If AUTOMATIC is non-zero, and the device implementation indicates
6430 no automatic redisplay, as printers do, then the device is not
6431 redisplayed. AUTOMATIC is set to zero when called from lisp
6432 functions (redraw-device) and (redisplay-device), and to non-zero
6433 when called from "lazy" redisplay();
6437 redisplay_device (struct device *d, int automatic)
6439 Lisp_Object frame, frmcons;
6441 int size_change_failed = 0;
6445 && (MAYBE_INT_DEVMETH (d, device_implementation_flags, ())
6446 & XDEVIMPF_NO_AUTO_REDISPLAY))
6449 if (DEVICE_STREAM_P (d)) /* nothing to do */
6452 /* It is possible that redisplay has been called before the
6453 device is fully initialized. If so then continue with the
6455 if (NILP (DEVICE_SELECTED_FRAME (d)))
6458 REDISPLAY_PREEMPTION_CHECK;
6462 /* Always do the selected frame first. */
6463 frame = DEVICE_SELECTED_FRAME (d);
6467 if (f->icon_changed || f->windows_changed)
6468 update_frame_icon (f);
6470 if (FRAME_REPAINT_P (f))
6472 if (CLASS_REDISPLAY_FLAGS_CHANGEDP(f))
6474 preempted = redisplay_frame (f, 0);
6480 /* If the frame redisplay did not get preempted, then this flag
6481 should have gotten set to 0. It might be possible for that
6482 not to happen if a size change event were to occur at an odd
6483 time. To make sure we don't miss anything we simply don't
6484 reset the top level flags until the condition ends up being
6485 in the right state. */
6486 if (f->size_changed)
6487 size_change_failed = 1;
6490 DEVICE_FRAME_LOOP (frmcons, d)
6492 f = XFRAME (XCAR (frmcons));
6494 if (f == XFRAME (DEVICE_SELECTED_FRAME (d)))
6497 if (f->icon_changed || f->windows_changed)
6498 update_frame_icon (f);
6500 if (FRAME_REPAINT_P (f))
6502 if (CLASS_REDISPLAY_FLAGS_CHANGEDP (f))
6504 preempted = redisplay_frame (f, 0);
6510 if (f->size_change_pending)
6511 size_change_failed = 1;
6515 /* If we get here then we redisplayed all of our frames without
6516 getting preempted so mark ourselves as clean. */
6517 CLASS_RESET_CHANGED_FLAGS (d);
6519 if (!size_change_failed)
6520 d->size_changed = 0;
6526 restore_profiling_redisplay_flag (Lisp_Object val)
6528 profiling_redisplay_flag = XINT (val);
6532 /* Ensure that all windows on all frames on all devices are displaying
6533 the current contents of their respective buffers. */
6536 redisplay_without_hooks (void)
6538 Lisp_Object devcons, concons;
6539 int size_change_failed = 0;
6540 int count = specpdl_depth ();
6542 if (profiling_active)
6544 record_unwind_protect (restore_profiling_redisplay_flag,
6545 make_int (profiling_redisplay_flag));
6546 profiling_redisplay_flag = 1;
6549 if (asynch_device_change_pending)
6550 handle_asynch_device_change ();
6552 if (!GLOBAL_REDISPLAY_FLAGS_CHANGEDP &&
6553 !disable_preemption && preemption_count < max_preempts)
6556 DEVICE_LOOP_NO_BREAK (devcons, concons)
6558 struct device *d = XDEVICE (XCAR (devcons));
6561 if (CLASS_REDISPLAY_FLAGS_CHANGEDP (d))
6563 preempted = redisplay_device (d, 1);
6568 RESET_CHANGED_SET_FLAGS;
6572 /* See comment in redisplay_device. */
6573 if (d->size_changed)
6574 size_change_failed = 1;
6577 preemption_count = 0;
6579 /* Mark redisplay as accurate */
6580 GLOBAL_RESET_CHANGED_FLAGS;
6581 RESET_CHANGED_SET_FLAGS;
6585 mark_all_faces_as_clean ();
6589 if (!size_change_failed)
6592 reset_buffer_changes ();
6595 unbind_to (count, Qnil);
6601 if (last_display_warning_tick != display_warning_tick &&
6602 !inhibit_warning_display)
6604 /* If an error occurs during this function, oh well.
6605 If we report another warning, we could get stuck in an
6606 infinite loop reporting warnings. */
6607 call0_trapping_errors (0, Qdisplay_warning_buffer);
6608 last_display_warning_tick = display_warning_tick;
6610 /* The run_hook_trapping_errors functions are smart enough not
6611 to do any evalling if the hook function is empty, so there
6612 should not be any significant time loss. All places in the
6613 C code that call redisplay() are prepared to handle GCing,
6614 so we should be OK. */
6615 #ifndef INHIBIT_REDISPLAY_HOOKS
6616 run_hook_trapping_errors ("Error in pre-redisplay-hook",
6617 Qpre_redisplay_hook);
6618 #endif /* INHIBIT_REDISPLAY_HOOKS */
6620 redisplay_without_hooks ();
6622 #ifndef INHIBIT_REDISPLAY_HOOKS
6623 run_hook_trapping_errors ("Error in post-redisplay-hook",
6624 Qpost_redisplay_hook);
6625 #endif /* INHIBIT_REDISPLAY_HOOKS */
6629 static char window_line_number_buf[32];
6631 /* Efficiently determine the window line number, and return a pointer
6632 to its printed representation. Do this regardless of whether
6633 line-number-mode is on. The first line in the buffer is counted as
6634 1. If narrowing is in effect, the lines are counted from the
6635 beginning of the visible portion of the buffer. */
6637 window_line_number (struct window *w, int type)
6639 struct device *d = XDEVICE (XFRAME (w->frame)->device);
6640 struct buffer *b = XBUFFER (w->buffer);
6641 /* Be careful in the order of these tests. The first clause will
6642 fail if DEVICE_SELECTED_FRAME == Qnil (since w->frame cannot be).
6643 This can occur when the frame title is computed really early */
6645 ((EQ(DEVICE_SELECTED_FRAME(d), w->frame) &&
6646 (w == XWINDOW (FRAME_SELECTED_WINDOW (device_selected_frame(d)))) &&
6647 EQ(DEVICE_CONSOLE(d), Vselected_console) &&
6648 XDEVICE(CONSOLE_SELECTED_DEVICE(XCONSOLE(DEVICE_CONSOLE(d)))) == d )
6650 : marker_position (w->pointm[type]));
6653 line = buffer_line_number (b, pos, 1);
6655 long_to_string (window_line_number_buf, line + 1);
6657 return window_line_number_buf;
6661 /* Given a character representing an object in a modeline
6662 specification, return a string (stored into the global array
6663 `mode_spec_bufbyte_string') with the information that object
6666 This function is largely unchanged from previous versions of the
6669 Warning! This code is also used for frame titles and can be called
6670 very early in the device/frame update process! JV
6674 decode_mode_spec (struct window *w, Emchar spec, int type)
6676 Lisp_Object obj = Qnil;
6677 const char *str = NULL;
6678 struct buffer *b = XBUFFER (w->buffer);
6680 Dynarr_reset (mode_spec_bufbyte_string);
6684 /* print buffer name */
6689 /* print visited file name */
6694 /* print the current column */
6697 Bufpos pt = (w == XWINDOW (Fselected_window (Qnil)))
6699 : marker_position (w->pointm[type]);
6700 int col = column_at_point (b, pt, 1) + !!column_number_start_at_one;
6703 long_to_string (buf, col);
6705 Dynarr_add_many (mode_spec_bufbyte_string,
6706 (const Bufbyte *) buf, strlen (buf));
6708 goto decode_mode_spec_done;
6710 /* print the file coding system */
6714 Lisp_Object codesys = b->buffer_file_coding_system;
6715 /* Be very careful here not to get an error. */
6716 if (NILP (codesys) || SYMBOLP (codesys) || CODING_SYSTEMP (codesys))
6718 codesys = Ffind_coding_system (codesys);
6719 if (CODING_SYSTEMP (codesys))
6720 obj = XCODING_SYSTEM_MNEMONIC (codesys);
6723 #endif /* FILE_CODING */
6726 /* print the current line number */
6728 str = window_line_number (w, type);
6731 /* print value of mode-name (obsolete) */
6736 /* print hyphen and frame number, if != 1 */
6740 struct frame *f = XFRAME (w->frame);
6741 if (FRAME_TTY_P (f) && f->order_count > 1 && f->order_count <= 99999999)
6743 /* Naughty, naughty */
6744 char * writable_str = alloca_array (char, 10);
6745 sprintf (writable_str, "-%d", f->order_count);
6749 #endif /* HAVE_TTY */
6752 /* print Narrow if appropriate */
6754 if (BUF_BEGV (b) > BUF_BEG (b)
6755 || BUF_ZV (b) < BUF_Z (b))
6759 /* print %, * or hyphen, if buffer is read-only, modified or neither */
6761 str = (!NILP (b->read_only)
6763 : ((BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
6768 /* print * or hyphen -- XEmacs change to allow a buffer to be
6769 read-only but still indicate whether it is modified. */
6771 str = ((BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
6773 : (!NILP (b->read_only)
6778 /* #### defined in 19.29 decode_mode_spec, but not in
6779 modeline-format doc string. */
6780 /* This differs from %* in that it ignores read-only-ness. */
6782 str = ((BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
6787 /* print process status */
6789 obj = Fget_buffer_process (w->buffer);
6791 str = GETTEXT ("no process");
6793 obj = Fsymbol_name (Fprocess_status (obj));
6796 /* Print name of selected frame. */
6798 obj = XFRAME (w->frame)->name;
6801 /* indicate TEXT or BINARY */
6803 /* #### NT does not use this any more. Now what? */
6807 /* print percent of buffer above top of window, or Top, Bot or All */
6810 Bufpos pos = marker_position (w->start[type]);
6812 /* This had better be while the desired lines are being done. */
6813 if (w->window_end_pos[type] <= BUF_Z (b) - BUF_ZV (b))
6815 if (pos <= BUF_BEGV (b))
6820 else if (pos <= BUF_BEGV (b))
6824 /* This hard limit is ok since the string it will hold has a
6825 fixed maximum length of 3. But just to be safe... */
6827 Charcount chars = pos - BUF_BEGV (b);
6828 Charcount total = BUF_ZV (b) - BUF_BEGV (b);
6830 /* Avoid overflow on big buffers */
6831 int percent = total > LONG_MAX/200 ?
6832 (chars + total/200) / (total / 100) :
6833 (chars * 100 + total/2) / total;
6835 /* We can't normally display a 3-digit number, so get us a
6836 2-digit number that is close. */
6840 sprintf (buf, "%d%%", percent);
6841 Dynarr_add_many (mode_spec_bufbyte_string, (Bufbyte *) buf,
6844 goto decode_mode_spec_done;
6849 /* print percent of buffer above bottom of window, perhaps plus
6850 Top, or print Bottom or All */
6853 Bufpos toppos = marker_position (w->start[type]);
6854 Bufpos botpos = BUF_Z (b) - w->window_end_pos[type];
6856 /* botpos is only accurate as of the last redisplay, so we can
6857 only treat it as a hint. In particular, after erase-buffer,
6858 botpos may be negative. */
6859 if (botpos < toppos)
6862 if (botpos >= BUF_ZV (b))
6864 if (toppos <= BUF_BEGV (b))
6871 /* This hard limit is ok since the string it will hold has a
6872 fixed maximum length of around 6. But just to be safe... */
6874 Charcount chars = botpos - BUF_BEGV (b);
6875 Charcount total = BUF_ZV (b) - BUF_BEGV (b);
6877 /* Avoid overflow on big buffers */
6878 int percent = total > LONG_MAX/200 ?
6879 (chars + total/200) / (total / 100) :
6880 (chars * 100 + total/2) / max (total, 1);
6882 /* We can't normally display a 3-digit number, so get us a
6883 2-digit number that is close. */
6887 if (toppos <= BUF_BEGV (b))
6888 sprintf (buf, "Top%d%%", percent);
6890 sprintf (buf, "%d%%", percent);
6892 Dynarr_add_many (mode_spec_bufbyte_string, (Bufbyte *) buf,
6895 goto decode_mode_spec_done;
6905 /* print one [ for each recursive editing level. */
6910 if (command_loop_level > 5)
6916 for (i = 0; i < command_loop_level; i++)
6917 Dynarr_add (mode_spec_bufbyte_string, '[');
6919 goto decode_mode_spec_done;
6922 /* print one ] for each recursive editing level. */
6927 if (command_loop_level > 5)
6933 for (i = 0; i < command_loop_level; i++)
6934 Dynarr_add (mode_spec_bufbyte_string, ']');
6936 goto decode_mode_spec_done;
6939 /* print infinitely many dashes -- handle at top level now */
6946 Dynarr_add_many (mode_spec_bufbyte_string,
6948 XSTRING_LENGTH (obj));
6950 Dynarr_add_many (mode_spec_bufbyte_string, (Bufbyte *) str, strlen (str));
6952 decode_mode_spec_done:
6953 Dynarr_add (mode_spec_bufbyte_string, '\0');
6956 /* Given a display line, free all of its data structures. */
6959 free_display_line (struct display_line *dl)
6963 if (dl->display_blocks)
6965 for (block = 0; block < Dynarr_largest (dl->display_blocks); block++)
6967 struct display_block *db = Dynarr_atp (dl->display_blocks, block);
6969 Dynarr_free (db->runes);
6972 Dynarr_free (dl->display_blocks);
6973 dl->display_blocks = NULL;
6976 if (dl->left_glyphs)
6978 Dynarr_free (dl->left_glyphs);
6979 dl->left_glyphs = NULL;
6982 if (dl->right_glyphs)
6984 Dynarr_free (dl->right_glyphs);
6985 dl->right_glyphs = NULL;
6990 /* Given an array of display lines, free them and all data structures
6991 contained within them. */
6994 free_display_lines (display_line_dynarr *dla)
6998 for (line = 0; line < Dynarr_largest (dla); line++)
7000 free_display_line (Dynarr_atp (dla, line));
7006 /* Call internal free routine for each set of display lines. */
7009 free_display_structs (struct window_mirror *mir)
7011 if (mir->current_display_lines)
7013 free_display_lines (mir->current_display_lines);
7014 mir->current_display_lines = 0;
7017 if (mir->desired_display_lines)
7019 free_display_lines (mir->desired_display_lines);
7020 mir->desired_display_lines = 0;
7026 mark_glyph_block_dynarr (glyph_block_dynarr *gba)
7030 glyph_block *gb = Dynarr_atp (gba, 0);
7031 glyph_block *gb_last = Dynarr_atp (gba, Dynarr_length (gba));
7033 for (; gb < gb_last; gb++)
7035 if (!NILP (gb->glyph))
7036 mark_object (gb->glyph);
7037 if (!NILP (gb->extent))
7038 mark_object (gb->extent);
7043 /* See the comment in image_instantiate_cache_result as to why marking
7044 the glyph will also mark the image_instance. */
7046 mark_redisplay_structs (display_line_dynarr *dla)
7048 display_line *dl = Dynarr_atp (dla, 0);
7049 display_line *dl_last = Dynarr_atp (dla, Dynarr_length (dla));
7051 for (; dl < dl_last; dl++)
7053 display_block_dynarr *dba = dl->display_blocks;
7054 display_block *db = Dynarr_atp (dba, 0);
7055 display_block *db_last = Dynarr_atp (dba, Dynarr_length (dba));
7057 for (; db < db_last; db++)
7059 rune_dynarr *ra = db->runes;
7060 rune *r = Dynarr_atp (ra, 0);
7061 rune *r_last = Dynarr_atp (ra, Dynarr_length (ra));
7063 for (; r < r_last; r++)
7065 if (r->type == RUNE_DGLYPH)
7067 if (!NILP (r->object.dglyph.glyph))
7068 mark_object (r->object.dglyph.glyph);
7069 if (!NILP (r->object.dglyph.extent))
7070 mark_object (r->object.dglyph.extent);
7075 mark_glyph_block_dynarr (dl->left_glyphs);
7076 mark_glyph_block_dynarr (dl->right_glyphs);
7081 mark_window_mirror (struct window_mirror *mir)
7083 mark_redisplay_structs (mir->current_display_lines);
7084 mark_redisplay_structs (mir->desired_display_lines);
7087 mark_window_mirror (mir->next);
7090 mark_window_mirror (mir->hchild);
7091 else if (mir->vchild)
7092 mark_window_mirror (mir->vchild);
7096 mark_redisplay (void)
7098 Lisp_Object frmcons, devcons, concons;
7100 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
7102 struct frame *f = XFRAME (XCAR (frmcons));
7103 update_frame_window_mirror (f);
7104 mark_window_mirror (f->root_mirror);
7109 /*****************************************************************************
7110 Line Start Cache Description and Rationale
7112 The traditional scrolling code in Emacs breaks in a variable height world.
7113 It depends on the key assumption that the number of lines that can be
7114 displayed at any given time is fixed. This led to a complete separation
7115 of the scrolling code from the redisplay code. In order to fully support
7116 variable height lines, the scrolling code must actually be tightly
7117 integrated with redisplay. Only redisplay can determine how many lines
7118 will be displayed on a screen for any given starting point.
7120 What is ideally wanted is a complete list of the starting buffer position
7121 for every possible display line of a buffer along with the height of that
7122 display line. Maintaining such a full list would be very expensive. We
7123 settle for having it include information for all areas which we happen to
7124 generate anyhow (i.e. the region currently being displayed) and for those
7125 areas we need to work with.
7127 In order to ensure that the cache accurately represents what redisplay
7128 would actually show, it is necessary to invalidate it in many situations.
7129 If the buffer changes, the starting positions may no longer be correct.
7130 If a face or an extent has changed then the line heights may have altered.
7131 These events happen frequently enough that the cache can end up being
7132 constantly disabled. With this potentially constant invalidation when is
7133 the cache ever useful?
7135 Even if the cache is invalidated before every single usage, it is
7136 necessary. Scrolling often requires knowledge about display lines which
7137 are actually above or below the visible region. The cache provides a
7138 convenient light-weight method of storing this information for multiple
7139 display regions. This knowledge is necessary for the scrolling code to
7140 always obey the First Golden Rule of Redisplay.
7142 If the cache already contains all of the information that the scrolling
7143 routines happen to need so that it doesn't have to go generate it, then we
7144 are able to obey the Third Golden Rule of Redisplay. The first thing we
7145 do to help out the cache is to always add the displayed region. This
7146 region had to be generated anyway, so the cache ends up getting the
7147 information basically for free. In those cases where a user is simply
7148 scrolling around viewing a buffer there is a high probability that this is
7149 sufficient to always provide the needed information. The second thing we
7150 can do is be smart about invalidating the cache.
7152 TODO -- Be smart about invalidating the cache. Potential places:
7154 + Insertions at end-of-line which don't cause line-wraps do not alter the
7155 starting positions of any display lines. These types of buffer
7156 modifications should not invalidate the cache. This is actually a large
7157 optimization for redisplay speed as well.
7159 + Buffer modifications frequently only affect the display of lines at and
7160 below where they occur. In these situations we should only invalidate
7161 the part of the cache starting at where the modification occurs.
7163 In case you're wondering, the Second Golden Rule of Redisplay is not
7165 ****************************************************************************/
7167 /* This will get used quite a bit so we don't want to be constantly
7168 allocating and freeing it. */
7169 static line_start_cache_dynarr *internal_cache;
7171 /* Makes internal_cache represent the TYPE display structs and only
7172 the TYPE display structs. */
7175 update_internal_cache_list (struct window *w, int type)
7178 display_line_dynarr *dla = window_display_lines (w, type);
7180 Dynarr_reset (internal_cache);
7181 for (line = 0; line < Dynarr_length (dla); line++)
7183 struct display_line *dl = Dynarr_atp (dla, line);
7189 struct line_start_cache lsc;
7191 lsc.start = dl->bufpos;
7192 lsc.end = dl->end_bufpos;
7193 lsc.height = dl->ascent + dl->descent;
7195 Dynarr_add (internal_cache, lsc);
7200 /* Reset the line cache if necessary. This should be run at the
7201 beginning of any function which access the cache. */
7204 validate_line_start_cache (struct window *w)
7206 struct buffer *b = XBUFFER (w->buffer);
7207 struct frame *f = XFRAME (w->frame);
7209 if (!w->line_cache_validation_override)
7211 /* f->extents_changed used to be in here because extent face and
7212 size changes can cause text shifting. However, the extent
7213 covering the region is constantly having its face set and
7214 priority altered by the mouse code. This means that the line
7215 start cache is constantly being invalidated. This is bad
7216 since the mouse code also triggers heavy usage of the cache.
7217 Since it is an unlikely that f->extents being changed
7218 indicates that the cache really needs to be updated and if it
7219 does redisplay will catch it pretty quickly we no longer
7220 invalidate the cache if it is set. This greatly speeds up
7221 dragging out regions with the mouse. */
7222 if (XINT (w->line_cache_last_updated) < BUF_MODIFF (b)
7226 Dynarr_reset (w->line_start_cache);
7231 /* Return the very first buffer position contained in the given
7232 window's cache, or -1 if the cache is empty. Assumes that the
7236 line_start_cache_start (struct window *w)
7238 line_start_cache_dynarr *cache = w->line_start_cache;
7240 if (!Dynarr_length (cache))
7243 return Dynarr_atp (cache, 0)->start;
7246 /* Return the very last buffer position contained in the given
7247 window's cache, or -1 if the cache is empty. Assumes that the
7251 line_start_cache_end (struct window *w)
7253 line_start_cache_dynarr *cache = w->line_start_cache;
7255 if (!Dynarr_length (cache))
7258 return Dynarr_atp (cache, Dynarr_length (cache) - 1)->end;
7261 /* Return the index of the line POINT is contained within in window
7262 W's line start cache. It will enlarge the cache or move the cache
7263 window in order to have POINT be present in the cache. MIN_PAST is
7264 a guarantee of the number of entries in the cache present on either
7265 side of POINT (unless a buffer boundary is hit). If MIN_PAST is -1
7266 then it will be treated as 0, but the cache window will not be
7267 allowed to shift. Returns -1 if POINT cannot be found in the cache
7271 point_in_line_start_cache (struct window *w, Bufpos point, int min_past)
7273 struct buffer *b = XBUFFER (w->buffer);
7274 line_start_cache_dynarr *cache = w->line_start_cache;
7275 unsigned int top, bottom, pos;
7277 validate_line_start_cache (w);
7278 w->line_cache_validation_override++;
7280 /* Let functions pass in negative values, but we still treat -1
7282 /* #### bogosity alert */
7283 if (min_past < 0 && min_past != -1)
7284 min_past = -min_past;
7286 if (!Dynarr_length (cache) || line_start_cache_start (w) > point
7287 || line_start_cache_end (w) < point)
7290 int win_char_height = window_char_height (w, 1);
7292 /* Occasionally we get here with a 0 height
7293 window. find_next_newline_no_quit will abort if we pass it a
7294 count of 0 so handle that case. */
7295 if (!win_char_height)
7296 win_char_height = 1;
7298 if (!Dynarr_length (cache))
7300 Bufpos from = find_next_newline_no_quit (b, point, -1);
7301 Bufpos to = find_next_newline_no_quit (b, from, win_char_height);
7303 update_line_start_cache (w, from, to, point, 0);
7305 if (!Dynarr_length (cache))
7307 w->line_cache_validation_override--;
7312 assert (Dynarr_length (cache));
7315 while (line_start_cache_start (w) > point
7316 && (loop < cache_adjustment || min_past == -1))
7320 from = line_start_cache_start (w);
7321 if (from <= BUF_BEGV (b))
7324 from = find_next_newline_no_quit (b, from, -win_char_height);
7325 to = line_start_cache_end (w);
7327 update_line_start_cache (w, from, to, point, 0);
7331 if (line_start_cache_start (w) > point)
7335 from = find_next_newline_no_quit (b, point, -1);
7336 if (from >= BUF_ZV (b))
7338 to = find_next_newline_no_quit (b, from, -win_char_height);
7343 to = find_next_newline_no_quit (b, from, win_char_height);
7345 update_line_start_cache (w, from, to, point, 0);
7349 while (line_start_cache_end (w) < point
7350 && (loop < cache_adjustment || min_past == -1))
7354 to = line_start_cache_end (w);
7355 if (to >= BUF_ZV (b))
7358 from = line_start_cache_end (w);
7359 to = find_next_newline_no_quit (b, from, win_char_height);
7361 update_line_start_cache (w, from, to, point, 0);
7365 if (line_start_cache_end (w) < point)
7369 from = find_next_newline_no_quit (b, point, -1);
7370 if (from >= BUF_ZV (b))
7372 to = find_next_newline_no_quit (b, from, -win_char_height);
7377 to = find_next_newline_no_quit (b, from, win_char_height);
7379 update_line_start_cache (w, from, to, point, 0);
7383 assert (Dynarr_length (cache));
7388 /* This could happen if the buffer is narrowed. */
7389 if (line_start_cache_start (w) > point
7390 || line_start_cache_end (w) < point)
7392 w->line_cache_validation_override--;
7398 top = Dynarr_length (cache) - 1;
7403 unsigned int new_pos;
7406 pos = (bottom + top + 1) >> 1;
7407 start = Dynarr_atp (cache, pos)->start;
7408 end = Dynarr_atp (cache, pos)->end;
7410 if (point >= start && point <= end)
7412 if (pos < min_past && line_start_cache_start (w) > BUF_BEGV (b))
7415 find_next_newline_no_quit (b, line_start_cache_start (w),
7417 Bufpos to = line_start_cache_end (w);
7419 update_line_start_cache (w, from, to, point, 0);
7420 goto find_point_loop;
7422 else if ((Dynarr_length (cache) - pos - 1) < min_past
7423 && line_start_cache_end (w) < BUF_ZV (b))
7425 Bufpos from = line_start_cache_end (w);
7426 Bufpos to = find_next_newline_no_quit (b, from,
7431 update_line_start_cache (w, from, to, point, 0);
7432 goto find_point_loop;
7436 w->line_cache_validation_override--;
7440 else if (point > end)
7442 else if (point < start)
7447 new_pos = (bottom + top + 1) >> 1;
7450 w->line_cache_validation_override--;
7456 /* Return a boolean indicating if POINT would be visible in window W
7457 if display of the window was to begin at STARTP. */
7460 point_would_be_visible (struct window *w, Bufpos startp, Bufpos point)
7462 struct buffer *b = XBUFFER (w->buffer);
7463 int pixpos = -WINDOW_TEXT_TOP_CLIP(w);
7464 int bottom = WINDOW_TEXT_HEIGHT (w);
7467 /* If point is before the intended start it obviously can't be visible. */
7471 /* If point or start are not in the accessible buffer range, then
7473 if (startp < BUF_BEGV (b) || startp > BUF_ZV (b)
7474 || point < BUF_BEGV (b) || point > BUF_ZV (b))
7477 validate_line_start_cache (w);
7478 w->line_cache_validation_override++;
7480 start_elt = point_in_line_start_cache (w, startp, 0);
7481 if (start_elt == -1)
7483 w->line_cache_validation_override--;
7487 assert (line_start_cache_start (w) <= startp
7488 && line_start_cache_end (w) >= startp);
7494 /* Expand the cache if necessary. */
7495 if (start_elt == Dynarr_length (w->line_start_cache))
7498 Dynarr_atp (w->line_start_cache, start_elt - 1)->start;
7500 start_elt = point_in_line_start_cache (w, old_startp,
7501 window_char_height (w, 0));
7503 /* We've already actually processed old_startp, so increment
7507 /* If this happens we didn't add any extra elements. Bummer. */
7508 if (start_elt == Dynarr_length (w->line_start_cache))
7510 w->line_cache_validation_override--;
7515 height = Dynarr_atp (w->line_start_cache, start_elt)->height;
7517 if (pixpos + height > bottom)
7519 if (bottom - pixpos < VERTICAL_CLIP (w, 0))
7521 w->line_cache_validation_override--;
7527 if (point <= Dynarr_atp (w->line_start_cache, start_elt)->end)
7529 w->line_cache_validation_override--;
7537 /* For the given window W, if display starts at STARTP, what will be
7538 the buffer position at the beginning or end of the last line
7539 displayed. The end of the last line is also know as the window end
7542 WARNING: It is possible that rediplay failed to layout any lines for the
7543 windows. Under normal circumstances this is rare. However it seems that it
7544 does occur in the following situation: A mouse event has come in and we
7545 need to compute its location in a window. That code (in
7546 pixel_to_glyph_translation) already can handle 0 as an error return value.
7548 #### With a little work this could probably be reworked as just a
7549 call to start_with_line_at_pixpos. */
7552 start_end_of_last_line (struct window *w, Bufpos startp, int end,
7555 struct buffer *b = XBUFFER (w->buffer);
7556 line_start_cache_dynarr *cache = w->line_start_cache;
7558 int bottom = WINDOW_TEXT_HEIGHT (w);
7562 validate_line_start_cache (w);
7563 w->line_cache_validation_override++;
7565 if (startp < BUF_BEGV (b))
7566 startp = BUF_BEGV (b);
7567 else if (startp > BUF_ZV (b))
7568 startp = BUF_ZV (b);
7571 start_elt = point_in_line_start_cache (w, cur_start, 0);
7572 if (start_elt == -1)
7573 return may_error ? 0 : startp;
7577 int height = Dynarr_atp (cache, start_elt)->height;
7579 cur_start = Dynarr_atp (cache, start_elt)->start;
7581 if (pixpos + height > bottom)
7583 /* Adjust for any possible clip. */
7584 if (bottom - pixpos < VERTICAL_CLIP (w, 0))
7589 w->line_cache_validation_override--;
7593 return BUF_BEGV (b);
7597 w->line_cache_validation_override--;
7599 return Dynarr_atp (cache, start_elt)->end;
7601 return Dynarr_atp (cache, start_elt)->start;
7607 if (start_elt == Dynarr_length (cache))
7609 Bufpos from = line_start_cache_end (w);
7610 int win_char_height = window_char_height (w, 0);
7611 Bufpos to = find_next_newline_no_quit (b, from,
7616 /* We've hit the end of the bottom so that's what it is. */
7617 if (from >= BUF_ZV (b))
7619 w->line_cache_validation_override--;
7623 update_line_start_cache (w, from, to, BUF_PT (b), 0);
7625 /* Updating the cache invalidates any current indexes. */
7626 start_elt = point_in_line_start_cache (w, cur_start, -1) + 1;
7631 /* For the given window W, if display starts at STARTP, what will be
7632 the buffer position at the beginning of the last line displayed. */
7635 start_of_last_line (struct window *w, Bufpos startp)
7637 return start_end_of_last_line (w, startp, 0 , 0);
7640 /* For the given window W, if display starts at STARTP, what will be
7641 the buffer position at the end of the last line displayed. This is
7642 also know as the window end position. */
7645 end_of_last_line (struct window *w, Bufpos startp)
7647 return start_end_of_last_line (w, startp, 1, 0);
7651 end_of_last_line_may_error (struct window *w, Bufpos startp)
7653 return start_end_of_last_line (w, startp, 1, 1);
7657 /* For window W, what does the starting position have to be so that
7658 the line containing POINT will cover pixel position PIXPOS. */
7661 start_with_line_at_pixpos (struct window *w, Bufpos point, int pixpos)
7663 struct buffer *b = XBUFFER (w->buffer);
7665 Bufpos cur_pos, prev_pos = point;
7666 int point_line_height;
7667 int pixheight = pixpos - WINDOW_TEXT_TOP (w);
7669 validate_line_start_cache (w);
7670 w->line_cache_validation_override++;
7672 cur_elt = point_in_line_start_cache (w, point, 0);
7673 /* #### See comment in update_line_start_cache about big minibuffers. */
7676 w->line_cache_validation_override--;
7680 point_line_height = Dynarr_atp (w->line_start_cache, cur_elt)->height;
7684 cur_pos = Dynarr_atp (w->line_start_cache, cur_elt)->start;
7686 pixheight -= Dynarr_atp (w->line_start_cache, cur_elt)->height;
7688 /* Do not take into account the value of vertical_clip here.
7689 That is the responsibility of the calling functions. */
7692 w->line_cache_validation_override--;
7693 if (-pixheight > point_line_height)
7694 /* We can't make the target line cover pixpos, so put it
7695 above pixpos. That way it will at least be visible. */
7705 int win_char_height;
7707 if (cur_pos <= BUF_BEGV (b))
7709 w->line_cache_validation_override--;
7710 return BUF_BEGV (b);
7713 win_char_height = window_char_height (w, 0);
7714 if (!win_char_height)
7715 win_char_height = 1;
7717 from = find_next_newline_no_quit (b, cur_pos, -win_char_height);
7718 to = line_start_cache_end (w);
7719 update_line_start_cache (w, from, to, point, 0);
7721 cur_elt = point_in_line_start_cache (w, cur_pos, 2) - 1;
7722 assert (cur_elt >= -1);
7723 /* This used to be cur_elt>=0 under the assumption that if
7724 point is in the top line and not at BUF_BEGV, then
7725 setting the window_start to a newline before the start of
7726 the first line will always cause scrolling.
7728 However in my (jv) opinion this is wrong. That new line
7729 can be hidden in various ways: invisible extents, an
7730 explicit window-start not at a newline character etc.
7731 The existence of those are indeed known to create crashes
7732 on that assert. So we have no option but to continue the
7733 search if we found point at the top of the line_start_cache
7735 cur_pos = Dynarr_atp (w->line_start_cache,0)->start;
7741 /* For window W, what does the starting position have to be so that
7742 the line containing point is on display line LINE. If LINE is
7743 positive it is considered to be the number of lines from the top of
7744 the window (0 is the top line). If it is negative the number is
7745 considered to be the number of lines from the bottom (-1 is the
7749 start_with_point_on_display_line (struct window *w, Bufpos point, int line)
7751 validate_line_start_cache (w);
7752 w->line_cache_validation_override++;
7756 int cur_elt = point_in_line_start_cache (w, point, line);
7758 if (cur_elt - line < 0)
7759 cur_elt = 0; /* Hit the top */
7763 w->line_cache_validation_override--;
7764 return Dynarr_atp (w->line_start_cache, cur_elt)->start;
7768 /* The calculated value of pixpos is correct for the bottom line
7769 or what we want when line is -1. Therefore we subtract one
7770 because we have already handled one line. */
7771 int new_line = -line - 1;
7772 int cur_elt = point_in_line_start_cache (w, point, new_line);
7773 int pixpos = WINDOW_TEXT_BOTTOM (w);
7774 Bufpos retval, search_point;
7776 /* If scroll_on_clipped_lines is false, the last "visible" line of
7777 the window covers the pixel at WINDOW_TEXT_BOTTOM (w) - 1.
7778 If s_o_c_l is true, then we don't want to count a clipped
7779 line, so back up from the bottom by the height of the line
7780 containing point. */
7781 if (scroll_on_clipped_lines)
7782 pixpos -= Dynarr_atp (w->line_start_cache, cur_elt)->height;
7786 if (cur_elt + new_line >= Dynarr_length (w->line_start_cache))
7788 /* Hit the bottom of the buffer. */
7790 (cur_elt + new_line) - Dynarr_length (w->line_start_cache) + 1;
7794 XSETWINDOW (window, w);
7795 default_face_height_and_width (window, &defheight, 0);
7797 cur_elt = Dynarr_length (w->line_start_cache) - 1;
7799 pixpos -= (adjustment * defheight);
7800 if (pixpos < WINDOW_TEXT_TOP (w))
7801 pixpos = WINDOW_TEXT_TOP (w);
7804 cur_elt = cur_elt + new_line;
7806 search_point = Dynarr_atp (w->line_start_cache, cur_elt)->start;
7808 retval = start_with_line_at_pixpos (w, search_point, pixpos);
7809 w->line_cache_validation_override--;
7814 /* This is used to speed up vertical scrolling by caching the known
7815 buffer starting positions for display lines. This allows the
7816 scrolling routines to avoid costly calls to regenerate_window. If
7817 NO_REGEN is true then it will only add the values in the DESIRED
7818 display structs which are in the given range.
7820 Note also that the FROM/TO values are minimums. It is possible
7821 that this function will actually add information outside of the
7822 lines containing those positions. This can't hurt but it could
7825 #### We currently force the cache to have only 1 contiguous region.
7826 It might help to make the cache a dynarr of caches so that we can
7827 cover more areas. This might, however, turn out to be a lot of
7828 overhead for too little gain. */
7831 update_line_start_cache (struct window *w, Bufpos from, Bufpos to,
7832 Bufpos point, int no_regen)
7834 struct buffer *b = XBUFFER (w->buffer);
7835 line_start_cache_dynarr *cache = w->line_start_cache;
7836 Bufpos low_bound, high_bound;
7838 validate_line_start_cache (w);
7839 w->line_cache_validation_override++;
7841 if (from < BUF_BEGV (b))
7842 from = BUF_BEGV (b);
7843 if (to > BUF_ZV (b))
7848 w->line_cache_validation_override--;
7852 if (Dynarr_length (cache))
7854 low_bound = line_start_cache_start (w);
7855 high_bound = line_start_cache_end (w);
7857 /* Check to see if the desired range is already in the cache. */
7858 if (from >= low_bound && to <= high_bound)
7860 w->line_cache_validation_override--;
7864 /* Check to make sure that the desired range is adjacent to the
7865 current cache. If not, invalidate the cache. */
7866 if (to < low_bound || from > high_bound)
7868 Dynarr_reset (cache);
7869 low_bound = high_bound = -1;
7874 low_bound = high_bound = -1;
7877 w->line_cache_last_updated = make_int (BUF_MODIFF (b));
7879 /* This could be integrated into the next two sections, but it is easier
7880 to follow what's going on by having it separate. */
7885 update_internal_cache_list (w, DESIRED_DISP);
7886 if (!Dynarr_length (internal_cache))
7888 w->line_cache_validation_override--;
7892 start = Dynarr_atp (internal_cache, 0)->start;
7894 Dynarr_atp (internal_cache, Dynarr_length (internal_cache) - 1)->end;
7896 /* We aren't allowed to generate additional information to fill in
7897 gaps, so if the DESIRED structs don't overlap the cache, reset the
7899 if (Dynarr_length (cache))
7901 if (end < low_bound || start > high_bound)
7902 Dynarr_reset (cache);
7904 /* #### What should really happen if what we are doing is
7905 extending a line (the last line)? */
7906 if (Dynarr_length (cache) == 1
7907 && Dynarr_length (internal_cache) == 1)
7908 Dynarr_reset (cache);
7911 if (!Dynarr_length (cache))
7913 Dynarr_add_many (cache, Dynarr_atp (internal_cache, 0),
7914 Dynarr_length (internal_cache));
7915 w->line_cache_validation_override--;
7919 /* An extra check just in case the calling function didn't pass in
7920 the bounds of the DESIRED structs in the first place. */
7921 if (start >= low_bound && end <= high_bound)
7923 w->line_cache_validation_override--;
7927 /* At this point we know that the internal cache partially overlaps
7929 if (start < low_bound)
7931 int ic_elt = Dynarr_length (internal_cache) - 1;
7934 if (Dynarr_atp (internal_cache, ic_elt)->start < low_bound)
7942 Dynarr_reset (cache);
7943 Dynarr_add_many (cache, Dynarr_atp (internal_cache, 0),
7944 Dynarr_length (internal_cache));
7945 w->line_cache_validation_override--;
7949 Dynarr_insert_many_at_start (cache, Dynarr_atp (internal_cache, 0),
7953 if (end > high_bound)
7957 while (ic_elt < Dynarr_length (internal_cache))
7959 if (Dynarr_atp (internal_cache, ic_elt)->start > high_bound)
7965 if (!(ic_elt < Dynarr_length (internal_cache)))
7967 Dynarr_reset (cache);
7968 Dynarr_add_many (cache, Dynarr_atp (internal_cache, 0),
7969 Dynarr_length (internal_cache));
7970 w->line_cache_validation_override--;
7974 Dynarr_add_many (cache, Dynarr_atp (internal_cache, ic_elt),
7975 Dynarr_length (internal_cache) - ic_elt);
7978 w->line_cache_validation_override--;
7982 if (!Dynarr_length (cache) || from < low_bound)
7984 Bufpos startp = find_next_newline_no_quit (b, from, -1);
7986 int old_lb = low_bound;
7988 while (startp < old_lb || low_bound == -1)
7993 regenerate_window (w, startp, point, CMOTION_DISP);
7994 update_internal_cache_list (w, CMOTION_DISP);
7996 /* If this assert is triggered then regenerate_window failed
7997 to layout a single line. This is not possible since we
7998 force at least a single line to be layout for CMOTION_DISP */
7999 assert (Dynarr_length (internal_cache));
8000 assert (startp == Dynarr_atp (internal_cache, 0)->start);
8002 ic_elt = Dynarr_length (internal_cache) - 1;
8003 if (low_bound != -1)
8007 if (Dynarr_atp (internal_cache, ic_elt)->start < old_lb)
8013 assert (ic_elt >= 0);
8015 new_startp = Dynarr_atp (internal_cache, ic_elt)->end + 1;
8018 * Handle invisible text properly:
8019 * If the last line we're inserting has the same end as the
8020 * line before which it will be added, merge the two lines.
8022 if (Dynarr_length (cache) &&
8023 Dynarr_atp (internal_cache, ic_elt)->end ==
8024 Dynarr_atp (cache, marker)->end)
8026 Dynarr_atp (cache, marker)->start
8027 = Dynarr_atp (internal_cache, ic_elt)->start;
8028 Dynarr_atp (cache, marker)->height
8029 = Dynarr_atp (internal_cache, ic_elt)->height;
8033 if (ic_elt >= 0) /* we still have lines to add.. */
8035 Dynarr_insert_many (cache, Dynarr_atp (internal_cache, 0),
8036 ic_elt + 1, marker);
8037 marker += (ic_elt + 1);
8040 if (startp < low_bound || low_bound == -1)
8042 startp = new_startp;
8043 if (startp > BUF_ZV (b))
8045 w->line_cache_validation_override--;
8051 assert (Dynarr_length (cache));
8052 assert (from >= low_bound);
8054 /* Readjust the high_bound to account for any changes made while
8055 correcting the low_bound. */
8056 high_bound = Dynarr_atp (cache, Dynarr_length (cache) - 1)->end;
8058 if (to > high_bound)
8060 Bufpos startp = Dynarr_atp (cache, Dynarr_length (cache) - 1)->end + 1;
8064 regenerate_window (w, startp, point, CMOTION_DISP);
8065 update_internal_cache_list (w, CMOTION_DISP);
8067 /* See comment above about regenerate_window failing. */
8068 assert (Dynarr_length (internal_cache));
8070 Dynarr_add_many (cache, Dynarr_atp (internal_cache, 0),
8071 Dynarr_length (internal_cache));
8072 high_bound = Dynarr_atp (cache, Dynarr_length (cache) - 1)->end;
8073 startp = high_bound + 1;
8075 while (to > high_bound);
8078 w->line_cache_validation_override--;
8079 assert (to <= high_bound);
8083 /* Given x and y coordinates in characters, relative to a window,
8084 return the pixel location corresponding to those coordinates. The
8085 pixel location returned is the center of the given character
8086 position. The pixel values are generated relative to the window,
8089 The modeline is considered to be part of the window. */
8092 glyph_to_pixel_translation (struct window *w, int char_x, int char_y,
8093 int *pix_x, int *pix_y)
8095 display_line_dynarr *dla = window_display_lines (w, CURRENT_DISP);
8096 int num_disp_lines, modeline;
8098 int defheight, defwidth;
8100 XSETWINDOW (window, w);
8101 default_face_height_and_width (window, &defheight, &defwidth);
8103 /* If we get a bogus value indicating somewhere above or to the left of
8104 the window, use the first window line or character position
8111 num_disp_lines = Dynarr_length (dla);
8115 if (Dynarr_atp (dla, 0)->modeline)
8122 /* First check if the y position intersects the display lines. */
8123 if (char_y < num_disp_lines)
8125 struct display_line *dl = Dynarr_atp (dla, char_y + modeline);
8126 struct display_block *db = get_display_block_from_line (dl, TEXT);
8128 *pix_y = (dl->ypos - dl->ascent +
8129 ((unsigned int) (dl->ascent + dl->descent - dl->clip) >> 1));
8131 if (char_x < Dynarr_length (db->runes))
8133 struct rune *rb = Dynarr_atp (db->runes, char_x);
8135 *pix_x = rb->xpos + (rb->width >> 1);
8139 int last_rune = Dynarr_length (db->runes) - 1;
8140 struct rune *rb = Dynarr_atp (db->runes, last_rune);
8142 char_x -= last_rune;
8144 *pix_x = rb->xpos + rb->width;
8145 *pix_x += ((char_x - 1) * defwidth);
8146 *pix_x += (defwidth >> 1);
8151 /* It didn't intersect, so extrapolate. #### For now, we include the
8152 modeline in this since we don't have true character positions in
8155 if (!Dynarr_length (w->face_cachels))
8156 reset_face_cachels (w);
8158 char_y -= num_disp_lines;
8160 if (Dynarr_length (dla))
8162 struct display_line *dl = Dynarr_atp (dla, Dynarr_length (dla) - 1);
8163 *pix_y = dl->ypos + dl->descent - dl->clip;
8166 *pix_y = WINDOW_TEXT_TOP (w);
8168 *pix_y += (char_y * defheight);
8169 *pix_y += (defheight >> 1);
8171 *pix_x = WINDOW_TEXT_LEFT (w);
8172 /* Don't adjust by one because this is still the unadjusted value. */
8173 *pix_x += (char_x * defwidth);
8174 *pix_x += (defwidth >> 1);
8177 if (*pix_x > w->pixel_left + w->pixel_width)
8178 *pix_x = w->pixel_left + w->pixel_width;
8179 if (*pix_y > w->pixel_top + w->pixel_height)
8180 *pix_y = w->pixel_top + w->pixel_height;
8182 *pix_x -= w->pixel_left;
8183 *pix_y -= w->pixel_top;
8186 /* Given a display line and a position, determine if there is a glyph
8187 there and return information about it if there is. */
8190 get_position_object (struct display_line *dl, Lisp_Object *obj1,
8191 Lisp_Object *obj2, int x_coord, int *low_x_coord,
8194 struct display_block *db;
8197 get_next_display_block (dl->bounds, dl->display_blocks, x_coord, 0);
8199 /* We use get_next_display_block to get the actual display block
8200 that would be displayed at x_coord. */
8202 if (block == NO_BLOCK)
8205 db = Dynarr_atp (dl->display_blocks, block);
8207 for (elt = 0; elt < Dynarr_length (db->runes); elt++)
8209 struct rune *rb = Dynarr_atp (db->runes, elt);
8211 if (rb->xpos <= x_coord && x_coord < (rb->xpos + rb->width))
8213 if (rb->type == RUNE_DGLYPH)
8215 *obj1 = rb->object.dglyph.glyph;
8216 *obj2 = rb->object.dglyph.extent;
8225 *low_x_coord = rb->xpos;
8227 *high_x_coord = rb->xpos + rb->width;
8234 #define UPDATE_CACHE_RETURN \
8236 d->pixel_to_glyph_cache.valid = 1; \
8237 d->pixel_to_glyph_cache.low_x_coord = low_x_coord; \
8238 d->pixel_to_glyph_cache.high_x_coord = high_x_coord; \
8239 d->pixel_to_glyph_cache.low_y_coord = low_y_coord; \
8240 d->pixel_to_glyph_cache.high_y_coord = high_y_coord; \
8241 d->pixel_to_glyph_cache.frame = f; \
8242 d->pixel_to_glyph_cache.col = *col; \
8243 d->pixel_to_glyph_cache.row = *row; \
8244 d->pixel_to_glyph_cache.obj_x = *obj_x; \
8245 d->pixel_to_glyph_cache.obj_y = *obj_y; \
8246 d->pixel_to_glyph_cache.w = *w; \
8247 d->pixel_to_glyph_cache.bufpos = *bufpos; \
8248 d->pixel_to_glyph_cache.closest = *closest; \
8249 d->pixel_to_glyph_cache.modeline_closest = *modeline_closest; \
8250 d->pixel_to_glyph_cache.obj1 = *obj1; \
8251 d->pixel_to_glyph_cache.obj2 = *obj2; \
8252 d->pixel_to_glyph_cache.retval = position; \
8253 RETURN_SANS_WARNINGS position; \
8256 /* Given x and y coordinates in pixels relative to a frame, return
8257 information about what is located under those coordinates.
8259 The return value will be one of:
8261 OVER_TOOLBAR: over one of the 4 frame toolbars
8262 OVER_MODELINE: over a modeline
8263 OVER_BORDER: over an internal border
8264 OVER_NOTHING: over the text area, but not over text
8265 OVER_OUTSIDE: outside of the frame border
8266 OVER_TEXT: over text in the text area
8272 -- nil if the coordinates are not over a glyph or a toolbar button.
8276 -- an extent, if the coordinates are over a glyph in the text area
8279 If the coordinates are over a glyph, OBJ_X and OBJ_Y give the
8280 equivalent coordinates relative to the upper-left corner of the glyph.
8282 If the coordinates are over a character, OBJ_X and OBJ_Y give the
8283 equivalent coordinates relative to the upper-left corner of the character.
8285 Otherwise, OBJ_X and OBJ_Y are undefined.
8289 pixel_to_glyph_translation (struct frame *f, int x_coord, int y_coord,
8290 int *col, int *row, int *obj_x, int *obj_y,
8291 struct window **w, Bufpos *bufpos,
8292 Bufpos *closest, Charcount *modeline_closest,
8293 Lisp_Object *obj1, Lisp_Object *obj2)
8296 struct pixel_to_glyph_translation_cache *cache;
8298 int frm_left, frm_right, frm_top, frm_bottom;
8299 int low_x_coord, high_x_coord, low_y_coord, high_y_coord;
8300 int position = OVER_NOTHING;
8301 int device_check_failed = 0;
8302 display_line_dynarr *dla;
8304 /* This is a safety valve in case this got called with a frame in
8305 the middle of being deleted. */
8306 if (!DEVICEP (f->device) || !DEVICE_LIVE_P (XDEVICE (f->device)))
8308 device_check_failed = 1;
8309 d = NULL, cache = NULL; /* Warning suppression */
8313 d = XDEVICE (f->device);
8314 cache = &d->pixel_to_glyph_cache;
8317 if (!device_check_failed
8319 && cache->frame == f
8320 && cache->low_x_coord <= x_coord
8321 && cache->high_x_coord > x_coord
8322 && cache->low_y_coord <= y_coord
8323 && cache->high_y_coord > y_coord)
8327 *obj_x = cache->obj_x;
8328 *obj_y = cache->obj_y;
8330 *bufpos = cache->bufpos;
8331 *closest = cache->closest;
8332 *modeline_closest = cache->modeline_closest;
8333 *obj1 = cache->obj1;
8334 *obj2 = cache->obj2;
8336 return cache->retval;
8347 *modeline_closest = -1;
8351 low_x_coord = x_coord;
8352 high_x_coord = x_coord + 1;
8353 low_y_coord = y_coord;
8354 high_y_coord = y_coord + 1;
8357 if (device_check_failed)
8358 return OVER_NOTHING;
8360 frm_left = FRAME_LEFT_BORDER_END (f);
8361 frm_right = FRAME_RIGHT_BORDER_START (f);
8362 frm_top = FRAME_TOP_BORDER_END (f);
8363 frm_bottom = FRAME_BOTTOM_BORDER_START (f);
8365 /* Check if the mouse is outside of the text area actually used by
8367 if (y_coord < frm_top)
8369 if (y_coord >= FRAME_TOP_BORDER_START (f))
8371 low_y_coord = FRAME_TOP_BORDER_START (f);
8372 high_y_coord = frm_top;
8373 position = OVER_BORDER;
8375 else if (y_coord >= 0)
8378 high_y_coord = FRAME_TOP_BORDER_START (f);
8379 position = OVER_TOOLBAR;
8383 low_y_coord = y_coord;
8385 position = OVER_OUTSIDE;
8388 else if (y_coord >= frm_bottom)
8390 if (y_coord < FRAME_BOTTOM_BORDER_END (f))
8392 low_y_coord = frm_bottom;
8393 high_y_coord = FRAME_BOTTOM_BORDER_END (f);
8394 position = OVER_BORDER;
8396 else if (y_coord < FRAME_PIXHEIGHT (f))
8398 low_y_coord = FRAME_BOTTOM_BORDER_END (f);
8399 high_y_coord = FRAME_PIXHEIGHT (f);
8400 position = OVER_TOOLBAR;
8404 low_y_coord = FRAME_PIXHEIGHT (f);
8405 high_y_coord = y_coord;
8406 position = OVER_OUTSIDE;
8410 if (position != OVER_TOOLBAR && position != OVER_BORDER)
8412 if (x_coord < frm_left)
8414 if (x_coord >= FRAME_LEFT_BORDER_START (f))
8416 low_x_coord = FRAME_LEFT_BORDER_START (f);
8417 high_x_coord = frm_left;
8418 position = OVER_BORDER;
8420 else if (x_coord >= 0)
8423 high_x_coord = FRAME_LEFT_BORDER_START (f);
8424 position = OVER_TOOLBAR;
8428 low_x_coord = x_coord;
8430 position = OVER_OUTSIDE;
8433 else if (x_coord >= frm_right)
8435 if (x_coord < FRAME_RIGHT_BORDER_END (f))
8437 low_x_coord = frm_right;
8438 high_x_coord = FRAME_RIGHT_BORDER_END (f);
8439 position = OVER_BORDER;
8441 else if (x_coord < FRAME_PIXWIDTH (f))
8443 low_x_coord = FRAME_RIGHT_BORDER_END (f);
8444 high_x_coord = FRAME_PIXWIDTH (f);
8445 position = OVER_TOOLBAR;
8449 low_x_coord = FRAME_PIXWIDTH (f);
8450 high_x_coord = x_coord;
8451 position = OVER_OUTSIDE;
8456 #ifdef HAVE_TOOLBARS
8457 if (position == OVER_TOOLBAR)
8459 *obj1 = toolbar_button_at_pixpos (f, x_coord, y_coord);
8462 UPDATE_CACHE_RETURN;
8464 #endif /* HAVE_TOOLBARS */
8466 /* We still have to return the window the pointer is next to and its
8467 relative y position even if it is outside the x boundary. */
8468 if (x_coord < frm_left)
8470 else if (x_coord > frm_right)
8471 x_coord = frm_right;
8473 /* Same in reverse. */
8474 if (y_coord < frm_top)
8476 else if (y_coord > frm_bottom)
8477 y_coord = frm_bottom;
8479 /* Find what window the given coordinates are actually in. */
8480 window = f->root_window;
8481 *w = find_window_by_pixel_pos (x_coord, y_coord, window);
8483 /* If we didn't find a window, we're done. */
8486 UPDATE_CACHE_RETURN;
8488 else if (position != OVER_NOTHING)
8491 *modeline_closest = -1;
8493 if (high_y_coord <= frm_top || high_y_coord >= frm_bottom)
8496 UPDATE_CACHE_RETURN;
8500 /* Check if the window is a minibuffer but isn't active. */
8501 if (MINI_WINDOW_P (*w) && !minibuf_level)
8503 /* Must reset the window value since some callers will ignore
8504 the return value if it is set. */
8506 UPDATE_CACHE_RETURN;
8509 /* See if the point is over window vertical divider */
8510 if (window_needs_vertical_divider (*w))
8512 int div_x_high = WINDOW_RIGHT (*w);
8513 int div_x_low = div_x_high - window_divider_width (*w);
8514 int div_y_high = WINDOW_BOTTOM (*w);
8515 int div_y_low = WINDOW_TOP (*w);
8517 if (div_x_low < x_coord && x_coord <= div_x_high &&
8518 div_y_low < y_coord && y_coord <= div_y_high)
8520 low_x_coord = div_x_low;
8521 high_x_coord = div_x_high;
8522 low_y_coord = div_y_low;
8523 high_y_coord = div_y_high;
8524 position = OVER_V_DIVIDER;
8525 UPDATE_CACHE_RETURN;
8529 dla = window_display_lines (*w, CURRENT_DISP);
8531 for (*row = 0; *row < Dynarr_length (dla); (*row)++)
8533 int really_over_nothing = 0;
8534 struct display_line *dl = Dynarr_atp (dla, *row);
8536 if ((int) (dl->ypos - dl->ascent) <= y_coord
8537 && y_coord <= (int) (dl->ypos + dl->descent))
8539 int check_margin_glyphs = 0;
8540 struct display_block *db = get_display_block_from_line (dl, TEXT);
8541 struct rune *rb = 0;
8543 if (x_coord < dl->bounds.left_white
8544 || x_coord >= dl->bounds.right_white)
8545 check_margin_glyphs = 1;
8547 low_y_coord = dl->ypos - dl->ascent;
8548 high_y_coord = dl->ypos + dl->descent + 1;
8550 if (position == OVER_BORDER
8551 || position == OVER_OUTSIDE
8552 || check_margin_glyphs)
8554 int x_check, left_bound;
8556 if (check_margin_glyphs)
8559 left_bound = dl->bounds.left_white;
8563 x_check = high_x_coord;
8564 left_bound = frm_left;
8567 if (Dynarr_length (db->runes))
8569 if (x_check <= left_bound)
8572 *modeline_closest = Dynarr_atp (db->runes, 0)->bufpos;
8574 *closest = Dynarr_atp (db->runes, 0)->bufpos;
8580 Dynarr_atp (db->runes,
8581 Dynarr_length (db->runes) - 1)->bufpos;
8584 Dynarr_atp (db->runes,
8585 Dynarr_length (db->runes) - 1)->bufpos;
8589 *modeline_closest += dl->offset;
8591 *closest += dl->offset;
8595 /* #### What should be here. */
8597 *modeline_closest = 0;
8602 if (check_margin_glyphs)
8604 if (x_coord < dl->bounds.left_in
8605 || x_coord >= dl->bounds.right_in)
8607 /* If we are over the outside margins then we
8608 know the loop over the text block isn't going
8609 to accomplish anything. So we go ahead and
8610 set what information we can right here and
8613 *obj_y = y_coord - (dl->ypos - dl->ascent);
8614 get_position_object (dl, obj1, obj2, x_coord,
8615 &low_x_coord, &high_x_coord);
8617 UPDATE_CACHE_RETURN;
8621 UPDATE_CACHE_RETURN;
8624 for (*col = 0; *col <= Dynarr_length (db->runes); (*col)++)
8626 int past_end = (*col == Dynarr_length (db->runes));
8629 rb = Dynarr_atp (db->runes, *col);
8632 (rb->xpos <= x_coord && x_coord < rb->xpos + rb->width))
8637 rb = Dynarr_atp (db->runes, *col);
8640 *bufpos = rb->bufpos + dl->offset;
8641 low_x_coord = rb->xpos;
8642 high_x_coord = rb->xpos + rb->width;
8644 if (rb->type == RUNE_DGLYPH)
8648 /* Find the first character after the glyph. */
8649 while (elt < Dynarr_length (db->runes))
8651 if (Dynarr_atp (db->runes, elt)->type != RUNE_DGLYPH)
8655 (Dynarr_atp (db->runes, elt)->bufpos +
8659 (Dynarr_atp (db->runes, elt)->bufpos +
8667 /* In this case we failed to find a non-glyph
8668 character so we return the last position
8669 displayed on the line. */
8670 if (elt == Dynarr_length (db->runes))
8673 *modeline_closest = dl->end_bufpos + dl->offset;
8675 *closest = dl->end_bufpos + dl->offset;
8676 really_over_nothing = 1;
8682 *modeline_closest = rb->bufpos + dl->offset;
8684 *closest = rb->bufpos + dl->offset;
8689 *row = window_displayed_height (*w);
8691 if (position == OVER_NOTHING)
8692 position = OVER_MODELINE;
8694 if (rb->type == RUNE_DGLYPH)
8696 *obj1 = rb->object.dglyph.glyph;
8697 *obj2 = rb->object.dglyph.extent;
8699 else if (rb->type == RUNE_CHAR)
8710 UPDATE_CACHE_RETURN;
8713 || (rb->type == RUNE_CHAR
8714 && CHARC_ASCII_EQ (rb->object.cglyph, '\n')))
8717 /* At this point we may have glyphs in the right
8719 if (check_margin_glyphs)
8720 get_position_object (dl, obj1, obj2, x_coord,
8721 &low_x_coord, &high_x_coord);
8722 UPDATE_CACHE_RETURN;
8727 if (rb->type == RUNE_DGLYPH)
8729 *obj1 = rb->object.dglyph.glyph;
8730 *obj2 = rb->object.dglyph.extent;
8732 else if (rb->type == RUNE_CHAR)
8743 *obj_x = x_coord - rb->xpos;
8744 *obj_y = y_coord - (dl->ypos - dl->ascent);
8746 /* At this point we may have glyphs in the left
8748 if (check_margin_glyphs)
8749 get_position_object (dl, obj1, obj2, x_coord, 0, 0);
8751 if (position == OVER_NOTHING && !really_over_nothing)
8752 position = OVER_TEXT;
8754 UPDATE_CACHE_RETURN;
8761 *row = Dynarr_length (dla) - 1;
8762 if (FRAME_WIN_P (f))
8764 int bot_elt = Dynarr_length (dla) - 1;
8768 struct display_line *dl = Dynarr_atp (dla, bot_elt);
8769 int adj_area = y_coord - (dl->ypos + dl->descent);
8773 XSETWINDOW (lwin, *w);
8774 default_face_height_and_width (lwin, 0, &defheight);
8776 *row += (adj_area / defheight);
8780 /* #### This should be checked out some more to determine what
8781 should really be going on. */
8782 if (!MARKERP ((*w)->start[CURRENT_DISP]))
8785 *closest = end_of_last_line_may_error (*w,
8786 marker_position ((*w)->start[CURRENT_DISP]));
8788 UPDATE_CACHE_RETURN;
8790 #undef UPDATE_CACHE_RETURN
8793 /***************************************************************************/
8795 /* Lisp functions */
8797 /***************************************************************************/
8799 DEFUN ("redisplay-echo-area", Fredisplay_echo_area, 0, 0, 0, /*
8800 Ensure that all minibuffers are correctly showing the echo area.
8804 Lisp_Object devcons, concons;
8806 DEVICE_LOOP_NO_BREAK (devcons, concons)
8808 struct device *d = XDEVICE (XCAR (devcons));
8809 Lisp_Object frmcons;
8811 DEVICE_FRAME_LOOP (frmcons, d)
8813 struct frame *f = XFRAME (XCAR (frmcons));
8815 if (FRAME_REPAINT_P (f) && FRAME_HAS_MINIBUF_P (f))
8817 Lisp_Object window = FRAME_MINIBUF_WINDOW (f);
8819 MAYBE_DEVMETH (d, frame_output_begin, (f));
8822 * If the frame size has changed, there may be random
8823 * chud on the screen left from previous messages
8824 * because redisplay_frame hasn't been called yet.
8825 * Clear the screen to get rid of the potential mess.
8827 if (f->echo_area_garbaged)
8829 MAYBE_DEVMETH (d, clear_frame, (f));
8830 f->echo_area_garbaged = 0;
8832 redisplay_window (window, 0);
8833 MAYBE_DEVMETH (d, frame_output_end, (f));
8835 call_redisplay_end_triggers (XWINDOW (window), 0);
8844 restore_disable_preemption_value (Lisp_Object value)
8846 disable_preemption = XINT (value);
8850 DEFUN ("redraw-frame", Fredraw_frame, 0, 2, 0, /*
8851 Clear frame FRAME and output again what is supposed to appear on it.
8852 FRAME defaults to the selected frame if omitted.
8853 Normally, redisplay is preempted as normal if input arrives. However,
8854 if optional second arg NO-PREEMPT is non-nil, redisplay will not stop for
8855 input and is guaranteed to proceed to completion.
8857 (frame, no_preempt))
8859 struct frame *f = decode_frame (frame);
8860 int count = specpdl_depth ();
8862 if (!NILP (no_preempt))
8864 record_unwind_protect (restore_disable_preemption_value,
8865 make_int (disable_preemption));
8866 disable_preemption++;
8870 redisplay_frame (f, 1);
8872 /* See the comment in Fredisplay_frame. */
8873 RESET_CHANGED_SET_FLAGS;
8875 return unbind_to (count, Qnil);
8878 DEFUN ("redisplay-frame", Fredisplay_frame, 0, 2, 0, /*
8879 Ensure that FRAME's contents are correctly displayed.
8880 This differs from `redraw-frame' in that it only redraws what needs to
8881 be updated, as opposed to unconditionally clearing and redrawing
8883 FRAME defaults to the selected frame if omitted.
8884 Normally, redisplay is preempted as normal if input arrives. However,
8885 if optional second arg NO-PREEMPT is non-nil, redisplay will not stop for
8886 input and is guaranteed to proceed to completion.
8888 (frame, no_preempt))
8890 struct frame *f = decode_frame (frame);
8891 int count = specpdl_depth ();
8893 if (!NILP (no_preempt))
8895 record_unwind_protect (restore_disable_preemption_value,
8896 make_int (disable_preemption));
8897 disable_preemption++;
8900 redisplay_frame (f, 1);
8902 /* If we don't reset the global redisplay flafs here, subsequent
8903 changes to the display will not get registered by redisplay
8904 because it thinks it already has registered changes. If you
8905 really knew what you were doing you could confuse redisplay by
8906 calling Fredisplay_frame while updating another frame. We assume
8907 that if you know what you are doing you will not be that
8909 RESET_CHANGED_SET_FLAGS;
8911 return unbind_to (count, Qnil);
8914 DEFUN ("redraw-device", Fredraw_device, 0, 2, 0, /*
8915 Clear device DEVICE and output again what is supposed to appear on it.
8916 DEVICE defaults to the selected device if omitted.
8917 Normally, redisplay is preempted as normal if input arrives. However,
8918 if optional second arg NO-PREEMPT is non-nil, redisplay will not stop for
8919 input and is guaranteed to proceed to completion.
8921 (device, no_preempt))
8923 struct device *d = decode_device (device);
8924 Lisp_Object frmcons;
8925 int count = specpdl_depth ();
8927 if (!NILP (no_preempt))
8929 record_unwind_protect (restore_disable_preemption_value,
8930 make_int (disable_preemption));
8931 disable_preemption++;
8934 DEVICE_FRAME_LOOP (frmcons, d)
8936 XFRAME (XCAR (frmcons))->clear = 1;
8938 redisplay_device (d, 0);
8940 /* See the comment in Fredisplay_frame. */
8941 RESET_CHANGED_SET_FLAGS;
8943 return unbind_to (count, Qnil);
8946 DEFUN ("redisplay-device", Fredisplay_device, 0, 2, 0, /*
8947 Ensure that DEVICE's contents are correctly displayed.
8948 This differs from `redraw-device' in that it only redraws what needs to
8949 be updated, as opposed to unconditionally clearing and redrawing
8951 DEVICE defaults to the selected device if omitted.
8952 Normally, redisplay is preempted as normal if input arrives. However,
8953 if optional second arg NO-PREEMPT is non-nil, redisplay will not stop for
8954 input and is guaranteed to proceed to completion.
8956 (device, no_preempt))
8958 struct device *d = decode_device (device);
8959 int count = specpdl_depth ();
8961 if (!NILP (no_preempt))
8963 record_unwind_protect (restore_disable_preemption_value,
8964 make_int (disable_preemption));
8965 disable_preemption++;
8968 redisplay_device (d, 0);
8970 /* See the comment in Fredisplay_frame. */
8971 RESET_CHANGED_SET_FLAGS;
8973 return unbind_to (count, Qnil);
8976 /* Big lie. Big lie. This will force all modelines to be updated
8977 regardless if the all flag is set or not. It remains in existence
8978 solely for backwards compatibility. */
8979 DEFUN ("redraw-modeline", Fredraw_modeline, 0, 1, 0, /*
8980 Force the modeline of the current buffer to be redisplayed.
8981 With optional non-nil ALL, force redisplay of all modelines.
8985 MARK_MODELINE_CHANGED;
8989 DEFUN ("force-cursor-redisplay", Fforce_cursor_redisplay, 0, 1, 0, /*
8990 Force an immediate update of the cursor on FRAME.
8991 FRAME defaults to the selected frame if omitted.
8995 redisplay_redraw_cursor (decode_frame (frame), 1);
9000 /***************************************************************************/
9002 /* Lisp-variable change triggers */
9004 /***************************************************************************/
9007 margin_width_changed_in_frame (Lisp_Object specifier, struct frame *f,
9010 /* Nothing to be done? */
9014 redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
9015 Lisp_Object in_object, int flags)
9017 /* #### clip_changed should really be renamed something like
9018 global_redisplay_change. */
9023 /* This is called if the built-in glyphs have their properties
9026 redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
9029 if (WINDOWP (locale))
9031 MARK_FRAME_GLYPHS_CHANGED (XFRAME (WINDOW_FRAME (XWINDOW (locale))));
9033 else if (FRAMEP (locale))
9035 MARK_FRAME_GLYPHS_CHANGED (XFRAME (locale));
9037 else if (DEVICEP (locale))
9039 Lisp_Object frmcons;
9040 DEVICE_FRAME_LOOP (frmcons, XDEVICE (locale))
9041 MARK_FRAME_GLYPHS_CHANGED (XFRAME (XCAR (frmcons)));
9043 else if (CONSOLEP (locale))
9045 Lisp_Object frmcons, devcons;
9046 CONSOLE_FRAME_LOOP_NO_BREAK (frmcons, devcons, XCONSOLE (locale))
9047 MARK_FRAME_GLYPHS_CHANGED (XFRAME (XCAR (frmcons)));
9049 else /* global or buffer */
9051 Lisp_Object frmcons, devcons, concons;
9052 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
9053 MARK_FRAME_GLYPHS_CHANGED (XFRAME (XCAR (frmcons)));
9058 text_cursor_visible_p_changed (Lisp_Object specifier, struct window *w,
9061 if (XFRAME (w->frame)->init_finished)
9062 Fforce_cursor_redisplay (w->frame);
9065 #ifdef MEMORY_USAGE_STATS
9068 /***************************************************************************/
9070 /* memory usage computation */
9072 /***************************************************************************/
9075 compute_rune_dynarr_usage (rune_dynarr *dyn, struct overhead_stats *ovstats)
9077 return dyn ? Dynarr_memory_usage (dyn, ovstats) : 0;
9081 compute_display_block_dynarr_usage (display_block_dynarr *dyn,
9082 struct overhead_stats *ovstats)
9089 total = Dynarr_memory_usage (dyn, ovstats);
9090 for (i = 0; i < Dynarr_largest (dyn); i++)
9091 total += compute_rune_dynarr_usage (Dynarr_at (dyn, i).runes, ovstats);
9097 compute_glyph_block_dynarr_usage (glyph_block_dynarr *dyn,
9098 struct overhead_stats *ovstats)
9100 return dyn ? Dynarr_memory_usage (dyn, ovstats) : 0;
9104 compute_display_line_dynarr_usage (display_line_dynarr *dyn,
9105 struct overhead_stats *ovstats)
9112 total = Dynarr_memory_usage (dyn, ovstats);
9113 for (i = 0; i < Dynarr_largest (dyn); i++)
9115 struct display_line *dl = &Dynarr_at (dyn, i);
9116 total += compute_display_block_dynarr_usage(dl->display_blocks, ovstats);
9117 total += compute_glyph_block_dynarr_usage (dl->left_glyphs, ovstats);
9118 total += compute_glyph_block_dynarr_usage (dl->right_glyphs, ovstats);
9125 compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
9126 struct overhead_stats *ovstats)
9128 return dyn ? Dynarr_memory_usage (dyn, ovstats) : 0;
9131 #endif /* MEMORY_USAGE_STATS */
9134 /***************************************************************************/
9136 /* initialization */
9138 /***************************************************************************/
9141 init_redisplay (void)
9143 disable_preemption = 0;
9144 preemption_count = 0;
9145 max_preempts = INIT_MAX_PREEMPTS;
9151 if (!cmotion_display_lines)
9152 cmotion_display_lines = Dynarr_new (display_line);
9153 if (!mode_spec_bufbyte_string)
9154 mode_spec_bufbyte_string = Dynarr_new (Bufbyte);
9155 if (!formatted_string_extent_dynarr)
9156 formatted_string_extent_dynarr = Dynarr_new (EXTENT);
9157 if (!formatted_string_extent_start_dynarr)
9158 formatted_string_extent_start_dynarr = Dynarr_new (Bytecount);
9159 if (!formatted_string_extent_end_dynarr)
9160 formatted_string_extent_end_dynarr = Dynarr_new (Bytecount);
9161 if (!internal_cache)
9162 internal_cache = Dynarr_new (line_start_cache);
9165 /* window system is nil when in -batch mode */
9166 if (!initialized || noninteractive)
9169 /* If the user wants to use a window system, we shouldn't bother
9170 initializing the terminal. This is especially important when the
9171 terminal is so dumb that emacs gives up before and doesn't bother
9172 using the window system.
9174 If the DISPLAY environment variable is set, try to use X, and die
9175 with an error message if that doesn't work. */
9177 #ifdef HAVE_X_WINDOWS
9178 if (!strcmp (display_use, "x"))
9180 /* Some stuff checks this way early. */
9181 Vwindow_system = Qx;
9182 Vinitial_window_system = Qx;
9185 #endif /* HAVE_X_WINDOWS */
9187 #ifdef HAVE_MS_WINDOWS
9188 if (!strcmp (display_use, "mswindows"))
9190 /* Some stuff checks this way early. */
9191 Vwindow_system = Qmswindows;
9192 Vinitial_window_system = Qmswindows;
9195 #endif /* HAVE_MS_WINDOWS */
9198 /* If no window system has been specified, try to use the terminal. */
9201 stderr_out ("XEmacs: standard input is not a tty\n");
9205 /* Look at the TERM variable */
9206 if (!getenv ("TERM"))
9208 stderr_out ("Please set the environment variable TERM; see tset(1).\n");
9212 Vinitial_window_system = Qtty;
9214 #else /* not HAVE_TTY */
9215 /* No DISPLAY specified, and no TTY support. */
9216 stderr_out ("XEmacs: Cannot open display.\n\
9217 Please set the environmental variable DISPLAY to an appropriate value.\n");
9224 syms_of_redisplay (void)
9226 defsymbol (&Qcursor_in_echo_area, "cursor-in-echo-area");
9227 #ifndef INHIBIT_REDISPLAY_HOOKS
9228 defsymbol (&Qpre_redisplay_hook, "pre-redisplay-hook");
9229 defsymbol (&Qpost_redisplay_hook, "post-redisplay-hook");
9230 #endif /* INHIBIT_REDISPLAY_HOOKS */
9231 defsymbol (&Qdisplay_warning_buffer, "display-warning-buffer");
9232 defsymbol (&Qbar_cursor, "bar-cursor");
9233 defsymbol (&Qredisplay_end_trigger_functions,
9234 "redisplay-end-trigger-functions");
9235 defsymbol (&Qtop_bottom, "top-bottom");
9236 defsymbol (&Qbuffer_list_changed_hook, "buffer-list-changed-hook");
9238 DEFSUBR (Fredisplay_echo_area);
9239 DEFSUBR (Fredraw_frame);
9240 DEFSUBR (Fredisplay_frame);
9241 DEFSUBR (Fredraw_device);
9242 DEFSUBR (Fredisplay_device);
9243 DEFSUBR (Fredraw_modeline);
9244 DEFSUBR (Fforce_cursor_redisplay);
9248 vars_of_redisplay (void)
9252 staticpro (&last_arrow_position);
9253 staticpro (&last_arrow_string);
9254 last_arrow_position = Qnil;
9255 last_arrow_string = Qnil;
9258 /* #### Probably temporary */
9259 DEFVAR_INT ("redisplay-cache-adjustment", &cache_adjustment /*
9260 \(Temporary) Setting this will impact the performance of the internal
9263 cache_adjustment = 2;
9265 DEFVAR_INT_MAGIC ("pixel-vertical-clip-threshold", &vertical_clip /*
9266 Minimum pixel height for clipped bottom display line.
9267 A clipped line shorter than this won't be displayed.
9269 redisplay_variable_changed);
9272 DEFVAR_INT_MAGIC ("pixel-horizontal-clip-threshold", &horizontal_clip /*
9273 Minimum visible area for clipped glyphs at right boundary.
9274 Clipped glyphs shorter than this won't be displayed.
9275 Only pixmap glyph instances are currently allowed to be clipped.
9277 redisplay_variable_changed);
9278 horizontal_clip = 5;
9280 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string /*
9281 String displayed by modeline-format's "%m" specification.
9283 Vglobal_mode_string = Qnil;
9285 DEFVAR_LISP_MAGIC ("overlay-arrow-position", &Voverlay_arrow_position /*
9286 Marker for where to display an arrow on top of the buffer text.
9287 This must be the beginning of a line in order to work.
9288 See also `overlay-arrow-string'.
9290 redisplay_variable_changed);
9291 Voverlay_arrow_position = Qnil;
9293 DEFVAR_LISP_MAGIC ("overlay-arrow-string", &Voverlay_arrow_string /*
9294 String or glyph to display as an arrow. See also `overlay-arrow-position'.
9295 (Note that despite the name of this variable, it can be set to a glyph as
9298 redisplay_variable_changed);
9299 Voverlay_arrow_string = Qnil;
9301 DEFVAR_INT ("scroll-step", &scroll_step /*
9302 *The number of lines to try scrolling a window by when point moves out.
9303 If that fails to bring point back on frame, point is centered instead.
9304 If this is zero, point is always centered after it moves off screen.
9308 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively /*
9309 *Scroll up to this many lines, to bring point back on screen.
9311 scroll_conservatively = 0;
9313 DEFVAR_BOOL_MAGIC ("truncate-partial-width-windows",
9314 &truncate_partial_width_windows /*
9315 *Non-nil means truncate lines in all windows less than full frame wide.
9317 redisplay_variable_changed);
9318 truncate_partial_width_windows = 1;
9320 DEFVAR_LISP ("visible-bell", &Vvisible_bell /*
9321 *Non-nil substitutes a visual signal for the audible bell.
9323 Default behavior is to flash the whole screen. On some platforms,
9324 special effects are available using the following values:
9326 'display Flash the whole screen (ie, the default behavior).
9327 'top-bottom Flash only the top and bottom lines of the selected frame.
9329 When effects are unavailable on a platform, the visual bell is the
9330 default, whole screen. (Currently only X supports any special effects.)
9332 Vvisible_bell = Qnil;
9334 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter /*
9335 *Non-nil means no need to redraw entire frame after suspending.
9336 A non-nil value is useful if the terminal can automatically preserve
9337 Emacs's frame display when you reenter Emacs.
9338 It is up to you to set this variable if your terminal can do that.
9340 no_redraw_on_reenter = 0;
9342 DEFVAR_LISP ("window-system", &Vwindow_system /*
9343 A symbol naming the window-system under which Emacs is running,
9344 such as `x', or nil if emacs is running on an ordinary terminal.
9346 Do not use this variable, except for GNU Emacs compatibility, as it
9347 gives wrong values in a multi-device environment. Use `console-type'
9350 Vwindow_system = Qnil;
9352 /* #### Temporary shit until window-system is eliminated. */
9353 DEFVAR_CONST_LISP ("initial-window-system", &Vinitial_window_system /*
9356 Vinitial_window_system = Qnil;
9358 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area /*
9359 Non-nil means put cursor in minibuffer, at end of any message there.
9361 cursor_in_echo_area = 0;
9363 /* #### Shouldn't this be generalized as follows:
9365 if nil, use block cursor.
9366 if a number, use a bar cursor of that width.
9367 Otherwise, use a 1-pixel bar cursor.
9369 #### Or better yet, this variable should be trashed entirely
9370 (use a Lisp-magic variable to maintain compatibility)
9371 and a specifier `cursor-shape' added, which allows a block
9372 cursor, a bar cursor, a flashing block or bar cursor,
9373 maybe a caret cursor, etc. */
9375 DEFVAR_LISP ("bar-cursor", &Vbar_cursor /*
9376 Use vertical bar cursor if non-nil. If t width is 1 pixel, otherwise 2.
9380 #ifndef INHIBIT_REDISPLAY_HOOKS
9381 xxDEFVAR_LISP ("pre-redisplay-hook", &Vpre_redisplay_hook /*
9382 Function or functions to run before every redisplay.
9384 Vpre_redisplay_hook = Qnil;
9386 xxDEFVAR_LISP ("post-redisplay-hook", &Vpost_redisplay_hook /*
9387 Function or functions to run after every redisplay.
9389 Vpost_redisplay_hook = Qnil;
9390 #endif /* INHIBIT_REDISPLAY_HOOKS */
9392 DEFVAR_LISP ("buffer-list-changed-hook", &Vbuffer_list_changed_hook /*
9393 Function or functions to call when a frame's buffer list has changed.
9394 This is called during redisplay, before redisplaying each frame.
9395 Functions on this hook are called with one argument, the frame.
9397 Vbuffer_list_changed_hook = Qnil;
9399 DEFVAR_INT ("display-warning-tick", &display_warning_tick /*
9400 Bump this to tell the C code to call `display-warning-buffer'
9401 at next redisplay. You should not normally change this; the function
9402 `display-warning' automatically does this at appropriate times.
9404 display_warning_tick = 0;
9406 DEFVAR_BOOL ("inhibit-warning-display", &inhibit_warning_display /*
9407 Non-nil means inhibit display of warning messages.
9408 You should *bind* this, not set it. Any pending warning messages
9409 will be displayed when the binding no longer applies.
9411 /* reset to 0 by startup.el after the splash screen has displayed.
9412 This way, the warnings don't obliterate the splash screen. */
9413 inhibit_warning_display = 1;
9415 DEFVAR_LISP ("window-size-change-functions",
9416 &Vwindow_size_change_functions /*
9417 Not currently implemented.
9418 Functions called before redisplay, if window sizes have changed.
9419 The value should be a list of functions that take one argument.
9420 Just before redisplay, for each frame, if any of its windows have changed
9421 size since the last redisplay, or have been split or deleted,
9422 all the functions in the list are called, with the frame as argument.
9424 Vwindow_size_change_functions = Qnil;
9426 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions /*
9427 Not currently implemented.
9428 Functions to call before redisplaying a window with scrolling.
9429 Each function is called with two arguments, the window
9430 and its new display-start position. Note that the value of `window-end'
9431 is not valid when these functions are called.
9433 Vwindow_scroll_functions = Qnil;
9435 DEFVAR_LISP ("redisplay-end-trigger-functions",
9436 &Vredisplay_end_trigger_functions /*
9437 See `set-window-redisplay-end-trigger'.
9439 Vredisplay_end_trigger_functions = Qnil;
9441 DEFVAR_BOOL ("column-number-start-at-one", &column_number_start_at_one /*
9442 *Non-nil means column display number starts at 1.
9444 column_number_start_at_one = 0;
9448 specifier_vars_of_redisplay (void)
9450 DEFVAR_SPECIFIER ("left-margin-width", &Vleft_margin_width /*
9451 *Width of left margin.
9452 This is a specifier; use `set-specifier' to change it.
9454 Vleft_margin_width = Fmake_specifier (Qnatnum);
9455 set_specifier_fallback (Vleft_margin_width, list1 (Fcons (Qnil, Qzero)));
9456 set_specifier_caching (Vleft_margin_width,
9457 offsetof (struct window, left_margin_width),
9458 some_window_value_changed,
9459 offsetof (struct frame, left_margin_width),
9460 margin_width_changed_in_frame);
9462 DEFVAR_SPECIFIER ("right-margin-width", &Vright_margin_width /*
9463 *Width of right margin.
9464 This is a specifier; use `set-specifier' to change it.
9466 Vright_margin_width = Fmake_specifier (Qnatnum);
9467 set_specifier_fallback (Vright_margin_width, list1 (Fcons (Qnil, Qzero)));
9468 set_specifier_caching (Vright_margin_width,
9469 offsetof (struct window, right_margin_width),
9470 some_window_value_changed,
9471 offsetof (struct frame, right_margin_width),
9472 margin_width_changed_in_frame);
9474 DEFVAR_SPECIFIER ("minimum-line-ascent", &Vminimum_line_ascent /*
9475 *Minimum ascent height of lines.
9476 This is a specifier; use `set-specifier' to change it.
9478 Vminimum_line_ascent = Fmake_specifier (Qnatnum);
9479 set_specifier_fallback (Vminimum_line_ascent, list1 (Fcons (Qnil, Qzero)));
9480 set_specifier_caching (Vminimum_line_ascent,
9481 offsetof (struct window, minimum_line_ascent),
9482 some_window_value_changed,
9485 DEFVAR_SPECIFIER ("minimum-line-descent", &Vminimum_line_descent /*
9486 *Minimum descent height of lines.
9487 This is a specifier; use `set-specifier' to change it.
9489 Vminimum_line_descent = Fmake_specifier (Qnatnum);
9490 set_specifier_fallback (Vminimum_line_descent, list1 (Fcons (Qnil, Qzero)));
9491 set_specifier_caching (Vminimum_line_descent,
9492 offsetof (struct window, minimum_line_descent),
9493 some_window_value_changed,
9496 DEFVAR_SPECIFIER ("use-left-overflow", &Vuse_left_overflow /*
9497 *Non-nil means use the left outside margin as extra whitespace when
9498 displaying 'whitespace or 'inside-margin glyphs.
9499 This is a specifier; use `set-specifier' to change it.
9501 Vuse_left_overflow = Fmake_specifier (Qboolean);
9502 set_specifier_fallback (Vuse_left_overflow, list1 (Fcons (Qnil, Qnil)));
9503 set_specifier_caching (Vuse_left_overflow,
9504 offsetof (struct window, use_left_overflow),
9505 some_window_value_changed,
9508 DEFVAR_SPECIFIER ("use-right-overflow", &Vuse_right_overflow /*
9509 *Non-nil means use the right outside margin as extra whitespace when
9510 displaying 'whitespace or 'inside-margin glyphs.
9511 This is a specifier; use `set-specifier' to change it.
9513 Vuse_right_overflow = Fmake_specifier (Qboolean);
9514 set_specifier_fallback (Vuse_right_overflow, list1 (Fcons (Qnil, Qnil)));
9515 set_specifier_caching (Vuse_right_overflow,
9516 offsetof (struct window, use_right_overflow),
9517 some_window_value_changed,
9520 DEFVAR_SPECIFIER ("text-cursor-visible-p", &Vtext_cursor_visible_p /*
9521 *Non-nil means the text cursor is visible (this is usually the case).
9522 This is a specifier; use `set-specifier' to change it.
9524 Vtext_cursor_visible_p = Fmake_specifier (Qboolean);
9525 set_specifier_fallback (Vtext_cursor_visible_p, list1 (Fcons (Qnil, Qt)));
9526 set_specifier_caching (Vtext_cursor_visible_p,
9527 offsetof (struct window, text_cursor_visible_p),
9528 text_cursor_visible_p_changed,