src/xterm.h

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