src/xterm.h

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