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