src/xterm.h

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