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 typedef struct display_line display_line;
239 short ypos; /* vertical position in pixels
240 of the baseline for this line. */
241 unsigned short ascent, descent; /* maximum values for this line.
242 The ascent is the number of
243 pixels above the baseline, and
244 the descent is the number of
245 pixels below the baseline.
246 The descent includes the baseline
247 pixel-row itself, I think. */
248 unsigned short clip; /* amount of bottom of line to clip
250 Bufpos bufpos; /* first buffer position on line */
251 Bufpos end_bufpos; /* last buffer position on line */
252 Charcount offset; /* adjustment to bufpos vals */
253 Charcount num_chars; /* # of chars on line
254 including expansion of tabs
256 int cursor_elt; /* rune block of TEXT display
257 block cursor is at or -1 */
258 char used_prop_data; /* can't incrementally update if line
259 used propagation data */
261 layout_bounds bounds; /* line boundary positions */
263 char modeline; /* t if this line is a modeline */
265 /* Dynamic array of display blocks */
266 display_block_dynarr *display_blocks;
268 /* Dynamic arrays of left and right glyph blocks */
269 glyph_block_dynarr *left_glyphs;
270 glyph_block_dynarr *right_glyphs;
275 Dynarr_declare (display_line);
276 } display_line_dynarr;
278 /* It could be argued that the following two structs belong in
279 extents.h, but they're only used by redisplay and it simplifies
280 the header files to put them here. */
284 Dynarr_declare (EXTENT);
287 struct font_metric_info
290 int height; /* always ascent + descent; for convenience */
297 /* NOTE NOTE NOTE: Currently the positions in an extent fragment
298 structure are Bytind's, not Bufpos's. This could change. */
300 struct extent_fragment
302 Lisp_Object object; /* buffer or string */
305 EXTENT_dynarr *extents;
306 glyph_block_dynarr *begin_glyphs, *end_glyphs;
307 unsigned int invisible:1;
308 unsigned int invisible_ellipses:1;
309 unsigned int previously_invisible:1;
310 unsigned int invisible_ellipses_already_displayed:1;
314 /*************************************************************************/
316 /*************************************************************************/
318 /* Quick flags to signal redisplay. redisplay() sets them all to 0
319 when it finishes. If none of them are set when it starts, it
320 assumes that nothing needs to be done. Functions that make a change
321 that is (potentially) visible on the screen should set the
324 If any of these flags are set, redisplay will look more carefully
325 to see if anything has really changed. */
327 /* non-nil if the contents of a buffer have changed since the last time
328 redisplay completed */
329 extern int buffers_changed;
330 extern int buffers_changed_set;
332 /* Nonzero if head_clip or tail_clip of a buffer has changed
333 since last redisplay that finished */
334 extern int clip_changed;
335 extern int clip_changed_set;
337 /* non-nil if any extent has changed since the last time redisplay completed */
338 extern int extents_changed;
339 extern int extents_changed_set;
341 /* non-nil if any face has changed since the last time redisplay completed */
342 extern int faces_changed;
344 /* Nonzero means one or more frames have been marked as garbaged */
345 extern int frame_changed;
347 /* True if any of the builtin display glyphs (continuation,
348 hscroll, control-arrow, etc) is in need of updating
350 extern int glyphs_changed;
351 extern int glyphs_changed_set;
353 /* True if any displayed subwindow is in need of updating
355 extern int subwindows_changed;
356 extern int subwindows_changed_set;
358 /* True if an icon is in need of updating somewhere. */
359 extern int icon_changed;
360 extern int icon_changed_set;
362 /* True if a menubar is in need of updating somewhere. */
363 extern int menubar_changed;
364 extern int menubar_changed_set;
366 /* true iff we should redraw the modelines on the next redisplay */
367 extern int modeline_changed;
368 extern int modeline_changed_set;
370 /* non-nil if point has changed in some buffer since the last time
371 redisplay completed */
372 extern int point_changed;
373 extern int point_changed_set;
375 /* non-nil if some frame has changed its size */
376 extern int size_changed;
378 /* non-nil if some device has signaled that it wants to change size */
379 extern int asynch_device_change_pending;
381 /* non-nil if any toolbar has changed */
382 extern int toolbar_changed;
383 extern int toolbar_changed_set;
385 /* non-nil if any window has changed since the last time redisplay completed */
386 extern int windows_changed;
388 /* non-nil if any frame's window structure has changed since the last
389 time redisplay completed */
390 extern int windows_structure_changed;
392 /* These macros can be relatively expensive. Since they are often
393 called numerous times between each call to redisplay, we keep track
394 if each has already been called and don't bother doing most of the
395 work if it is currently set. */
397 #define MARK_TYPE_CHANGED(object) do { \
398 if (!object##_changed_set) { \
399 Lisp_Object MTC_devcons, MTC_concons; \
400 DEVICE_LOOP_NO_BREAK (MTC_devcons, MTC_concons) \
402 Lisp_Object MTC_frmcons; \
403 struct device *MTC_d = XDEVICE (XCAR (MTC_devcons)); \
404 DEVICE_FRAME_LOOP (MTC_frmcons, MTC_d) \
406 struct frame *MTC_f = XFRAME (XCAR (MTC_frmcons)); \
407 MTC_f->object##_changed = 1; \
410 MTC_d->object##_changed = 1; \
412 object##_changed = 1; \
413 object##_changed_set = 1; } \
416 #define MARK_BUFFERS_CHANGED MARK_TYPE_CHANGED (buffers)
417 #define MARK_CLIP_CHANGED MARK_TYPE_CHANGED (clip)
418 #define MARK_EXTENTS_CHANGED MARK_TYPE_CHANGED (extents)
419 #define MARK_ICON_CHANGED MARK_TYPE_CHANGED (icon)
420 #define MARK_MENUBAR_CHANGED MARK_TYPE_CHANGED (menubar)
421 #define MARK_MODELINE_CHANGED MARK_TYPE_CHANGED (modeline)
422 #define MARK_POINT_CHANGED MARK_TYPE_CHANGED (point)
423 #define MARK_TOOLBAR_CHANGED MARK_TYPE_CHANGED (toolbar)
424 #define MARK_GLYPHS_CHANGED MARK_TYPE_CHANGED (glyphs)
425 #define MARK_SUBWINDOWS_CHANGED MARK_TYPE_CHANGED (subwindows)
427 /* Anytime a console, device or frame is added or deleted we need to reset
429 #define RESET_CHANGED_SET_FLAGS \
431 buffers_changed_set = 0; \
432 clip_changed_set = 0; \
433 extents_changed_set = 0; \
434 icon_changed_set = 0; \
435 menubar_changed_set = 0; \
436 modeline_changed_set = 0; \
437 point_changed_set = 0; \
438 toolbar_changed_set = 0; \
439 glyphs_changed_set = 0; \
440 subwindows_changed_set = 0; \
444 /*************************************************************************/
445 /* redisplay global variables */
446 /*************************************************************************/
448 /* redisplay structure used by various utility routines. */
449 extern display_line_dynarr *cmotion_display_lines;
451 /* Nonzero means truncate lines in all windows less wide than the frame. */
452 extern int truncate_partial_width_windows;
454 /* Nonzero if we're in a display critical section. */
455 extern int in_display;
457 /* Nonzero means no need to redraw the entire frame on resuming
458 a suspended Emacs. This is useful on terminals with multiple pages,
459 where one page is used for Emacs and another for all else. */
460 extern int no_redraw_on_reenter;
462 /* Nonzero means flash the frame instead of ringing the bell. */
463 extern int visible_bell;
465 /* Thickness of shadow border around 3D modelines. */
466 extern Lisp_Object Vmodeline_shadow_thickness;
468 /* Scroll if point lands on the bottom line and that line is partially
470 extern int scroll_on_clipped_lines;
472 extern Lisp_Object Vglobal_mode_string;
474 /* The following two variables are defined in emacs.c and are used
475 to convey information discovered on the command line way early
476 (before *anything* is initialized). */
478 /* If non-zero, a window-system was specified on the command line.
479 Defined in emacs.c. */
480 extern int display_arg;
482 /* Type of display specified. Defined in emacs.c. */
483 extern CONST char *display_use;
485 /* Nonzero means reading single-character input with prompt
486 so put cursor on minibuffer after the prompt. */
488 extern int cursor_in_echo_area;
490 extern Lisp_Object Qbar_cursor, Qcursor_in_echo_area, Vwindow_system;
493 /*************************************************************************/
494 /* redisplay exported functions */
495 /*************************************************************************/
496 EXFUN (Fredraw_frame, 2);
498 int redisplay_text_width_string (struct window *w, int findex,
499 Bufbyte *nonreloc, Lisp_Object reloc,
500 Bytecount offset, Bytecount len);
501 int redisplay_frame_text_width_string (struct frame *f,
505 Bytecount offset, Bytecount len);
506 void redisplay (void);
507 struct display_block *get_display_block_from_line (struct display_line *dl,
508 enum display_type type);
509 layout_bounds calculate_display_line_boundaries (struct window *w,
511 Bufpos point_at_center (struct window *w, int type, Bufpos start,
513 int line_at_center (struct window *w, int type, Bufpos start, Bufpos point);
514 int window_half_pixpos (struct window *w);
515 void redisplay_echo_area (void);
516 void free_display_structs (struct window_mirror *mir);
517 Bufbyte *generate_formatted_string (struct window *w, Lisp_Object format_str,
518 Lisp_Object result_str, face_index findex,
520 int real_current_modeline_height (struct window *w);
521 int pixel_to_glyph_translation (struct frame *f, int x_coord,
522 int y_coord, int *col, int *row,
523 int *obj_x, int *obj_y,
524 struct window **w, Bufpos *bufpos,
525 Bufpos *closest, Charcount *modeline_closest,
526 Lisp_Object *obj1, Lisp_Object *obj2);
527 void glyph_to_pixel_translation (struct window *w, int char_x,
528 int char_y, int *pix_x, int *pix_y);
529 void mark_redisplay (void (*) (Lisp_Object));
530 int point_in_line_start_cache (struct window *w, Bufpos point,
532 int point_would_be_visible (struct window *w, Bufpos startp,
534 Bufpos start_of_last_line (struct window *w, Bufpos startp);
535 Bufpos end_of_last_line (struct window *w, Bufpos startp);
536 Bufpos start_with_line_at_pixpos (struct window *w, Bufpos point,
538 Bufpos start_with_point_on_display_line (struct window *w, Bufpos point,
540 int redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
541 Lisp_Object in_object, int flags);
542 void redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
545 #ifdef MEMORY_USAGE_STATS
546 int compute_display_line_dynarr_usage (display_line_dynarr *dyn,
547 struct overhead_stats *ovstats);
548 int compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
549 struct overhead_stats *ovstats);
553 /* defined in redisplay-output.c */
554 int get_next_display_block (layout_bounds bounds,
555 display_block_dynarr *dba, int start_pos,
557 void redisplay_output_subwindow (struct window *w, struct display_line *dl,
558 Lisp_Object image_instance, int xpos,
559 int xoffset, int start_pixpos, int width,
560 face_index findex, int cursor_start,
561 int cursor_width, int cursor_height);
562 void redisplay_clear_region (Lisp_Object window, face_index findex, int x,
563 int y, int width, int height);
564 void redisplay_clear_bottom_of_window (struct window *w,
565 display_line_dynarr *ddla,
566 int min_start, int max_end);
567 void redisplay_update_line (struct window *w, int first_line,
568 int last_line, int update_values);
569 void redisplay_output_window (struct window *w);
570 int redisplay_move_cursor (struct window *w, Bufpos new_point,
572 void redisplay_redraw_cursor (struct frame *f, int run_begin_end_meths);
573 void output_display_line (struct window *w, display_line_dynarr *cdla,
574 display_line_dynarr *ddla, int line,
575 int force_start, int force_end);
577 #endif /* _XEMACS_REDISPLAY_H_ */