src/xterm.h

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