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