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