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 but not always RootWindow.  */
 351   Window parent_desc;
 352
 353 #ifdef USE_X_TOOLKIT
 354   /* The widget of this screen.  This is the window of a "shell" widget.  */
 355   Widget widget;
 356   /* The XmPanedWindows...  */
 357   Widget column_widget;
 358   /* The widget of the edit portion of this screen; the window in
 359      "window_desc" is inside of this.  */
 360   Widget edit_widget;
 361
 362   Widget menubar_widget;
 363 #endif
 364
 365   /* If >=0, a bitmap index.  The indicated bitmap is used for the
 366      icon. */
 367   int icon_bitmap;
 368
 369   XFontStruct *font;
 370
 371   /* Pixel values used for various purposes.
 372      border_pixel may be -1 meaning use a gray tile.  */
 373   unsigned long background_pixel;
 374   unsigned long foreground_pixel;
 375   unsigned long cursor_pixel;
 376   unsigned long border_pixel;
 377   unsigned long mouse_pixel;
 378   unsigned long cursor_foreground_pixel;
 379
 380   /* Descriptor for the cursor in use for this window.  */
 381   Cursor text_cursor;
 382   Cursor nontext_cursor;
 383   Cursor modeline_cursor;
 384   Cursor cross_cursor;
 385
 386   /* The name that was associated with the icon, the last time
 387      it was refreshed.  Usually the same as the name of the
 388      buffer in the currently selected window in the frame */
 389   char *icon_label;
 390
 391   /* Flag to set when the X window needs to be completely repainted.  */
 392   int needs_exposure;
 393
 394   /* What kind of text cursor is drawn in this window right now?
 395      (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
 396   enum text_cursor_kinds current_cursor;
 397
 398   /* What kind of text cursor should we draw in the future?
 399      This should always be filled_box_cursor or bar_cursor.  */
 400   enum text_cursor_kinds desired_cursor;
 401
 402   /* These are the current window manager hints.  It seems that
 403      XSetWMHints, when presented with an unset bit in the `flags'
 404      member of the hints structure, does not leave the corresponding
 405      attribute unchanged; rather, it resets that attribute to its
 406      default value.  For example, unless you set the `icon_pixmap'
 407      field and the `IconPixmapHint' bit, XSetWMHints will forget what
 408      your icon pixmap was.  This is rather troublesome, since some of
 409      the members (for example, `input' and `icon_pixmap') want to stay
 410      the same throughout the execution of Emacs.  So, we keep this
 411      structure around, just leaving values in it and adding new bits
 412      to the mask as we go.  */
 413   XWMHints wm_hints;
 414
 415   /* The size of the extra width currently allotted for vertical
 416      scroll bars, in pixels.  */
 417   int vertical_scroll_bar_extra;
 418
 419   /* Table of parameter faces for this frame.  Any X resources (pixel
 420      values, fonts) referred to here have been allocated explicitly
 421      for this face, and should be freed if we change the face.  */
 422   struct face **param_faces;
 423   int n_param_faces;
 424
 425   /* Table of computed faces for this frame.  These are the faces
 426      whose indexes go into the upper bits of a glyph, computed by
 427      combining the parameter faces specified by overlays, text
 428      properties, and what have you.  The X resources mentioned here
 429      are all shared with parameter faces.  */
 430   struct face **computed_faces;
 431   int n_computed_faces;         /* How many are valid */
 432   int size_computed_faces;      /* How many are allocated */
 433
 434   /* This is the gravity value for the specified window position.  */
 435   int win_gravity;
 436
 437   /* The geometry flags for this window.  */
 438   int size_hint_flags;
 439
 440   /* This is the Emacs structure for the X display this frame is on.  */
 441   struct x_display_info *display_info;
 442 };
 443
 444 /* Get at the computed faces of an X window frame.  */
 445 #define FRAME_PARAM_FACES(f) ((f)->display.x->param_faces)
 446 #define FRAME_N_PARAM_FACES(f) ((f)->display.x->n_param_faces)
 447 #define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
 448 #define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
 449
 450 #define FRAME_COMPUTED_FACES(f) ((f)->display.x->computed_faces)
 451 #define FRAME_N_COMPUTED_FACES(f) ((f)->display.x->n_computed_faces)
 452 #define FRAME_SIZE_COMPUTED_FACES(f) ((f)->display.x->size_computed_faces)
 453 #define FRAME_DEFAULT_FACE(f) ((f)->display.x->computed_faces[0])
 454 #define FRAME_MODE_LINE_FACE(f) ((f)->display.x->computed_faces[1])
 455
 456 /* Return the window associated with the frame F.  */
 457 #define FRAME_X_WINDOW(f) ((f)->display.x->window_desc)
 458
 459 #define FRAME_FOREGROUND_PIXEL(f) ((f)->display.x->foreground_pixel)
 460 #define FRAME_BACKGROUND_PIXEL(f) ((f)->display.x->background_pixel)
 461 #define FRAME_FONT(f) ((f)->display.x->font)
 462
 463 /* This gives the x_display_info structure for the display F is on.  */
 464 #define FRAME_X_DISPLAY_INFO(f) ((f)->display.x->display_info)
 465
 466 /* This is the `Display *' which frame F is on.  */
 467 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
 468
 469 /* This is the `Screen *' which frame F is on.  */
 470 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 471
 472 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 473 #define PIXEL_WIDTH(f) ((f)->display.x->pixel_width)
 474 #define PIXEL_HEIGHT(f) ((f)->display.x->pixel_height)
 475
 476 #define FRAME_DESIRED_CURSOR(f) ((f)->display.x->desired_cursor)
 477
 478 \f
 479 /* X-specific scroll bar stuff.  */
 480
 481 /* We represent scroll bars as lisp vectors.  This allows us to place
 482    references to them in windows without worrying about whether we'll
 483    end up with windows referring to dead scroll bars; the garbage
 484    collector will free it when its time comes.
 485
 486    We use struct scroll_bar as a template for accessing fields of the
 487    vector.  */
 488
 489 struct scroll_bar {
 490
 491   /* These fields are shared by all vectors.  */
 492   EMACS_INT size_from_Lisp_Vector_struct;
 493   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 494
 495   /* The window we're a scroll bar for.  */
 496   Lisp_Object window;
 497
 498   /* The next and previous in the chain of scroll bars in this frame.  */
 499   Lisp_Object next, prev;
 500
 501   /* The X window representing this scroll bar.  Since this is a full
 502      32-bit quantity, we store it split into two 32-bit values.  */
 503   Lisp_Object x_window_low, x_window_high;
 504
 505   /* The position and size of the scroll bar in pixels, relative to the
 506      frame.  */
 507   Lisp_Object top, left, width, height;
 508
 509   /* The starting and ending positions of the handle, relative to the
 510      handle area (i.e. zero is the top position, not
 511      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 512      hasn't been drawn yet.
 513
 514      These are not actually the locations where the beginning and end
 515      are drawn; in order to keep handles from becoming invisible when
 516      editing large files, we establish a minimum height by always
 517      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 518      where they would be normally; the bottom and top are in a
 519      different co-ordinate system.  */
 520   Lisp_Object start, end;
 521
 522   /* If the scroll bar handle is currently being dragged by the user,
 523      this is the number of pixels from the top of the handle to the
 524      place where the user grabbed it.  If the handle isn't currently
 525      being dragged, this is Qnil.  */
 526   Lisp_Object dragging;
 527 };
 528
 529 /* The number of elements a vector holding a struct scroll_bar needs.  */
 530 #define SCROLL_BAR_VEC_SIZE                                     \
 531   ((sizeof (struct scroll_bar)                                  \
 532     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 533    / sizeof (Lisp_Object))
 534
 535 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 536 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 537
 538
 539 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 540 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 541
 542 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 543 #define SCROLL_BAR_UNPACK(low, high, int32) \
 544   (XSETINT ((low),   (int32)        & 0xffff), \
 545    XSETINT ((high), ((int32) >> 16) & 0xffff))
 546
 547
 548 /* Extract the X window id of the scroll bar from a struct scroll_bar.  */
 549 #define SCROLL_BAR_X_WINDOW(ptr) \
 550   ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
 551
 552 /* Store a window id in a struct scroll_bar.  */
 553 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
 554   (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
 555
 556
 557 /* Return the outside pixel height for a vertical scroll bar HEIGHT
 558    rows high on frame F.  */
 559 #define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
 560   ((height) * (f)->display.x->line_height)
 561
 562 /* Return the inside width of a vertical scroll bar, given the outside
 563    width.  */
 564 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
 565   ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
 566
 567 /* Return the length of the rectangle within which the top of the
 568    handle must stay.  This isn't equivalent to the inside height,
 569    because the scroll bar handle has a minimum height.
 570
 571    This is the real range of motion for the scroll bar, so when we're
 572    scaling buffer positions to scroll bar positions, we use this, not
 573    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 574 #define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
 575   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 576
 577 /* Return the inside height of vertical scroll bar, given the outside
 578    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 579 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
 580   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 581
 582
 583 /* Border widths for scroll bars.
 584
 585    Scroll bar windows don't have any X borders; their border width is
 586    set to zero, and we redraw borders ourselves.  This makes the code
 587    a bit cleaner, since we don't have to convert between outside width
 588    (used when relating to the rest of the screen) and inside width
 589    (used when sizing and drawing the scroll bar window itself).
 590
 591    The handle moves up and down/back and forth in a rectangle inset
 592    from the edges of the scroll bar.  These are widths by which we
 593    inset the handle boundaries from the scroll bar edges.  */
 594 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
 595 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
 596 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
 597 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
 598
 599 /* Minimum lengths for scroll bar handles, in pixels.  */
 600 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 601
 602 \f
 603 /* Manipulating pixel sizes and character sizes.
 604    Knowledge of which factors affect the overall size of the window should
 605    be hidden in these macros, if that's possible.
 606
 607    Return the upper/left pixel position of the character cell on frame F
 608    at ROW/COL.  */
 609 #define CHAR_TO_PIXEL_ROW(f, row) \
 610   ((f)->display.x->internal_border_width \
 611    + (row) * (f)->display.x->line_height)
 612 #define CHAR_TO_PIXEL_COL(f, col) \
 613   ((f)->display.x->internal_border_width \
 614    + (col) * FONT_WIDTH ((f)->display.x->font))
 615
 616 /* Return the pixel width/height of frame F if it has
 617    WIDTH columns/HEIGHT rows.  */
 618 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 619   (CHAR_TO_PIXEL_COL (f, width) \
 620    + (f)->display.x->vertical_scroll_bar_extra \
 621    + (f)->display.x->internal_border_width)
 622 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 623   (CHAR_TO_PIXEL_ROW (f, height) \
 624    + (f)->display.x->internal_border_width)
 625
 626
 627 /* Return the row/column (zero-based) of the character cell containing
 628    the pixel on FRAME at ROW/COL.  */
 629 #define PIXEL_TO_CHAR_ROW(f, row) \
 630   (((row) - (f)->display.x->internal_border_width) \
 631    / (f)->display.x->line_height)
 632 #define PIXEL_TO_CHAR_COL(f, col) \
 633   (((col) - (f)->display.x->internal_border_width) \
 634    / FONT_WIDTH ((f)->display.x->font))
 635
 636 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 637    frame F?  */
 638 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 639   (PIXEL_TO_CHAR_COL (f, ((width) \
 640                           - (f)->display.x->internal_border_width \
 641                           - (f)->display.x->vertical_scroll_bar_extra)))
 642 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 643   (PIXEL_TO_CHAR_ROW (f, ((height) \
 644                           - (f)->display.x->internal_border_width)))
 645 \f
 646 /* If a struct input_event has a kind which is selection_request_event
 647    or selection_clear_event, then its contents are really described
 648    by this structure.  */
 649
 650 /* For an event of kind selection_request_event,
 651    this structure really describes the contents.  */
 652 struct selection_input_event
 653 {
 654   int kind;
 655   Display *display;
 656   Window requestor;
 657   Atom selection, target, property;
 658   Time time;
 659 };
 660
 661 #define SELECTION_EVENT_DISPLAY(eventp) \
 662   (((struct selection_input_event *) (eventp))->display)
 663 #define SELECTION_EVENT_REQUESTOR(eventp)       \
 664   (((struct selection_input_event *) (eventp))->requestor)
 665 #define SELECTION_EVENT_SELECTION(eventp)       \
 666   (((struct selection_input_event *) (eventp))->selection)
 667 #define SELECTION_EVENT_TARGET(eventp)  \
 668   (((struct selection_input_event *) (eventp))->target)
 669 #define SELECTION_EVENT_PROPERTY(eventp)        \
 670   (((struct selection_input_event *) (eventp))->property)
 671 #define SELECTION_EVENT_TIME(eventp)    \
 672   (((struct selection_input_event *) (eventp))->time)
 673
 674 \f
 675 /* Interface to the face code functions.  */
 676
 677 /* Create the first two computed faces for a frame -- the ones that
 678    have GC's.  */
 679 extern void init_frame_faces (/* FRAME_PTR */);
 680
 681 /* Free the resources for the faces associated with a frame.  */
 682 extern void free_frame_faces (/* FRAME_PTR */);
 683
 684 /* Given a computed face, find or make an equivalent display face
 685    in face_vector, and return a pointer to it.  */
 686 extern struct face *intern_face (/* FRAME_PTR, struct face * */);
 687
 688 /* Given a frame and a face name, return the face's ID number, or
 689    zero if it isn't a recognized face name.  */
 690 extern int face_name_id_number (/* FRAME_PTR, Lisp_Object */);
 691
 692 /* Return non-zero if FONT1 and FONT2 have the same size bounding box.
 693    We assume that they're both character-cell fonts.  */
 694 extern int same_size_fonts (/* XFontStruct *, XFontStruct * */);
 695
 696 /* Recompute the GC's for the default and modeline faces.
 697    We call this after changing frame parameters on which those GC's
 698    depend.  */
 699 extern void recompute_basic_faces (/* FRAME_PTR */);
 700
 701 /* Return the face ID associated with a buffer position POS.  Store
 702    into *ENDPTR the next position at which a different face is
 703    needed.  This does not take account of glyphs that specify their
 704    own face codes.  F is the frame in use for display, and W is a
 705    window displaying the current buffer.
 706
 707    REGION_BEG, REGION_END delimit the region, so it can be highlighted.  */
 708 extern int compute_char_face (/* FRAME_PTR frame,
 709                                  struct window *w,
 710                                  int pos,
 711                                  int region_beg, int region_end,
 712                                  int *endptr */);
 713 /* Return the face ID to use to display a special glyph which selects
 714    FACE_CODE as the face ID, assuming that ordinarily the face would
 715    be BASIC_FACE.  F is the frame.  */
 716 extern int compute_glyph_face (/* FRAME_PTR, int */);