src/xterm.h

   1 /* Definitions and headers for communication with X protocol.
   2    Copyright (C) 1989, 1993, 1994 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #include <X11/Xlib.h>
  21 #include <X11/cursorfont.h>
  22 #include <X11/Xutil.h>
  23 #include <X11/keysym.h>
  24 #include <X11/Xatom.h>
  25 #include <X11/Xresource.h>
  26
  27 #ifdef USE_X_TOOLKIT
  28 #include <X11/StringDefs.h>
  29 #include <X11/IntrinsicP.h>     /* CoreP.h needs this */
  30 #include <X11/CoreP.h>          /* foul, but we need this to use our own
  31                                    window inside a widget instead of one
  32                                    that Xt creates... */
  33 #include <X11/StringDefs.h>
  34 #endif
  35
  36 /* The class of this X application.  */
  37 #define EMACS_CLASS "Emacs"
  38 \f
  39 /* Bookkeeping to distinguish X versions.  */
  40
  41 /* HAVE_X11R4 is defined if we have the features of X11R4.  It should
  42    be defined when we're using X11R5, since X11R5 has the features of
  43    X11R4.  If, in the future, we find we need more of these flags
  44    (HAVE_X11R5, for example), code should always be written to test
  45    the most recent flag first:
  46
  47       #ifdef HAVE_X11R5
  48         ...
  49       #elif HAVE_X11R4
  50         ...
  51       #elif HAVE_X11
  52         ...
  53       #endif
  54
  55    If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
  56    looks a lot like another one, consider moving the text into a macro
  57    whose definition is configuration-dependent, but whose usage is
  58    universal - like the stuff in systime.h.
  59
  60    It turns out that we can auto-detect whether we're being compiled
  61    with X11R3 or X11R4 by looking for the flag macros for R4 structure
  62    members that R3 doesn't have.  */
  63 #ifdef PBaseSize
  64 /* AIX 3.1's X is somewhere between X11R3 and X11R4.  It has
  65    PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
  66    XSetWMIconName.
  67    AIX 3.2 is at least X11R4.  */
  68 #if (!defined AIX) || (defined AIX3_2)
  69 #define HAVE_X11R4
  70 #endif
  71 #endif
  72
  73 #ifdef XlibSpecificationRelease
  74 #if XlibSpecificationRelease >= 5
  75 #define HAVE_X11R5
  76 /* In case someone has X11R5 on AIX 3.1,
  77    make sure HAVE_X11R4 is defined as well as HAVE_X11R5.  */
  78 #define HAVE_X11R4
  79 #endif
  80 #endif
  81 \f
  82 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
  83                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  84 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
  85                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  86
  87 #define FONT_WIDTH(f)   ((f)->max_bounds.width)
  88 #define FONT_HEIGHT(f)  ((f)->ascent + (f)->descent)
  89 #define FONT_BASE(f)    ((f)->ascent)
  90
  91 #define CHECK_X_FRAME(f, frame)                 \
  92   if (NILP (frame))                             \
  93     f = selected_frame;                         \
  94   else                                          \
  95     {                                           \
  96       CHECK_LIVE_FRAME (frame, 0);              \
  97       f = XFRAME (frame);                       \
  98     }                                           \
  99   if (! FRAME_X_P (f))
 100
 101
 102
 103 /* The mask of events that text windows always want to receive.  This
 104    does not include mouse movement events.  It is used when the window
 105    is created (in x_window) and and in selection processing.
 106
 107    We do include ButtonReleases in this set because Emacs isn't always
 108    fast enough to catch them when it wants them, and they're rare
 109    enough that they don't use much processor time.  */
 110
 111 #define STANDARD_EVENT_SET      \
 112   (KeyPressMask                 \
 113    | ExposureMask               \
 114    | ButtonPressMask            \
 115    | ButtonReleaseMask          \
 116    | PointerMotionMask          \
 117    | PointerMotionHintMask      \
 118    | StructureNotifyMask        \
 119    | FocusChangeMask            \
 120    | LeaveWindowMask            \
 121    | EnterWindowMask            \
 122    | VisibilityChangeMask)
 123
 124 /* This checks to make sure we have a display.  */
 125 extern void check_x ();
 126
 127 extern struct frame *x_window_to_frame ();
 128
 129 #ifdef USE_X_TOOLKIT
 130 extern struct frame *x_any_window_to_frame ();
 131 extern struct frame *x_top_window_to_frame ();
 132 #endif
 133
 134 /* The frame (if any) which has the X window that has keyboard focus.
 135    Zero if none.  This is examined by Ffocus_frame in xfns.c */
 136
 137 extern struct frame *x_focus_frame;
 138
 139 extern Visual *select_visual ();
 140
 141 enum text_cursor_kinds {
 142   filled_box_cursor, hollow_box_cursor, bar_cursor
 143 };
 144
 145 /* This data type is used for the font_table field
 146    of struct x_display_info.  */
 147
 148 struct font_info
 149 {
 150   XFontStruct *font;
 151   char *name;
 152   char *full_name;
 153 };
 154
 155 /* Structure recording X pixmap and reference count.
 156    If REFCOUNT is 0 then this record is free to be reused.  */
 157
 158 struct x_bitmap_record
 159 {
 160   Pixmap pixmap;
 161   char *file;
 162   int refcount;
 163   /* Record some info about this pixmap.  */
 164   int height, width, depth;
 165 };
 166 \f
 167 /* For each X display, we have a structure that records
 168    information about it.  */
 169
 170 struct x_display_info
 171 {
 172   /* Chain of all x_display_info structures.  */
 173   struct x_display_info *next;
 174   /* Connection number (normally a file descriptor number).  */
 175   int connection;
 176   /* This says how to access this display in Xlib.  */
 177   Display *display;
 178   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 179      The same cons cell also appears in x_display_name_list.  */
 180   Lisp_Object name_list_element;
 181   /* Number of frames that are on this display.  */
 182   int reference_count;
 183   /* The Screen this connection is connected to.  */
 184   Screen *screen;
 185   /* The Visual being used for this display.  */
 186   Visual *visual;
 187   /* Number of panes on this screen.  */
 188   int n_planes;
 189   /* Dimensions of this screen.  */
 190   int height, width;
 191   /* Mask of things that cause the mouse to be grabbed.  */
 192   int grabbed;
 193   /* Emacs bitmap-id of the default icon bitmap for this frame.
 194      Or -1 if none has been allocated yet.  */
 195   int icon_bitmap_id;
 196   /* The root window of this screen.  */
 197   Window root_window;
 198   /* The cursor to use for vertical scroll bars.  */
 199   Cursor vertical_scroll_bar_cursor;
 200   /* X Resource data base */
 201   XrmDatabase xrdb;
 202
 203   /* A table of all the fonts we have already loaded.  */
 204   struct font_info *font_table;
 205
 206   /* The current capacity of x_font_table.  */
 207   int font_table_size;
 208
 209   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 210   GC scratch_cursor_gc;
 211
 212   /* These variables describe the range of text currently shown
 213      in its mouse-face, together with the window they apply to.
 214      As long as the mouse stays within this range, we need not
 215      redraw anything on its account.  */
 216   int mouse_face_beg_row, mouse_face_beg_col;
 217   int mouse_face_end_row, mouse_face_end_col;
 218   int mouse_face_past_end;
 219   Lisp_Object mouse_face_window;
 220   int mouse_face_face_id;
 221
 222   /* 1 if a mouse motion event came and we didn't handle it right away because
 223      gc was in progress.  */
 224   int mouse_face_deferred_gc;
 225
 226   /* FRAME and X, Y position of mouse when last checked for
 227      highlighting.  X and Y can be negative or out of range for the frame.  */
 228   struct frame *mouse_face_mouse_frame;
 229   int mouse_face_mouse_x, mouse_face_mouse_y;
 230
 231   /* Nonzero means defer mouse-motion highlighting.  */
 232   int mouse_face_defer;
 233
 234   char *x_id_name;
 235
 236   /* The number of fonts actually stored in x_font_table.
 237      font_table[n] is used and valid iff 0 <= n < n_fonts.
 238      0 <= n_fonts <= font_table_size.  */
 239   int n_fonts;
 240
 241   /* Pointer to bitmap records.  */
 242   struct x_bitmap_record *bitmaps;
 243
 244   /* Allocated size of bitmaps field.  */
 245   int bitmaps_size;
 246
 247   /* Last used bitmap index.  */
 248   int bitmaps_last;
 249
 250   /* Which modifier keys are on which modifier bits?
 251
 252      With each keystroke, X returns eight bits indicating which modifier
 253      keys were held down when the key was pressed.  The interpretation
 254      of the top five modifier bits depends on what keys are attached
 255      to them.  If the Meta_L and Meta_R keysyms are on mod5, then mod5
 256      is the meta bit.
 257
 258      meta_mod_mask is a mask containing the bits used for the meta key.
 259      It may have more than one bit set, if more than one modifier bit
 260      has meta keys on it.  Basically, if EVENT is a KeyPress event,
 261      the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
 262
 263      shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
 264      lock modifier bit, or zero otherwise.  Non-alphabetic keys should
 265      only be affected by the lock modifier bit if XK_Shift_Lock is in
 266      use; XK_Caps_Lock should only affect alphabetic keys.  With this
 267      arrangement, the lock modifier should shift the character if
 268      (EVENT.state & shift_lock_mask) != 0.  */
 269   int meta_mod_mask, shift_lock_mask;
 270
 271   /* These are like meta_mod_mask, but for different modifiers.  */
 272   int alt_mod_mask, super_mod_mask, hyper_mod_mask;
 273
 274   /* Communication with window managers.  */
 275   Atom Xatom_wm_protocols;
 276   /* Kinds of protocol things we may receive.  */
 277   Atom Xatom_wm_take_focus;
 278   Atom Xatom_wm_save_yourself;
 279   Atom Xatom_wm_delete_window;
 280   /* Atom for indicating window state to the window manager.  */
 281   Atom Xatom_wm_change_state;
 282   /* Other WM communication */
 283   Atom Xatom_wm_configure_denied; /* When our config request is denied */
 284   Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
 285   /* EditRes protocol */
 286   Atom Xatom_editres;
 287
 288   /* More atoms, which are selection types.  */
 289   Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
 290   Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
 291   Xatom_ATOM_PAIR;
 292 };
 293
 294 /* This is a chain of structures for all the X displays currently in use.  */
 295 extern struct x_display_info *x_display_list;
 296
 297 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 298    one for each element of x_display_list and in the same order.
 299    NAME is the name of the frame.
 300    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 301 extern Lisp_Object x_display_name_list;
 302
 303 extern struct x_display_info *x_display_info_for_display ();
 304 extern struct x_display_info *x_display_info_for_name ();
 305
 306 extern struct x_display_info *x_term_init ();
 307 \f
 308 /* Each X frame object points to its own struct x_display object
 309    in the display.x field.  The x_display structure contains all
 310    the information that is specific to X windows.  */
 311
 312 struct x_display
 313 {
 314   /* Position of the X window (x and y offsets in root window).  */
 315   int left_pos;
 316   int top_pos;
 317
 318   /* Border width of the X window as known by the X window system.  */
 319   int border_width;
 320
 321   /* Size of the X window in pixels.  */
 322   int pixel_height, pixel_width;
 323
 324   /* Height of a line, in pixels.  */
 325   int line_height;
 326
 327   /* The tiled border used when the mouse is out of the frame.  */
 328   Pixmap border_tile;
 329
 330   /* Here are the Graphics Contexts for the default font.  */
 331   GC normal_gc;                         /* Normal video */
 332   GC reverse_gc;                        /* Reverse video */
 333   GC cursor_gc;                         /* cursor drawing */
 334
 335   /* Width of the internal border.  This is a line of background color
 336      just inside the window's border.  When the frame is selected,
 337      a highlighting is displayed inside the internal border.  */
 338   int internal_border_width;
 339
 340   /* The X window used for this frame.
 341      May be zero while the frame object is being created
 342      and the X window has not yet been created.  */
 343   Window window_desc;
 344
 345   /* The X window used for the bitmap icon;
 346      or 0 if we don't have a bitmap icon.  */
 347   Window icon_desc;
 348
 349   /* The X window that is the parent of this X window.
 350      Usually this is a window that was made by the window manager,
 351      but it can be the root window, and it can be explicitly specified
 352      (see the explicit_parent field, below).  */
 353   Window parent_desc;
 354
 355 #ifdef USE_X_TOOLKIT
 356   /* The widget of this screen.  This is the window of a "shell" widget.  */
 357   Widget widget;
 358   /* The XmPanedWindows...  */
 359   Widget column_widget;
 360   /* The widget of the edit portion of this screen; the window in
 361      "window_desc" is inside of this.  */
 362   Widget edit_widget;
 363
 364   Widget menubar_widget;
 365 #endif
 366
 367   /* If >=0, a bitmap index.  The indicated bitmap is used for the
 368      icon. */
 369   int icon_bitmap;
 370
 371   XFontStruct *font;
 372
 373   /* Pixel values used for various purposes.
 374      border_pixel may be -1 meaning use a gray tile.  */
 375   unsigned long background_pixel;
 376   unsigned long foreground_pixel;
 377   unsigned long cursor_pixel;
 378   unsigned long border_pixel;
 379   unsigned long mouse_pixel;
 380   unsigned long cursor_foreground_pixel;
 381
 382   /* Descriptor for the cursor in use for this window.  */
 383   Cursor text_cursor;
 384   Cursor nontext_cursor;
 385   Cursor modeline_cursor;
 386   Cursor cross_cursor;
 387
 388   /* The name that was associated with the icon, the last time
 389      it was refreshed.  Usually the same as the name of the
 390      buffer in the currently selected window in the frame */
 391   char *icon_label;
 392
 393   /* Flag to set when the X window needs to be completely repainted.  */
 394   int needs_exposure;
 395
 396   /* What kind of text cursor is drawn in this window right now?
 397      (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
 398   enum text_cursor_kinds current_cursor;
 399
 400   /* What kind of text cursor should we draw in the future?
 401      This should always be filled_box_cursor or bar_cursor.  */
 402   enum text_cursor_kinds desired_cursor;
 403
 404   /* These are the current window manager hints.  It seems that
 405      XSetWMHints, when presented with an unset bit in the `flags'
 406      member of the hints structure, does not leave the corresponding
 407      attribute unchanged; rather, it resets that attribute to its
 408      default value.  For example, unless you set the `icon_pixmap'
 409      field and the `IconPixmapHint' bit, XSetWMHints will forget what
 410      your icon pixmap was.  This is rather troublesome, since some of
 411      the members (for example, `input' and `icon_pixmap') want to stay
 412      the same throughout the execution of Emacs.  So, we keep this
 413      structure around, just leaving values in it and adding new bits
 414      to the mask as we go.  */
 415   XWMHints wm_hints;
 416
 417   /* The size of the extra width currently allotted for vertical
 418      scroll bars, in pixels.  */
 419   int vertical_scroll_bar_extra;
 420
 421   /* Table of parameter faces for this frame.  Any X resources (pixel
 422      values, fonts) referred to here have been allocated explicitly
 423      for this face, and should be freed if we change the face.  */
 424   struct face **param_faces;
 425   int n_param_faces;
 426
 427   /* Table of computed faces for this frame.  These are the faces
 428      whose indexes go into the upper bits of a glyph, computed by
 429      combining the parameter faces specified by overlays, text
 430      properties, and what have you.  The X resources mentioned here
 431      are all shared with parameter faces.  */
 432   struct face **computed_faces;
 433   int n_computed_faces;         /* How many are valid */
 434   int size_computed_faces;      /* How many are allocated */
 435
 436   /* This is the gravity value for the specified window position.  */
 437   int win_gravity;
 438
 439   /* The geometry flags for this window.  */
 440   int size_hint_flags;
 441
 442   /* This is the Emacs structure for the X display this frame is on.  */
 443   struct x_display_info *display_info;
 444
 445   /* Nonzero means our parent is another application's window
 446      and was explicitly specified.  */
 447   char explicit_parent;
 448 };
 449
 450 /* Get at the computed faces of an X window frame.  */
 451 #define FRAME_PARAM_FACES(f) ((f)->display.x->param_faces)
 452 #define FRAME_N_PARAM_FACES(f) ((f)->display.x->n_param_faces)
 453 #define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
 454 #define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
 455
 456 #define FRAME_COMPUTED_FACES(f) ((f)->display.x->computed_faces)
 457 #define FRAME_N_COMPUTED_FACES(f) ((f)->display.x->n_computed_faces)
 458 #define FRAME_SIZE_COMPUTED_FACES(f) ((f)->display.x->size_computed_faces)
 459 #define FRAME_DEFAULT_FACE(f) ((f)->display.x->computed_faces[0])
 460 #define FRAME_MODE_LINE_FACE(f) ((f)->display.x->computed_faces[1])
 461
 462 /* Return the window associated with the frame F.  */
 463 #define FRAME_X_WINDOW(f) ((f)->display.x->window_desc)
 464
 465 #define FRAME_FOREGROUND_PIXEL(f) ((f)->display.x->foreground_pixel)
 466 #define FRAME_BACKGROUND_PIXEL(f) ((f)->display.x->background_pixel)
 467 #define FRAME_FONT(f) ((f)->display.x->font)
 468
 469 /* This gives the x_display_info structure for the display F is on.  */
 470 #define FRAME_X_DISPLAY_INFO(f) ((f)->display.x->display_info)
 471
 472 /* This is the `Display *' which frame F is on.  */
 473 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
 474
 475 /* This is the `Screen *' which frame F is on.  */
 476 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 477
 478 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 479 #define PIXEL_WIDTH(f) ((f)->display.x->pixel_width)
 480 #define PIXEL_HEIGHT(f) ((f)->display.x->pixel_height)
 481
 482 #define FRAME_DESIRED_CURSOR(f) ((f)->display.x->desired_cursor)
 483
 484 \f
 485 /* X-specific scroll bar stuff.  */
 486
 487 /* We represent scroll bars as lisp vectors.  This allows us to place
 488    references to them in windows without worrying about whether we'll
 489    end up with windows referring to dead scroll bars; the garbage
 490    collector will free it when its time comes.
 491
 492    We use struct scroll_bar as a template for accessing fields of the
 493    vector.  */
 494
 495 struct scroll_bar {
 496
 497   /* These fields are shared by all vectors.  */
 498   EMACS_INT size_from_Lisp_Vector_struct;
 499   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 500
 501   /* The window we're a scroll bar for.  */
 502   Lisp_Object window;
 503
 504   /* The next and previous in the chain of scroll bars in this frame.  */
 505   Lisp_Object next, prev;
 506
 507   /* The X window representing this scroll bar.  Since this is a full
 508      32-bit quantity, we store it split into two 32-bit values.  */
 509   Lisp_Object x_window_low, x_window_high;
 510
 511   /* The position and size of the scroll bar in pixels, relative to the
 512      frame.  */
 513   Lisp_Object top, left, width, height;
 514
 515   /* The starting and ending positions of the handle, relative to the
 516      handle area (i.e. zero is the top position, not
 517      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 518      hasn't been drawn yet.
 519
 520      These are not actually the locations where the beginning and end
 521      are drawn; in order to keep handles from becoming invisible when
 522      editing large files, we establish a minimum height by always
 523      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 524      where they would be normally; the bottom and top are in a
 525      different co-ordinate system.  */
 526   Lisp_Object start, end;
 527
 528   /* If the scroll bar handle is currently being dragged by the user,
 529      this is the number of pixels from the top of the handle to the
 530      place where the user grabbed it.  If the handle isn't currently
 531      being dragged, this is Qnil.  */
 532   Lisp_Object dragging;
 533 };
 534
 535 /* The number of elements a vector holding a struct scroll_bar needs.  */
 536 #define SCROLL_BAR_VEC_SIZE                                     \
 537   ((sizeof (struct scroll_bar)                                  \
 538     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 539    / sizeof (Lisp_Object))
 540
 541 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 542 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 543
 544
 545 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 546 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 547
 548 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 549 #define SCROLL_BAR_UNPACK(low, high, int32) \
 550   (XSETINT ((low),   (int32)        & 0xffff), \
 551    XSETINT ((high), ((int32) >> 16) & 0xffff))
 552
 553
 554 /* Extract the X window id of the scroll bar from a struct scroll_bar.  */
 555 #define SCROLL_BAR_X_WINDOW(ptr) \
 556   ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
 557
 558 /* Store a window id in a struct scroll_bar.  */
 559 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
 560   (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
 561
 562
 563 /* Return the outside pixel height for a vertical scroll bar HEIGHT
 564    rows high on frame F.  */
 565 #define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
 566   ((height) * (f)->display.x->line_height)
 567
 568 /* Return the inside width of a vertical scroll bar, given the outside
 569    width.  */
 570 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
 571   ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
 572
 573 /* Return the length of the rectangle within which the top of the
 574    handle must stay.  This isn't equivalent to the inside height,
 575    because the scroll bar handle has a minimum height.
 576
 577    This is the real range of motion for the scroll bar, so when we're
 578    scaling buffer positions to scroll bar positions, we use this, not
 579    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 580 #define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
 581   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 582
 583 /* Return the inside height of vertical scroll bar, given the outside
 584    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 585 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
 586   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 587
 588
 589 /* Border widths for scroll bars.
 590
 591    Scroll bar windows don't have any X borders; their border width is
 592    set to zero, and we redraw borders ourselves.  This makes the code
 593    a bit cleaner, since we don't have to convert between outside width
 594    (used when relating to the rest of the screen) and inside width
 595    (used when sizing and drawing the scroll bar window itself).
 596
 597    The handle moves up and down/back and forth in a rectangle inset
 598    from the edges of the scroll bar.  These are widths by which we
 599    inset the handle boundaries from the scroll bar edges.  */
 600 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
 601 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
 602 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
 603 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
 604
 605 /* Minimum lengths for scroll bar handles, in pixels.  */
 606 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 607
 608 \f
 609 /* Manipulating pixel sizes and character sizes.
 610    Knowledge of which factors affect the overall size of the window should
 611    be hidden in these macros, if that's possible.
 612
 613    Return the upper/left pixel position of the character cell on frame F
 614    at ROW/COL.  */
 615 #define CHAR_TO_PIXEL_ROW(f, row) \
 616   ((f)->display.x->internal_border_width \
 617    + (row) * (f)->display.x->line_height)
 618 #define CHAR_TO_PIXEL_COL(f, col) \
 619   ((f)->display.x->internal_border_width \
 620    + (col) * FONT_WIDTH ((f)->display.x->font))
 621
 622 /* Return the pixel width/height of frame F if it has
 623    WIDTH columns/HEIGHT rows.  */
 624 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 625   (CHAR_TO_PIXEL_COL (f, width) \
 626    + (f)->display.x->vertical_scroll_bar_extra \
 627    + (f)->display.x->internal_border_width)
 628 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 629   (CHAR_TO_PIXEL_ROW (f, height) \
 630    + (f)->display.x->internal_border_width)
 631
 632
 633 /* Return the row/column (zero-based) of the character cell containing
 634    the pixel on FRAME at ROW/COL.  */
 635 #define PIXEL_TO_CHAR_ROW(f, row) \
 636   (((row) - (f)->display.x->internal_border_width) \
 637    / (f)->display.x->line_height)
 638 #define PIXEL_TO_CHAR_COL(f, col) \
 639   (((col) - (f)->display.x->internal_border_width) \
 640    / FONT_WIDTH ((f)->display.x->font))
 641
 642 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 643    frame F?  */
 644 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 645   (PIXEL_TO_CHAR_COL (f, ((width) \
 646                           - (f)->display.x->internal_border_width \
 647                           - (f)->display.x->vertical_scroll_bar_extra)))
 648 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 649   (PIXEL_TO_CHAR_ROW (f, ((height) \
 650                           - (f)->display.x->internal_border_width)))
 651 \f
 652 /* If a struct input_event has a kind which is selection_request_event
 653    or selection_clear_event, then its contents are really described
 654    by this structure.  */
 655
 656 /* For an event of kind selection_request_event,
 657    this structure really describes the contents.  */
 658 struct selection_input_event
 659 {
 660   int kind;
 661   Display *display;
 662   Window requestor;
 663   Atom selection, target, property;
 664   Time time;
 665 };
 666
 667 #define SELECTION_EVENT_DISPLAY(eventp) \
 668   (((struct selection_input_event *) (eventp))->display)
 669 #define SELECTION_EVENT_REQUESTOR(eventp)       \
 670   (((struct selection_input_event *) (eventp))->requestor)
 671 #define SELECTION_EVENT_SELECTION(eventp)       \
 672   (((struct selection_input_event *) (eventp))->selection)
 673 #define SELECTION_EVENT_TARGET(eventp)  \
 674   (((struct selection_input_event *) (eventp))->target)
 675 #define SELECTION_EVENT_PROPERTY(eventp)        \
 676   (((struct selection_input_event *) (eventp))->property)
 677 #define SELECTION_EVENT_TIME(eventp)    \
 678   (((struct selection_input_event *) (eventp))->time)
 679
 680 \f
 681 /* Interface to the face code functions.  */
 682
 683 /* Create the first two computed faces for a frame -- the ones that
 684    have GC's.  */
 685 extern void init_frame_faces (/* FRAME_PTR */);
 686
 687 /* Free the resources for the faces associated with a frame.  */
 688 extern void free_frame_faces (/* FRAME_PTR */);
 689
 690 /* Given a computed face, find or make an equivalent display face
 691    in face_vector, and return a pointer to it.  */
 692 extern struct face *intern_face (/* FRAME_PTR, struct face * */);
 693
 694 /* Given a frame and a face name, return the face's ID number, or
 695    zero if it isn't a recognized face name.  */
 696 extern int face_name_id_number (/* FRAME_PTR, Lisp_Object */);
 697
 698 /* Return non-zero if FONT1 and FONT2 have the same size bounding box.
 699    We assume that they're both character-cell fonts.  */
 700 extern int same_size_fonts (/* XFontStruct *, XFontStruct * */);
 701
 702 /* Recompute the GC's for the default and modeline faces.
 703    We call this after changing frame parameters on which those GC's
 704    depend.  */
 705 extern void recompute_basic_faces (/* FRAME_PTR */);
 706
 707 /* Return the face ID associated with a buffer position POS.  Store
 708    into *ENDPTR the next position at which a different face is
 709    needed.  This does not take account of glyphs that specify their
 710    own face codes.  F is the frame in use for display, and W is a
 711    window displaying the current buffer.
 712
 713    REGION_BEG, REGION_END delimit the region, so it can be highlighted.  */
 714 extern int compute_char_face (/* FRAME_PTR frame,
 715                                  struct window *w,
 716                                  int pos,
 717                                  int region_beg, int region_end,
 718                                  int *endptr */);
 719 /* Return the face ID to use to display a special glyph which selects
 720    FACE_CODE as the face ID, assuming that ordinarily the face would
 721    be BASIC_FACE.  F is the frame.  */
 722 extern int compute_glyph_face (/* FRAME_PTR, int */);