src/xterm.h

   1 /* Definitions and headers for communication with X protocol.
   2    Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003,
   3                  2004, 2005, 2006, 2007, 2008 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 3 of the License, or
  10 (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include <X11/Xlib.h>
  21 #include <X11/cursorfont.h>
  22
  23 /* Include Xutil.h after keysym.h to work around a bug that prevents
  24    correct recognition of AltGr key in some X versions.  */
  25
  26 #include <X11/keysym.h>
  27 #include <X11/Xutil.h>
  28
  29 #include <X11/Xatom.h>
  30 #include <X11/Xresource.h>
  31
  32 #ifdef USE_X_TOOLKIT
  33 #include <X11/StringDefs.h>
  34 #include <X11/IntrinsicP.h>     /* CoreP.h needs this */
  35 #include <X11/CoreP.h>          /* foul, but we need this to use our own
  36                                    window inside a widget instead of one
  37                                    that Xt creates... */
  38 #include <X11/StringDefs.h>
  39
  40 typedef Widget xt_or_gtk_widget;
  41 #endif
  42
  43 #ifdef USE_GTK
  44 #include <gtk/gtk.h>
  45 #include <gdk/gdkx.h>
  46
  47 /* Some definitions to reduce conditionals.  */
  48 typedef GtkWidget *xt_or_gtk_widget;
  49 #define XtParent(x) (gtk_widget_get_parent (x))
  50 #undef XSync
  51 #define XSync(d, b) do { gdk_window_process_all_updates (); \
  52                          XSync (d, b);  } while (0)
  53
  54
  55 #endif /* USE_GTK */
  56
  57 \f
  58 /* Bookkeeping to distinguish X versions.  */
  59
  60
  61 #ifdef HAVE_X_I18N
  62 #include <X11/Xlocale.h>
  63 #endif
  64 \f
  65 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
  66                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  67 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
  68                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  69
  70 #define FONT_WIDTH(f)   ((f)->max_width)
  71 #define FONT_HEIGHT(f)  ((f)->ascent + (f)->descent)
  72 #define FONT_BASE(f)    ((f)->ascent)
  73 #define FONT_DESCENT(f) ((f)->descent)
  74
  75 /* The mask of events that text windows always want to receive.  This
  76    includes mouse movement events, since handling the mouse-font text property
  77    means that we must track mouse motion all the time.  */
  78
  79 #define STANDARD_EVENT_SET      \
  80   (KeyPressMask                 \
  81    | ExposureMask               \
  82    | ButtonPressMask            \
  83    | ButtonReleaseMask          \
  84    | PointerMotionMask          \
  85    | StructureNotifyMask        \
  86    | FocusChangeMask            \
  87    | LeaveWindowMask            \
  88    | EnterWindowMask            \
  89    | VisibilityChangeMask)
  90
  91 /* Structure recording X pixmap and reference count.
  92    If REFCOUNT is 0 then this record is free to be reused.  */
  93
  94 struct x_bitmap_record
  95 {
  96   Pixmap pixmap;
  97   int have_mask;
  98   Pixmap mask;
  99   char *file;
 100   int refcount;
 101   /* Record some info about this pixmap.  */
 102   int height, width, depth;
 103 };
 104 \f
 105 /* For each X display, we have a structure that records
 106    information about it.  */
 107
 108 struct x_display_info
 109 {
 110   /* Chain of all x_display_info structures.  */
 111   struct x_display_info *next;
 112
 113   /* The generic display parameters corresponding to this X display. */
 114   struct terminal *terminal;
 115
 116   /* Connection number (normally a file descriptor number).  */
 117   int connection;
 118
 119   /* This says how to access this display in Xlib.  */
 120   Display *display;
 121
 122   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 123      The same cons cell also appears in x_display_name_list.  */
 124   Lisp_Object name_list_element;
 125
 126   /* Number of frames that are on this display.  */
 127   int reference_count;
 128
 129   /* The Screen this connection is connected to.  */
 130   Screen *screen;
 131
 132   /* Dots per inch of the screen.  */
 133   double resx, resy;
 134
 135   /* The Visual being used for this display.  */
 136   Visual *visual;
 137
 138   /* The colormap being used.  */
 139   Colormap cmap;
 140
 141   /* Number of planes on this screen.  */
 142   int n_planes;
 143
 144   /* Mask of things that cause the mouse to be grabbed.  */
 145   int grabbed;
 146
 147   /* Emacs bitmap-id of the default icon bitmap for this frame.
 148      Or -1 if none has been allocated yet.  */
 149   int icon_bitmap_id;
 150
 151   /* The root window of this screen.  */
 152   Window root_window;
 153
 154   /* Client leader window.  */
 155   Window client_leader_window;
 156
 157   /* The cursor to use for vertical scroll bars.  */
 158   Cursor vertical_scroll_bar_cursor;
 159
 160 #ifdef USE_GTK
 161   /* The GDK cursor for scroll bars and popup menus.  */
 162   GdkCursor *xg_cursor;
 163 #endif
 164
 165   /* X Resource data base */
 166   XrmDatabase xrdb;
 167
 168   /* Minimum width over all characters in all fonts in font_table.  */
 169   int smallest_char_width;
 170
 171   /* Minimum font height over all fonts in font_table.  */
 172   int smallest_font_height;
 173
 174   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 175   GC scratch_cursor_gc;
 176
 177   /* These variables describe the range of text currently shown in its
 178      mouse-face, together with the window they apply to.  As long as
 179      the mouse stays within this range, we need not redraw anything on
 180      its account.  Rows and columns are glyph matrix positions in
 181      MOUSE_FACE_WINDOW.  */
 182   int mouse_face_beg_row, mouse_face_beg_col;
 183   int mouse_face_beg_x, mouse_face_beg_y;
 184   int mouse_face_end_row, mouse_face_end_col;
 185   int mouse_face_end_x, mouse_face_end_y;
 186   int mouse_face_past_end;
 187   Lisp_Object mouse_face_window;
 188   int mouse_face_face_id;
 189   Lisp_Object mouse_face_overlay;
 190
 191   /* 1 if a mouse motion event came and we didn't handle it right away because
 192      gc was in progress.  */
 193   int mouse_face_deferred_gc;
 194
 195   /* FRAME and X, Y position of mouse when last checked for
 196      highlighting.  X and Y can be negative or out of range for the frame.  */
 197   struct frame *mouse_face_mouse_frame;
 198   int mouse_face_mouse_x, mouse_face_mouse_y;
 199
 200   /* Nonzero means defer mouse-motion highlighting.  */
 201   int mouse_face_defer;
 202
 203   /* Nonzero means that the mouse highlight should not be shown.  */
 204   int mouse_face_hidden;
 205
 206   int mouse_face_image_state;
 207
 208   char *x_id_name;
 209
 210   /* The number of fonts opened for this display.  */
 211   int n_fonts;
 212
 213   /* Pointer to bitmap records.  */
 214   struct x_bitmap_record *bitmaps;
 215
 216   /* Allocated size of bitmaps field.  */
 217   int bitmaps_size;
 218
 219   /* Last used bitmap index.  */
 220   int bitmaps_last;
 221
 222   /* Which modifier keys are on which modifier bits?
 223
 224      With each keystroke, X returns eight bits indicating which modifier
 225      keys were held down when the key was pressed.  The interpretation
 226      of the top five modifier bits depends on what keys are attached
 227      to them.  If the Meta_L and Meta_R keysyms are on mod5, then mod5
 228      is the meta bit.
 229
 230      meta_mod_mask is a mask containing the bits used for the meta key.
 231      It may have more than one bit set, if more than one modifier bit
 232      has meta keys on it.  Basically, if EVENT is a KeyPress event,
 233      the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
 234
 235      shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
 236      lock modifier bit, or zero otherwise.  Non-alphabetic keys should
 237      only be affected by the lock modifier bit if XK_Shift_Lock is in
 238      use; XK_Caps_Lock should only affect alphabetic keys.  With this
 239      arrangement, the lock modifier should shift the character if
 240      (EVENT.state & shift_lock_mask) != 0.  */
 241   int meta_mod_mask, shift_lock_mask;
 242
 243   /* These are like meta_mod_mask, but for different modifiers.  */
 244   int alt_mod_mask, super_mod_mask, hyper_mod_mask;
 245
 246   /* Communication with window managers.  */
 247   Atom Xatom_wm_protocols;
 248
 249   /* Kinds of protocol things we may receive.  */
 250   Atom Xatom_wm_take_focus;
 251   Atom Xatom_wm_save_yourself;
 252   Atom Xatom_wm_delete_window;
 253
 254   /* Atom for indicating window state to the window manager.  */
 255   Atom Xatom_wm_change_state;
 256
 257   /* Other WM communication */
 258   Atom Xatom_wm_configure_denied; /* When our config request is denied */
 259   Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
 260   Atom Xatom_wm_client_leader;    /* Id of client leader window.  */
 261
 262   /* EditRes protocol */
 263   Atom Xatom_editres;
 264
 265   /* More atoms, which are selection types.  */
 266   Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
 267   Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
 268   Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
 269   Xatom_ATOM_PAIR;
 270
 271   /* More atoms for font properties.  The last three are private
 272      properties, see the comments in src/fontset.h.  */
 273   Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
 274   Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
 275   Xatom_MULE_DEFAULT_ASCENT;
 276
 277   /* More atoms for Ghostscript support.  */
 278   Atom Xatom_DONE, Xatom_PAGE;
 279
 280   /* Atom used in toolkit scroll bar client messages.  */
 281   Atom Xatom_Scrollbar;
 282
 283   /* Atom used in XEmbed client messages.  */
 284   Atom Xatom_XEMBED;
 285
 286   int cut_buffers_initialized; /* Whether we're sure they all exist */
 287
 288   /* The frame (if any) which has the X window that has keyboard focus.
 289      Zero if none.  This is examined by Ffocus_frame in xfns.c.  Note
 290      that a mere EnterNotify event can set this; if you need to know the
 291      last frame specified in a FocusIn or FocusOut event, use
 292      x_focus_event_frame.  */
 293   struct frame *x_focus_frame;
 294
 295   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 296      separate from x_focus_frame, because whether or not LeaveNotify
 297      events cause us to lose focus depends on whether or not we have
 298      received a FocusIn event for it.  */
 299   struct frame *x_focus_event_frame;
 300
 301   /* The frame which currently has the visual highlight, and should get
 302      keyboard input (other sorts of input have the frame encoded in the
 303      event).  It points to the X focus frame's selected window's
 304      frame.  It differs from x_focus_frame when we're using a global
 305      minibuffer.  */
 306   struct frame *x_highlight_frame;
 307
 308   /* The null pixel used for filling a character background with
 309      background color of a gc.  */
 310   Pixmap null_pixel;
 311
 312   /* The gray pixmap.  */
 313   Pixmap gray;
 314
 315 #ifdef HAVE_X_I18N
 316   /* XIM (X Input method).  */
 317   XIM xim;
 318   XIMStyles *xim_styles;
 319 #endif
 320
 321   /* If non-null, a cache of the colors in the color map.  Don't
 322      use this directly, call x_color_cells instead.  */
 323   XColor *color_cells;
 324   int ncolor_cells;
 325
 326   /* Bits and shifts to use to compose pixel values on TrueColor visuals.  */
 327   int red_bits, blue_bits, green_bits;
 328   int red_offset, blue_offset, green_offset;
 329
 330   /* The type of window manager we have.  If we move FRAME_OUTER_WINDOW
 331      to x/y 0/0, some window managers (type A) puts the window manager
 332      decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
 333      Other window managers (type B) puts the window including decorations
 334      at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
 335      Record the type of WM in use so we can compensate for type A WMs.  */
 336   enum
 337     {
 338       X_WMTYPE_UNKNOWN,
 339       X_WMTYPE_A,
 340       X_WMTYPE_B
 341     } wm_type;
 342
 343
 344   /* Atoms that are drag and drop atoms */
 345   Atom *x_dnd_atoms;
 346   size_t x_dnd_atoms_size;
 347   size_t x_dnd_atoms_length;
 348
 349   /* Extended window manager hints, Atoms supported by the window manager  */
 350   Atom *net_supported_atoms;
 351   int nr_net_supported_atoms;
 352   Window net_supported_window;
 353 };
 354
 355 #ifdef HAVE_X_I18N
 356 /* Whether or not to use XIM if we have it.  */
 357 extern int use_xim;
 358 #endif
 359
 360 /* This checks to make sure we have a display.  */
 361 extern void check_x P_ ((void));
 362
 363 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
 364
 365 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
 366 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
 367 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
 368 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
 369 #endif
 370
 371 /* This is a chain of structures for all the X displays currently in use.  */
 372 extern struct x_display_info *x_display_list;
 373
 374 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 375    one for each element of x_display_list and in the same order.
 376    NAME is the name of the frame.
 377    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 378 extern Lisp_Object x_display_name_list;
 379
 380 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
 381 extern Lisp_Object Vx_pixel_size_width_font_regexp;
 382
 383 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
 384 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
 385 extern void x_set_frame_alpha P_ ((struct frame *));
 386
 387 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
 388 extern int x_display_ok  P_ ((const char *));
 389
 390 extern void select_visual P_ ((struct x_display_info *));
 391
 392 \f
 393 struct font;
 394
 395 /* Each X frame object points to its own struct x_output object
 396    in the output_data.x field.  The x_output structure contains
 397    the information that is specific to X windows.  */
 398
 399 struct x_output
 400 {
 401   /* Height of menu bar widget, in pixels.
 402      Zero if not using the X toolkit.
 403      When using the toolkit, this value is not meaningful
 404      if the menubar is turned off.  */
 405   int menubar_height;
 406
 407   /* Height of tool bar widget, in pixels.
 408      Zero if not using an external tool bar.  */
 409   int toolbar_height;
 410
 411   /* The tiled border used when the mouse is out of the frame.  */
 412   Pixmap border_tile;
 413
 414   /* Here are the Graphics Contexts for the default font.  */
 415   GC normal_gc;                         /* Normal video */
 416   GC reverse_gc;                        /* Reverse video */
 417   GC cursor_gc;                         /* cursor drawing */
 418
 419   /* The X window used for this frame.
 420      May be zero while the frame object is being created
 421      and the X window has not yet been created.  */
 422   Window window_desc;
 423
 424   /* The X window used for the bitmap icon;
 425      or 0 if we don't have a bitmap icon.  */
 426   Window icon_desc;
 427
 428   /* The X window that is the parent of this X window.
 429      Usually this is a window that was made by the window manager,
 430      but it can be the root window, and it can be explicitly specified
 431      (see the explicit_parent field, below).  */
 432   Window parent_desc;
 433
 434 #ifdef USE_X_TOOLKIT
 435   /* The widget of this screen.  This is the window of a "shell" widget.  */
 436   Widget widget;
 437   /* The XmPanedWindows...  */
 438   Widget column_widget;
 439   /* The widget of the edit portion of this screen; the window in
 440      "window_desc" is inside of this.  */
 441   Widget edit_widget;
 442
 443   Widget menubar_widget;
 444 #endif
 445
 446 #ifdef USE_GTK
 447   /* The widget of this screen.  This is the window of a top widget.  */
 448   GtkWidget *widget;
 449   /* The widget of the edit portion of this screen; the window in
 450      "window_desc" is inside of this.  */
 451   GtkWidget *edit_widget;
 452   /* The widget used for laying out widgets vertically.  */
 453   GtkWidget *vbox_widget;
 454   /* The menubar in this frame.  */
 455   GtkWidget *menubar_widget;
 456   /* The tool bar in this frame  */
 457   GtkWidget *toolbar_widget;
 458   /* The handle box that makes the tool bar detachable.  */
 459   GtkWidget *handlebox_widget;
 460   /* Non-zero if the tool bar is detached.  */
 461   int toolbar_detached;
 462
 463   /* The last size hints set.  */
 464   GdkGeometry size_hints;
 465   long hint_flags;
 466 #endif
 467
 468   /* If >=0, a bitmap index.  The indicated bitmap is used for the
 469      icon. */
 470   int icon_bitmap;
 471
 472   /* Default ASCII font of this frame.  */
 473   struct font *font;
 474
 475   /* The baseline offset of the default ASCII font.  */
 476   int baseline_offset;
 477
 478   /* If a fontset is specified for this frame instead of font, this
 479      value contains an ID of the fontset, else -1.  */
 480   int fontset;
 481
 482   /* Pixel values used for various purposes.
 483      border_pixel may be -1 meaning use a gray tile.  */
 484 #if 0 /* These are also defined in struct frame.  Use that instead.  */
 485   unsigned long background_pixel;
 486   unsigned long foreground_pixel;
 487 #endif
 488   unsigned long cursor_pixel;
 489   unsigned long border_pixel;
 490   unsigned long mouse_pixel;
 491   unsigned long cursor_foreground_pixel;
 492
 493   /* Foreground color for scroll bars.  A value of -1 means use the
 494      default (black for non-toolkit scroll bars).  */
 495   unsigned long scroll_bar_foreground_pixel;
 496
 497   /* Background color for scroll bars.  A value of -1 means use the
 498      default (background color of the frame for non-toolkit scroll
 499      bars).  */
 500   unsigned long scroll_bar_background_pixel;
 501
 502   /* Top and bottom shadow colors for 3d toolkit scrollbars.  -1 means
 503      let the scroll compute them itself.  */
 504   unsigned long scroll_bar_top_shadow_pixel;
 505   unsigned long scroll_bar_bottom_shadow_pixel;
 506
 507   /* Descriptor for the cursor in use for this window.  */
 508   Cursor text_cursor;
 509   Cursor nontext_cursor;
 510   Cursor modeline_cursor;
 511   Cursor hand_cursor;
 512   Cursor hourglass_cursor;
 513   Cursor horizontal_drag_cursor;
 514
 515   /* Window whose cursor is hourglass_cursor.  This window is temporarily
 516      mapped to display an hourglass cursor.  */
 517   Window hourglass_window;
 518
 519   /* Non-zero means hourglass cursor is currently displayed.  */
 520   unsigned hourglass_p : 1;
 521
 522   /* Flag to set when the X window needs to be completely repainted.  */
 523   int needs_exposure;
 524
 525   /* These are the current window manager hints.  It seems that
 526      XSetWMHints, when presented with an unset bit in the `flags'
 527      member of the hints structure, does not leave the corresponding
 528      attribute unchanged; rather, it resets that attribute to its
 529      default value.  For example, unless you set the `icon_pixmap'
 530      field and the `IconPixmapHint' bit, XSetWMHints will forget what
 531      your icon pixmap was.  This is rather troublesome, since some of
 532      the members (for example, `input' and `icon_pixmap') want to stay
 533      the same throughout the execution of Emacs.  So, we keep this
 534      structure around, just leaving values in it and adding new bits
 535      to the mask as we go.  */
 536   XWMHints wm_hints;
 537
 538   /* This is the Emacs structure for the X display this frame is on.  */
 539   struct x_display_info *display_info;
 540
 541   /* This is a button event that wants to activate the menubar.
 542      We save it here until the command loop gets to think about it.  */
 543   XEvent *saved_menu_event;
 544
 545   /* This is the widget id used for this frame's menubar in lwlib.  */
 546 #ifdef USE_X_TOOLKIT
 547   int id;
 548 #endif
 549
 550   /* Nonzero means our parent is another application's window
 551      and was explicitly specified.  */
 552   char explicit_parent;
 553
 554   /* Nonzero means tried already to make this frame visible.  */
 555   char asked_for_visible;
 556
 557   /* Nonzero if this frame was ever previously visible.  */
 558   char has_been_visible;
 559
 560 #ifdef HAVE_X_I18N
 561   /* Input context (currently, this means Compose key handler setup).  */
 562   XIC xic;
 563   XIMStyle xic_style;
 564   XFontSet xic_xfs;
 565   char *xic_base_fontname;
 566 #endif
 567
 568   /* Relief GCs, colors etc.  */
 569   struct relief
 570   {
 571     GC gc;
 572     unsigned long pixel;
 573     int allocated_p;
 574   }
 575   black_relief, white_relief;
 576
 577   /* The background for which the above relief GCs were set up.
 578      They are changed only when a different background is involved.  */
 579   unsigned long relief_background;
 580
 581   /* Xt waits for a ConfigureNotify event from the window manager in
 582      EmacsFrameSetCharSize when the shell widget is resized.  For some
 583      window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
 584      arrive for an unknown reason and Emacs hangs in Xt.  If this is
 585      zero, tell Xt not to wait.  */
 586   int wait_for_wm;
 587
 588   /* As x_pixels_diff, but to FRAME_OUTER_WINDOW.  For some reason the
 589      two might differ by a pixel, depending on WM */
 590   int x_pixels_outer_diff;
 591
 592   /* As y_pixels_diff, but to FRAME_OUTER_WINDOW.  In the toolkit version,
 593      these may differ because this does not take into account possible
 594      menubar.  y_pixels_diff is with menubar height included */
 595   int y_pixels_outer_diff;
 596
 597   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 598      frame, or IMPLICIT if we received an EnterNotify.
 599      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 600   int focus_state;
 601
 602   /* The offset we need to add to compensate for type A WMs.  */
 603   int move_offset_top;
 604   int move_offset_left;
 605
 606   /* The frame's left/top offsets before we call XMoveWindow.  See
 607      x_check_expected_move.  */
 608   int left_before_move;
 609   int top_before_move;
 610 };
 611
 612 #define No_Cursor (None)
 613
 614 enum
 615 {
 616   /* Values for focus_state, used as bit mask.
 617      EXPLICIT means we received a FocusIn for the frame and know it has
 618      the focus.  IMPLICIT means we recevied an EnterNotify and the frame
 619      may have the focus if no window manager is running.
 620      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 621   FOCUS_NONE     = 0,
 622   FOCUS_IMPLICIT = 1,
 623   FOCUS_EXPLICIT = 2
 624 };
 625
 626
 627 /* Return the X output data for frame F.  */
 628 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
 629
 630 /* Return the X window used for displaying data in frame F.  */
 631 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
 632
 633 /* Return the outermost X window associated with the frame F.  */
 634 #ifdef USE_X_TOOLKIT
 635 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ?             \
 636                                XtWindow ((f)->output_data.x->widget) :  \
 637                                FRAME_X_WINDOW (f))
 638 #else
 639 #ifdef USE_GTK
 640 #define GTK_WIDGET_TO_X_WIN(w) \
 641   ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
 642
 643 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
 644 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
 645 #define FRAME_OUTER_WINDOW(f)                                   \
 646        (FRAME_GTK_OUTER_WIDGET (f) ?                            \
 647         GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) :      \
 648          FRAME_X_WINDOW (f))
 649
 650 #else /* !USE_GTK */
 651 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
 652 #endif /* !USE_GTK */
 653 #endif
 654
 655
 656 #define FRAME_FONT(f) ((f)->output_data.x->font)
 657 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
 658 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
 659 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
 660 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
 661
 662 /* This gives the x_display_info structure for the display F is on.  */
 663 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
 664
 665 /* This is the `Display *' which frame F is on.  */
 666 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
 667
 668 /* This is the `Screen *' which frame F is on.  */
 669 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 670 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
 671
 672 /* This is the Visual which frame F is on.  */
 673 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
 674
 675 /* This is the Colormap which frame F uses.  */
 676 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
 677
 678 /* This is the 'font_info *' which frame F has.  */
 679 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
 680
 681 /* The difference in pixels between the top left corner of the
 682    Emacs window (including possible window manager decorations)
 683    and FRAME_X_WINDOW (f).  */
 684 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
 685      ((f)->output_data.x->x_pixels_outer_diff)
 686 #define FRAME_OUTER_TO_INNER_DIFF_Y(f)          \
 687      ((f)->output_data.x->y_pixels_outer_diff   \
 688       + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
 689
 690
 691 #define FRAME_XIC(f) ((f)->output_data.x->xic)
 692 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
 693 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
 694 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
 695 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
 696 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
 697
 698 /* Value is the smallest width of any character in any font on frame F.  */
 699
 700 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 701      FRAME_X_DISPLAY_INFO(F)->smallest_char_width
 702
 703 /* Value is the smallest height of any font on frame F.  */
 704
 705 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 706      FRAME_X_DISPLAY_INFO(F)->smallest_font_height
 707 \f
 708 /* X-specific scroll bar stuff.  */
 709
 710 /* We represent scroll bars as lisp vectors.  This allows us to place
 711    references to them in windows without worrying about whether we'll
 712    end up with windows referring to dead scroll bars; the garbage
 713    collector will free it when its time comes.
 714
 715    We use struct scroll_bar as a template for accessing fields of the
 716    vector.  */
 717
 718 struct scroll_bar
 719 {
 720   /* These fields are shared by all vectors.  */
 721   EMACS_INT size_from_Lisp_Vector_struct;
 722   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 723
 724   /* The window we're a scroll bar for.  */
 725   Lisp_Object window;
 726
 727   /* The next and previous in the chain of scroll bars in this frame.  */
 728   Lisp_Object next, prev;
 729
 730   /* Fields from `x_window' down will not be traced by the GC.  */
 731
 732   /* The X window representing this scroll bar.  */
 733   Window x_window;
 734
 735   /* The position and size of the scroll bar in pixels, relative to the
 736      frame.  */
 737   int top, left, width, height;
 738
 739   /* The starting and ending positions of the handle, relative to the
 740      handle area (i.e. zero is the top position, not
 741      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 742      hasn't been drawn yet.
 743
 744      These are not actually the locations where the beginning and end
 745      are drawn; in order to keep handles from becoming invisible when
 746      editing large files, we establish a minimum height by always
 747      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 748      where they would be normally; the bottom and top are in a
 749      different co-ordinate system.  */
 750   int start, end;
 751
 752   /* If the scroll bar handle is currently being dragged by the user,
 753      this is the number of pixels from the top of the handle to the
 754      place where the user grabbed it.  If the handle isn't currently
 755      being dragged, this is Qnil.  */
 756   Lisp_Object dragging;
 757
 758   /* 1 if the background of the fringe that is adjacent to a scroll
 759      bar is extended to the gap between the fringe and the bar.  */
 760   unsigned int fringe_extended_p : 1;
 761 };
 762
 763 /* The number of elements a vector holding a struct scroll_bar needs.  */
 764 #define SCROLL_BAR_VEC_SIZE                                     \
 765   ((sizeof (struct scroll_bar)                                  \
 766     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 767    / sizeof (Lisp_Object))
 768
 769 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 770 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 771
 772
 773 /* Extract the X widget of the scroll bar from a struct scroll_bar.
 774    XtWindowToWidget should be fast enough since Xt uses a hash table
 775    to map windows to widgets.  */
 776
 777 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
 778   XtWindowToWidget (dpy, ptr->x_window)
 779
 780 /* Store a widget id in a struct scroll_bar.  */
 781
 782 #define SET_SCROLL_BAR_X_WIDGET(ptr, w)         \
 783   do {                                          \
 784     Window window = XtWindow (w);               \
 785     ptr->x_window = window;                     \
 786 } while (0)
 787
 788
 789 /* Return the inside width of a vertical scroll bar, given the outside
 790    width.  */
 791 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
 792   ((width) \
 793    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 794    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 795    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 796
 797 /* Return the length of the rectangle within which the top of the
 798    handle must stay.  This isn't equivalent to the inside height,
 799    because the scroll bar handle has a minimum height.
 800
 801    This is the real range of motion for the scroll bar, so when we're
 802    scaling buffer positions to scroll bar positions, we use this, not
 803    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 804 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
 805   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 806
 807 /* Return the inside height of vertical scroll bar, given the outside
 808    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 809 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
 810   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 811
 812
 813 /* Border widths for scroll bars.
 814
 815    Scroll bar windows don't have any X borders; their border width is
 816    set to zero, and we redraw borders ourselves.  This makes the code
 817    a bit cleaner, since we don't have to convert between outside width
 818    (used when relating to the rest of the screen) and inside width
 819    (used when sizing and drawing the scroll bar window itself).
 820
 821    The handle moves up and down/back and forth in a rectangle inset
 822    from the edges of the scroll bar.  These are widths by which we
 823    inset the handle boundaries from the scroll bar edges.  */
 824 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
 825 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
 826 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
 827 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
 828
 829 /* Minimum lengths for scroll bar handles, in pixels.  */
 830 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 831
 832 /* Trimming off a few pixels from each side prevents
 833    text from glomming up against the scroll bar */
 834 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 835
 836 \f
 837 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
 838    or SELECTION_CLEAR_EVENT, then its contents are really described
 839    by this structure.  */
 840
 841 /* For an event of kind SELECTION_REQUEST_EVENT,
 842    this structure really describes the contents.
 843    **Don't make this struct longer!**
 844    If it overlaps the frame_or_window field of struct input_event,
 845    that will cause GC to crash.  */
 846 struct selection_input_event
 847 {
 848   int kind;
 849   Display *display;
 850   /* We spell it with an "o" here because X does.  */
 851   Window requestor;
 852   Atom selection, target, property;
 853   Time time;
 854 };
 855
 856 #define SELECTION_EVENT_DISPLAY(eventp) \
 857   (((struct selection_input_event *) (eventp))->display)
 858 /* We spell it with an "o" here because X does.  */
 859 #define SELECTION_EVENT_REQUESTOR(eventp)       \
 860   (((struct selection_input_event *) (eventp))->requestor)
 861 #define SELECTION_EVENT_SELECTION(eventp)       \
 862   (((struct selection_input_event *) (eventp))->selection)
 863 #define SELECTION_EVENT_TARGET(eventp)  \
 864   (((struct selection_input_event *) (eventp))->target)
 865 #define SELECTION_EVENT_PROPERTY(eventp)        \
 866   (((struct selection_input_event *) (eventp))->property)
 867 #define SELECTION_EVENT_TIME(eventp)    \
 868   (((struct selection_input_event *) (eventp))->time)
 869
 870 \f
 871 struct window;
 872 struct glyph_matrix;
 873 struct frame;
 874 struct input_event;
 875 struct face;
 876 struct image;
 877
 878 /* From xselect.c.  */
 879
 880 void x_handle_selection_notify P_ ((XSelectionEvent *));
 881 void x_handle_property_notify P_ ((XPropertyEvent *));
 882
 883 /* From xfns.c.  */
 884
 885 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
 886                                         Lisp_Object, Lisp_Object,
 887                                         Lisp_Object, Lisp_Object));
 888 struct frame *check_x_frame P_ ((Lisp_Object));
 889 EXFUN (Fx_display_color_p, 1);
 890 EXFUN (Fx_display_grayscale_p, 1);
 891 extern void x_free_gcs P_ ((struct frame *));
 892
 893 /* From xrdb.c.  */
 894
 895 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
 896 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
 897 int x_get_resource P_ ((XrmDatabase, char *, char *,
 898                         XrmRepresentation, XrmValue *));
 899 void x_delete_display P_ ((struct x_display_info *));
 900 void x_make_frame_visible P_ ((struct frame *));
 901 void x_iconify_frame P_ ((struct frame *));
 902 void x_wm_set_size_hint P_ ((struct frame *, long, int));
 903 int x_text_icon P_ ((struct frame *, char *));
 904 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
 905 void x_set_window_size P_ ((struct frame *, int, int, int));
 906 void x_wm_set_window_state P_ ((struct frame *, int));
 907 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
 908
 909 /* Defined in xterm.c */
 910
 911 extern void cancel_mouse_face P_ ((struct frame *));
 912 extern void x_scroll_bar_clear P_ ((struct frame *));
 913 extern int x_text_icon P_ ((struct frame *, char *));
 914 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
 915 extern void x_catch_errors P_ ((Display *));
 916 extern void x_check_errors P_ ((Display *, char *));
 917 extern int x_had_errors_p P_ ((Display *));
 918 extern int x_catching_errors P_ ((void));
 919 extern void x_uncatch_errors P_ ((void));
 920 extern void x_clear_errors P_ ((Display *));
 921 extern void x_set_window_size P_ ((struct frame *, int, int, int));
 922 extern void x_set_mouse_position P_ ((struct frame *, int, int));
 923 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
 924 extern void x_ewmh_activate_frame P_ ((struct frame *));
 925 extern void x_raise_frame P_ ((struct frame *));
 926 extern void x_lower_frame P_ ((struct frame *));
 927 extern void x_make_frame_visible P_ ((struct frame *));
 928 extern void x_make_frame_invisible P_ ((struct frame *));
 929 extern void x_iconify_frame P_ ((struct frame *));
 930 extern void x_free_frame_resources P_ ((struct frame *));
 931 extern void x_destroy_window P_ ((struct frame *));
 932 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
 933 extern void x_wm_set_window_state P_ ((struct frame *, int));
 934 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
 935 extern void x_delete_display P_ ((struct x_display_info *));
 936 extern void x_delete_terminal P_ ((struct terminal *terminal));
 937 extern void x_initialize P_ ((void));
 938 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
 939 #ifdef USE_X_TOOLKIT
 940 extern XtAppContext Xt_app_con;
 941 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
 942                                                   unsigned long *,
 943                                                   double, int));
 944 extern void x_activate_timeout_atimer P_ ((void));
 945 #endif
 946 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
 947 extern void x_query_color P_ ((struct frame *f, XColor *));
 948 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
 949 extern void set_vertical_scroll_bar P_ ((struct window *));
 950
 951 extern int x_dispatch_event P_ ((XEvent *, Display *));
 952 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
 953                                                 unsigned));
 954 extern int x_display_pixel_height P_ ((struct x_display_info *));
 955 extern int x_display_pixel_width P_ ((struct x_display_info *));
 956
 957 /* Defined in xselect.c */
 958
 959 extern void x_handle_property_notify P_ ((XPropertyEvent *));
 960 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
 961 extern void x_handle_selection_event P_ ((struct input_event *));
 962 extern void x_clear_frame_selections P_ ((struct frame *));
 963
 964 extern int x_handle_dnd_message P_ ((struct frame *,
 965                                      XClientMessageEvent *,
 966                                      struct x_display_info *,
 967                                      struct input_event *bufp));
 968 extern int x_check_property_data P_ ((Lisp_Object));
 969 extern void x_fill_property_data P_ ((Display *,
 970                                       Lisp_Object,
 971                                       void *,
 972                                       int));
 973 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
 974                                                 unsigned char *,
 975                                                 Atom,
 976                                                 int,
 977                                                 unsigned long));
 978
 979 /* Defined in xfns.c */
 980
 981 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
 982
 983 #ifdef USE_GTK
 984 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
 985 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
 986 #endif /* USE_GTK */
 987
 988 extern void x_real_positions P_ ((struct frame *, int *, int *));
 989 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
 990 extern void x_set_border_pixel P_ ((struct frame *, int));
 991 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
 992 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
 993 extern void xic_free_xfontset P_ ((struct frame *));
 994 extern void create_frame_xic P_ ((struct frame *));
 995 extern void destroy_frame_xic P_ ((struct frame *));
 996 extern void xic_set_preeditarea P_ ((struct window *, int, int));
 997 extern void xic_set_statusarea P_ ((struct frame *));
 998 extern void xic_set_xfontset P_ ((struct frame *, char *));
 999 extern int x_pixel_width P_ ((struct frame *));
