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 int thickness; /* how thick to make hline */
149 int 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 Bufpos bufpos; /* first buffer position on line */
277 Bufpos end_bufpos; /* last buffer position on line */
278 Charcount offset; /* adjustment to bufpos vals */
279 Charcount num_chars; /* # of chars on line
280 including expansion of tabs
282 int cursor_elt; /* rune block of TEXT display
283 block cursor is at or -1 */
284 char used_prop_data; /* can't incrementally update if line
285 used propagation data */
287 layout_bounds bounds; /* line boundary positions */
289 char modeline; /* t if this line is a modeline */
291 /* Dynamic array of display blocks */
292 display_block_dynarr *display_blocks;
294 /* Dynamic arrays of left and right glyph blocks */
295 glyph_block_dynarr *left_glyphs;
296 glyph_block_dynarr *right_glyphs;
298 face_index left_margin_findex;
299 face_index right_margin_findex;
300 face_index default_findex;
303 #define DISPLAY_LINE_HEIGHT(dl) \
304 (dl->ascent + dl->descent - dl->clip)
305 #define DISPLAY_LINE_YPOS(dl) \
306 (dl->ypos - dl->ascent)
310 Dynarr_declare (display_line);
311 } display_line_dynarr;
313 /* It could be argued that the following two structs belong in
314 extents.h, but they're only used by redisplay and it simplifies
315 the header files to put them here. */
319 Dynarr_declare (EXTENT);
322 struct font_metric_info
325 int height; /* always ascent + descent; for convenience */
332 /* NOTE NOTE NOTE: Currently the positions in an extent fragment
333 structure are Bytind's, not Bufpos's. This could change. */
335 struct extent_fragment
337 Lisp_Object object; /* buffer or string */
340 EXTENT_dynarr *extents;
341 glyph_block_dynarr *begin_glyphs, *end_glyphs;
342 unsigned int invisible:1;
343 unsigned int invisible_ellipses:1;
344 unsigned int previously_invisible:1;
345 unsigned int invisible_ellipses_already_displayed:1;
349 /*************************************************************************/
351 /*************************************************************************/
353 /* Quick flags to signal redisplay. redisplay() sets them all to 0
354 when it finishes. If none of them are set when it starts, it
355 assumes that nothing needs to be done. Functions that make a change
356 that is (potentially) visible on the screen should set the
359 If any of these flags are set, redisplay will look more carefully
360 to see if anything has really changed. */
362 /* non-nil if the contents of a buffer have changed since the last time
363 redisplay completed */
364 extern int buffers_changed;
365 extern int buffers_changed_set;
367 /* Nonzero if head_clip or tail_clip of a buffer has changed
368 since last redisplay that finished */
369 extern int clip_changed;
370 extern int clip_changed_set;
372 /* non-nil if any extent has changed since the last time redisplay completed */
373 extern int extents_changed;
374 extern int extents_changed_set;
376 /* non-nil if any face has changed since the last time redisplay completed */
377 extern int faces_changed;
379 /* Nonzero means one or more frames have been marked as garbaged */
380 extern int frame_changed;
382 /* True if any of the builtin display glyphs (continuation,
383 hscroll, control-arrow, etc) is in need of updating
385 extern int glyphs_changed;
386 extern int glyphs_changed_set;
388 /* True if any displayed subwindow is in need of updating
390 extern int subwindows_changed;
391 extern int subwindows_changed_set;
393 /* True if an icon is in need of updating somewhere. */
394 extern int icon_changed;
395 extern int icon_changed_set;
397 /* True if a menubar is in need of updating somewhere. */
398 extern int menubar_changed;
399 extern int menubar_changed_set;
401 /* true iff we should redraw the modelines on the next redisplay */
402 extern int modeline_changed;
403 extern int modeline_changed_set;
405 /* non-nil if point has changed in some buffer since the last time
406 redisplay completed */
407 extern int point_changed;
408 extern int point_changed_set;
410 /* non-nil if some frame has changed its size */
411 extern int size_changed;
413 /* non-nil if some device has signaled that it wants to change size */
414 extern int asynch_device_change_pending;
416 /* non-nil if any toolbar has changed */
417 extern int toolbar_changed;
418 extern int toolbar_changed_set;
420 /* non-nil if any gutter has changed */
421 extern int gutter_changed;
422 extern int gutter_changed_set;
424 /* non-nil if any window has changed since the last time redisplay completed */
425 extern int windows_changed;
427 /* non-nil if any frame's window structure has changed since the last
428 time redisplay completed */
429 extern int windows_structure_changed;
431 /* These macros can be relatively expensive. Since they are often
432 called numerous times between each call to redisplay, we keep track
433 if each has already been called and don't bother doing most of the
434 work if it is currently set. */
436 #define MARK_TYPE_CHANGED(object) do { \
437 if (!object##_changed_set) { \
438 Lisp_Object MTC_devcons, MTC_concons; \
439 DEVICE_LOOP_NO_BREAK (MTC_devcons, MTC_concons) \
441 Lisp_Object MTC_frmcons; \
442 struct device *MTC_d = XDEVICE (XCAR (MTC_devcons)); \
443 DEVICE_FRAME_LOOP (MTC_frmcons, MTC_d) \
445 struct frame *MTC_f = XFRAME (XCAR (MTC_frmcons)); \
446 MTC_f->object##_changed = 1; \
449 MTC_d->object##_changed = 1; \
451 object##_changed = 1; \
452 object##_changed_set = 1; } \
455 #define MARK_BUFFERS_CHANGED MARK_TYPE_CHANGED (buffers)
456 #define MARK_CLIP_CHANGED MARK_TYPE_CHANGED (clip)
457 #define MARK_EXTENTS_CHANGED MARK_TYPE_CHANGED (extents)
458 #define MARK_ICON_CHANGED MARK_TYPE_CHANGED (icon)
459 #define MARK_MENUBAR_CHANGED MARK_TYPE_CHANGED (menubar)
460 #define MARK_MODELINE_CHANGED MARK_TYPE_CHANGED (modeline)
461 #define MARK_POINT_CHANGED MARK_TYPE_CHANGED (point)
462 #define MARK_TOOLBAR_CHANGED MARK_TYPE_CHANGED (toolbar)
463 #define MARK_GUTTER_CHANGED MARK_TYPE_CHANGED (gutter)
464 #define MARK_GLYPHS_CHANGED MARK_TYPE_CHANGED (glyphs)
465 #define MARK_SUBWINDOWS_CHANGED MARK_TYPE_CHANGED (subwindows)
467 /* Anytime a console, device or frame is added or deleted we need to reset
469 #define RESET_CHANGED_SET_FLAGS \
471 buffers_changed_set = 0; \
472 clip_changed_set = 0; \
473 extents_changed_set = 0; \
474 icon_changed_set = 0; \
475 menubar_changed_set = 0; \
476 modeline_changed_set = 0; \
477 point_changed_set = 0; \
478 toolbar_changed_set = 0; \
479 gutter_changed_set = 0; \
480 glyphs_changed_set = 0; \
481 subwindows_changed_set = 0; \
485 /*************************************************************************/
486 /* redisplay global variables */
487 /*************************************************************************/
489 /* redisplay structure used by various utility routines. */
490 extern display_line_dynarr *cmotion_display_lines;
492 /* Nonzero means truncate lines in all windows less wide than the frame. */
493 extern int truncate_partial_width_windows;
495 /* Nonzero if we're in a display critical section. */
496 extern int in_display;
498 /* Nonzero means no need to redraw the entire frame on resuming
499 a suspended Emacs. This is useful on terminals with multiple pages,
500 where one page is used for Emacs and another for all else. */
501 extern int no_redraw_on_reenter;
503 /* Nonzero means flash the frame instead of ringing the bell. */
504 extern int visible_bell;
506 /* Thickness of shadow border around 3D modelines. */
507 extern Lisp_Object Vmodeline_shadow_thickness;
509 /* Scroll if point lands on the bottom line and that line is partially
511 extern int scroll_on_clipped_lines;
513 extern Lisp_Object Vglobal_mode_string;
515 /* The following two variables are defined in emacs.c and are used
516 to convey information discovered on the command line way early
517 (before *anything* is initialized). */
519 /* If non-zero, a window-system was specified on the command line.
520 Defined in emacs.c. */
521 extern int display_arg;
523 /* Type of display specified. Defined in emacs.c. */
524 extern CONST char *display_use;
526 /* Nonzero means reading single-character input with prompt
527 so put cursor on minibuffer after the prompt. */
529 extern int cursor_in_echo_area;
531 extern Lisp_Object Qbar_cursor, Qcursor_in_echo_area, Vwindow_system;
534 /*************************************************************************/
535 /* redisplay exported functions */
536 /*************************************************************************/
537 EXFUN (Fredraw_frame, 2);
539 int redisplay_text_width_string (struct window *w, int findex,
540 Bufbyte *nonreloc, Lisp_Object reloc,
541 Bytecount offset, Bytecount len);
542 int redisplay_frame_text_width_string (struct frame *f,
546 Bytecount offset, Bytecount len);
547 void redisplay (void);
548 struct display_block *get_display_block_from_line (struct display_line *dl,
549 enum display_type type);
550 layout_bounds calculate_display_line_boundaries (struct window *w,
552 Bufpos point_at_center (struct window *w, int type, Bufpos start,
554 int line_at_center (struct window *w, int type, Bufpos start, Bufpos point);
555 int window_half_pixpos (struct window *w);
556 void redisplay_echo_area (void);
557 void free_display_structs (struct window_mirror *mir);
558 Bufbyte *generate_formatted_string (struct window *w, Lisp_Object format_str,
559 Lisp_Object result_str, face_index findex,
561 void generate_displayable_area (struct window *w, Lisp_Object disp_string,
562 int xpos, int ypos, int width, int height,
563 display_line_dynarr* dl,
564 Bufpos start_pos, face_index default_face);
565 int real_current_modeline_height (struct window *w);
566 int pixel_to_glyph_translation (struct frame *f, int x_coord,
567 int y_coord, int *col, int *row,
568 int *obj_x, int *obj_y,
569 struct window **w, Bufpos *bufpos,
570 Bufpos *closest, Charcount *modeline_closest,
571 Lisp_Object *obj1, Lisp_Object *obj2);
572 void glyph_to_pixel_translation (struct window *w, int char_x,
573 int char_y, int *pix_x, int *pix_y);
574 void mark_redisplay (void (*) (Lisp_Object));
575 int point_in_line_start_cache (struct window *w, Bufpos point,
577 int point_would_be_visible (struct window *w, Bufpos startp,
579 Bufpos start_of_last_line (struct window *w, Bufpos startp);
580 Bufpos end_of_last_line (struct window *w, Bufpos startp);
581 Bufpos start_with_line_at_pixpos (struct window *w, Bufpos point,
583 Bufpos start_with_point_on_display_line (struct window *w, Bufpos point,
585 int redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
586 Lisp_Object in_object, int flags);
587 void redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
590 #ifdef MEMORY_USAGE_STATS
591 int compute_display_line_dynarr_usage (display_line_dynarr *dyn,
592 struct overhead_stats *ovstats);
593 int compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
594 struct overhead_stats *ovstats);
598 /* defined in redisplay-output.c */
599 int get_next_display_block (layout_bounds bounds,
600 display_block_dynarr *dba, int start_pos,
602 void redisplay_output_subwindow (struct window *w, struct display_line *dl,
603 Lisp_Object image_instance, int xpos,
604 int xoffset, int start_pixpos, int width,
605 face_index findex, int cursor_start,
606 int cursor_width, int cursor_height);
607 void redisplay_unmap_subwindows_maybe (struct frame* f, int x, int y, int width, int height);
608 void redisplay_clear_to_window_end (struct window *w, int ypos1, int ypos2);
609 void redisplay_clear_region (Lisp_Object window, face_index findex, int x,
610 int y, int width, int height);
611 void redisplay_clear_bottom_of_window (struct window *w,
612 display_line_dynarr *ddla,
613 int min_start, int max_end);
614 void redisplay_update_line (struct window *w, int first_line,
615 int last_line, int update_values);
616 void redisplay_output_window (struct window *w);
617 int redisplay_move_cursor (struct window *w, Bufpos new_point,
619 void redisplay_redraw_cursor (struct frame *f, int run_begin_end_meths);
620 void output_display_line (struct window *w, display_line_dynarr *cdla,
621 display_line_dynarr *ddla, int line,
622 int force_start, int force_end);
624 #endif /* _XEMACS_REDISPLAY_H_ */