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 /* This checks to make sure we have a display.  */
 370
 371 extern void check_x (void);
 372
 373 extern struct frame *x_window_to_frame (struct x_display_info *, int);
 374 extern struct frame *x_any_window_to_frame (struct x_display_info *, int);
 375 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
 376                                                 XEvent *);
 377 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
 378
 379 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
 380                                                 XEvent *);
 381
 382 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
 383 #define x_any_window_to_frame x_window_to_frame
 384 #define x_top_window_to_frame x_window_to_frame
 385 #endif
 386
 387 /* This is a chain of structures for all the X displays currently in use.  */
 388 extern struct x_display_info *x_display_list;
 389
 390 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 391    one for each element of x_display_list and in the same order.
 392    NAME is the name of the frame.
 393    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 394 extern Lisp_Object x_display_name_list;
 395
 396 extern struct x_display_info *x_display_info_for_display (Display *);
 397
 398 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
 399 extern int x_display_ok  (const char *);
 400
 401 extern void select_visual (struct x_display_info *);
 402
 403 \f
 404 struct font;
 405
 406 /* Each X frame object points to its own struct x_output object
 407    in the output_data.x field.  The x_output structure contains
 408    the information that is specific to X windows.  */
 409
 410 struct x_output
 411 {
 412   /* Height of menu bar widget, in pixels.
 413      Zero if not using the X toolkit.
 414      When using the toolkit, this value is not meaningful
 415      if the menubar is turned off.  */
 416   int menubar_height;
 417
 418   /* Height of tool bar widget, in pixels.  top_height is used if tool bar
 419      at top, bottom_height if tool bar is at the bottom.
 420      Zero if not using an external tool bar or if tool bar is vertical.  */
 421   int toolbar_top_height, toolbar_bottom_height;
 422
 423   /* Width of tool bar widget, in pixels.  left_width is used if tool bar
 424      at left, right_width if tool bar is at the right.
 425      Zero if not using an external tool bar or if tool bar is horizontal.  */
 426   int toolbar_left_width, toolbar_right_width;
 427
 428   /* The tiled border used when the mouse is out of the frame.  */
 429   Pixmap border_tile;
 430
 431   /* Here are the Graphics Contexts for the default font.  */
 432   GC normal_gc;                         /* Normal video */
 433   GC reverse_gc;                        /* Reverse video */
 434   GC cursor_gc;                         /* cursor drawing */
 435
 436   /* The X window used for this frame.
 437      May be zero while the frame object is being created
 438      and the X window has not yet been created.  */
 439   Window window_desc;
 440
 441   /* The X window used for the bitmap icon;
 442      or 0 if we don't have a bitmap icon.  */
 443   Window icon_desc;
 444
 445   /* The X window that is the parent of this X window.
 446      Usually this is a window that was made by the window manager,
 447      but it can be the root window, and it can be explicitly specified
 448      (see the explicit_parent field, below).  */
 449   Window parent_desc;
 450
 451 #ifdef USE_X_TOOLKIT
 452   /* The widget of this screen.  This is the window of a "shell" widget.  */
 453   Widget widget;
 454   /* The XmPanedWindows...  */
 455   Widget column_widget;
 456   /* The widget of the edit portion of this screen; the window in
 457      "window_desc" is inside of this.  */
 458   Widget edit_widget;
 459
 460   Widget menubar_widget;
 461 #endif
 462
 463 #ifdef USE_GTK
 464   /* The widget of this screen.  This is the window of a top widget.  */
 465   GtkWidget *widget;
 466   /* The widget of the edit portion of this screen; the window in
 467      "window_desc" is inside of this.  */
 468   GtkWidget *edit_widget;
 469   /* The widget used for laying out widgets vertically.  */
 470   GtkWidget *vbox_widget;
 471   /* The widget used for laying out widgets horizontally.  */
 472   GtkWidget *hbox_widget;
 473   /* The menubar in this frame.  */
 474   GtkWidget *menubar_widget;
 475   /* The tool bar in this frame  */
 476   GtkWidget *toolbar_widget;
 477   /* The handle box that makes the tool bar detachable.  */
 478   GtkWidget *handlebox_widget;
 479   /* Non-zero if the tool bar is detached.  */
 480   int toolbar_detached;
 481   /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical).  */
 482   int toolbar_in_hbox;
 483
 484   /* The last size hints set.  */
 485   GdkGeometry size_hints;
 486   long hint_flags;
 487
 488 #ifdef USE_GTK_TOOLTIP
 489   GtkTooltip *ttip_widget;
 490   GtkWidget *ttip_lbl;
 491   GtkWindow *ttip_window;
 492 #endif /* USE_GTK_TOOLTIP */
 493
 494 #endif /* USE_GTK */
 495
 496   /* If >=0, a bitmap index.  The indicated bitmap is used for the
 497      icon. */
 498   ptrdiff_t icon_bitmap;
 499
 500   /* Default ASCII font of this frame.  */
 501   struct font *font;
 502
 503   /* The baseline offset of the default ASCII font.  */
 504   int baseline_offset;
 505
 506   /* If a fontset is specified for this frame instead of font, this
 507      value contains an ID of the fontset, else -1.  */
 508   int fontset;
 509
 510   /* Pixel values used for various purposes.
 511      border_pixel may be -1 meaning use a gray tile.  */
 512 #if 0 /* These are also defined in struct frame.  Use that instead.  */
 513   unsigned long background_pixel;
 514   unsigned long foreground_pixel;
 515 #endif
 516   unsigned long cursor_pixel;
 517   unsigned long border_pixel;
 518   unsigned long mouse_pixel;
 519   unsigned long cursor_foreground_pixel;
 520
 521   /* Foreground color for scroll bars.  A value of -1 means use the
 522      default (black for non-toolkit scroll bars).  */
 523   unsigned long scroll_bar_foreground_pixel;
 524
 525   /* Background color for scroll bars.  A value of -1 means use the
 526      default (background color of the frame for non-toolkit scroll
 527      bars).  */
 528   unsigned long scroll_bar_background_pixel;
 529
 530   /* Top and bottom shadow colors for 3d toolkit scrollbars.  -1 means
 531      let the scroll compute them itself.  */
 532   unsigned long scroll_bar_top_shadow_pixel;
 533   unsigned long scroll_bar_bottom_shadow_pixel;
 534
 535   /* Descriptor for the cursor in use for this window.  */
 536   Cursor text_cursor;
 537   Cursor nontext_cursor;
 538   Cursor modeline_cursor;
 539   Cursor hand_cursor;
 540   Cursor hourglass_cursor;
 541   Cursor horizontal_drag_cursor;
 542   Cursor current_cursor;
 543
 544   /* Window whose cursor is hourglass_cursor.  This window is temporarily
 545      mapped to display an hourglass cursor.  */
 546   Window hourglass_window;
 547
 548   /* Non-zero means hourglass cursor is currently displayed.  */
 549   unsigned hourglass_p : 1;
 550
 551   /* These are the current window manager hints.  It seems that
 552      XSetWMHints, when presented with an unset bit in the `flags'
 553      member of the hints structure, does not leave the corresponding
 554      attribute unchanged; rather, it resets that attribute to its
 555      default value.  For example, unless you set the `icon_pixmap'
 556      field and the `IconPixmapHint' bit, XSetWMHints will forget what
 557      your icon pixmap was.  This is rather troublesome, since some of
 558      the members (for example, `input' and `icon_pixmap') want to stay
 559      the same throughout the execution of Emacs.  So, we keep this
 560      structure around, just leaving values in it and adding new bits
 561      to the mask as we go.  */
 562   XWMHints wm_hints;
 563
 564   /* This is the Emacs structure for the X display this frame is on.  */
 565   struct x_display_info *display_info;
 566
 567   /* This is a button event that wants to activate the menubar.
 568      We save it here until the command loop gets to think about it.  */
 569   XEvent *saved_menu_event;
 570
 571   /* This is the widget id used for this frame's menubar in lwlib.  */
 572 #ifdef USE_X_TOOLKIT
 573   int id;
 574 #endif
 575
 576   /* Nonzero means our parent is another application's window
 577      and was explicitly specified.  */
 578   char explicit_parent;
 579
 580   /* Nonzero means tried already to make this frame visible.  */
 581   char asked_for_visible;
 582
 583   /* Nonzero if this frame was ever previously visible.  */
 584   char has_been_visible;
 585
 586 #ifdef HAVE_X_I18N
 587   /* Input context (currently, this means Compose key handler setup).  */
 588   XIC xic;
 589   XIMStyle xic_style;
 590   XFontSet xic_xfs;
 591   char *xic_base_fontname;
 592 #endif
 593
 594   /* Relief GCs, colors etc.  */
 595   struct relief
 596   {
 597     GC gc;
 598     unsigned long pixel;
 599     int allocated_p;
 600   }
 601   black_relief, white_relief;
 602
 603   /* The background for which the above relief GCs were set up.
 604      They are changed only when a different background is involved.  */
 605   unsigned long relief_background;
 606
 607   /* Xt waits for a ConfigureNotify event from the window manager in
 608      EmacsFrameSetCharSize when the shell widget is resized.  For some
 609      window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
 610      arrive for an unknown reason and Emacs hangs in Xt.  If this is
 611      zero, tell Xt not to wait.  */
 612   int wait_for_wm;
 613
 614   /* As x_pixels_diff, but to FRAME_OUTER_WINDOW.  For some reason the
 615      two might differ by a pixel, depending on WM */
 616   int x_pixels_outer_diff;
 617
 618   /* As y_pixels_diff, but to FRAME_OUTER_WINDOW.  In the toolkit version,
 619      these may differ because this does not take into account possible
 620      menubar.  y_pixels_diff is with menubar height included */
 621   int y_pixels_outer_diff;
 622
 623   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 624      frame, or IMPLICIT if we received an EnterNotify.
 625      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 626   int focus_state;
 627
 628   /* The offset we need to add to compensate for type A WMs.  */
 629   int move_offset_top;
 630   int move_offset_left;
 631
 632   /* The frame's left/top offsets before we call XMoveWindow.  See
 633      x_check_expected_move.  */
 634   int left_before_move;
 635   int top_before_move;
 636
 637   /* Non-zero if _NET_WM_STATE_HIDDEN is set for this frame.  */
 638   int net_wm_state_hidden_seen;
 639 };
 640
 641 #define No_Cursor (None)
 642
 643 enum
 644 {
 645   /* Values for focus_state, used as bit mask.
 646      EXPLICIT means we received a FocusIn for the frame and know it has
 647      the focus.  IMPLICIT means we received an EnterNotify and the frame
 648      may have the focus if no window manager is running.
 649      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 650   FOCUS_NONE     = 0,
 651   FOCUS_IMPLICIT = 1,
 652   FOCUS_EXPLICIT = 2
 653 };
 654
 655
 656 /* Return the X output data for frame F.  */
 657 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
 658
 659 /* Return the X window used for displaying data in frame F.  */
 660 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
 661
 662 /* Return the outermost X window associated with the frame F.  */
 663 #ifdef USE_X_TOOLKIT
 664 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ?             \
 665                                XtWindow ((f)->output_data.x->widget) :  \
 666                                FRAME_X_WINDOW (f))
 667 #else
 668 #ifdef USE_GTK
 669 /* Functions not present in older Gtk+ */
 670
 671 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
 672 #define gtk_widget_get_window(w) ((w)->window)
 673 #endif
 674 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
 675 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
 676 #endif
 677 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
 678 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
 679 #define gtk_adjustment_get_upper(w) ((w)->upper)
 680 #endif
 681
 682 #ifdef HAVE_GTK3
 683 #define DEFAULT_GDK_DISPLAY() \
 684   gdk_x11_display_get_xdisplay (gdk_display_get_default ())
 685 #else
 686 #undef GDK_WINDOW_XID
 687 #define GDK_WINDOW_XID(w) GDK_WINDOW_XWINDOW (w)
 688 #define DEFAULT_GDK_DISPLAY() GDK_DISPLAY ()
 689 #define gtk_widget_get_preferred_size(a, ign, b) \
 690   gtk_widget_size_request (a, b)
 691 #endif
 692
 693 #define GTK_WIDGET_TO_X_WIN(w) \
 694   ((w) && gtk_widget_get_window (w) \
 695    ? GDK_WINDOW_XID (gtk_widget_get_window (w)) : 0)
 696
 697 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
 698 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
 699 #define FRAME_OUTER_WINDOW(f)                                   \
 700        (FRAME_GTK_OUTER_WIDGET (f) ?                            \
 701         GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) :      \
 702          FRAME_X_WINDOW (f))
 703
 704 #else /* !USE_GTK */
 705 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
 706 #endif /* !USE_GTK */
 707 #endif
 708
 709
 710 #define FRAME_FONT(f) ((f)->output_data.x->font)
 711 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
 712 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
 713 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
 714 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
 715   ((f)->output_data.x->toolbar_bottom_height)
 716 #define FRAME_TOOLBAR_HEIGHT(f) \
 717   (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
 718 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
 719 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
 720 #define FRAME_TOOLBAR_WIDTH(f) \
 721   (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
 722 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
 723
 724 /* This gives the x_display_info structure for the display F is on.  */
 725 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
 726
 727 /* This is the `Display *' which frame F is on.  */
 728 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
 729
 730 /* This is the `Screen *' which frame F is on.  */
 731 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 732 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
 733
 734 /* This is the Visual which frame F is on.  */
 735 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
 736
 737 /* This is the Colormap which frame F uses.  */
 738 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
 739
 740 /* The difference in pixels between the top left corner of the
 741    Emacs window (including possible window manager decorations)
 742    and FRAME_X_WINDOW (f).  */
 743 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
 744      ((f)->output_data.x->x_pixels_outer_diff)
 745 #define FRAME_OUTER_TO_INNER_DIFF_Y(f)          \
 746      ((f)->output_data.x->y_pixels_outer_diff   \
 747       + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
 748
 749
 750 #define FRAME_XIC(f) ((f)->output_data.x->xic)
 751 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
 752 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
 753 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
 754 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
 755 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
 756
 757 /* Value is the smallest width of any character in any font on frame F.  */
 758
 759 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 760      FRAME_X_DISPLAY_INFO(F)->smallest_char_width
 761
 762 /* Value is the smallest height of any font on frame F.  */
 763
 764 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 765      FRAME_X_DISPLAY_INFO(F)->smallest_font_height
 766 \f
 767 /* X-specific scroll bar stuff.  */
 768
 769 /* We represent scroll bars as lisp vectors.  This allows us to place
 770    references to them in windows without worrying about whether we'll
 771    end up with windows referring to dead scroll bars; the garbage
 772    collector will free it when its time comes.
 773
 774    We use struct scroll_bar as a template for accessing fields of the
 775    vector.  */
 776
 777 struct scroll_bar
 778 {
 779   /* These fields are shared by all vectors.  */
 780   struct vectorlike_header header;
 781
 782   /* The window we're a scroll bar for.  */
 783   Lisp_Object window;
 784
 785   /* The next and previous in the chain of scroll bars in this frame.  */
 786   Lisp_Object next, prev;
 787
 788   /* Fields from `x_window' down will not be traced by the GC.  */
 789
 790   /* The X window representing this scroll bar.  */
 791   Window x_window;
 792
 793   /* The position and size of the scroll bar in pixels, relative to the
 794      frame.  */
 795   int top, left, width, height;
 796
 797   /* The starting and ending positions of the handle, relative to the
 798      handle area (i.e. zero is the top position, not
 799      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 800      hasn't been drawn yet.
 801
 802      These are not actually the locations where the beginning and end
 803      are drawn; in order to keep handles from becoming invisible when
 804      editing large files, we establish a minimum height by always
 805      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 806      where they would be normally; the bottom and top are in a
 807      different co-ordinate system.  */
 808   int start, end;
 809
 810   /* If the scroll bar handle is currently being dragged by the user,
 811      this is the number of pixels from the top of the handle to the
 812      place where the user grabbed it.  If the handle isn't currently
 813      being dragged, this is Qnil.  */
 814   Lisp_Object dragging;
 815
 816   /* 1 if the background of the fringe that is adjacent to a scroll
 817      bar is extended to the gap between the fringe and the bar.  */
 818   unsigned int fringe_extended_p : 1;
 819 };
 820
 821 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 822 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 823
 824
 825 /* Extract the X widget of the scroll bar from a struct scroll_bar.
 826    XtWindowToWidget should be fast enough since Xt uses a hash table
 827    to map windows to widgets.  */
 828
 829 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
 830   XtWindowToWidget (dpy, ptr->x_window)
 831
 832 /* Store a widget id in a struct scroll_bar.  */
 833
 834 #define SET_SCROLL_BAR_X_WIDGET(ptr, w)         \
 835   do {                                          \
 836     Window window = XtWindow (w);               \
 837     ptr->x_window = window;                     \
 838 } while (0)
 839
 840
 841 /* Return the inside width of a vertical scroll bar, given the outside
 842    width.  */
 843 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
 844   ((width) \
 845    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 846    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 847    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 848
 849 /* Return the length of the rectangle within which the top of the
 850    handle must stay.  This isn't equivalent to the inside height,
 851    because the scroll bar handle has a minimum height.
 852
 853    This is the real range of motion for the scroll bar, so when we're
 854    scaling buffer positions to scroll bar positions, we use this, not
 855    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 856 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
 857   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 858
 859 /* Return the inside height of vertical scroll bar, given the outside
 860    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 861 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
 862   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 863
 864
 865 /* Border widths for scroll bars.
 866
 867    Scroll bar windows don't have any X borders; their border width is
 868    set to zero, and we redraw borders ourselves.  This makes the code
 869    a bit cleaner, since we don't have to convert between outside width
 870    (used when relating to the rest of the screen) and inside width
 871    (used when sizing and drawing the scroll bar window itself).
 872
 873    The handle moves up and down/back and forth in a rectangle inset
 874    from the edges of the scroll bar.  These are widths by which we
 875    inset the handle boundaries from the scroll bar edges.  */
 876 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
 877 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
 878 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
 879 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
 880
 881 /* Minimum lengths for scroll bar handles, in pixels.  */
 882 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 883
 884 /* Trimming off a few pixels from each side prevents
 885    text from glomming up against the scroll bar */
 886 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 887
 888 \f
 889 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
 890    or SELECTION_CLEAR_EVENT, then its contents are really described
 891    by this structure.  */
 892
 893 /* For an event of kind SELECTION_REQUEST_EVENT,
 894    this structure really describes the contents.
 895    **Don't make this struct longer!**
 896    If it overlaps the frame_or_window field of struct input_event,
 897    that will cause GC to crash.  */
 898 struct selection_input_event
 899 {
 900   int kind;
 901   Display *display;
 902   /* We spell it with an "o" here because X does.  */
 903   Window requestor;
 904   Atom selection, target, property;
 905   Time time;
 906 };
 907
 908 #define SELECTION_EVENT_DISPLAY(eventp) \
 909   (((struct selection_input_event *) (eventp))->display)
 910 /* We spell it with an "o" here because X does.  */
 911 #define SELECTION_EVENT_REQUESTOR(eventp)       \
 912   (((struct selection_input_event *) (eventp))->requestor)
 913 #define SELECTION_EVENT_SELECTION(eventp)       \
 914   (((struct selection_input_event *) (eventp))->selection)
 915 #define SELECTION_EVENT_TARGET(eventp)  \
 916   (((struct selection_input_event *) (eventp))->target)
 917 #define SELECTION_EVENT_PROPERTY(eventp)        \
 918   (((struct selection_input_event *) (eventp))->property)
 919 #define SELECTION_EVENT_TIME(eventp)    \
 920   (((struct selection_input_event *) (eventp))->time)
 921
 922 \f
 923 struct window;
 924 struct glyph_matrix;
 925 struct frame;
 926 struct input_event;
 927 struct face;
 928 struct image;
 929
 930 /* From xselect.c.  */
 931
 932 void x_handle_selection_notify (XSelectionEvent *);
 933 void x_handle_property_notify (XPropertyEvent *);
 934
 935 /* From xfns.c.  */
 936
 937 struct frame *check_x_frame (Lisp_Object);
 938 extern void x_free_gcs (struct frame *);
 939
 940 /* From xrdb.c.  */
 941
 942 XrmDatabase x_load_resources (Display *, const char *, const char *,
 943                               const char *);
 944
 945 /* Defined in xterm.c */
 946
 947 extern int x_text_icon (struct frame *, const char *);
 948 extern void x_catch_errors (Display *);
 949 extern void x_check_errors (Display *, const char *)
 950   ATTRIBUTE_FORMAT_PRINTF (2, 0);
 951 extern int x_had_errors_p (Display *);
 952 extern void x_uncatch_errors (void);
 953 extern void x_clear_errors (Display *);
 954 extern void x_set_window_size (struct frame *, int, int, int);
 955 extern void x_set_mouse_position (struct frame *, int, int);
 956 extern void x_set_mouse_pixel_position (struct frame *, int, int);
 957 extern void xembed_request_focus (struct frame *);
 958 extern void x_ewmh_activate_frame (struct frame *);
 959 extern void x_delete_terminal (struct terminal *terminal);
 960 extern unsigned long x_copy_color (struct frame *, unsigned long);
 961 #ifdef USE_X_TOOLKIT
 962 extern XtAppContext Xt_app_con;
 963 extern void x_activate_timeout_atimer (void);
 964 #endif
 965 #ifdef USE_LUCID
 966 extern bool x_alloc_lighter_color_for_widget (Widget, Display *, Colormap,
 967                                               unsigned long *,
 968                                               double, int);
 969 #endif
 970 extern bool x_alloc_nearest_color (struct frame *, Colormap, XColor *);
 971 extern void x_query_color (struct frame *f, XColor *);
 972 extern void x_clear_area (Display *, Window, int, int, int, int, int);
 973 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
 974 extern void x_mouse_leave (struct x_display_info *);
 975 #endif
 976
 977 #ifdef USE_X_TOOLKIT
 978 extern int x_dispatch_event (XEvent *, Display *);
 979 #endif
 980 extern int x_x_to_emacs_modifiers (struct x_display_info *, int);
 981 extern int x_display_pixel_height (struct x_display_info *);
 982 extern int x_display_pixel_width (struct x_display_info *);
 983
 984 extern void x_set_sticky (struct frame *, Lisp_Object, Lisp_Object);
 985 extern void x_wait_for_event (struct frame *, int);
 986
 987 /* Defined in xselect.c */
 988
 989 extern void x_handle_property_notify (XPropertyEvent *);
 990 extern void x_handle_selection_notify (XSelectionEvent *);
 991 extern void x_handle_selection_event (struct input_event *);
 992 extern void x_clear_frame_selections (struct frame *);
 993
 994 extern void x_send_client_event (Lisp_Object display,
 995                                  Lisp_Object dest,
 996                                  Lisp_Object from,
 997                                  Atom message_type,
 998                                  Lisp_Object format,
 999                                  Lisp_Object values);
1000
1001 extern int x_handle_dnd_message (struct frame *,
1002                                  XClientMessageEvent *,
1003                                  struct x_display_info *,
1004                                  struct input_event *bufp);
1005 extern int x_check_property_data (Lisp_Object);
1006 extern void x_fill_property_data (Display *,
1007                                   Lisp_Object,
1008                                   void *,
1009                                   int);
1010 extern Lisp_Object x_property_data_to_lisp (struct frame *,
1011                                             const unsigned char *,
1012                                             Atom,
1013                                             int,
1014                                             unsigned long);
1015 extern void x_clipboard_manager_save_frame (Lisp_Object);
1016 extern void x_clipboard_manager_save_all (void);
1017
1018 /* Defined in xfns.c */
1019
1020 extern struct x_display_info * check_x_display_info (Lisp_Object);
1021 extern Lisp_Object x_get_focus_frame (struct frame *);
1022 extern int x_in_use;
1023
1024 #ifdef USE_GTK
1025 extern int xg_set_icon (struct frame *, Lisp_Object);
1026 extern int xg_set_icon_from_xpm_data (struct frame *, const char**);
1027 #endif /* USE_GTK */
1028
1029 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1030 extern void xic_free_xfontset (struct frame *);
1031 extern void create_frame_xic (struct frame *);
1032 extern void destroy_frame_xic (struct frame *);
1033 extern void xic_set_preeditarea (struct window *, int, int);
1034 extern void xic_set_statusarea (struct frame *);
1035 extern void xic_set_xfontset (struct frame *, const char *);
1036 extern int x_pixel_width (struct frame *);
1037 extern int x_pixel_height (struct frame *);
1038 extern bool x_defined_color (struct frame *, const char *, XColor *, bool);
1039 #ifdef HAVE_X_I18N
1040 extern void free_frame_xic (struct frame *);
1041 # if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1042 extern char * xic_create_fontsetname (const char *base_fontname, int motif);
1043 # endif
1044 #endif
1045
1046 /* Defined in xfaces.c */
1047
1048 #ifdef USE_X_TOOLKIT
1049 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1050                                unsigned long *, int);
1051 #endif /* USE_X_TOOLKIT */
1052
1053 /* Defined in xmenu.c */
1054
1055 #if defined USE_GTK || defined USE_MOTIF
1056 extern void x_menu_set_in_use (int);
1057 #endif
1058 #ifdef USE_MOTIF
1059 extern void x_menu_wait_for_event (void *data);
1060 #endif
1061 extern int popup_activated (void);
1062 extern void initialize_frame_menubar (struct frame *);
1063
1064 /* Defined in widget.c */
1065
1066 #ifdef USE_X_TOOLKIT
1067 extern void widget_store_internal_border (Widget);
1068 #endif
1069
1070 /* Defined in xsmfns.c */
1071 #ifdef HAVE_X_SM
1072 extern void x_session_initialize (struct x_display_info *dpyinfo);
1073 extern int x_session_have_connection (void);
1074 extern void x_session_close (void);
1075 #endif
1076
1077 /* Defined in xterm.c */
1078
1079 extern Lisp_Object Qx_gtk_map_stock;
1080
1081 /* Is the frame embedded into another application? */
1082
1083 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1084
1085
1086 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1087 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1088
1089 #define STORE_XCHAR2B(chp, b1, b2) \
1090   ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1091
1092 #define XCHAR2B_BYTE1(chp) \
1093   ((chp)->byte1)
1094
1095 #define XCHAR2B_BYTE2(chp) \
1096   ((chp)->byte2)
1097
1098
1099 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight)      \
1100   ((nr).x = (rx),                                       \
1101    (nr).y = (ry),                                       \
1102    (nr).width = (rwidth),                               \
1103    (nr).height = (rheight))
1104
1105 #endif /* XTERM_H */