1 /* Redisplay data structures.
2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
3 Copyright (C) 1996 Chuck Thompson.
4 Copyright (C) 1995, 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Not in FSF. */
25 #ifndef _XEMACS_REDISPLAY_H_
26 #define _XEMACS_REDISPLAY_H_
28 /* Redisplay DASSERT types */
30 #define DB_DISP_TEXT_LAYOUT 2
31 #define DB_DISP_REDISPLAY 4
33 /* These are the possible return values from pixel_to_glyph_translation. */
34 #define OVER_MODELINE 0
36 #define OVER_OUTSIDE 2
37 #define OVER_NOTHING 3
39 #define OVER_TOOLBAR 5
40 #define OVER_V_DIVIDER 6
44 /* Imagine that the text in the buffer is displayed on a piece of paper
45 the width of the frame and very very tall. The line start cache is
46 an array of struct line_start_cache's, describing the start and
47 end buffer positions for a contiguous set of lines on that piece
50 typedef struct line_start_cache line_start_cache;
51 struct line_start_cache
59 Dynarr_declare (line_start_cache);
60 } line_start_cache_dynarr;
62 /* The possible types of runes.
64 #### The Lisp_Glyph type is broken. There should instead be a pixmap
65 type. Currently the device-specific output routines have to worry
66 about whether the glyph is textual or not, etc. For Mule this is
67 a big problem because you might need multiple fonts to display the
68 text. It also eliminates optimizations that could come from glumping
69 the text of multiple text glyphs together -- this makes displaying
70 binary files (with lots of control chars, etc.) very very slow. */
82 #define IGNORE_CURSOR 4
84 #define DEFAULT_INDEX (face_index) 0
85 #define MODELINE_INDEX (face_index) 1
87 /* A rune is a single display element, such as a printable character
88 or pixmap. Any single character in a buffer has one or more runes
89 (or zero, if the character is invisible) corresponding to it.
90 (Printable characters typically have one rune associated with them,
91 but control characters have two -- a ^ and a letter -- and other
92 non-printing characters (those displayed in octal) have four. */
94 typedef struct rune rune;
97 face_index findex; /* face rune is displayed with. The
98 face_index is an index into a
99 window-specific array of face cache
100 elements. Each face cache element
101 corresponds to one "merged face"
102 (the result of merging all the
103 faces that overlap the rune) and
104 contains the instance values for
105 each of the face properties in this
106 particular window. */
108 short xpos; /* horizontal starting position in pixels */
109 short width; /* pixel width of rune */
112 Bufpos bufpos; /* buffer position this rune is displaying;
113 for the modeline, the value here is a
114 Charcount, but who's looking? */
115 Bufpos endpos; /* if set this rune covers a range of pos */
116 /* #### Chuck, what does it mean for a rune
117 to cover a range of pos? I don't get
119 unsigned int cursor_type :3; /* is this rune covered by the cursor? */
120 unsigned int type :3; /* type of rune object */
122 union /* Information specific to the type of rune */
128 Lisp_Object extent; /* extent rune is attached to, if any.
129 If this is a rune in the modeline
130 then this might be nil. */
132 int xoffset; /* Number of pixels that need to be
133 chopped off the left of the glyph.
134 This has the effect of shifting the
135 glyph to the left while still clipping
142 Emchar ch; /* Character of this rune. */
148 short thickness; /* how thick to make hline */
149 short yoffset; /* how far down from top of line to put top */
151 } object; /* actual rune object */
156 Dynarr_declare (rune);
159 /* These must have distinct values. Note that the ordering actually
160 represents priority levels. TEXT has the lowest priority level. */
167 RIGHT_OUTSIDE_MARGIN,
171 /* A display block represents a run of text on a single line.
172 Apparently there is only one display block per line for each
173 of the types listed in `enum display_type'.
175 A display block consists mostly of an array of runes, one per
176 atomic display element (printable character, pixmap, etc.). */
178 /* #### Yuckity yuckity yuck yuck yuck yuck yuck!!
180 Chuck, I think you should redo this. It should not be the
181 responsibility of the device-specific code to worry about
182 the different faces. The generic stuff in redisplay-output.c
183 should glump things up into sub-blocks, each of which
184 corresponds to a single pixmap or a single run of text in
187 It might still make sense for the device-specific output routine
188 to get passed an entire display line. That way, it can make
189 calls to XDrawText() (which draws multiple runs of single-font
190 data) instead of XDrawString(). The reason for this is to
191 reduce the amount of X traffic, which will help things significantly
194 typedef struct display_block display_block;
197 enum display_type type; /* type of display block */
199 int start_pos; /* starting pixel position of block */
200 int end_pos; /* ending pixel position of block */
202 rune_dynarr *runes; /* Dynamic array of runes */
207 Dynarr_declare (display_block);
208 } display_block_dynarr;
210 typedef struct layout_bounds_type
220 typedef struct glyph_block glyph_block;
225 /* The rest are only used by margin routines. */
233 Dynarr_declare (glyph_block);
234 } glyph_block_dynarr;
236 /*************************************************************************/
238 /*************************************************************************/
240 /* Modeline commentary: IMO the modeline is handled very badly, we
241 special case virtually *everything* in the redisplay routines for
242 the modeline. The fact that dl->bufpos can be either a buffer
243 position or a char count highlights this. There is no abstraction at
244 all that I can find and it means that the code is made very ugly as
245 a result. Either we should treat the modeline *entirely* separately,
246 or we should abstract to something that applies equally well to the
247 modeline and to buffer text, the things are not enormously different
248 after all and handling them identically at some level would
249 eliminate some bugs that still exist (mainly to do with modeline
250 handling). This problem doesn't help trying to implement gutters
251 which are somewhere in between buffer text and modeline text.
253 Redisplay commentary: Everything in redisplay is tied very tightly
254 to the things that are being displayed, and the context,
255 e.g. buffers and windows. According to Chuck this is so that we can
256 get speed, which seems fine to me, however this usage is extended
257 too far down the redispay routines IMO. At some level there should
258 be functions that know how to display strings with extents and
259 faces, regardless of buffer etc. After all the window system does
260 not care. <andy@xemacs.org> */
262 typedef struct display_line display_line;
265 short ypos; /* vertical position in pixels
266 of the baseline for this line. */
267 unsigned short ascent, descent; /* maximum values for this line.
268 The ascent is the number of
269 pixels above the baseline, and
270 the descent is the number of
271 pixels below the baseline.
272 The descent includes the baseline
273 pixel-row itself, I think. */
274 unsigned short clip; /* amount of bottom of line to clip
276 unsigned short top_clip; /* amount of top of line to clip
278 Bufpos bufpos; /* first buffer position on line */
279 Bufpos end_bufpos; /* last buffer position on line */
280 Charcount offset; /* adjustment to bufpos vals */
281 Charcount num_chars; /* # of chars on line
282 including expansion of tabs
284 int cursor_elt; /* rune block of TEXT display
285 block cursor is at or -1 */
286 char used_prop_data; /* can't incrementally update if line
287 used propagation data */
289 layout_bounds bounds; /* line boundary positions */
291 char modeline; /* t if this line is a modeline */
293 /* Dynamic array of display blocks */
294 display_block_dynarr *display_blocks;
296 /* Dynamic arrays of left and right glyph blocks */
297 glyph_block_dynarr *left_glyphs;
298 glyph_block_dynarr *right_glyphs;
300 face_index left_margin_findex;
301 face_index right_margin_findex;
302 face_index default_findex;
305 #define DISPLAY_LINE_HEIGHT(dl) \
306 (dl->ascent + dl->descent - (dl->clip + dl->top_clip))
307 #define DISPLAY_LINE_YPOS(dl) \
308 (dl->ypos - (dl->ascent - dl->top_clip))
309 #define DISPLAY_LINE_YEND(dl) \
310 ((dl->ypos + dl->descent) - dl->clip)
314 Dynarr_declare (display_line);
315 } display_line_dynarr;
317 /* The following two structures are used to represent an area to
318 displayed and where to display it. Using these two structures all
319 combinations of clipping and position can be accommodated. */
321 /* This represents an area to be displayed into. */
322 typedef struct display_box display_box;
325 int xpos; /* absolute horizontal position of area */
326 int ypos; /* absolute vertical position of area */
330 /* This represents the area from a glyph to be displayed. */
331 typedef struct display_glyph_area display_glyph_area;
332 struct display_glyph_area
334 int xoffset; /* horizontal offset of the glyph, +ve means
335 display the glyph with x offset by xoffset,
336 -ve means display starting xoffset into the
338 int yoffset; /* vertical offset of the glyph, +ve means
339 display the glyph with y offset by yoffset,
340 -ve means display starting xoffset into the
342 int width, height; /* width and height of glyph to display. */
345 /* It could be argued that the following two structs belong in
346 extents.h, but they're only used by redisplay and it simplifies
347 the header files to put them here. */
351 Dynarr_declare (EXTENT);
354 struct font_metric_info
357 int height; /* always ascent + descent; for convenience */
364 /* NOTE NOTE NOTE: Currently the positions in an extent fragment
365 structure are Bytind's, not Bufpos's. This could change. */
367 struct extent_fragment
369 Lisp_Object object; /* buffer or string */
372 EXTENT_dynarr *extents;
373 glyph_block_dynarr *begin_glyphs, *end_glyphs;
374 unsigned int invisible:1;
375 unsigned int invisible_ellipses:1;
376 unsigned int previously_invisible:1;
377 unsigned int invisible_ellipses_already_displayed:1;
382 #define EDGE_BOTTOM 4
384 #define EDGE_ALL (EDGE_TOP | EDGE_LEFT | EDGE_BOTTOM | EDGE_RIGHT)
387 /*************************************************************************/
389 /*************************************************************************/
391 /* Quick flags to signal redisplay. redisplay() sets them all to 0
392 when it finishes. If none of them are set when it starts, it
393 assumes that nothing needs to be done. Functions that make a change
394 that is (potentially) visible on the screen should set the
397 If any of these flags are set, redisplay will look more carefully
398 to see if anything has really changed. */
400 /* non-nil if the contents of a buffer have changed since the last time
401 redisplay completed */
402 extern int buffers_changed;
403 extern int buffers_changed_set;
405 /* Nonzero if head_clip or tail_clip of a buffer has changed
406 since last redisplay that finished */
407 extern int clip_changed;
408 extern int clip_changed_set;
410 /* non-nil if any extent has changed since the last time redisplay completed */
411 extern int extents_changed;
412 extern int extents_changed_set;
414 /* non-nil if any face has changed since the last time redisplay completed */
415 extern int faces_changed;
417 /* Nonzero means one or more frames have been marked as garbaged */
418 extern int frame_changed;
420 /* True if any of the builtin display glyphs (continuation,
421 hscroll, control-arrow, etc) is in need of updating
423 extern int glyphs_changed;
424 extern int glyphs_changed_set;
426 /* True if any displayed subwindow is in need of updating
428 extern int subwindows_changed;
429 extern int subwindows_changed_set;
431 /* True if any displayed subwindow is in need of updating
433 extern int subwindows_state_changed;
434 extern int subwindows_state_changed_set;
436 /* True if an icon is in need of updating somewhere. */
437 extern int icon_changed;
438 extern int icon_changed_set;
440 /* True if a menubar is in need of updating somewhere. */
441 extern int menubar_changed;
442 extern int menubar_changed_set;
444 /* true iff we should redraw the modelines on the next redisplay */
445 extern int modeline_changed;
446 extern int modeline_changed_set;
448 /* non-nil if point has changed in some buffer since the last time
449 redisplay completed */
450 extern int point_changed;
451 extern int point_changed_set;
453 /* non-nil if some frame has changed its size */
454 extern int size_changed;
456 /* non-nil if some device has signaled that it wants to change size */
457 extern int asynch_device_change_pending;
459 /* non-nil if any toolbar has changed */
460 extern int toolbar_changed;
461 extern int toolbar_changed_set;
463 /* non-nil if any gutter has changed */
464 extern int gutter_changed;
465 extern int gutter_changed_set;
467 /* non-nil if any window has changed since the last time redisplay completed */
468 extern int windows_changed;
470 /* non-nil if any frame's window structure has changed since the last
471 time redisplay completed */
472 extern int windows_structure_changed;
474 /* These macros can be relatively expensive. Since they are often
475 called numerous times between each call to redisplay, we keep track
476 if each has already been called and don't bother doing most of the
477 work if it is currently set. */
479 #define MARK_TYPE_CHANGED(object) do { \
480 if (!object##_changed_set) { \
481 Lisp_Object MTC_devcons, MTC_concons; \
482 DEVICE_LOOP_NO_BREAK (MTC_devcons, MTC_concons) \
484 Lisp_Object MTC_frmcons; \
485 struct device *MTC_d = XDEVICE (XCAR (MTC_devcons)); \
486 DEVICE_FRAME_LOOP (MTC_frmcons, MTC_d) \
488 struct frame *MTC_f = XFRAME (XCAR (MTC_frmcons)); \
489 MTC_f->object##_changed = 1; \
492 MTC_d->object##_changed = 1; \
494 object##_changed = 1; \
495 object##_changed_set = 1; } \
498 #define MARK_BUFFERS_CHANGED MARK_TYPE_CHANGED (buffers)
499 #define MARK_CLIP_CHANGED MARK_TYPE_CHANGED (clip)
500 #define MARK_EXTENTS_CHANGED MARK_TYPE_CHANGED (extents)
501 #define MARK_ICON_CHANGED MARK_TYPE_CHANGED (icon)
502 #define MARK_MENUBAR_CHANGED MARK_TYPE_CHANGED (menubar)
503 #define MARK_MODELINE_CHANGED MARK_TYPE_CHANGED (modeline)
504 #define MARK_POINT_CHANGED MARK_TYPE_CHANGED (point)
505 #define MARK_TOOLBAR_CHANGED MARK_TYPE_CHANGED (toolbar)
506 #define MARK_GUTTER_CHANGED MARK_TYPE_CHANGED (gutter)
507 #define MARK_GLYPHS_CHANGED MARK_TYPE_CHANGED (glyphs)
508 #define MARK_SUBWINDOWS_CHANGED MARK_TYPE_CHANGED (subwindows)
509 #define MARK_SUBWINDOWS_STATE_CHANGED MARK_TYPE_CHANGED (subwindows_state)
512 #define CLASS_RESET_CHANGED_FLAGS(p) do { \
513 (p)->buffers_changed = 0; \
514 (p)->clip_changed = 0; \
515 (p)->extents_changed = 0; \
516 (p)->faces_changed = 0; \
517 (p)->frame_changed = 0; \
518 (p)->icon_changed = 0; \
519 (p)->menubar_changed = 0; \
520 (p)->modeline_changed = 0; \
521 (p)->point_changed = 0; \
522 (p)->toolbar_changed = 0; \
523 (p)->gutter_changed = 0; \
524 (p)->glyphs_changed = 0; \
525 (p)->subwindows_changed = 0; \
526 (p)->subwindows_state_changed = 0; \
527 (p)->windows_changed = 0; \
528 (p)->windows_structure_changed = 0; \
531 #define GLOBAL_RESET_CHANGED_FLAGS do { \
532 buffers_changed = 0; \
534 extents_changed = 0; \
538 menubar_changed = 0; \
539 modeline_changed = 0; \
541 toolbar_changed = 0; \
542 gutter_changed = 0; \
543 glyphs_changed = 0; \
544 subwindows_changed = 0; \
545 subwindows_state_changed = 0; \
546 windows_changed = 0; \
547 windows_structure_changed = 0; \
550 #define CLASS_REDISPLAY_FLAGS_CHANGEDP(p) \
551 ( (p)->buffers_changed || \
552 (p)->clip_changed || \
553 (p)->extents_changed || \
554 (p)->faces_changed || \
555 (p)->frame_changed || \
556 (p)->icon_changed || \
557 (p)->menubar_changed || \
558 (p)->modeline_changed || \
559 (p)->point_changed || \
560 (p)->toolbar_changed || \
561 (p)->gutter_changed || \
562 (p)->glyphs_changed || \
563 (p)->subwindows_changed || \
564 (p)->subwindows_state_changed || \
565 (p)->windows_changed || \
566 (p)->windows_structure_changed )
568 #define GLOBAL_REDISPLAY_FLAGS_CHANGEDP \
569 ( buffers_changed || \
576 modeline_changed || \
581 subwindows_changed || \
582 subwindows_state_changed || \
584 windows_structure_changed )
587 /* Anytime a console, device or frame is added or deleted we need to reset
589 #define RESET_CHANGED_SET_FLAGS do { \
590 buffers_changed_set = 0; \
591 clip_changed_set = 0; \
592 extents_changed_set = 0; \
593 icon_changed_set = 0; \
594 menubar_changed_set = 0; \
595 modeline_changed_set = 0; \
596 point_changed_set = 0; \
597 toolbar_changed_set = 0; \
598 gutter_changed_set = 0; \
599 glyphs_changed_set = 0; \
600 subwindows_changed_set = 0; \
601 subwindows_state_changed_set = 0; \
605 /*************************************************************************/
606 /* redisplay global variables */
607 /*************************************************************************/
609 /* redisplay structure used by various utility routines. */
610 extern display_line_dynarr *cmotion_display_lines;
612 /* Nonzero means truncate lines in all windows less wide than the frame. */
613 extern int truncate_partial_width_windows;
615 /* Nonzero if we're in a display critical section. */
616 extern int in_display;
618 /* Nonzero means no need to redraw the entire frame on resuming
619 a suspended Emacs. This is useful on terminals with multiple pages,
620 where one page is used for Emacs and another for all else. */
621 extern int no_redraw_on_reenter;
623 /* Nonzero means flash the frame instead of ringing the bell. */
624 extern int visible_bell;
626 /* Thickness of shadow border around 3D modelines. */
627 extern Lisp_Object Vmodeline_shadow_thickness;
629 /* Scroll if point lands on the bottom line and that line is partially
631 extern int scroll_on_clipped_lines;
633 extern Lisp_Object Vglobal_mode_string;
635 /* The following two variables are defined in emacs.c and are used
636 to convey information discovered on the command line way early
637 (before *anything* is initialized). */
639 /* If non-zero, a window-system was specified on the command line.
640 Defined in emacs.c. */
641 extern int display_arg;
643 /* Type of display specified. Defined in emacs.c. */
644 extern CONST char *display_use;
646 /* Nonzero means reading single-character input with prompt
647 so put cursor on minibuffer after the prompt. */
649 extern int cursor_in_echo_area;
651 extern Lisp_Object Qbar_cursor, Qcursor_in_echo_area, Vwindow_system;
654 /*************************************************************************/
655 /* redisplay exported functions */
656 /*************************************************************************/
657 EXFUN (Fredraw_frame, 2);
659 int redisplay_text_width_string (struct window *w, int findex,
660 Bufbyte *nonreloc, Lisp_Object reloc,
661 Bytecount offset, Bytecount len);
662 int redisplay_frame_text_width_string (struct frame *f,
666 Bytecount offset, Bytecount len);
667 void redisplay (void);
668 struct display_block *get_display_block_from_line (struct display_line *dl,
669 enum display_type type);
670 layout_bounds calculate_display_line_boundaries (struct window *w,
672 Bufpos point_at_center (struct window *w, int type, Bufpos start,
674 int line_at_center (struct window *w, int type, Bufpos start, Bufpos point);
675 int window_half_pixpos (struct window *w);
676 void redisplay_echo_area (void);
677 void free_display_structs (struct window_mirror *mir);
678 void free_display_lines (display_line_dynarr *dla);
679 Bufbyte *generate_formatted_string (struct window *w, Lisp_Object format_str,
680 Lisp_Object result_str, face_index findex,
682 void generate_displayable_area (struct window *w, Lisp_Object disp_string,
683 int xpos, int ypos, int width, int height,
684 display_line_dynarr* dl,
685 Bufpos start_pos, face_index default_face);
686 int real_current_modeline_height (struct window *w);
687 int pixel_to_glyph_translation (struct frame *f, int x_coord,
688 int y_coord, int *col, int *row,
689 int *obj_x, int *obj_y,
690 struct window **w, Bufpos *bufpos,
691 Bufpos *closest, Charcount *modeline_closest,
692 Lisp_Object *obj1, Lisp_Object *obj2);
693 void glyph_to_pixel_translation (struct window *w, int char_x,
694 int char_y, int *pix_x, int *pix_y);
695 void mark_redisplay (void);
696 int point_in_line_start_cache (struct window *w, Bufpos point,
698 int point_would_be_visible (struct window *w, Bufpos startp,
700 Bufpos start_of_last_line (struct window *w, Bufpos startp);
701 Bufpos end_of_last_line (struct window *w, Bufpos startp);
702 Bufpos start_with_line_at_pixpos (struct window *w, Bufpos point,
704 Bufpos start_with_point_on_display_line (struct window *w, Bufpos point,
706 int redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
707 Lisp_Object in_object, int flags);
708 void redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
711 #ifdef MEMORY_USAGE_STATS
712 int compute_display_line_dynarr_usage (display_line_dynarr *dyn,
713 struct overhead_stats *ovstats);
714 int compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
715 struct overhead_stats *ovstats);
719 /* defined in redisplay-output.c */
720 int get_next_display_block (layout_bounds bounds,
721 display_block_dynarr *dba, int start_pos,
723 void redisplay_output_layout (struct window *w,
724 Lisp_Object image_instance,
725 struct display_box* db, struct display_glyph_area* dga,
726 face_index findex, int cursor_start, int cursor_width,
728 void redisplay_output_subwindow (struct window *w,
729 Lisp_Object image_instance,
730 struct display_box* db, struct display_glyph_area* dga,
731 face_index findex, int cursor_start, int cursor_width,
733 void redisplay_unmap_subwindows_maybe (struct frame* f, int x, int y, int width, int height);
734 void redisplay_output_pixmap (struct window *w,
735 Lisp_Object image_instance,
736 struct display_box* db, struct display_glyph_area* dga,
737 face_index findex, int cursor_start, int cursor_width,
738 int cursor_height, int offset_bitmap);
739 int redisplay_calculate_display_boxes (struct display_line *dl, int xpos,
740 int xoffset, int start_pixpos, int width,
741 struct display_box* dest,
742 struct display_glyph_area* src);
743 int redisplay_normalize_glyph_area (struct display_box* dest,
744 struct display_glyph_area* glyphsrc);
745 void redisplay_clear_to_window_end (struct window *w, int ypos1, int ypos2);
746 void redisplay_clear_region (Lisp_Object window, face_index findex, int x,
747 int y, int width, int height);
748 void redisplay_clear_bottom_of_window (struct window *w,
749 display_line_dynarr *ddla,
750 int min_start, int max_end);
751 void redisplay_update_line (struct window *w, int first_line,
752 int last_line, int update_values);
753 void redisplay_output_window (struct window *w);
754 void bevel_modeline (struct window *w, struct display_line *dl);
755 int redisplay_move_cursor (struct window *w, Bufpos new_point,
757 void redisplay_redraw_cursor (struct frame *f, int run_begin_end_meths);
758 void output_display_line (struct window *w, display_line_dynarr *cdla,
759 display_line_dynarr *ddla, int line,
760 int force_start, int force_end);
762 #endif /* _XEMACS_REDISPLAY_H_ */