src/xterm.h

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