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