1000 extern int x_pixel_height P_ ((struct frame *));
1001 extern int x_char_width P_ ((struct frame *));
1002 extern int x_char_height P_ ((struct frame *));
1003 extern int x_screen_planes P_ ((struct frame *));
1004 extern void x_sync P_ ((struct frame *));
1005 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1006 #ifdef HAVE_X_I18N
1007 extern void free_frame_xic P_ ((struct frame *));
1008 #endif
1009 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1010
1011 /* Defined in xfaces.c */
1012
1013 extern int compute_glyph_face P_ ((struct frame *, int, int));
1014 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1015 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1016                                    unsigned long *, int));
1017
1018 /* Defined in xmenu.c */
1019
1020 extern void x_menu_set_in_use P_ ((int));
1021 extern void x_menu_wait_for_event P_ ((void *data));
1022 extern void x_activate_menubar P_ ((struct frame *));
1023 extern int popup_activated P_ ((void));
1024 extern void initialize_frame_menubar P_ ((struct frame *));
1025 extern void free_frame_menubar P_ ((struct frame *));
1026
1027 /* Defined in widget.c */
1028
1029 #ifdef USE_X_TOOLKIT
1030 extern void widget_store_internal_border P_ ((Widget));
1031 #endif
1032
1033 /* Defined in xsmfns.c */
1034 #ifdef HAVE_X_SM
1035 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1036 extern int x_session_check_input P_ ((struct input_event *bufp));
1037 extern int x_session_have_connection P_ ((void));
1038 extern void x_session_close P_ ((void));
1039 #endif
1040
1041 /* XEmbed implementation.  */
1042
1043 #define XEMBED_VERSION 0
1044
1045 enum xembed_info
1046   {
1047     XEMBED_MAPPED = 1 << 0
1048   };
1049
1050 enum xembed_message
1051   {
1052     XEMBED_EMBEDDED_NOTIFY        = 0,
1053     XEMBED_WINDOW_ACTIVATE        = 1,
1054     XEMBED_WINDOW_DEACTIVATE      = 2,
1055     XEMBED_REQUEST_FOCUS          = 3,
1056     XEMBED_FOCUS_IN               = 4,
1057     XEMBED_FOCUS_OUT              = 5,
1058     XEMBED_FOCUS_NEXT             = 6,
1059     XEMBED_FOCUS_PREV             = 7,
1060
1061     XEMBED_MODALITY_ON            = 10,
1062     XEMBED_MODALITY_OFF           = 11,
1063     XEMBED_REGISTER_ACCELERATOR   = 12,
1064     XEMBED_UNREGISTER_ACCELERATOR = 13,
1065     XEMBED_ACTIVATE_ACCELERATOR   = 14
1066   };
1067
1068 enum xembed_focus
1069   {
1070     XEMBED_FOCUS_CURRENT = 0,
1071     XEMBED_FOCUS_FIRST   = 1,
1072     XEMBED_FOCUS_LAST    = 2
1073   };
1074
1075 enum xembed_modifier
1076   {
1077     XEMBED_MODIFIER_SHIFT   = 1 << 0,
1078     XEMBED_MODIFIER_CONTROL = 1 << 1,
1079     XEMBED_MODIFIER_ALT     = 1 << 2,
1080     XEMBED_MODIFIER_SUPER   = 1 << 3,
1081     XEMBED_MODIFIER_HYPER   = 1 << 4
1082   };
1083
1084 enum xembed_accelerator
1085   {
1086     XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1087   };
1088
1089 /* Defined in xterm.c */
1090
1091 extern void xembed_set_info P_ ((struct frame *f, enum xembed_info flags));
1092 extern void xembed_send_message P_ ((struct frame *f, Time time,
1093                                      enum xembed_message message,
1094                                      long detail, long data1, long data2));
1095
1096 /* Is the frame embedded into another application? */
1097
1098 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1099
1100
1101 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1102 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1103
1104 #define STORE_XCHAR2B(chp, b1, b2) \
1105   ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1106
1107 #define XCHAR2B_BYTE1(chp) \
1108   ((chp)->byte1)
1109
1110 #define XCHAR2B_BYTE2(chp) \
1111   ((chp)->byte2)
1112
1113
1114 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight)      \
1115   ((nr).x = (rx),                                       \
1116    (nr).y = (ry),                                       \
1117    (nr).width = (rwidth),                               \
1118    (nr).height = (rheight))
1119
1120 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1121    (do not change this comment) */