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