src/xterm.h

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