src/xterm.h

   1 /* Definitions and headers for communication with X protocol.
   2    Copyright (C) 1989, 1993-1994, 1998-2012 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef XTERM_H
  20 #define XTERM_H
  21
  22 #include <X11/Xlib.h>
  23 #include <X11/cursorfont.h>
  24
  25 /* Include Xutil.h after keysym.h to work around a bug that prevents
  26    correct recognition of AltGr key in some X versions.  */
  27
  28 #include <X11/keysym.h>
  29 #include <X11/Xutil.h>
  30
  31 #include <X11/Xatom.h>
  32 #include <X11/Xresource.h>
  33
  34 #ifdef USE_X_TOOLKIT
  35 #include <X11/StringDefs.h>
  36 #include <X11/IntrinsicP.h>     /* CoreP.h needs this */
  37 #include <X11/CoreP.h>          /* foul, but we need this to use our own
  38                                    window inside a widget instead of one
  39                                    that Xt creates... */
  40 #include <X11/StringDefs.h>
  41
  42 typedef Widget xt_or_gtk_widget;
  43 #endif
  44
  45 #ifdef USE_GTK
  46 #include <gtk/gtk.h>
  47 #include <gdk/gdkx.h>
  48
  49 /* Some definitions to reduce conditionals.  */
  50 typedef GtkWidget *xt_or_gtk_widget;
  51 #define XtParent(x) (gtk_widget_get_parent (x))
  52 #undef XSync
  53 #define XSync(d, b) do { gdk_window_process_all_updates (); \
  54                          XSync (d, b);  } while (0)
  55
  56 /* The GtkTooltip API came in 2.12, but gtk-enable-tooltips in 2.14. */
  57 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 13
  58 #define USE_GTK_TOOLTIP
  59 #endif
  60
  61 #endif /* USE_GTK */
  62
  63 \f
  64 /* Bookkeeping to distinguish X versions.  */
  65
  66
  67 #ifdef HAVE_X_I18N
  68 #include <X11/Xlocale.h>
  69 #endif
  70 \f
  71 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
  72                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  73 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
  74                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  75
  76 #define FONT_WIDTH(f)   ((f)->max_width)
  77 #define FONT_HEIGHT(f)  ((f)->ascent + (f)->descent)
  78 #define FONT_BASE(f)    ((f)->ascent)
  79 #define FONT_DESCENT(f) ((f)->descent)
  80
  81 /* The mask of events that text windows always want to receive.  This
  82    includes mouse movement events, since handling the mouse-font text property
  83    means that we must track mouse motion all the time.  */
  84
  85 #define STANDARD_EVENT_SET      \
  86   (KeyPressMask                 \
  87    | ExposureMask               \
  88    | ButtonPressMask            \
  89    | ButtonReleaseMask          \
  90    | PointerMotionMask          \
  91    | StructureNotifyMask        \
  92    | FocusChangeMask            \
  93    | LeaveWindowMask            \
  94    | EnterWindowMask            \
  95    | VisibilityChangeMask)
  96
  97 #ifdef HAVE_X11R6_XIM
  98 /* Data structure passed to xim_instantiate_callback.  */
  99 struct xim_inst_t
 100 {
 101   struct x_display_info *dpyinfo;
 102   char *resource_name;
 103 };
 104 #endif /* HAVE_X11R6_XIM */
 105
 106 /* Structure recording X pixmap and reference count.
 107    If REFCOUNT is 0 then this record is free to be reused.  */
 108
 109 struct x_bitmap_record
 110 {
 111   Pixmap pixmap;
 112   int have_mask;
 113   Pixmap mask;
 114   char *file;
 115   int refcount;
 116   /* Record some info about this pixmap.  */
 117   int height, width, depth;
 118 };
 119 \f
 120 /* For each X display, we have a structure that records
 121    information about it.  */
 122
 123 struct x_display_info
 124 {
 125   /* Chain of all x_display_info structures.  */
 126   struct x_display_info *next;
 127
 128   /* The generic display parameters corresponding to this X display. */
 129   struct terminal *terminal;
 130
 131   /* Connection number (normally a file descriptor number).  */
 132   int connection;
 133
 134   /* This says how to access this display in Xlib.  */
 135   Display *display;
 136
 137   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 138      The same cons cell also appears in x_display_name_list.  */
 139   Lisp_Object name_list_element;
 140
 141   /* Number of frames that are on this display.  */
 142   int reference_count;
 143
 144   /* The Screen this connection is connected to.  */
 145   Screen *screen;
 146
 147   /* Dots per inch of the screen.  */
 148   double resx, resy;
 149
 150   /* The Visual being used for this display.  */
 151   Visual *visual;
 152
 153   /* The colormap being used.  */
 154   Colormap cmap;
 155
 156   /* Number of planes on this screen.  */
 157   int n_planes;
 158
 159   /* Mask of things that cause the mouse to be grabbed.  */
 160   int grabbed;
 161
 162   /* Emacs bitmap-id of the default icon bitmap for this frame.
 163      Or -1 if none has been allocated yet.  */
 164   ptrdiff_t icon_bitmap_id;
 165
 166   /* The root window of this screen.  */
 167   Window root_window;
 168
 169   /* Client leader window.  */
 170   Window client_leader_window;
 171
 172   /* The cursor to use for vertical scroll bars.  */
 173   Cursor vertical_scroll_bar_cursor;
 174
 175   /* The invisible cursor used for pointer blanking.  */
 176   Cursor invisible_cursor;
 177
 178 #ifdef USE_GTK
 179   /* The GDK cursor for scroll bars and popup menus.  */
 180   GdkCursor *xg_cursor;
 181 #endif
 182
 183   /* X Resource data base */
 184   XrmDatabase xrdb;
 185
 186   /* Minimum width over all characters in all fonts in font_table.  */
 187   int smallest_char_width;
 188
 189   /* Minimum font height over all fonts in font_table.  */
 190   int smallest_font_height;
 191
 192   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 193   GC scratch_cursor_gc;
 194
 195   /* Information about the range of text currently shown in
 196      mouse-face.  */
 197   Mouse_HLInfo mouse_highlight;
 198
 199   char *x_id_name;
 200
 201   /* The number of fonts opened for this display.  */
 202   int n_fonts;
 203
 204   /* Pointer to bitmap records.  */
 205   struct x_bitmap_record *bitmaps;
 206
 207   /* Allocated size of bitmaps field.  */
 208   ptrdiff_t bitmaps_size;
 209
 210   /* Last used bitmap index.  */
 211   ptrdiff_t bitmaps_last;
 212
 213   /* Which modifier keys are on which modifier bits?
 214
 215      With each keystroke, X returns eight bits indicating which modifier
 216      keys were held down when the key was pressed.  The interpretation
 217      of the top five modifier bits depends on what keys are attached
 218      to them.  If the Meta_L and Meta_R keysyms are on mod5, then mod5
 219      is the meta bit.
 220
 221      meta_mod_mask is a mask containing the bits used for the meta key.
 222      It may have more than one bit set, if more than one modifier bit
 223      has meta keys on it.  Basically, if EVENT is a KeyPress event,
 224      the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
 225
 226      shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
 227      lock modifier bit, or zero otherwise.  Non-alphabetic keys should
 228      only be affected by the lock modifier bit if XK_Shift_Lock is in
 229      use; XK_Caps_Lock should only affect alphabetic keys.  With this
 230      arrangement, the lock modifier should shift the character if
 231      (EVENT.state & shift_lock_mask) != 0.  */
 232   int meta_mod_mask, shift_lock_mask;
 233
 234   /* These are like meta_mod_mask, but for different modifiers.  */
 235   int alt_mod_mask, super_mod_mask, hyper_mod_mask;
 236
 237   /* Communication with window managers.  */
 238   Atom Xatom_wm_protocols;
 239
 240   /* Kinds of protocol things we may receive.  */
 241   Atom Xatom_wm_take_focus;
 242   Atom Xatom_wm_save_yourself;
 243   Atom Xatom_wm_delete_window;
 244
 245   /* Atom for indicating window state to the window manager.  */
 246   Atom Xatom_wm_change_state;
 247
 248   /* Other WM communication */
 249   Atom Xatom_wm_configure_denied; /* When our config request is denied */
 250   Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
 251   Atom Xatom_wm_client_leader;    /* Id of client leader window.  */
 252
 253   /* EditRes protocol */
 254   Atom Xatom_editres;
 255
 256   /* More atoms, which are selection types.  */
 257   Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
 258   Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
 259   Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
 260   Xatom_ATOM, Xatom_ATOM_PAIR, Xatom_CLIPBOARD_MANAGER;
 261
 262   /* More atoms for font properties.  The last three are private
 263      properties, see the comments in src/fontset.h.  */
 264   Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
 265   Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
 266   Xatom_MULE_DEFAULT_ASCENT;
 267
 268   /* More atoms for Ghostscript support.  */
 269   Atom Xatom_DONE, Xatom_PAGE;
 270
 271   /* Atom used in toolkit scroll bar client messages.  */
 272   Atom Xatom_Scrollbar;
 273
 274   /* Atom used in XEmbed client messages.  */
 275   Atom Xatom_XEMBED, Xatom_XEMBED_INFO;
 276
 277   /* The frame (if any) which has the X window that has keyboard focus.
 278      Zero if none.  This is examined by Ffocus_frame in xfns.c.  Note
 279      that a mere EnterNotify event can set this; if you need to know the
 280      last frame specified in a FocusIn or FocusOut event, use
 281      x_focus_event_frame.  */
 282   struct frame *x_focus_frame;
 283
 284   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 285      separate from x_focus_frame, because whether or not LeaveNotify
 286      events cause us to lose focus depends on whether or not we have
 287      received a FocusIn event for it.  */
 288   struct frame *x_focus_event_frame;
 289
 290   /* The frame which currently has the visual highlight, and should get
 291      keyboard input (other sorts of input have the frame encoded in the
 292      event).  It points to the X focus frame's selected window's
 293      frame.  It differs from x_focus_frame when we're using a global
 294      minibuffer.  */
 295   struct frame *x_highlight_frame;
 296
 297   /* The gray pixmap.  */
 298   Pixmap gray;
 299
 300 #ifdef HAVE_X_I18N
 301   /* XIM (X Input method).  */
 302   XIM xim;
 303   XIMStyles *xim_styles;
 304   struct xim_inst_t *xim_callback_data;
 305 #endif
 306
 307   /* If non-null, a cache of the colors in the color map.  Don't
 308      use this directly, call x_color_cells instead.  */
 309   XColor *color_cells;
 310   int ncolor_cells;
 311
 312   /* Bits and shifts to use to compose pixel values on TrueColor visuals.  */
 313   int red_bits, blue_bits, green_bits;
 314   int red_offset, blue_offset, green_offset;
 315
 316   /* The type of window manager we have.  If we move FRAME_OUTER_WINDOW
 317      to x/y 0/0, some window managers (type A) puts the window manager
 318      decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
 319      Other window managers (type B) puts the window including decorations
 320      at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
 321      Record the type of WM in use so we can compensate for type A WMs.  */
 322   enum
 323     {
 324       X_WMTYPE_UNKNOWN,
 325       X_WMTYPE_A,
 326       X_WMTYPE_B
 327     } wm_type;
 328
 329
 330   /* Atoms that are drag and drop atoms */
 331   Atom *x_dnd_atoms;
 332   ptrdiff_t x_dnd_atoms_size;
 333   ptrdiff_t x_dnd_atoms_length;
 334
 335   /* Extended window manager hints, Atoms supported by the window manager and
 336      atoms for setting the window type.  */
 337   Atom Xatom_net_supported, Xatom_net_supporting_wm_check;
 338   Atom *net_supported_atoms;
 339   int nr_net_supported_atoms;
 340   Window net_supported_window;
 341   Atom Xatom_net_window_type, Xatom_net_window_type_tooltip;
 342   Atom Xatom_net_active_window;
 343
 344   /* Atoms dealing with EWMH (i.e. _NET_...) */
 345   Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen,
 346     Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
 347     Xatom_net_wm_state_sticky, Xatom_net_wm_state_hidden,
 348     Xatom_net_frame_extents;
 349
 350   /* XSettings atoms and windows.  */
 351   Atom Xatom_xsettings_sel, Xatom_xsettings_prop, Xatom_xsettings_mgr;
 352   Window xsettings_window;
 353
 354   /* Frame name and icon name */
 355   Atom Xatom_net_wm_name, Xatom_net_wm_icon_name;
 356   /* Frame opacity */
 357   Atom Xatom_net_wm_window_opacity;
 358
 359   /* SM */
 360   Atom Xatom_SM_CLIENT_ID;
 361 };
 362
 363 #ifdef HAVE_X_I18N
 364 /* Whether or not to use XIM if we have it.  */
 365 extern int use_xim;
 366 #endif
 367
 368 /* This checks to make sure we have a display.  */
 369
 370 extern void check_x (void);
 371
 372 extern struct frame *x_window_to_frame (struct x_display_info *, int);
 373 extern struct frame *x_any_window_to_frame (struct x_display_info *, int);
 374 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
 375                                                 XEvent *);
 376 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
 377
 378 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
 379                                                 XEvent *);
 380
 381 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
 382 #define x_any_window_to_frame x_window_to_frame
 383 #define x_top_window_to_frame x_window_to_frame
 384 #endif
 385
 386 /* This is a chain of structures for all the X displays currently in use.  */
 387 extern struct x_display_info *x_display_list;
 388
 389 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 390    one for each element of x_display_list and in the same order.
 391    NAME is the name of the frame.
 392    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 393 extern Lisp_Object x_display_name_list;
 394
 395 extern struct x_display_info *x_display_info_for_display (Display *);
 396
 397 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
 398 extern int x_display_ok  (const char *);
 399
 400 extern void select_visual (struct x_display_info *);
 401
 402 \f
 403 struct font;
 404
 405 /* Each X frame object points to its own struct x_output object
 406    in the output_data.x field.  The x_output structure contains
 407    the information that is specific to X windows.  */
 408
 409 struct x_output
 410 {
 411   /* Height of menu bar widget, in pixels.
 412      Zero if not using the X toolkit.
 413      When using the toolkit, this value is not meaningful
 414      if the menubar is turned off.  */
 415   int menubar_height;
 416
 417   /* Height of tool bar widget, in pixels.  top_height is used if tool bar
 418      at top, bottom_height if tool bar is at the bottom.
 419      Zero if not using an external tool bar or if tool bar is vertical.  */
 420   int toolbar_top_height, toolbar_bottom_height;
 421
 422   /* Width of tool bar widget, in pixels.  left_width is used if tool bar
 423      at left, right_width if tool bar is at the right.
 424      Zero if not using an external tool bar or if tool bar is horizontal.  */
 425   int toolbar_left_width, toolbar_right_width;
 426
 427   /* The tiled border used when the mouse is out of the frame.  */
 428   Pixmap border_tile;
 429
 430   /* Here are the Graphics Contexts for the default font.  */
 431   GC normal_gc;                         /* Normal video */
 432   GC reverse_gc;                        /* Reverse video */
 433   GC cursor_gc;                         /* cursor drawing */
 434
 435   /* The X window used for this frame.
 436      May be zero while the frame object is being created
 437      and the X window has not yet been created.  */
 438   Window window_desc;
 439
 440   /* The X window used for the bitmap icon;
 441      or 0 if we don't have a bitmap icon.  */
 442   Window icon_desc;
 443
 444   /* The X window that is the parent of this X window.
 445      Usually this is a window that was made by the window manager,
 446      but it can be the root window, and it can be explicitly specified
 447      (see the explicit_parent field, below).  */
 448   Window parent_desc;
 449
 450 #ifdef USE_X_TOOLKIT
 451   /* The widget of this screen.  This is the window of a "shell" widget.  */
 452   Widget widget;
 453   /* The XmPanedWindows...  */
 454   Widget column_widget;
 455   /* The widget of the edit portion of this screen; the window in
 456      "window_desc" is inside of this.  */
 457   Widget edit_widget;
 458
 459   Widget menubar_widget;
 460 #endif
 461
 462 #ifdef USE_GTK
 463   /* The widget of this screen.  This is the window of a top widget.  */
 464   GtkWidget *widget;
 465   /* The widget of the edit portion of this screen; the window in
 466      "window_desc" is inside of this.  */
 467   GtkWidget *edit_widget;
 468   /* The widget used for laying out widgets vertically.  */
 469   GtkWidget *vbox_widget;
 470   /* The widget used for laying out widgets horizontally.  */
 471   GtkWidget *hbox_widget;
 472   /* The menubar in this frame.  */
 473   GtkWidget *menubar_widget;
 474   /* The tool bar in this frame  */
 475   GtkWidget *toolbar_widget;
 476   /* The handle box that makes the tool bar detachable.  */
 477   GtkWidget *handlebox_widget;
 478   /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical).  */
 479   int toolbar_in_hbox;
 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 struct frame *check_x_frame (Lisp_Object);
 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 extern int x_in_use;
