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