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