git.chise.org Git - chise/xemacs-chise.git.1/blob - src/redisplay.h

   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.
   5
   6 This file is part of XEmacs.
   7
   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
  11 later version.
  12
  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
  16 for more details.
  17
  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.  */
  22
  23 /* Synched up with: Not in FSF. */
  24
  25 #ifndef _XEMACS_REDISPLAY_H_
  26 #define _XEMACS_REDISPLAY_H_
  27
  28 /* Redisplay DASSERT types */
  29 #define DB_DISP_POS             1
  30 #define DB_DISP_TEXT_LAYOUT     2
  31 #define DB_DISP_REDISPLAY       4
  32
  33 /* These are the possible return values from pixel_to_glyph_translation. */
  34 #define OVER_MODELINE           0
  35 #define OVER_TEXT               1
  36 #define OVER_OUTSIDE            2
  37 #define OVER_NOTHING            3
  38 #define OVER_BORDER             4
  39 #define OVER_TOOLBAR            5
  40 #define OVER_V_DIVIDER          6
  41
  42 #define NO_BLOCK        -1
  43
  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
  48    of paper. */
  49
  50 typedef struct line_start_cache line_start_cache;
  51 struct line_start_cache
  52 {
  53   Bufpos start, end;
  54   int height;
  55 };
  56
  57 typedef struct
  58 {
  59   Dynarr_declare (line_start_cache);
  60 } line_start_cache_dynarr;
  61
  62 /* The possible types of runes.
  63
  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. */
  71
  72 #define RUNE_BLANK      0
  73 #define RUNE_CHAR       1
  74 #define RUNE_DGLYPH     2
  75 #define RUNE_HLINE      3
  76 #define RUNE_VLINE      4
  77
  78 #define CURSOR_ON       0
  79 #define CURSOR_OFF      1
  80 #define NO_CURSOR       2
  81 #define NEXT_CURSOR     3
  82 #define IGNORE_CURSOR   4
  83
  84 #define DEFAULT_INDEX   (face_index) 0
  85 #define MODELINE_INDEX  (face_index) 1
  86
  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. */
  93
  94 typedef struct rune rune;
  95 struct rune
  96 {
  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. */
 107
 108   short xpos;                   /* horizontal starting position in pixels */
 109   short width;                  /* pixel width of rune */
 110
 111
 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
 118                                    this. */
 119   unsigned int cursor_type :3;  /* is this rune covered by the cursor? */
 120   unsigned int type :3;         /* type of rune object */
 121
 122   union                         /* Information specific to the type of rune */
 123   {
 124     /* DGLYPH */
 125     struct
 126     {
 127       Lisp_Object glyph;
 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. */
 131
 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
 136                                    at XPOS. */
 137     } dglyph;
 138
 139     /* CHAR */
 140     struct
 141     {
 142       Emchar ch;                /* Cbaracter of this rune. */
 143     } chr;
 144
 145     /* HLINE */
 146     struct
 147     {
 148       int thickness;            /* how thick to make hline */
 149       int yoffset;              /* how far down from top of line to put top */
 150     } hline;
 151   } object;                     /* actual rune object */
 152 };
 153
 154 typedef struct
 155 {
 156   Dynarr_declare (rune);
 157 } rune_dynarr;
 158
 159 /* These must have distinct values.  Note that the ordering actually
 160    represents priority levels.  TEXT has the lowest priority level. */
 161 enum display_type
 162 {
 163   TEXT,
 164   LEFT_OUTSIDE_MARGIN,
 165   LEFT_INSIDE_MARGIN,
 166   RIGHT_INSIDE_MARGIN,
 167   RIGHT_OUTSIDE_MARGIN,
 168   OVERWRITE
 169 };
 170
 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'.
 174
 175    A display block consists mostly of an array of runes, one per
 176    atomic display element (printable character, pixmap, etc.). */
 177
 178 /* #### Yuckity yuckity yuck yuck yuck yuck yuck!!
 179
 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
 185    the same font.
 186
 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
 192    on a slow line. */
 193
 194 typedef struct display_block display_block;
 195 struct display_block
 196 {
 197   enum display_type type;       /* type of display block */
 198
 199   int start_pos;                /* starting pixel position of block */
 200   int end_pos;                  /* ending pixel position of block */
 201
 202   rune_dynarr *runes;           /* Dynamic array of runes */
 203 };
 204
 205 typedef struct
 206 {
 207   Dynarr_declare (display_block);
 208 } display_block_dynarr;
 209
 210 typedef struct layout_bounds_type
 211 {
 212   int left_out;
 213   int left_in;
 214   int left_white;
 215   int right_white;
 216   int right_in;
 217   int right_out;
 218 } layout_bounds;
 219
 220 typedef struct glyph_block glyph_block;
 221 struct glyph_block
 222 {
 223   Lisp_Object glyph;
 224   Lisp_Object extent;
 225   /* The rest are only used by margin routines. */
 226   face_index findex;
 227   int active;
 228   int width;
 229 };
 230
 231 typedef struct
 232 {
 233   Dynarr_declare (glyph_block);
 234 } glyph_block_dynarr;
 235
 236 typedef struct display_line display_line;
 237 struct display_line
 238 {
 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
 249                                            in pixels.*/
 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
 255                                            and control chars */
 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 propogation data */
 260
 261   layout_bounds bounds;                 /* line boundary positions */
 262
 263   char modeline;                        /* t if this line is a modeline */
 264
 265   /* Dynamic array of display blocks */
 266   display_block_dynarr *display_blocks;
 267
 268   /* Dynamic arrays of left and right glyph blocks */
 269   glyph_block_dynarr *left_glyphs;
 270   glyph_block_dynarr *right_glyphs;
 271 };
 272
 273 typedef struct
 274 {
 275   Dynarr_declare (display_line);
 276 } display_line_dynarr;
 277
 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. */
 281
 282 typedef struct
 283 {
 284   Dynarr_declare (EXTENT);
 285 } EXTENT_dynarr;
 286
 287 struct font_metric_info
 288 {
 289   int width;
 290   int height;                   /* always ascent + descent; for convenience */
 291   int ascent;
 292   int descent;
 293
 294   int proportional_p;
 295 };
 296
 297 /* NOTE NOTE NOTE: Currently the positions in an extent fragment
 298    structure are Bytind's, not Bufpos's.  This could change. */
 299
 300 struct extent_fragment
 301 {
 302   Lisp_Object object; /* buffer or string */
 303   struct frame *frm;
 304   Bytind pos, end;
 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;
 311 };
 312
 313 \f
 314 /*************************************************************************/
 315 /*                              change flags                             */
 316 /*************************************************************************/
 317
 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
 322    appropriate flag.
 323
 324    If any of these flags are set, redisplay will look more carefully
 325    to see if anything has really changed. */
 326
 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;
 331
 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;
 336
 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;
 340
 341 /* non-nil if any face has changed since the last time redisplay completed */
 342 extern int faces_changed;
 343
 344 /* Nonzero means one or more frames have been marked as garbaged */
 345 extern int frame_changed;
 346
 347 /* True if any of the builtin display glyphs (continuation,
 348    hscroll, control-arrow, etc) is in need of updating
 349    somewhere. */
 350 extern int glyphs_changed;
 351 extern int glyphs_changed_set;
 352
 353 /* True if an icon is in need of updating somewhere. */
 354 extern int icon_changed;
 355 extern int icon_changed_set;
 356
 357 /* True if a menubar is in need of updating somewhere. */
 358 extern int menubar_changed;
 359 extern int menubar_changed_set;
 360
 361 /* true iff we should redraw the modelines on the next redisplay */
 362 extern int modeline_changed;
 363 extern int modeline_changed_set;
 364
 365 /* non-nil if point has changed in some buffer since the last time
 366    redisplay completed */
 367 extern int point_changed;
 368 extern int point_changed_set;
 369
 370 /* non-nil if some frame has changed its size */
 371 extern int size_changed;
 372
 373 /* non-nil if some device has signaled that it wants to change size */
 374 extern int asynch_device_change_pending;
 375
 376 /* non-nil if any toolbar has changed */
 377 extern int toolbar_changed;
 378 extern int toolbar_changed_set;
 379
 380 /* non-nil if any window has changed since the last time redisplay completed */
 381 extern int windows_changed;
 382
 383 /* non-nil if any frame's window structure has changed since the last
 384    time redisplay completed */
 385 extern int windows_structure_changed;
 386
 387 /* These macros can be relatively expensive.  Since they are often
 388    called numerous times between each call to redisplay, we keep track
 389    if each has already been called and don't bother doing most of the
 390    work if it is currently set. */
 391
 392 #define MARK_TYPE_CHANGED(object) do {                                  \
 393   if (!object##_changed_set) {                                          \
 394     Lisp_Object _devcons_, _concons_;                                   \
 395     DEVICE_LOOP_NO_BREAK (_devcons_, _concons_)                         \
 396       {                                                                 \
 397         Lisp_Object _frmcons_;                                          \
 398         struct device *_d_ = XDEVICE (XCAR (_devcons_));                \
 399         DEVICE_FRAME_LOOP (_frmcons_, _d_)                              \
 400           {                                                             \
 401             struct frame *_f_ = XFRAME (XCAR (_frmcons_));              \
 402             _f_->object##_changed = 1;                                  \
 403             _f_->modiff++;                                              \
 404           }                                                             \
 405         _d_->object##_changed = 1;                                      \
 406       }                                                                 \
 407     object##_changed = 1;                                               \
 408     object##_changed_set = 1; }                                         \
 409   }  while (0)
 410
 411 #define MARK_BUFFERS_CHANGED MARK_TYPE_CHANGED (buffers)
 412 #define MARK_CLIP_CHANGED MARK_TYPE_CHANGED (clip)
 413 #define MARK_EXTENTS_CHANGED MARK_TYPE_CHANGED (extents)
 414 #define MARK_ICON_CHANGED MARK_TYPE_CHANGED (icon)
 415 #define MARK_MENUBAR_CHANGED MARK_TYPE_CHANGED (menubar)
 416 #define MARK_MODELINE_CHANGED MARK_TYPE_CHANGED (modeline)
 417 #define MARK_POINT_CHANGED MARK_TYPE_CHANGED (point)
 418 #define MARK_TOOLBAR_CHANGED MARK_TYPE_CHANGED (toolbar)
 419 #define MARK_GLYPHS_CHANGED MARK_TYPE_CHANGED (glyphs)
 420
 421 /* Anytime a console, device or frame is added or deleted we need to reset
 422    these flags. */
 423 #define RESET_CHANGED_SET_FLAGS                                         \
 424   do {                                                                  \
 425     buffers_changed_set = 0;                                            \
 426     clip_changed_set = 0;                                               \
 427     extents_changed_set = 0;                                            \
 428     icon_changed_set = 0;                                               \
 429     menubar_changed_set = 0;                                            \
 430     modeline_changed_set = 0;                                           \
 431     point_changed_set = 0;                                              \
 432     toolbar_changed_set = 0;                                            \
 433     glyphs_changed_set = 0;                                             \
 434   } while (0)
 435
 436 \f
 437 /*************************************************************************/
 438 /*                       redisplay global variables                      */
 439 /*************************************************************************/
 440
 441 /* redisplay structre used by various utility routines. */
 442 extern display_line_dynarr *cmotion_display_lines;
 443
 444 /* Nonzero means truncate lines in all windows less wide than the frame. */
 445 extern int truncate_partial_width_windows;
 446
 447 /* Nonzero if we're in a display critical section. */
 448 extern int in_display;
 449
 450 /* Nonzero means no need to redraw the entire frame on resuming
 451    a suspended Emacs.  This is useful on terminals with multiple pages,
 452    where one page is used for Emacs and another for all else. */
 453 extern int no_redraw_on_reenter;
 454
 455 /* Nonzero means flash the frame instead of ringing the bell.  */
 456 extern int visible_bell;
 457
 458 /* Thickness of shadow border around 3D modelines. */
 459 extern Lisp_Object Vmodeline_shadow_thickness;
 460
 461 /* Scroll if point lands on the bottom line and that line is partially
 462    clipped. */
 463 extern int scroll_on_clipped_lines;
 464
 465 extern Lisp_Object Vglobal_mode_string;
 466
 467 /* The following two variables are defined in emacs.c and are used
 468    to convey information discovered on the command line way early
 469    (before *anything* is initialized). */
 470
 471 /* If non-zero, a window-system was specified on the command line.
 472    Defined in emacs.c. */
 473 extern int display_arg;
 474
 475 /* Type of display specified.  Defined in emacs.c. */
 476 extern char *display_use;
 477
 478 /* Nonzero means reading single-character input with prompt
 479    so put cursor on minibuffer after the prompt.  */
 480
 481 extern int cursor_in_echo_area;
 482
 483 extern Lisp_Object Qbar_cursor, Qcursor_in_echo_area, Vwindow_system;
 484
 485 \f
 486 /*************************************************************************/
 487 /*                     redisplay exported functions                      */
 488 /*************************************************************************/
 489 EXFUN (Fredraw_frame, 2);
 490
 491 int redisplay_text_width_string (struct window *w, int findex,
 492                                  Bufbyte *nonreloc, Lisp_Object reloc,
 493                                  Bytecount offset, Bytecount len);
 494 int redisplay_frame_text_width_string (struct frame *f,
 495                                        Lisp_Object face,
 496                                        Bufbyte *nonreloc,
 497                                        Lisp_Object reloc,
 498                                        Bytecount offset, Bytecount len);
 499 void redisplay (void);
 500 struct display_block *get_display_block_from_line (struct display_line *dl,
 501                                                    enum display_type type);
 502 layout_bounds calculate_display_line_boundaries (struct window *w,
 503                                                  int modeline);
 504 Bufpos point_at_center (struct window *w, int type, Bufpos start,
 505                         Bufpos point);
 506 int line_at_center (struct window *w, int type, Bufpos start, Bufpos point);
 507 int window_half_pixpos (struct window *w);
 508 void redisplay_echo_area (void);
 509 void free_display_structs (struct window_mirror *mir);
 510 Bufbyte *generate_formatted_string (struct window *w, Lisp_Object format_str,
 511                                     Lisp_Object result_str, face_index findex,
 512                                     int type);
 513 int real_current_modeline_height (struct window *w);
 514 int pixel_to_glyph_translation (struct frame *f, int x_coord,
 515                                 int y_coord, int *col, int *row,
 516                                 int *obj_x, int *obj_y,
 517                                 struct window **w, Bufpos *bufpos,
 518                                 Bufpos *closest, Charcount *modeline_closest,
 519                                 Lisp_Object *obj1, Lisp_Object *obj2);
 520 void glyph_to_pixel_translation (struct window *w, int char_x,
 521                                  int char_y, int *pix_x, int *pix_y);
 522 void mark_redisplay (void (*) (Lisp_Object));
 523 int point_in_line_start_cache (struct window *w, Bufpos point,
 524                                int min_past);
 525 int point_would_be_visible (struct window *w, Bufpos startp,
 526                     Bufpos point);
 527 Bufpos start_of_last_line (struct window *w, Bufpos startp);
 528 Bufpos end_of_last_line (struct window *w, Bufpos startp);
 529 Bufpos start_with_line_at_pixpos (struct window *w, Bufpos point,
 530                                   int pixpos);
 531 Bufpos start_with_point_on_display_line (struct window *w, Bufpos point,
 532                                          int line);
 533 int redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
 534                                 Lisp_Object in_object, int flags);
 535 void redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
 536                               Lisp_Object locale);
 537
 538 #ifdef MEMORY_USAGE_STATS
 539 int compute_display_line_dynarr_usage (display_line_dynarr *dyn,
 540                                        struct overhead_stats *ovstats);
 541 int compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
 542                                            struct overhead_stats *ovstats);
 543 #endif
 544
 545
 546 /* defined in redisplay-output.c */
 547 int get_next_display_block (layout_bounds bounds,
 548                             display_block_dynarr *dba, int start_pos,
 549                             int *next_start);
 550 void redisplay_clear_bottom_of_window (struct window *w,
 551                                        display_line_dynarr *ddla,
 552                                        int min_start, int max_end);
 553 void redisplay_update_line (struct window *w, int first_line,
 554                             int last_line, int update_values);
 555 void redisplay_output_window (struct window *w);
 556 int redisplay_move_cursor (struct window *w, Bufpos new_point,
 557                            int no_output_end);
 558 void redisplay_redraw_cursor (struct frame *f, int run_begin_end_meths);
 559 void output_display_line (struct window *w, display_line_dynarr *cdla,
 560                           display_line_dynarr *ddla, int line,
 561                           int force_start, int force_end);
 562
 563 #endif /* _XEMACS_REDISPLAY_H_ */