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