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_X11R5
  81 #define HAVE_X_I18N
  82 #include <X11/Xlocale.h>
  83 #endif
  84 \f
  85 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
  86                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  87 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
  88                                          XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
  89
  90 #define FONT_WIDTH(f)   ((f)->max_bounds.width)
  91 #define FONT_HEIGHT(f)  ((f)->ascent + (f)->descent)
  92 #define FONT_BASE(f)    ((f)->ascent)
  93
  94 /* The mask of events that text windows always want to receive.  This
  95    includes mouse movement events, since handling the mouse-font text property
  96    means that we must track mouse motion all the time.  */
  97
  98 #define STANDARD_EVENT_SET      \
  99   (KeyPressMask                 \
 100    | ExposureMask               \
 101    | ButtonPressMask            \
 102    | ButtonReleaseMask          \
 103    | PointerMotionMask          \
 104    | StructureNotifyMask        \
 105    | FocusChangeMask            \
 106    | LeaveWindowMask            \
 107    | EnterWindowMask            \
 108    | VisibilityChangeMask)
 109
 110 /* This checks to make sure we have a display.  */
 111 extern void check_x ();
 112
 113 extern struct frame *x_window_to_frame ();
 114
 115 #ifdef USE_X_TOOLKIT
 116 extern struct frame *x_any_window_to_frame ();
 117 extern struct frame *x_non_menubar_window_to_frame ();
 118 extern struct frame *x_top_window_to_frame ();
 119 #endif
 120
 121 extern Visual *select_visual ();
 122
 123 enum text_cursor_kinds
 124 {
 125   NO_CURSOR = -1,
 126   FILLED_BOX_CURSOR,
 127   HOLLOW_BOX_CURSOR,
 128   BAR_CURSOR
 129 };
 130
 131 /* Structure recording X pixmap and reference count.
 132    If REFCOUNT is 0 then this record is free to be reused.  */
 133
 134 struct x_bitmap_record
 135 {
 136   Pixmap pixmap;
 137   char *file;
 138   int refcount;
 139   /* Record some info about this pixmap.  */
 140   int height, width, depth;
 141 };
 142 \f
 143 /* For each X display, we have a structure that records
 144    information about it.  */
 145
 146 struct x_display_info
 147 {
 148   /* Chain of all x_display_info structures.  */
 149   struct x_display_info *next;
 150
 151   /* Connection number (normally a file descriptor number).  */
 152   int connection;
 153
 154   /* This says how to access this display in Xlib.  */
 155   Display *display;
 156
 157   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 158      The same cons cell also appears in x_display_name_list.  */
 159   Lisp_Object name_list_element;
 160
 161   /* Number of frames that are on this display.  */
 162   int reference_count;
 163
 164   /* The Screen this connection is connected to.  */
 165   Screen *screen;
 166
 167   /* Dots per inch of the screen.  */
 168   double resx, resy;
 169
 170   /* The Visual being used for this display.  */
 171   Visual *visual;
 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
 349 /* This is a chain of structures for all the X displays currently in use.  */
 350 extern struct x_display_info *x_display_list;
 351
 352 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 353    one for each element of x_display_list and in the same order.
 354    NAME is the name of the frame.
 355    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 356 extern Lisp_Object x_display_name_list;
 357
 358 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
 359 extern Lisp_Object Vx_pixel_size_width_font_regexp;
 360
 361 /* A flag to control how to display unibyte 8-bit character.  */
 362 extern int unibyte_display_via_language_environment;
 363
 364 struct x_display_info *x_display_info_for_display P_ ((Display *));
 365 struct x_display_info *x_display_info_for_name ();
 366
 367 extern struct x_display_info *x_term_init ();
 368
 369 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
 370
 371 extern struct font_info *x_get_font_info(), *x_load_font (), *x_query_font ();
 372 extern void x_find_ccl_program();
 373 \f
 374 /* Each X frame object points to its own struct x_output object
 375    in the output_data.x field.  The x_output structure contains
 376    the information that is specific to X windows.  */
 377
 378 struct x_output
 379 {
 380   /* Position of the X window (x and y offsets in root window).  */
 381   int left_pos;
 382   int top_pos;
 383
 384   /* Border width of the X window as known by the X window system.  */
 385   int border_width;
 386
 387   /* Size of the X window in pixels.  */
 388   int pixel_height, pixel_width;
 389
 390   /* Height of menu bar widget, in pixels.
 391      Zero if not using the X toolkit.
 392      When using the toolkit, this value is not meaningful
 393      if the menubar is turned off.  */
 394   int menubar_height;
 395
 396   /* Height of a line, in pixels.  */
 397   int line_height;
 398
 399   /* The tiled border used when the mouse is out of the frame.  */
 400   Pixmap border_tile;
 401
 402   /* Here are the Graphics Contexts for the default font.  */
 403   GC normal_gc;                         /* Normal video */
 404   GC reverse_gc;                        /* Reverse video */
 405   GC cursor_gc;                         /* cursor drawing */
 406
 407   /* Width of the internal border.  This is a line of background color
 408      just inside the window's border.  When the frame is selected,
 409      a highlighting is displayed inside the internal border.  */
 410   int internal_border_width;
 411
 412   /* The X window used for this frame.
 413      May be zero while the frame object is being created
 414      and the X window has not yet been created.  */
 415   Window window_desc;
 416
 417   /* The X window used for the bitmap icon;
 418      or 0 if we don't have a bitmap icon.  */
 419   Window icon_desc;
 420
 421   /* The X window that is the parent of this X window.
 422      Usually this is a window that was made by the window manager,
 423      but it can be the root window, and it can be explicitly specified
 424      (see the explicit_parent field, below).  */
 425   Window parent_desc;
 426
 427 #ifdef USE_X_TOOLKIT
 428   /* The widget of this screen.  This is the window of a "shell" widget.  */
 429   Widget widget;
 430   /* The XmPanedWindows...  */
 431   Widget column_widget;
 432   /* The widget of the edit portion of this screen; the window in
 433      "window_desc" is inside of this.  */
 434   Widget edit_widget;
 435
 436   Widget menubar_widget;
 437 #endif
 438
 439   /* If >=0, a bitmap index.  The indicated bitmap is used for the
 440      icon. */
 441   int icon_bitmap;
 442
 443   /* Default ASCII font of this frame.  */
 444   XFontStruct *font;
 445
 446   /* The baseline position of the default ASCII font.  */
 447   int font_baseline;
 448
 449   /* If a fontset is specified for this frame instead of font, this
 450      value contains an ID of the fontset, else -1.  */
 451   int fontset;
 452
 453   /* Pixel values used for various purposes.
 454      border_pixel may be -1 meaning use a gray tile.  */
 455   unsigned long background_pixel;
 456   unsigned long foreground_pixel;
 457   unsigned long cursor_pixel;
 458   unsigned long border_pixel;
 459   unsigned long mouse_pixel;
 460   unsigned long cursor_foreground_pixel;
 461
 462   /* Foreground color for scroll bars.  A value of -1 means use the
 463      default (black for non-toolkit scroll bars).  */
 464   unsigned long scroll_bar_foreground_pixel;
 465
 466   /* Background color for scroll bars.  A value of -1 means use the
 467      default (background color of the frame for non-toolkit scroll
 468      bars).  */
 469   unsigned long scroll_bar_background_pixel;
 470
 471   /* Descriptor for the cursor in use for this window.  */
 472   Cursor text_cursor;
 473   Cursor nontext_cursor;
 474   Cursor modeline_cursor;
 475   Cursor cross_cursor;
 476   Cursor busy_cursor;
 477
 478   /* Window whose cursor is busy_cursor.  This window is temporarily
 479      mapped to display a busy-cursor.  */
 480   Window busy_window;
 481
 482   /* Non-zero means busy cursor is currently displayed.  */
 483   unsigned busy_p : 1;
 484
 485   /* Flag to set when the X window needs to be completely repainted.  */
 486   int needs_exposure;
 487
 488   /* What kind of text cursor is drawn in this window right now?
 489      (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
 490   enum text_cursor_kinds current_cursor;
 491
 492   /* What kind of text cursor should we draw in the future?
 493      This should always be filled_box_cursor or bar_cursor.  */
 494   enum text_cursor_kinds desired_cursor;
 495
 496   /* Width of bar cursor (if we are using that).  */
 497   int cursor_width;
 498
 499   /* These are the current window manager hints.  It seems that
 500      XSetWMHints, when presented with an unset bit in the `flags'
 501      member of the hints structure, does not leave the corresponding
 502      attribute unchanged; rather, it resets that attribute to its
 503      default value.  For example, unless you set the `icon_pixmap'
 504      field and the `IconPixmapHint' bit, XSetWMHints will forget what
 505      your icon pixmap was.  This is rather troublesome, since some of
 506      the members (for example, `input' and `icon_pixmap') want to stay
 507      the same throughout the execution of Emacs.  So, we keep this
 508      structure around, just leaving values in it and adding new bits
 509      to the mask as we go.  */
 510   XWMHints wm_hints;
 511
 512   /* The size of the extra width currently allotted for vertical
 513      scroll bars, in pixels.  */
 514   int vertical_scroll_bar_extra;
 515
 516   /* The extra width currently allotted for the areas in which
 517      truncation marks, continuation marks, and overlay arrows are
 518      displayed.  */
 519   int flags_areas_extra;
 520
 521   /* This is the gravity value for the specified window position.  */
 522   int win_gravity;
 523
 524   /* The geometry flags for this window.  */
 525   int size_hint_flags;
 526
 527   /* This is the Emacs structure for the X display this frame is on.  */
 528   struct x_display_info *display_info;
 529
 530   /* This is a button event that wants to activate the menubar.
 531      We save it here until the command loop gets to think about it.  */
 532   XEvent *saved_menu_event;
 533
 534   /* This is the widget id used for this frame's menubar in lwlib.  */
 535 #ifdef USE_X_TOOLKIT
 536   int id;
 537 #endif
 538
 539   /* Nonzero means our parent is another application's window
 540      and was explicitly specified.  */
 541   char explicit_parent;
 542
 543   /* Nonzero means tried already to make this frame visible.  */
 544   char asked_for_visible;
 545
 546   /* Nonzero if this frame was ever previously visible.  */
 547   char has_been_visible;
 548
 549 #ifdef HAVE_X_I18N
 550   /* Input method. */
 551   XIM xim;
 552   /* Input context (currently, this means Compose key handler setup).  */
 553   XIC xic;
 554 #endif
 555
 556   /* Relief GCs, colors etc.  */
 557   struct relief
 558   {
 559     GC gc;
 560     unsigned long pixel;
 561     int allocated_p;
 562   }
 563   black_relief, white_relief;
 564
 565   /* The background for which the above relief GCs were set up.
 566      They are changed only when a different background is involved.  */
 567   unsigned long relief_background;
 568 };
 569
 570 /* Return the X window used for displaying data in frame F.  */
 571 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
 572
 573 /* Return the outermost X window associated with the frame F.  */
 574 #ifdef USE_X_TOOLKIT
 575 #define FRAME_OUTER_WINDOW(f) (XtWindow ((f)->output_data.x->widget))
 576 #else
 577 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
 578 #endif
 579
 580 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 581 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 582 #define FRAME_FONT(f) ((f)->output_data.x->font)
 583 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
 584 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
 585 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
 586
 587 /* Width of the default font of frame F.  Must be defined by each
 588    terminal specific header.  */
 589 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 590
 591 /* This gives the x_display_info structure for the display F is on.  */
 592 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
 593
 594 /* This is the `Display *' which frame F is on.  */
 595 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
 596
 597 /* This is the `Screen *' which frame F is on.  */
 598 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 599
 600 /* This is the 'font_info *' which frame F has.  */
 601 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
 602
 603 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 604 #define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
 605 #define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
 606
 607 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
 608
 609 #define FRAME_XIM(f) ((f)->output_data.x->xim)
 610 #define FRAME_XIC(f) ((f)->output_data.x->xic)
 611
 612 /* Value is the smallest width of any character in any font on frame F.  */
 613
 614 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 615      FRAME_X_DISPLAY_INFO(F)->smallest_char_width
 616
 617 /* Value is the smallest height of any font on frame F.  */
 618
 619 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 620      FRAME_X_DISPLAY_INFO(F)->smallest_font_height
 621
 622 /* Return a pointer to the image cache of frame F.  */
 623
 624 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
 625
 626 \f
 627 /* Pixel width of the bitmaps drawn to indicate truncation,
 628    continuation etc.  */
 629
 630 #define FRAME_FLAGS_BITMAP_WIDTH(f)     8
 631 #define FRAME_FLAGS_BITMAP_HEIGHT(f)    8
 632
 633 /* Total width of a areas reserved for drawing truncation bitmaps,
 634    continuation bitmaps and alike.  The width is in canonical char
 635    units of the frame.  This must currently be the case because window
 636    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 637    able to split windows horizontally nicely.  */
 638
 639 #define FRAME_X_FLAGS_AREA_COLS(F)                                      \
 640      ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1)     \
 641       / CANON_X_UNIT ((F)))
 642
 643 /* Total width of flags areas in pixels.  */
 644
 645 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
 646      (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
 647
 648 /* Pixel-width of the left flags area.  */
 649
 650 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
 651      (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 652
 653 /* Pixel-width of the right flags area.  Note that we are doing
 654    integer arithmetic here, so don't loose a pixel if the total
 655    width is an odd number.  */
 656
 657 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F)       \
 658      (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 659
 660
 661 \f
 662 /* X-specific scroll bar stuff.  */
 663
 664 /* We represent scroll bars as lisp vectors.  This allows us to place
 665    references to them in windows without worrying about whether we'll
 666    end up with windows referring to dead scroll bars; the garbage
 667    collector will free it when its time comes.
 668
 669    We use struct scroll_bar as a template for accessing fields of the
 670    vector.  */
 671
 672 struct scroll_bar {
 673
 674   /* These fields are shared by all vectors.  */
 675   EMACS_INT size_from_Lisp_Vector_struct;
 676   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 677
 678   /* The window we're a scroll bar for.  */
 679   Lisp_Object window;
 680
 681   /* The next and previous in the chain of scroll bars in this frame.  */
 682   Lisp_Object next, prev;
 683
 684   /* The X window representing this scroll bar.  Since this is a full
 685      32-bit quantity, we store it split into two 32-bit values.  */
 686   Lisp_Object x_window_low, x_window_high;
 687
 688   /* Same as above for the widget.  */
 689   Lisp_Object x_widget_low, x_widget_high;
 690
 691   /* The position and size of the scroll bar in pixels, relative to the
 692      frame.  */
 693   Lisp_Object top, left, width, height;
 694
 695   /* The starting and ending positions of the handle, relative to the
 696      handle area (i.e. zero is the top position, not
 697      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 698      hasn't been drawn yet.
 699
 700      These are not actually the locations where the beginning and end
 701      are drawn; in order to keep handles from becoming invisible when
 702      editing large files, we establish a minimum height by always
 703      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 704      where they would be normally; the bottom and top are in a
 705      different co-ordinate system.  */
 706   Lisp_Object start, end;
 707
 708   /* If the scroll bar handle is currently being dragged by the user,
 709      this is the number of pixels from the top of the handle to the
 710      place where the user grabbed it.  If the handle isn't currently
 711      being dragged, this is Qnil.  */
 712   Lisp_Object dragging;
 713 };
 714
 715 /* The number of elements a vector holding a struct scroll_bar needs.  */
 716 #define SCROLL_BAR_VEC_SIZE                                     \
 717   ((sizeof (struct scroll_bar)                                  \
 718     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 719    / sizeof (Lisp_Object))
 720
 721 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 722 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 723
 724
 725 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 726 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 727
 728 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 729 #define SCROLL_BAR_UNPACK(low, high, int32) \
 730   (XSETINT ((low),   (int32)        & 0xffff), \
 731    XSETINT ((high), ((int32) >> 16) & 0xffff))
 732
 733
 734 /* Extract the X window id of the scroll bar from a struct scroll_bar.  */
 735 #define SCROLL_BAR_X_WINDOW(ptr) \
 736   ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
 737
 738 /* Store a window id in a struct scroll_bar.  */
 739 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
 740   (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
 741
 742 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 743 #define SCROLL_BAR_X_WIDGET(ptr) \
 744   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 745
 746 /* Store a widget id in a struct scroll_bar.  */
 747 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 748   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 749
 750
 751 /* Return the inside width of a vertical scroll bar, given the outside
 752    width.  */
 753 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
 754   ((width) \
 755    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 756    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 757    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 758
 759 /* Return the length of the rectangle within which the top of the
 760    handle must stay.  This isn't equivalent to the inside height,
 761    because the scroll bar handle has a minimum height.
 762
 763    This is the real range of motion for the scroll bar, so when we're
 764    scaling buffer positions to scroll bar positions, we use this, not
 765    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 766 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
 767   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 768
 769 /* Return the inside height of vertical scroll bar, given the outside
 770    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 771 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
 772   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 773
 774
 775 /* Border widths for scroll bars.
 776
 777    Scroll bar windows don't have any X borders; their border width is
 778    set to zero, and we redraw borders ourselves.  This makes the code
 779    a bit cleaner, since we don't have to convert between outside width
 780    (used when relating to the rest of the screen) and inside width
 781    (used when sizing and drawing the scroll bar window itself).
 782
 783    The handle moves up and down/back and forth in a rectangle inset
 784    from the edges of the scroll bar.  These are widths by which we
 785    inset the handle boundaries from the scroll bar edges.  */
 786 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
 787 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
 788 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
 789 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
 790
 791 /* Minimum lengths for scroll bar handles, in pixels.  */
 792 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 793
 794 /* Trimming off a few pixels from each side prevents
 795    text from glomming up against the scroll bar */
 796 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 797
 798 \f
 799 /* Manipulating pixel sizes and character sizes.
 800    Knowledge of which factors affect the overall size of the window should
 801    be hidden in these macros, if that's possible.
 802
 803    Return the upper/left pixel position of the character cell on frame F
 804    at ROW/COL.  */
 805 #define CHAR_TO_PIXEL_ROW(f, row) \
 806   ((f)->output_data.x->internal_border_width \
 807    + (row) * (f)->output_data.x->line_height)
 808 #define CHAR_TO_PIXEL_COL(f, col) \
 809   ((f)->output_data.x->internal_border_width \
 810    + (col) * FONT_WIDTH ((f)->output_data.x->font))
 811
 812 /* Return the pixel width/height of frame F if it has
 813    WIDTH columns/HEIGHT rows.  */
 814 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 815   (CHAR_TO_PIXEL_COL (f, width) \
 816    + (f)->output_data.x->vertical_scroll_bar_extra \
 817    + (f)->output_data.x->flags_areas_extra \
 818    + (f)->output_data.x->internal_border_width)
 819 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 820   (CHAR_TO_PIXEL_ROW (f, height) \
 821    + (f)->output_data.x->internal_border_width)
 822
 823
 824 /* Return the row/column (zero-based) of the character cell containing
 825    the pixel on FRAME at ROW/COL.  */
 826 #define PIXEL_TO_CHAR_ROW(f, row) \
 827   (((row) - (f)->output_data.x->internal_border_width) \
 828    / (f)->output_data.x->line_height)
 829 #define PIXEL_TO_CHAR_COL(f, col) \
 830   (((col) - (f)->output_data.x->internal_border_width) \
 831    / FONT_WIDTH ((f)->output_data.x->font))
 832
 833 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 834    frame F?  */
 835 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 836   (PIXEL_TO_CHAR_COL (f, ((width) \
 837                           - (f)->output_data.x->internal_border_width \
 838                           - (f)->output_data.x->flags_areas_extra \
 839                           - (f)->output_data.x->vertical_scroll_bar_extra)))
 840 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 841   (PIXEL_TO_CHAR_ROW (f, ((height) \
 842                           - (f)->output_data.x->internal_border_width)))
 843
 844 \f
 845 /* If a struct input_event has a kind which is selection_request_event
 846    or selection_clear_event, then its contents are really described
 847    by this structure.  */
 848
 849 /* For an event of kind selection_request_event,
 850    this structure really describes the contents.
 851    **Don't make this struct longer!**
 852    If it overlaps the frame_or_window field of struct input_event,
 853    that will cause GC to crash.  */
 854 struct selection_input_event
 855 {
 856   int kind;
 857   Display *display;
 858   /* We spell it with an "o" here because X does.  */
 859   Window requestor;
 860   Atom selection, target, property;
 861   Time time;
 862 };
 863
 864 #define SELECTION_EVENT_DISPLAY(eventp) \
 865   (((struct selection_input_event *) (eventp))->display)
 866 /* We spell it with an "o" here because X does.  */
 867 #define SELECTION_EVENT_REQUESTOR(eventp)       \
 868   (((struct selection_input_event *) (eventp))->requestor)
 869 #define SELECTION_EVENT_SELECTION(eventp)       \
 870   (((struct selection_input_event *) (eventp))->selection)
 871 #define SELECTION_EVENT_TARGET(eventp)  \
 872   (((struct selection_input_event *) (eventp))->target)
 873 #define SELECTION_EVENT_PROPERTY(eventp)        \
 874   (((struct selection_input_event *) (eventp))->property)
 875 #define SELECTION_EVENT_TIME(eventp)    \
 876   (((struct selection_input_event *) (eventp))->time)
 877
 878 \f
 879 struct window;
 880 struct glyph_matrix;
 881 struct frame;
 882 struct input_event;
 883
 884 /* From xselect.c.  */
 885
 886 void x_handle_selection_notify P_ ((XSelectionEvent *));
 887 void x_handle_property_notify P_ ((XPropertyEvent *));
 888
 889 /* From xfns.c.  */
 890
 891 void x_real_positions P_ ((struct frame *, int *, int *));
 892 void x_destroy_bitmap P_ ((struct frame *, int));
 893 int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
 894 int x_create_bitmap_from_data P_ ((struct frame *, char *, unsigned,
 895                                    unsigned));
 896 void x_reference_bitmap P_ ((struct frame *, int));
 897 void x_sync P_ ((struct frame *));
 898 int x_bitmap_pixmap P_ ((struct frame *, int));
 899 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
 900 int x_bitmap_height P_ ((struct frame *, int));
 901 int x_bitmap_width P_ ((struct frame *, int));
 902 int defined_color P_ ((struct frame *, char *, XColor *, int));
 903 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
 904                                         Lisp_Object, Lisp_Object,
 905                                         Lisp_Object, Lisp_Object));
 906 struct frame *check_x_frame P_ ((Lisp_Object));
 907 EXFUN (Fx_display_color_p, 1);
 908 EXFUN (Fx_display_grayscale_p, 1);
 909
 910 /* From xrdb.c.  */
 911
 912 char *x_get_string_resource P_ ((XrmDatabase, char *, char *));
 913 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
 914 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
 915 int x_get_resource P_ ((XrmDatabase, char *, char *,
 916                         XrmRepresentation, XrmValue *));
 917 void x_delete_display P_ ((struct x_display_info *));
 918 void x_make_frame_visible P_ ((struct frame *));
 919 void x_iconify_frame P_ ((struct frame *));
 920 void x_wm_set_size_hint P_ ((struct frame *, long, int));
 921 void x_set_offset P_ ((struct frame *, int, int, int));
 922 void x_wm_set_icon_position P_ ((struct frame *, int, int));
 923 int x_catch_errors P_ ((Display *));
 924 int x_had_errors_p P_ ((Display *));
 925 void x_uncatch_errors P_ ((Display *, int));
 926 void x_check_errors P_ ((Display *, char *));
 927 int x_text_icon P_ ((struct frame *, char *));
 928 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
 929 void x_set_window_size P_ ((struct frame *, int, int, int));
 930 void x_wm_set_window_state P_ ((struct frame *, int));
 931 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
 932
 933 extern void pixel_to_glyph_coords P_ ((struct frame *, int, int,
 934                                        int *, int *, XRectangle *, int));
 935
 936 /* Defined in xterm.c */
 937
 938 extern void clear_mouse_face P_ ((struct x_display_info *));
 939 extern void cancel_mouse_face P_ ((struct frame *));
 940 extern void x_scroll_bar_clear P_ ((struct frame *));
 941 extern void x_start_queuing_selection_requests P_ ((Display *));
 942 extern void x_stop_queuing_selection_requests P_ ((Display *));
 943 extern void x_update_cursor P_ ((struct frame *, int));
 944 extern int x_text_icon P_ ((struct frame *, char *));
 945 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
 946 extern int x_catch_errors P_ ((Display *));
 947 extern void x_check_errors P_ ((Display *, char *));
 948 extern int x_had_errors_p P_ ((Display *));
 949 extern void x_uncatch_errors P_ ((Display *, int));
 950 extern Lisp_Object x_new_font P_ ((struct frame *, char *));
 951 extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
 952 extern void x_set_offset P_ ((struct frame *, int, int, int));
 953 extern void x_set_window_size P_ ((struct frame *, int, int, int));
 954 extern void x_set_mouse_position P_ ((struct frame *, int, int));
 955 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
 956 extern void x_raise_frame P_ ((struct frame *));
 957 extern void x_lower_frame P_ ((struct frame *));
 958 extern void x_make_frame_visible P_ ((struct frame *));
 959 extern void x_make_frame_invisible P_ ((struct frame *));
 960 extern void x_iconify_frame P_ ((struct frame *));
 961 extern void x_destroy_window P_ ((struct frame *));
 962 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
 963 extern void x_wm_set_window_state P_ ((struct frame *, int));
 964 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
 965 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
 966 extern void x_delete_display P_ ((struct x_display_info *));
 967 extern void x_initialize P_ ((void));
 968 void x_display_cursor P_ ((struct window *, int, int, int, int, int));
 969 void x_update_cursor P_ ((struct frame *, int));
 970
 971 /* Defined in xselect.c */
 972
 973 extern void x_handle_property_notify P_ ((XPropertyEvent *));
 974 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
 975 extern void x_handle_selection_request P_ ((struct input_event *));
 976 extern void x_handle_selection_clear P_ ((struct input_event *));
 977 extern void x_clear_frame_selections P_ ((struct frame *));
 978
 979 /* Defined in xfns.c */
 980
 981 extern int have_menus_p P_ ((void));
 982 extern int x_bitmap_height P_ ((struct frame *, int));
 983 extern int x_bitmap_width P_ ((struct frame *, int));
 984 extern int x_bitmap_pixmap P_ ((struct frame *, int));
 985 extern void x_reference_bitmap P_ ((struct frame *, int));
 986 extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
 987                                           unsigned int, unsigned int));
 988 extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
 989 extern void x_destroy_bitmap P_ ((struct frame *, int));
 990 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
 991 extern void x_real_positions P_ ((struct frame *, int *, int *));
 992 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
 993 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
 994 extern void x_set_border_pixel P_ ((struct frame *, int));
 995 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
 996 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
 997 extern int x_pixel_width P_ ((struct frame *));
 998 extern int x_pixel_height P_ ((struct frame *));
 999 extern int x_char_width P_ ((struct frame *));
1000 extern int x_char_height P_ ((struct frame *));
1001 extern int x_screen_planes P_ ((struct frame *));
1002 extern void x_sync P_ ((struct frame *));
1003
1004 /* Defined in xfaces.c */
1005
1006 extern int frame_update_line_height P_ ((struct frame *));
1007 extern int compute_glyph_face P_ ((struct frame *, int, int));
1008 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1009
1010 /* Defined in xmenu.c */
1011
1012 extern void x_activate_menubar P_ ((struct frame *));
1013 extern int popup_activated P_ ((void));
1014 extern void initialize_frame_menubar P_ ((struct frame *));
1015
1016 /* Defined in widget.c */
1017
1018 #ifdef USE_X_TOOLKIT
1019 extern void widget_store_internal_border P_ ((Widget));
1020 #endif