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