src/xterm.h

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