src/frame.h

   1 /* Define frame-object for GNU Emacs.
   2    Copyright (C) 1993, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
   3                  2005 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 /* Don't multiply include: dispextern.h includes macterm.h which
  23    includes frame.h some emacs source includes both dispextern.h and
  24    frame.h */
  25
  26 #ifndef EMACS_FRAME_H
  27 #define EMACS_FRAME_H
  28
  29 \f
  30 /* Miscellanea.  */
  31
  32 /* Nonzero means there is at least one garbaged frame. */
  33 extern int frame_garbaged;
  34
  35 /* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
  36    print.  */
  37
  38 extern int message_buf_print;
  39
  40 \f
  41 /* The structure representing a frame.  */
  42
  43 enum output_method
  44 {
  45   output_initial,
  46   output_termcap,
  47   output_x_window,
  48   output_msdos_raw,
  49   output_w32,
  50   output_mac
  51 };
  52
  53 enum vertical_scroll_bar_type
  54 {
  55   vertical_scroll_bar_none,
  56   vertical_scroll_bar_left,
  57   vertical_scroll_bar_right
  58 };
  59
  60 enum text_cursor_kinds
  61 {
  62   DEFAULT_CURSOR = -2,
  63   NO_CURSOR = -1,
  64   FILLED_BOX_CURSOR,
  65   HOLLOW_BOX_CURSOR,
  66   BAR_CURSOR,
  67   HBAR_CURSOR
  68 };
  69
  70 #define FRAME_FOREGROUND_PIXEL(f) ((f)->foreground_pixel)
  71 #define FRAME_BACKGROUND_PIXEL(f) ((f)->background_pixel)
  72
  73 struct device;
  74
  75 struct frame
  76 {
  77   EMACS_INT size;
  78   struct Lisp_Vector *next;
  79
  80   /* All Lisp_Object components must come first.
  81      Only EMACS_INT values can be intermixed with them.
  82      That ensures they are all aligned normally.  */
  83
  84   /* Name of this frame: a Lisp string.  It is used for looking up resources,
  85      as well as for the title in some cases.  */
  86   Lisp_Object name;
  87
  88   /* The name to use for the icon, the last time
  89      it was refreshed.  nil means not explicitly specified.  */
  90   Lisp_Object icon_name;
  91
  92   /* This is the frame title specified explicitly, if any.
  93      Usually it is nil.  */
  94   Lisp_Object title;
  95
  96   /* The frame which should receive keystrokes that occur in this
  97      frame, or nil if they should go to the frame itself.  This is
  98      usually nil, but if the frame is minibufferless, we can use this
  99      to redirect keystrokes to a surrogate minibuffer frame when
 100      needed.
 101
 102      Note that a value of nil is different than having the field point
 103      to the frame itself.  Whenever the Fselect_frame function is used
 104      to shift from one frame to the other, any redirections to the
 105      original frame are shifted to the newly selected frame; if
 106      focus_frame is nil, Fselect_frame will leave it alone.  */
 107   Lisp_Object focus_frame;
 108
 109   /* This frame's root window.  Every frame has one.
 110      If the frame has only a minibuffer window, this is it.
 111      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
 112   Lisp_Object root_window;
 113
 114   /* This frame's selected window.
 115      Each frame has its own window hierarchy
 116      and one of the windows in it is selected within the frame.
 117      The selected window of the selected frame is Emacs's selected window.  */
 118   Lisp_Object selected_window;
 119
 120   /* This frame's minibuffer window.
 121      Most frames have their own minibuffer windows,
 122      but only the selected frame's minibuffer window
 123      can actually appear to exist.  */
 124   Lisp_Object minibuffer_window;
 125
 126   /* Parameter alist of this frame.
 127      These are the parameters specified when creating the frame
 128      or modified with modify-frame-parameters.  */
 129   Lisp_Object param_alist;
 130
 131   /* List of scroll bars on this frame.
 132      Actually, we don't specify exactly what is stored here at all; the
 133      scroll bar implementation code can use it to store anything it likes.
 134      This field is marked by the garbage collector.  It is here
 135      instead of in the `device' structure so that the garbage
 136      collector doesn't need to look inside the window-system-dependent
 137      structure.  */
 138   Lisp_Object scroll_bars;
 139   Lisp_Object condemned_scroll_bars;
 140
 141   /* Vector describing the items to display in the menu bar.
 142      Each item has four elements in this vector.
 143      They are KEY, STRING, SUBMAP, and HPOS.
 144      (HPOS is not used in when the X toolkit is in use.)
 145      There are four additional elements of nil at the end, to terminate.  */
 146   Lisp_Object menu_bar_items;
 147
 148   /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA).  */
 149   Lisp_Object face_alist;
 150
 151   /* A vector that records the entire structure of this frame's menu bar.
 152      For the format of the data, see extensive comments in xmenu.c.
 153      Only the X toolkit version uses this.  */
 154   Lisp_Object menu_bar_vector;
 155   /* Number of elements in the vector that have meaningful data.  */
 156   EMACS_INT menu_bar_items_used;
 157
 158   /* Predicate for selecting buffers for other-buffer.  */
 159   Lisp_Object buffer_predicate;
 160
 161   /* List of buffers viewed in this frame, for other-buffer.  */
 162   Lisp_Object buffer_list;
 163
 164   /* A dummy window used to display menu bars under X when no X
 165      toolkit support is available.  */
 166   Lisp_Object menu_bar_window;
 167
 168   /* A window used to display the tool-bar of a frame.  */
 169   Lisp_Object tool_bar_window;
 170
 171   /* Desired and current tool-bar items.  */
 172   Lisp_Object tool_bar_items;
 173
 174   /* Desired and current contents displayed in tool_bar_window.  */
 175   Lisp_Object desired_tool_bar_string, current_tool_bar_string;
 176
 177   /* beyond here, there should be no more Lisp_Object components.  */
 178
 179   /* Cache of realized faces.  */
 180   struct face_cache *face_cache;
 181
 182   /* A buffer to hold the frame's name.  We can't use the Lisp
 183      string's pointer (`name', above) because it might get relocated.  */
 184   char *namebuf;
 185
 186   /* Glyph pool and matrix. */
 187   struct glyph_pool *current_pool;
 188   struct glyph_pool *desired_pool;
 189   struct glyph_matrix *desired_matrix;
 190   struct glyph_matrix *current_matrix;
 191
 192   /* 1 means that glyphs on this frame have been initialized so it can
 193      be used for output.  */
 194   unsigned glyphs_initialized_p : 1;
 195
 196 #if defined (USE_GTK)
 197   /* Nonzero means using a tool bar that comes from the toolkit.  */
 198   int external_tool_bar;
 199 #endif
 200
 201   /* Margin at the top of the frame.  Used to display the tool-bar.  */
 202   int tool_bar_lines;
 203
 204   int n_tool_bar_items;
 205
 206   /* A buffer for decode_mode_line. */
 207   char *decode_mode_spec_buffer;
 208
 209   /* See do_line_insertion_deletion_costs for info on these arrays. */
 210   /* Cost of inserting 1 line on this frame */
 211   int *insert_line_cost;
 212   /* Cost of deleting 1 line on this frame */
 213   int *delete_line_cost;
 214   /* Cost of inserting n lines on this frame */
 215   int *insert_n_lines_cost;
 216   /* Cost of deleting n lines on this frame */
 217   int *delete_n_lines_cost;
 218
 219   /* Size of this frame, excluding fringes, scroll bars etc.,
 220      in units of canonical characters.  */
 221   EMACS_INT text_lines, text_cols;
 222
 223   /* Total size of this frame (i.e. its native window), in units of
 224      canonical characters.  */
 225   EMACS_INT total_lines, total_cols;
 226
 227   /* New text height and width for pending size change.
 228      0 if no change pending.  */
 229   int new_text_lines, new_text_cols;
 230
 231   /* Pixel position of the frame window (x and y offsets in root window).  */
 232   int left_pos, top_pos;
 233
 234   /* Size of the frame window in pixels.  */
 235   int pixel_height, pixel_width;
 236
 237   /* These many pixels are the difference between the outer window (i.e. the
 238      left and top of the window manager decoration) and FRAME_X_WINDOW. */
 239   int x_pixels_diff, y_pixels_diff;
 240
 241   /* This is the gravity value for the specified window position.  */
 242   int win_gravity;
 243
 244   /* The geometry flags for this window.  */
 245   int size_hint_flags;
 246
 247   /* Border width of the frame window as known by the (X) window system.  */
 248   int border_width;
 249
 250   /* Width of the internal border.  This is a line of background color
 251      just inside the window's border.  When the frame is selected,
 252      a highlighting is displayed inside the internal border.  */
 253   int internal_border_width;
 254
 255   /* Canonical X unit.  Width of default font, in pixels.  */
 256   int column_width;
 257
 258   /* Widht of space glyph of default font, in pixels.  */
 259   int space_width;
 260
 261   /* Canonical Y unit.  Height of a line, in pixels.  */
 262   int line_height;
 263
 264   /* The output method says how the contents of this frame are
 265      displayed.  It could be using termcap, or using an X window.
 266      This must be the same as the device->type. */
 267   enum output_method output_method;
 268
 269   /* The display device that this frame uses.  If this is NULL, then
 270      the frame has been deleted. */
 271   struct device *device;
 272
 273   /* Device-dependent, frame-local auxiliary data used for displaying
 274      the contents.  When the frame is deleted, this data is deleted as
 275      well. */
 276   union output_data
 277   {
 278     struct tty_output *tty;     /* termchar.h */
 279     struct x_output *x;         /* xterm.h */
 280     struct w32_output *w32;     /* w32term.h */
 281     struct mac_output *mac;     /* macterm.h */
 282     EMACS_INT nothing;
 283   }
 284   output_data;
 285
 286   /* Total width of fringes reserved for drawing truncation bitmaps,
 287      continuation bitmaps and alike.  The width is in canonical char
 288      units of the frame.  This must currently be the case because window
 289      sizes aren't pixel values.  If it weren't the case, we wouldn't be
 290      able to split windows horizontally nicely.  */
 291   int fringe_cols;
 292
 293   /* The extra width (in pixels) currently allotted for fringes.  */
 294   int left_fringe_width, right_fringe_width;
 295
 296   /* See FULLSCREEN_ enum below */
 297   int want_fullscreen;
 298
 299   /* Number of lines of menu bar.  */
 300   int menu_bar_lines;
 301
 302 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
 303     || defined (USE_GTK)
 304   /* Nonzero means using a menu bar that comes from the X toolkit.  */
 305   int external_menu_bar;
 306 #endif
 307
 308   /* Nonzero if last attempt at redisplay on this frame was preempted.  */
 309   char display_preempted;
 310
 311   /* visible is nonzero if the frame is currently displayed; we check
 312      it to see if we should bother updating the frame's contents.
 313      DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
 314
 315      Note that, since invisible frames aren't updated, whenever a
 316      frame becomes visible again, it must be marked as garbaged.  The
 317      FRAME_SAMPLE_VISIBILITY macro takes care of this.
 318
 319      On ttys and on Windows NT/9X, to avoid wasting effort updating
 320      visible frames that are actually completely obscured by other
 321      windows on the display, we bend the meaning of visible slightly:
 322      if greater than 1, then the frame is obscured - we still consider
 323      it to be "visible" as seen from lisp, but we don't bother
 324      updating it.  We must take care to garbage the frame when it
 325      ceaces to be obscured though.
 326
 327      iconified is nonzero if the frame is currently iconified.
 328
 329      Asynchronous input handlers should NOT change these directly;
 330      instead, they should change async_visible or async_iconified, and
 331      let the FRAME_SAMPLE_VISIBILITY macro set visible and iconified
 332      at the next redisplay.
 333
 334      These should probably be considered read-only by everyone except
 335      FRAME_SAMPLE_VISIBILITY.
 336
 337      These two are mutually exclusive.  They might both be zero, if the
 338      frame has been made invisible without an icon.  */
 339   char visible, iconified;
 340
 341   /* Asynchronous input handlers change these, and
 342      FRAME_SAMPLE_VISIBILITY copies them into visible and iconified.
 343      See FRAME_SAMPLE_VISIBILITY, below.  */
 344   volatile char async_visible, async_iconified;
 345
 346   /* Nonzero if this frame should be redrawn.  */
 347   volatile char garbaged;
 348
 349   /* True if frame actually has a minibuffer window on it.
 350      0 if using a minibuffer window that isn't on this frame.  */
 351   char has_minibuffer;
 352
 353   /* 0 means, if this frame has just one window,
 354      show no modeline for that window.  */
 355   char wants_modeline;
 356
 357   /* Non-zero if the hardware device this frame is displaying on can
 358      support scroll bars.  */
 359   char can_have_scroll_bars;
 360
 361   /* If can_have_scroll_bars is non-zero, this is non-zero if we should
 362      actually display them on this frame.  */
 363   enum vertical_scroll_bar_type vertical_scroll_bar_type;
 364
 365   /* What kind of text cursor should we draw in the future?
 366      This should always be filled_box_cursor or bar_cursor.  */
 367   enum text_cursor_kinds desired_cursor;
 368
 369   /* Width of bar cursor (if we are using that).  */
 370   int cursor_width;
 371
 372   /* What kind of text cursor should we draw when the cursor blinks off?
 373      This can be filled_box_cursor or bar_cursor or no_cursor.  */
 374   enum text_cursor_kinds blink_off_cursor;
 375
 376   /* Width of bar cursor (if we are using that) for blink-off state.  */
 377   int blink_off_cursor_width;
 378
 379   /* Non-0 means raise this frame to the top of the heap when selected.  */
 380   char auto_raise;
 381
 382   /* Non-0 means lower this frame to the bottom of the stack when left.  */
 383   char auto_lower;
 384
 385   /* True if frame's root window can't be split.  */
 386   char no_split;
 387
 388   /* If this is set, then Emacs won't change the frame name to indicate
 389      the current buffer, etcetera.  If the user explicitly sets the frame
 390      name, this gets set.  If the user sets the name to Qnil, this is
 391      cleared.  */
 392   char explicit_name;
 393
 394   /* Nonzero if size of some window on this frame has changed.  */
 395   char window_sizes_changed;
 396
 397   /* Storage for messages to this frame. */
 398   char *message_buf;
 399
 400   /* Nonnegative if current redisplay should not do scroll computation
 401      for lines beyond a certain vpos.  This is the vpos.  */
 402   int scroll_bottom_vpos;
 403
 404   /* Configured width of the scroll bar, in pixels and in characters.
 405      config_scroll_bar_cols tracks config_scroll_bar_width if the
 406      latter is positive; a zero value in config_scroll_bar_width means
 407      to compute the actual width on the fly, using config_scroll_bar_cols
 408      and the current font width.  */
 409   int config_scroll_bar_width;
 410   int config_scroll_bar_cols;
 411
 412   /* The size of the extra width currently allotted for vertical
 413      scroll bars in this frame, in pixels.  */
 414   int scroll_bar_actual_width;
 415
 416   /* The baud rate that was used to calculate costs for this frame.  */
 417   int cost_calculation_baud_rate;
 418
 419   /* Nonzero if the mouse has moved on this display device
 420      since the last time we checked.  */
 421   char mouse_moved;
 422
 423   /* Exponent for gamma correction of colors.  1/(VIEWING_GAMMA *
 424      SCREEN_GAMMA) where viewing_gamma is 0.4545 and SCREEN_GAMMA is a
 425      frame parameter.  0 means don't do gamma correction.  */
 426   double gamma;
 427
 428   /* Additional space to put between text lines on this frame.  */
 429   int extra_line_spacing;
 430
 431   /* Set to non-zero in change_frame_size when size of frame changed
 432      Clear the frame in clear_garbaged_frames if set.  */
 433   unsigned resized_p : 1;
 434
 435   /* Set to non-zero in when we want for force a flush_display in
 436      update_frame, usually after resizing the frame.  */
 437   unsigned force_flush_display_p : 1;
 438
 439   /* All display backends seem to need these two pixel values. */
 440   unsigned long background_pixel;
 441   unsigned long foreground_pixel;
 442
 443   /* Set to non-zero if the default face for the frame has been
 444      realized.  Reset to zero whenever the default face changes.
 445      Used to see the difference between a font change and face change.  */
 446   unsigned default_face_done_p : 1;
 447
 448   /* Set to non-zero if this frame has already been hscrolled during
 449      current redisplay.  */
 450   unsigned already_hscrolled_p : 1;
 451
 452   /* Set to non-zero when current redisplay has updated frame.  */
 453   unsigned updated_p : 1;
 454 };
 455
 456 #ifdef MULTI_KBOARD
 457 #define FRAME_KBOARD(f) ((f)->device->kboard)
 458 #else
 459 #define FRAME_KBOARD(f) (&the_only_kboard)
 460 #endif
 461
 462 typedef struct frame *FRAME_PTR;
 463
 464 #define XFRAME(p) (eassert (GC_FRAMEP(p)),(struct frame *) XPNTR (p))
 465 #define XSETFRAME(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FRAME))
 466
 467 /* Given a window, return its frame as a Lisp_Object.  */
 468 #define WINDOW_FRAME(w) (w)->frame
 469
 470 /* Test a frame for particular kinds of display methods.  */
 471 #define FRAME_INITIAL_P(f) ((f)->output_method == output_initial)
 472 #define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
 473 #define FRAME_X_P(f) ((f)->output_method == output_x_window)
 474 #define FRAME_W32_P(f) ((f)->output_method == output_w32)
 475 #define FRAME_MSDOS_P(f) ((f)->output_method == output_msdos_raw)
 476 #define FRAME_MAC_P(f) ((f)->output_method == output_mac)
 477
 478 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 479    defined to be the predicate for the window system being used.  */
 480
 481 #ifdef HAVE_X_WINDOWS
 482 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 483 #endif
 484 #ifdef HAVE_NTGUI
 485 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 486 #endif
 487 #ifdef MAC_OS
 488 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
 489 #endif
 490 #ifndef FRAME_WINDOW_P
 491 #define FRAME_WINDOW_P(f) (0)
 492 #endif
 493
 494 /* Nonzero if frame F is still alive (not deleted).  */
 495 #define FRAME_LIVE_P(f) ((f)->device != 0)
 496
 497 /* Nonzero if frame F is a minibuffer-only frame.  */
 498 #define FRAME_MINIBUF_ONLY_P(f) \
 499   EQ (FRAME_ROOT_WINDOW (f), FRAME_MINIBUF_WINDOW (f))
 500
 501 /* Nonzero if frame F contains a minibuffer window.
 502    (If this is 0, F must use some other minibuffer window.)  */
 503 #define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
 504
 505 /* Pixel height of frame F, including non-toolkit menu bar and
 506    non-toolkit tool bar lines.  */
 507 #define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
 508
 509 /* Pixel width of frame F.  */
 510 #define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
 511
 512 /* Height of frame F, measured in canonical lines, including
 513    non-toolkit menu bar and non-toolkit tool bar lines.  */
 514 #define FRAME_LINES(f) (f)->text_lines
 515
 516 /* Width of frame F, measured in canonical character columns,
 517    not including scroll bars if any.  */
 518 #define FRAME_COLS(f) (f)->text_cols
 519
 520 /* Number of lines of frame F used for menu bar.
 521    This is relevant on terminal frames and on
 522    X Windows when not using the X toolkit.
 523    These lines are counted in FRAME_LINES.  */
 524 #define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
 525
 526 /* Nonzero if this frame should display a tool bar
 527    in a way that does not use any text lines.  */
 528 #if defined (USE_GTK)
 529 #define FRAME_EXTERNAL_TOOL_BAR(f) (f)->external_tool_bar
 530 #else
 531 #define FRAME_EXTERNAL_TOOL_BAR(f) 0
 532 #endif
 533
 534 /* Number of lines of frame F used for the tool-bar.  */
 535
 536 #define FRAME_TOOL_BAR_LINES(f) (f)->tool_bar_lines
 537
 538
 539 /* Lines above the top-most window in frame F.  */
 540
 541 #define FRAME_TOP_MARGIN(F) \
 542      (FRAME_MENU_BAR_LINES (F) + FRAME_TOOL_BAR_LINES (F))
 543
 544 /* Nonzero if this frame should display a menu bar
 545    in a way that does not use any text lines.  */
 546 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
 547     || defined (USE_GTK)
 548 #define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
 549 #else
 550 #define FRAME_EXTERNAL_MENU_BAR(f) 0
 551 #endif
 552 #define FRAME_VISIBLE_P(f) ((f)->visible != 0)
 553
 554 /* Nonzero if frame F is currently visible but hidden.  */
 555 #define FRAME_OBSCURED_P(f) ((f)->visible > 1)
 556
 557 /* Nonzero if frame F is currently iconified.  */
 558 #define FRAME_ICONIFIED_P(f) (f)->iconified
 559
 560 #define FRAME_SET_VISIBLE(f,p) \
 561   ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
 562 #define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
 563 #define FRAME_GARBAGED_P(f) (f)->garbaged
 564
 565 /* Nonzero means do not allow splitting this frame's window.  */
 566 #define FRAME_NO_SPLIT_P(f) (f)->no_split
 567
 568 /* Not really implemented.  */
 569 #define FRAME_WANTS_MODELINE_P(f) (f)->wants_modeline
 570
 571 /* Nonzero if a size change has been requested for frame F
 572    but not yet really put into effect.  This can be true temporarily
 573    when an X event comes in at a bad time.  */
 574 #define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
 575
 576 /* The minibuffer window of frame F, if it has one; otherwise nil.  */
 577 #define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
 578
 579 /* The root window of the window tree of frame F.  */
 580 #define FRAME_ROOT_WINDOW(f) (f)->root_window
 581
 582 /* The currently selected window of the window tree of frame F.  */
 583 #define FRAME_SELECTED_WINDOW(f) (f)->selected_window
 584
 585 #define FRAME_INSERT_COST(f) (f)->insert_line_cost
 586 #define FRAME_DELETE_COST(f) (f)->delete_line_cost
 587 #define FRAME_INSERTN_COST(f) (f)->insert_n_lines_cost
 588 #define FRAME_DELETEN_COST(f) (f)->delete_n_lines_cost
 589 #define FRAME_MESSAGE_BUF(f) (f)->message_buf
 590 #define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
 591 #define FRAME_FOCUS_FRAME(f) (f)->focus_frame
 592
 593 /* Nonzero if frame F supports scroll bars.
 594    If this is zero, then it is impossible to enable scroll bars
 595    on frame F.  */
 596 #define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
 597
 598 /* This frame slot says whether scroll bars are currently enabled for frame F,
 599    and which side they are on.  */
 600 #define FRAME_VERTICAL_SCROLL_BAR_TYPE(f) ((f)->vertical_scroll_bar_type)
 601 #define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
 602      ((f)->vertical_scroll_bar_type != vertical_scroll_bar_none)
 603 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT(f) \
 604      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_left)
 605 #define FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT(f) \
 606      ((f)->vertical_scroll_bar_type == vertical_scroll_bar_right)
 607
 608 /* Width that a scroll bar in frame F should have, if there is one.
 609    Measured in pixels.
 610    If scroll bars are turned off, this is still nonzero.  */
 611 #define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
 612
 613 /* Width that a scroll bar in frame F should have, if there is one.
 614    Measured in columns (characters).
 615    If scroll bars are turned off, this is still nonzero.  */
 616 #define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
 617
 618 /* Width of a scroll bar in frame F, measured in columns (characters),
 619    but only if scroll bars are on the left.  If scroll bars are on
 620    the right in this frame, or there are no scroll bars, value is 0.  */
 621
 622 #define FRAME_LEFT_SCROLL_BAR_COLS(f)                   \
 623      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)        \
 624       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 625       : 0)
 626
 627 /* Width of a left scroll bar in frame F, measured in pixels */
 628
 629 #define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f)                                     \
 630   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)                           \
 631    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 632    : 0)
 633
 634 /* Width of a scroll bar in frame F, measured in columns (characters),
 635    but only if scroll bars are on the right.  If scroll bars are on
 636    the left in this frame, or there are no scroll bars, value is 0.  */
 637
 638 #define FRAME_RIGHT_SCROLL_BAR_COLS(f)                  \
 639      (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)       \
 640       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 641       : 0)
 642
 643 /* Width of a right scroll bar area in frame F, measured in pixels */
 644
 645 #define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f)                                    \
 646   (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f)                          \
 647    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 648    : 0)
 649
 650 /* Actual width of a scroll bar in frame F, measured in columns.  */
 651
 652 #define FRAME_SCROLL_BAR_COLS(f)                        \
 653      (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                \
 654       ? FRAME_CONFIG_SCROLL_BAR_COLS (f)                \
 655       : 0)
 656
 657 /* Actual width of a scroll bar area in frame F, measured in pixels.  */
 658
 659 #define FRAME_SCROLL_BAR_AREA_WIDTH(f)                                  \
 660   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                                   \
 661    ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))        \
 662    : 0)
 663
 664 /* Total width of frame F, in columns (characters),
 665    including the width used by scroll bars if any.  */
 666
 667 #define FRAME_TOTAL_COLS(f) ((f)->total_cols)
 668
 669 /* Set the width of frame F to VAL.
 670    VAL is the width of a full-frame window,
 671    not including scroll bars and fringes.  */
 672
 673 #define SET_FRAME_COLS(f, val)                                          \
 674      (FRAME_COLS (f) = (val),                                           \
 675       (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
 676
 677 /* Given a value WIDTH for frame F's nominal width,
 678    return the value that FRAME_TOTAL_COLS should have.  */
 679
 680 #define FRAME_TOTAL_COLS_ARG(f, width)          \
 681      ((width)                                   \
 682       + FRAME_SCROLL_BAR_COLS (f)               \
 683       + FRAME_FRINGE_COLS (f))
 684
 685 /* Maximum + 1 legitimate value for FRAME_CURSOR_X.  */
 686
 687 #define FRAME_CURSOR_X_LIMIT(f) \
 688      (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
 689
 690 /* Nonzero if frame F has scroll bars.  */
 691
 692 #define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
 693
 694 #define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
 695 #define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
 696 #define FRAME_COST_BAUD_RATE(f) ((f)->cost_calculation_baud_rate)
 697
 698 #define FRAME_DESIRED_CURSOR(f) ((f)->desired_cursor)
 699 #define FRAME_BLINK_OFF_CURSOR(f) ((f)->blink_off_cursor)
 700 #define FRAME_CURSOR_WIDTH(f) ((f)->cursor_width)
 701 #define FRAME_BLINK_OFF_CURSOR_WIDTH(f) ((f)->blink_off_cursor_width)
 702
 703 /* Return a pointer to the face cache of frame F.  */
 704
 705 #define FRAME_FACE_CACHE(F)     (F)->face_cache
 706
 707 /* Return the size of message_buf of the frame F.  We multiply the
 708    width of the frame by 4 because multi-byte form may require at most
 709    4-byte for a character.  */
 710
 711 #define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
 712
 713 /* Emacs's redisplay code could become confused if a frame's
 714    visibility changes at arbitrary times.  For example, if a frame is
 715    visible while the desired glyphs are being built, but becomes
 716    invisible before they are updated, then some rows of the
 717    desired_glyphs will be left marked as enabled after redisplay is
 718    complete, which should never happen.  The next time the frame
 719    becomes visible, redisplay will probably barf.
 720
 721    Currently, there are no similar situations involving iconified, but
 722    the principle is the same.
 723
 724    So instead of having asynchronous input handlers directly set and
 725    clear the frame's visibility and iconification flags, they just set
 726    the async_visible and async_iconified flags; the redisplay code
 727    calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
 728    which sets visible and iconified from their asynchronous
 729    counterparts.
 730
 731    Synchronous code must use the FRAME_SET_VISIBLE macro.
 732
 733    Also, if a frame used to be invisible, but has just become visible,
 734    it must be marked as garbaged, since redisplay hasn't been keeping
 735    up its contents.
 736
 737    Note that a tty frame is visible if and only if it is the topmost
 738    frame. */
 739
 740 #define FRAME_SAMPLE_VISIBILITY(f) \
 741   (((f)->async_visible && (f)->visible != (f)->async_visible) ? \
 742    SET_FRAME_GARBAGED (f) : 0, \
 743    (f)->visible = (f)->async_visible, \
 744    (f)->iconified = (f)->async_iconified)
 745
 746 #define CHECK_FRAME(x)                                  \
 747      do {                                               \
 748        if (! FRAMEP (x))                                \
 749          x = wrong_type_argument (Qframep, (x));        \
 750      } while (0)
 751
 752 #define CHECK_LIVE_FRAME(x)                             \
 753      do {                                               \
 754        if (! FRAMEP (x)                                 \
 755            || ! FRAME_LIVE_P (XFRAME (x)))              \
 756          x = wrong_type_argument (Qframe_live_p, (x));  \
 757      } while (0)
 758
 759 /* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
 760    `for' loop which iterates over the elements of Vframe_list.  The
 761    loop will set FRAME_VAR, a Lisp_Object, to each frame in
 762    Vframe_list in succession and execute the statement.  LIST_VAR
 763    should be a Lisp_Object too; it is used to iterate through the
 764    Vframe_list.
 765
 766    This macro is a holdover from a time when multiple frames weren't always
 767    supported.  An alternate definition of the macro would expand to
 768    something which executes the statement once.  */
 769
 770 #define FOR_EACH_FRAME(list_var, frame_var)                     \
 771   for ((list_var) = Vframe_list;                                \
 772        (CONSP (list_var)                                        \
 773         && (frame_var = XCAR (list_var), 1));           \
 774        list_var = XCDR (list_var))
 775
 776
 777 extern Lisp_Object Qframep, Qframe_live_p;
 778 extern Lisp_Object Qtty, Qtty_type;
 779 extern Lisp_Object Qdevice, Qdisplay_live_p;
 780
 781 extern struct frame *last_nonminibuf_frame;
 782
 783 extern struct frame *make_initial_frame P_ ((void));
 784 extern struct frame *make_terminal_frame P_ ((struct device *));
 785 extern struct frame *make_frame P_ ((int));
 786 #ifdef HAVE_WINDOW_SYSTEM
 787 extern struct frame *make_minibuffer_frame P_ ((void));
 788 extern struct frame *make_frame_without_minibuffer P_ ((Lisp_Object,
 789                                                         struct kboard *,
 790                                                         Lisp_Object));
 791 #endif /* HAVE_WINDOW_SYSTEM */
 792 extern int other_visible_frames P_ ((struct frame *));
 793
 794 extern Lisp_Object Vframe_list;
 795 extern Lisp_Object Vdefault_frame_alist;
 796
 797 extern Lisp_Object Vterminal_frame;
 798
 799 extern Lisp_Object Vmouse_highlight;
 800 \f
 801 /* The currently selected frame.  */
 802
 803 extern Lisp_Object selected_frame;
 804
 805 /* Value is a pointer to the selected frame.  If the selected frame
 806    isn't live, abort.  */
 807
 808 #define SELECTED_FRAME()                                \
 809      ((FRAMEP (selected_frame)                          \
 810        && FRAME_LIVE_P (XFRAME (selected_frame)))       \
 811       ? XFRAME (selected_frame)                         \
 812       : (abort (), (struct frame *) 0))
 813
 814 \f
 815 /***********************************************************************
 816                         Display-related Macros
 817  ***********************************************************************/
 818
 819 /* Canonical y-unit on frame F.
 820    This value currently equals the line height of the frame (which is
 821    the height of the default font of F).  */
 822
 823 #define FRAME_LINE_HEIGHT(F) ((F)->line_height)
 824
 825 /* Canonical x-unit on frame F.
 826    This value currently equals the average width of the default font of F.  */
 827
 828 #define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
 829
 830 /* Space glyph width of the default font of frame F.  */
 831
 832 #define FRAME_SPACE_WIDTH(F) ((F)->space_width)
 833
 834
 835 /* Pixel width of areas used to display truncation marks, continuation
 836    marks, overlay arrows.  This is 0 for terminal frames.  */
 837
 838 #ifdef HAVE_WINDOW_SYSTEM
 839
 840 /* Total width of fringes reserved for drawing truncation bitmaps,
 841    continuation bitmaps and alike.  The width is in canonical char
 842    units of the frame.  This must currently be the case because window
 843    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 844    able to split windows horizontally nicely.  */
 845
 846 #define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
 847
 848 /* Pixel-width of the left and right fringe.  */
 849
 850 #define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
 851 #define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
 852
 853 /* Total width of fringes in pixels.  */
 854
 855 #define FRAME_TOTAL_FRINGE_WIDTH(F) \
 856   (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
 857
 858
 859 /* Pixel-width of internal border lines */
 860
 861 #define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
 862
 863 #else /* not HAVE_WINDOW_SYSTEM */
 864
 865 #define FRAME_FRINGE_COLS(F)    0
 866 #define FRAME_TOTAL_FRINGE_WIDTH(F)     0
 867 #define FRAME_LEFT_FRINGE_WIDTH(F)  0
 868 #define FRAME_RIGHT_FRINGE_WIDTH(F) 0
 869 #define FRAME_INTERNAL_BORDER_WIDTH(F) 0
 870
 871 #endif /* not HAVE_WINDOW_SYSTEM */
 872
 873
 874
 875 \f
 876 /***********************************************************************
 877             Conversion between canonical units and pixels
 878  ***********************************************************************/
 879
 880 /* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
 881    y-unit are fractions of FRAME_LINE_HEIGHT of a frame.  Both are
 882    represented as Lisp numbers, i.e. integers or floats.  */
 883
 884 /* Convert canonical value X to pixels.  F is the frame whose
 885    canonical char width is to be used.  X must be a Lisp integer or
 886    float.  Value is a C integer.  */
 887
 888 #define FRAME_PIXEL_X_FROM_CANON_X(F, X)                \
 889      (INTEGERP (X)                                      \
 890       ? XINT (X) * FRAME_COLUMN_WIDTH (F)               \
 891       : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
 892
 893 /* Convert canonical value Y to pixels.  F is the frame whose
 894    canonical character height is to be used.  X must be a Lisp integer
 895    or float.  Value is a C integer.  */
 896
 897 #define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y)                \
 898      (INTEGERP (Y)                                      \
 899       ? XINT (Y) * FRAME_LINE_HEIGHT (F)                \
 900       : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
 901
 902 /* Convert pixel-value X to canonical units.  F is the frame whose
 903    canonical character width is to be used.  X is a C integer.  Result
 904    is a Lisp float if X is not a multiple of the canon width,
 905    otherwise it's a Lisp integer.  */
 906
 907 #define FRAME_CANON_X_FROM_PIXEL_X(F, X)                        \
 908      ((X) % FRAME_COLUMN_WIDTH (F) != 0                         \
 909       ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F))      \
 910       : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
 911
 912 /* Convert pixel-value Y to canonical units.  F is the frame whose
 913    canonical character height is to be used.  Y is a C integer.
 914    Result is a Lisp float if Y is not a multiple of the canon width,
 915    otherwise it's a Lisp integer.  */
 916
 917 #define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y)                        \
 918      ((Y) % FRAME_LINE_HEIGHT (F)                               \
 919       ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F))       \
 920       : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
 921
 922
 923 \f
 924 /* Manipulating pixel sizes and character sizes.
 925    Knowledge of which factors affect the overall size of the window should
 926    be hidden in these macros, if that's possible.
 927
 928    Return the upper/left pixel position of the character cell on frame F
 929    at ROW/COL.  */
 930
 931 #define FRAME_LINE_TO_PIXEL_Y(f, row) \
 932   (FRAME_INTERNAL_BORDER_WIDTH (f)  \
 933    + (row) * FRAME_LINE_HEIGHT (f))
 934
 935 #define FRAME_COL_TO_PIXEL_X(f, col) \
 936   (FRAME_INTERNAL_BORDER_WIDTH (f) \
 937    + (col) * FRAME_COLUMN_WIDTH (f))
 938
 939 /* Return the pixel width/height of frame F if it has
 940    COLS columns/LINES rows.  */
 941
 942 #define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
 943   (FRAME_COL_TO_PIXEL_X (f, cols) \
 944    + (f)->scroll_bar_actual_width \
 945    + FRAME_TOTAL_FRINGE_WIDTH (f)      \
 946    + FRAME_INTERNAL_BORDER_WIDTH (f))
 947
 948 #define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
 949   (FRAME_LINE_TO_PIXEL_Y (f, lines) \
 950    + FRAME_INTERNAL_BORDER_WIDTH (f))
 951
 952
 953 /* Return the row/column (zero-based) of the character cell containing
 954    the pixel on FRAME at Y/X.  */
 955
 956 #define FRAME_PIXEL_Y_TO_LINE(f, y) \
 957   (((y) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
 958    / FRAME_LINE_HEIGHT (f))
 959
 960 #define FRAME_PIXEL_X_TO_COL(f, x) \
 961   (((x) - FRAME_INTERNAL_BORDER_WIDTH (f))      \
 962    / FRAME_COLUMN_WIDTH (f))
 963
 964 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 965    frame F?  */
 966
 967 #define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width)                \
 968   (FRAME_PIXEL_X_TO_COL (f, ((width)                            \
 969                              - FRAME_INTERNAL_BORDER_WIDTH (f)  \
 970                              - FRAME_TOTAL_FRINGE_WIDTH (f)     \
 971                              - (f)->scroll_bar_actual_width)))
 972
 973 #define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
 974   (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
 975                               - FRAME_INTERNAL_BORDER_WIDTH (f))))
 976
 977
 978 /***********************************************************************
 979                                 Frame Parameters
 980  ***********************************************************************/
 981
 982 extern Lisp_Object Qauto_raise, Qauto_lower;
 983 extern Lisp_Object Qborder_color, Qborder_width;
 984 extern Lisp_Object Qbuffer_predicate, Qbuffer_list;
 985 extern Lisp_Object Qcursor_color, Qcursor_type;
 986 extern Lisp_Object Qfont;
 987 extern Lisp_Object Qbackground_color, Qforeground_color;
 988 extern Lisp_Object Qicon, Qicon_name, Qicon_type, Qicon_left, Qicon_top;
 989 extern Lisp_Object Qinternal_border_width;
 990 extern Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
 991 extern Lisp_Object Qmouse_color;
 992 extern Lisp_Object Qname, Qtitle;
 993 extern Lisp_Object Qparent_id;
 994 extern Lisp_Object Qunsplittable, Qvisibility;
 995 extern Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
 996 extern Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
 997 extern Lisp_Object Qscreen_gamma;
 998 extern Lisp_Object Qline_spacing;
 999 extern Lisp_Object Qwait_for_wm;
1000 extern Lisp_Object Qfullscreen;
1001
1002 extern Lisp_Object Qleft_fringe, Qright_fringe;
1003 extern Lisp_Object Qheight, Qwidth;
1004 extern Lisp_Object Qminibuffer, Qmodeline;
1005 extern Lisp_Object Qonly;
1006 extern Lisp_Object Qx, Qw32, Qmac, Qpc;
1007 extern Lisp_Object Qvisible;
1008 extern Lisp_Object Qdisplay_type;
1009 extern Lisp_Object Qbackground_mode;
1010
1011 extern Lisp_Object Qx_resource_name;
1012
1013 extern Lisp_Object Qleft, Qright, Qtop, Qbox;
1014 extern Lisp_Object Qdisplay;
1015
1016 extern Lisp_Object Qwindow_system;
1017
1018 #ifdef HAVE_WINDOW_SYSTEM
1019
1020 /* The class of this X application.  */
1021 #define EMACS_CLASS "Emacs"
1022
1023 enum
1024 {
1025   /* Values used as a bit mask, BOTH == WIDTH | HEIGHT.  */
1026   FULLSCREEN_NONE       = 0,
1027   FULLSCREEN_WIDTH      = 1,
1028   FULLSCREEN_HEIGHT     = 2,
1029   FULLSCREEN_BOTH       = 3,
1030   FULLSCREEN_WAIT       = 4,
1031 };
1032
1033
1034 /* These are in xterm.c, w32term.c, etc.  */
1035
1036 extern void x_set_scroll_bar_default_width P_ ((struct frame *));
1037 extern void x_set_offset P_ ((struct frame *, int, int, int));
1038 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
1039
1040 extern Lisp_Object x_new_font P_ ((struct frame *, char *));
1041 extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
1042
1043
1044 /* These are in frame.c  */
1045
1046 extern Lisp_Object Vx_resource_name;
1047 extern Lisp_Object Vx_resource_class;
1048
1049
1050 extern Lisp_Object Qface_set_after_frame_default;
1051
1052 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
1053                                      int *, int *));
1054
1055 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1056 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1057
1058 extern void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
1059 extern void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
1060 extern void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
1061 extern void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
1062 extern void x_set_fringe_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1063 extern void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
1064 extern void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
1065                                              Lisp_Object));
1066 extern void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
1067 extern void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
1068 extern void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
1069 extern void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
1070 extern void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
1071                                             Lisp_Object));
1072 extern void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object,
1073                                         Lisp_Object));
1074
1075 extern Lisp_Object x_icon_type P_ ((struct frame *));
1076
1077 extern int x_figure_window_size P_ ((struct frame *, Lisp_Object, int));
1078
1079
1080 extern void validate_x_resource_name P_ ((void));
1081
1082 #endif /* HAVE_WINDOW_SYSTEM */
1083
1084 #endif /* not EMACS_FRAME_H */
1085
1086 /* arch-tag: 0df048ee-e6bf-4f48-bd56-e3cd055dd8c4
1087    (do not change this comment) */