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