src/xterm.h

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