1012
1013 #ifdef USE_GTK
1014 extern int xg_set_icon (struct frame *, Lisp_Object);
1015 extern int xg_set_icon_from_xpm_data (struct frame *, const char**);
1016 #endif /* USE_GTK */
1017
1018 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1019 extern void xic_free_xfontset (struct frame *);
1020 extern void create_frame_xic (struct frame *);
1021 extern void destroy_frame_xic (struct frame *);
1022 extern void xic_set_preeditarea (struct window *, int, int);
1023 extern void xic_set_statusarea (struct frame *);
1024 extern void xic_set_xfontset (struct frame *, const char *);
1025 extern int x_pixel_width (struct frame *);
1026 extern int x_pixel_height (struct frame *);
1027 extern bool x_defined_color (struct frame *, const char *, XColor *, bool);
1028 #ifdef HAVE_X_I18N
1029 extern void free_frame_xic (struct frame *);
1030 # if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1031 extern char * xic_create_fontsetname (const char *base_fontname, int motif);
1032 # endif
1033 #endif
1034
1035 /* Defined in xfaces.c */
1036
1037 #ifdef USE_X_TOOLKIT
1038 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1039                                unsigned long *, int);
1040 #endif /* USE_X_TOOLKIT */
1041
1042 /* Defined in xmenu.c */
1043
1044 #if defined USE_GTK || defined USE_MOTIF
1045 extern void x_menu_set_in_use (int);
1046 #endif
1047 #ifdef USE_MOTIF
1048 extern void x_menu_wait_for_event (void *data);
1049 #endif
1050 extern int popup_activated (void);
1051 extern void initialize_frame_menubar (struct frame *);
1052
1053 /* Defined in widget.c */
1054
1055 #ifdef USE_X_TOOLKIT
1056 extern void widget_store_internal_border (Widget);
1057 #endif
1058
1059 /* Defined in xsmfns.c */
1060 #ifdef HAVE_X_SM
1061 extern void x_session_initialize (struct x_display_info *dpyinfo);
1062 extern int x_session_have_connection (void);
1063 extern void x_session_close (void);
1064 #endif
1065
1066 /* Defined in xterm.c */
1067
1068 extern Lisp_Object Qx_gtk_map_stock;
1069
1070 /* Is the frame embedded into another application? */
1071
1072 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1073
1074
1075 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1076 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1077
1078 #define STORE_XCHAR2B(chp, b1, b2) \
1079   ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1080
1081 #define XCHAR2B_BYTE1(chp) \
1082   ((chp)->byte1)
1083
1084 #define XCHAR2B_BYTE2(chp) \
1085   ((chp)->byte2)
1086
1087
1088 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight)      \
1089   ((nr).x = (rx),                                       \
1090    (nr).y = (ry),                                       \
1091    (nr).width = (rwidth),                               \
1092    (nr).height = (rheight))
1093
1094 #endif /* XTERM_H */