src/xterm.h

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