xterm.h 38.3 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions and headers for communication with X protocol.
2
   Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000, 2001, 2001
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22 23 24 25 26 27 28

#include <X11/Xlib.h>
#include <X11/cursorfont.h>
#include <X11/Xutil.h>
#include <X11/keysym.h>
#include <X11/Xatom.h>
#include <X11/Xresource.h>

29 30 31 32 33 34 35 36 37
#ifdef USE_X_TOOLKIT
#include <X11/StringDefs.h>
#include <X11/IntrinsicP.h>	/* CoreP.h needs this */
#include <X11/CoreP.h>		/* foul, but we need this to use our own
				   window inside a widget instead of one 
				   that Xt creates... */
#include <X11/StringDefs.h>
#endif

38 39 40 41
/* The class of this X application.  */
#define EMACS_CLASS "Emacs"

/* Bookkeeping to distinguish X versions.  */
Jim Blandy's avatar
Jim Blandy committed
42

Jim Blandy's avatar
Jim Blandy committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/* HAVE_X11R4 is defined if we have the features of X11R4.  It should
   be defined when we're using X11R5, since X11R5 has the features of
   X11R4.  If, in the future, we find we need more of these flags
   (HAVE_X11R5, for example), code should always be written to test
   the most recent flag first:

      #ifdef HAVE_X11R5
        ...
      #elif HAVE_X11R4
        ...
      #elif HAVE_X11
        ...
      #endif

   If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
   looks a lot like another one, consider moving the text into a macro
   whose definition is configuration-dependent, but whose usage is
   universal - like the stuff in systime.h.

   It turns out that we can auto-detect whether we're being compiled
Jim Blandy's avatar
Jim Blandy committed
63 64 65
   with X11R3 or X11R4 by looking for the flag macros for R4 structure
   members that R3 doesn't have.  */
#ifdef PBaseSize
66 67
/* AIX 3.1's X is somewhere between X11R3 and X11R4.  It has
   PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
68 69 70
   XSetWMIconName.  
   AIX 3.2 is at least X11R4.  */
#if (!defined AIX) || (defined AIX3_2)
Jim Blandy's avatar
Jim Blandy committed
71 72
#define HAVE_X11R4
#endif
73
#endif
Jim Blandy's avatar
Jim Blandy committed
74

75
#ifdef HAVE_X11R5
76 77 78
/* In case someone has X11R5 on AIX 3.1,
   make sure HAVE_X11R4 is defined as well as HAVE_X11R5.  */
#define HAVE_X11R4
79
#endif
80

81
#ifdef HAVE_X_I18N
82 83
#include <X11/Xlocale.h>
#endif
84 85 86 87 88

#define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
					 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
#define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
					 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93 94

#define FONT_WIDTH(f)	((f)->max_bounds.width)
#define FONT_HEIGHT(f)	((f)->ascent + (f)->descent)
#define FONT_BASE(f)    ((f)->ascent)

/* The mask of events that text windows always want to receive.  This
95 96
   includes mouse movement events, since handling the mouse-font text property
   means that we must track mouse motion all the time.  */
Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101

#define STANDARD_EVENT_SET      \
  (KeyPressMask			\
   | ExposureMask		\
   | ButtonPressMask		\
Jim Blandy's avatar
Jim Blandy committed
102 103
   | ButtonReleaseMask		\
   | PointerMotionMask		\
Jim Blandy's avatar
Jim Blandy committed
104 105 106 107 108 109
   | StructureNotifyMask	\
   | FocusChangeMask		\
   | LeaveWindowMask		\
   | EnterWindowMask		\
   | VisibilityChangeMask)

110 111 112 113 114 115
enum text_cursor_kinds
{
  NO_CURSOR = -1,
  FILLED_BOX_CURSOR,
  HOLLOW_BOX_CURSOR,
  BAR_CURSOR
Jim Blandy's avatar
Jim Blandy committed
116
};
Richard M. Stallman's avatar
Richard M. Stallman committed
117 118 119 120 121 122 123 124 125 126 127 128

/* Structure recording X pixmap and reference count.
   If REFCOUNT is 0 then this record is free to be reused.  */

struct x_bitmap_record
{
  Pixmap pixmap;
  char *file;
  int refcount;
  /* Record some info about this pixmap.  */
  int height, width, depth;
};
129 130 131

/* For each X display, we have a structure that records
   information about it.  */
Jim Blandy's avatar
Jim Blandy committed
132

133
struct x_display_info
134
{
Richard M. Stallman's avatar
Richard M. Stallman committed
135
  /* Chain of all x_display_info structures.  */
136
  struct x_display_info *next;
137
  
138 139
  /* Connection number (normally a file descriptor number).  */
  int connection;
140
  
141
  /* This says how to access this display in Xlib.  */
142
  Display *display;
143
  
Richard M. Stallman's avatar
Richard M. Stallman committed
144 145 146
  /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
     The same cons cell also appears in x_display_name_list.  */
  Lisp_Object name_list_element;
147
  
148 149
  /* Number of frames that are on this display.  */
  int reference_count;
150
  
151 152
  /* The Screen this connection is connected to.  */
  Screen *screen;
153 154 155 156

  /* Dots per inch of the screen.  */
  double resx, resy;
  
157 158
  /* The Visual being used for this display.  */
  Visual *visual;
159 160 161

  /* THe colormap being used.  */
  Colormap cmap;
162
  
163 164
  /* Number of panes on this screen.  */
  int n_planes;
165
  
166 167
  /* Dimensions of this screen.  */
  int height, width;
168
  
169 170
  /* Mask of things that cause the mouse to be grabbed.  */
  int grabbed;
171
  
172 173 174
  /* Emacs bitmap-id of the default icon bitmap for this frame.
     Or -1 if none has been allocated yet.  */
  int icon_bitmap_id;
175
  
176 177
  /* The root window of this screen.  */
  Window root_window;
178
  
Richard M. Stallman's avatar
Richard M. Stallman committed
179 180
  /* The cursor to use for vertical scroll bars.  */
  Cursor vertical_scroll_bar_cursor;
181
  
182 183 184
  /* X Resource data base */
  XrmDatabase xrdb;

Richard M. Stallman's avatar
Richard M. Stallman committed
185 186 187 188 189 190
  /* A table of all the fonts we have already loaded.  */
  struct font_info *font_table;

  /* The current capacity of x_font_table.  */
  int font_table_size;

191 192 193 194 195 196
  /* Minimum width over all characters in all fonts in font_table.  */
  int smallest_char_width;

  /* Minimum font height over all fonts in font_table.  */
  int smallest_font_height;

Richard M. Stallman's avatar
Richard M. Stallman committed
197 198 199
  /* Reusable Graphics Context for drawing a cursor in a non-default face. */
  GC scratch_cursor_gc;

200 201 202 203 204
  /* These variables describe the range of text currently shown in its
     mouse-face, together with the window they apply to.  As long as
     the mouse stays within this range, we need not redraw anything on
     its account.  Rows and columns are glyph matrix positions in
     MOUSE_FACE_WINDOW.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
205
  int mouse_face_beg_row, mouse_face_beg_col;
206
  int mouse_face_beg_x, mouse_face_beg_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
207
  int mouse_face_end_row, mouse_face_end_col;
208
  int mouse_face_end_x, mouse_face_end_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
209 210 211
  int mouse_face_past_end;
  Lisp_Object mouse_face_window;
  int mouse_face_face_id;
212
  Lisp_Object mouse_face_overlay;
Richard M. Stallman's avatar
Richard M. Stallman committed
213 214 215 216 217 218 219 220 221 222 223 224 225

  /* 1 if a mouse motion event came and we didn't handle it right away because
     gc was in progress.  */
  int mouse_face_deferred_gc;

  /* FRAME and X, Y position of mouse when last checked for
     highlighting.  X and Y can be negative or out of range for the frame.  */
  struct frame *mouse_face_mouse_frame;
  int mouse_face_mouse_x, mouse_face_mouse_y;

  /* Nonzero means defer mouse-motion highlighting.  */
  int mouse_face_defer;

226 227
  int mouse_face_image_state;

Richard M. Stallman's avatar
Richard M. Stallman committed
228 229 230
  char *x_id_name;

  /* The number of fonts actually stored in x_font_table.
231 232
     font_table[n] is used and valid iff 0 <= n < n_fonts.  0 <=
     n_fonts <= font_table_size and font_table[i].name != 0.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
233 234 235 236 237 238 239 240 241 242 243
  int n_fonts;

  /* Pointer to bitmap records.  */
  struct x_bitmap_record *bitmaps;

  /* Allocated size of bitmaps field.  */
  int bitmaps_size;

  /* Last used bitmap index.  */
  int bitmaps_last;

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  /* Which modifier keys are on which modifier bits?

     With each keystroke, X returns eight bits indicating which modifier
     keys were held down when the key was pressed.  The interpretation
     of the top five modifier bits depends on what keys are attached
     to them.  If the Meta_L and Meta_R keysyms are on mod5, then mod5
     is the meta bit.

     meta_mod_mask is a mask containing the bits used for the meta key.
     It may have more than one bit set, if more than one modifier bit
     has meta keys on it.  Basically, if EVENT is a KeyPress event,
     the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.

     shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
     lock modifier bit, or zero otherwise.  Non-alphabetic keys should
     only be affected by the lock modifier bit if XK_Shift_Lock is in
     use; XK_Caps_Lock should only affect alphabetic keys.  With this
     arrangement, the lock modifier should shift the character if
     (EVENT.state & shift_lock_mask) != 0.  */
  int meta_mod_mask, shift_lock_mask;

  /* These are like meta_mod_mask, but for different modifiers.  */
  int alt_mod_mask, super_mod_mask, hyper_mod_mask;

  /* Communication with window managers.  */
  Atom Xatom_wm_protocols;
270
  
271 272 273 274
  /* Kinds of protocol things we may receive.  */
  Atom Xatom_wm_take_focus;
  Atom Xatom_wm_save_yourself;
  Atom Xatom_wm_delete_window;
275
  
276 277
  /* Atom for indicating window state to the window manager.  */
  Atom Xatom_wm_change_state;
278
  
279 280 281
  /* Other WM communication */
  Atom Xatom_wm_configure_denied; /* When our config request is denied */
  Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
282
  
283 284 285 286 287
  /* EditRes protocol */
  Atom Xatom_editres;

  /* More atoms, which are selection types.  */
  Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
288
  Xatom_COMPOUND_TEXT,
289 290
  Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
  Xatom_ATOM_PAIR;
291

292
  /* More atoms for font properties.  The last three are private
293 294
     properties, see the comments in src/fontset.h.  */
  Atom Xatom_PIXEL_SIZE,
295 296
  Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
  Xatom_MULE_DEFAULT_ASCENT;
297

298 299 300 301 302 303
  /* More atoms for Ghostscript support.  */
  Atom Xatom_DONE, Xatom_PAGE;

  /* Atom used in toolkit scroll bar client messages.  */
  Atom Xatom_Scrollbar;

304
#ifdef MULTI_KBOARD
305
  struct kboard *kboard;
306
#endif
307
  int cut_buffers_initialized; /* Whether we're sure they all exist */
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

  /* The frame (if any) which has the X window that has keyboard focus.
     Zero if none.  This is examined by Ffocus_frame in xfns.c.  Note
     that a mere EnterNotify event can set this; if you need to know the
     last frame specified in a FocusIn or FocusOut event, use
     x_focus_event_frame.  */
  struct frame *x_focus_frame;

  /* The last frame mentioned in a FocusIn or FocusOut event.  This is
     separate from x_focus_frame, because whether or not LeaveNotify
     events cause us to lose focus depends on whether or not we have
     received a FocusIn event for it.  */
  struct frame *x_focus_event_frame;

  /* The frame which currently has the visual highlight, and should get
     keyboard input (other sorts of input have the frame encoded in the
     event).  It points to the X focus frame's selected window's
     frame.  It differs from x_focus_frame when we're using a global
     minibuffer.  */
  struct frame *x_highlight_frame;
328 329 330 331

  /* The null pixel used for filling a character background with
     background color of a gc.  */
  Pixmap null_pixel;
332 333 334 335 336 337

  /* The gray pixmap.  */
  Pixmap gray;

  /* Cache of images.  */
  struct image_cache *image_cache;
338 339 340 341 342 343

#ifdef HAVE_X_I18N
  /* XIM (X Input method).  */
  XIM xim;
  XIMStyles *xim_styles;
#endif
344 345 346 347 348

  /* If non-null, a cache of the colors in the color map.  Don't
     use this directly, call x_color_cells instead.  */
  XColor *color_cells;
  int ncolor_cells;
349
};
350

Gerd Moellmann's avatar
Gerd Moellmann committed
351 352 353 354 355 356 357 358 359 360 361
/* This checks to make sure we have a display.  */
extern void check_x P_ ((void));

extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));

#ifdef USE_X_TOOLKIT
extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
#endif

362 363 364
/* This is a chain of structures for all the X displays currently in use.  */
extern struct x_display_info *x_display_list;

Richard M. Stallman's avatar
Richard M. Stallman committed
365 366 367 368 369 370
/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
   one for each element of x_display_list and in the same order.
   NAME is the name of the frame.
   FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
extern Lisp_Object x_display_name_list;

371 372 373
/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
extern Lisp_Object Vx_pixel_size_width_font_regexp;

374
/* A flag to control how to display unibyte 8-bit character.  */
375
extern int unibyte_display_via_language_environment;
376

Gerd Moellmann's avatar
Gerd Moellmann committed
377 378
extern struct x_display_info *x_display_info_for_display P_ ((Display *));
extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
379

Gerd Moellmann's avatar
Gerd Moellmann committed
380
extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
381

382
extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
383
extern void select_visual P_ ((struct x_display_info *));
Gerd Moellmann's avatar
Gerd Moellmann committed
384 385 386 387
extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
extern struct font_info *x_query_font P_ ((struct frame *, char *));
extern void x_find_ccl_program P_ ((struct font_info *));
388

389 390
/* Each X frame object points to its own struct x_output object
   in the output_data.x field.  The x_output structure contains
Jim Blandy's avatar
Jim Blandy committed
391 392
   the information that is specific to X windows.  */

393
struct x_output
Jim Blandy's avatar
Jim Blandy committed
394 395 396 397 398 399 400 401
{
  /* Position of the X window (x and y offsets in root window).  */
  int left_pos;
  int top_pos;

  /* Border width of the X window as known by the X window system.  */
  int border_width;

402
  /* Size of the X window in pixels.  */
Jim Blandy's avatar
Jim Blandy committed
403 404
  int pixel_height, pixel_width;

405 406 407 408 409 410
  /* Height of menu bar widget, in pixels.
     Zero if not using the X toolkit.
     When using the toolkit, this value is not meaningful
     if the menubar is turned off.  */
  int menubar_height;

411 412 413
  /* Height of a line, in pixels.  */
  int line_height;

414
  /* The tiled border used when the mouse is out of the frame.  */
Jim Blandy's avatar
Jim Blandy committed
415 416
  Pixmap border_tile;

417
  /* Here are the Graphics Contexts for the default font.  */
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422
  GC normal_gc;				/* Normal video */
  GC reverse_gc;			/* Reverse video */
  GC cursor_gc;				/* cursor drawing */

  /* Width of the internal border.  This is a line of background color
Jim Blandy's avatar
Jim Blandy committed
423
     just inside the window's border.  When the frame is selected,
Jim Blandy's avatar
Jim Blandy committed
424 425 426
     a highlighting is displayed inside the internal border.  */
  int internal_border_width;

Jim Blandy's avatar
Jim Blandy committed
427 428
  /* The X window used for this frame.
     May be zero while the frame object is being created
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433 434 435 436
     and the X window has not yet been created.  */
  Window window_desc;

  /* The X window used for the bitmap icon;
     or 0 if we don't have a bitmap icon.  */
  Window icon_desc;

  /* The X window that is the parent of this X window.
437 438 439
     Usually this is a window that was made by the window manager,
     but it can be the root window, and it can be explicitly specified
     (see the explicit_parent field, below).  */
Jim Blandy's avatar
Jim Blandy committed
440 441
  Window parent_desc;

442 443 444 445 446 447 448 449 450 451 452 453
#ifdef USE_X_TOOLKIT
  /* The widget of this screen.  This is the window of a "shell" widget.  */
  Widget widget;
  /* The XmPanedWindows...  */
  Widget column_widget;
  /* The widget of the edit portion of this screen; the window in
     "window_desc" is inside of this.  */
  Widget edit_widget;

  Widget menubar_widget;
#endif

454 455 456
  /* If >=0, a bitmap index.  The indicated bitmap is used for the
     icon. */
  int icon_bitmap;
Jim Blandy's avatar
Jim Blandy committed
457

458
  /* Default ASCII font of this frame.  */
459
  XFontStruct *font;
Jim Blandy's avatar
Jim Blandy committed
460

461 462
  /* The baseline offset of the default ASCII font.  */
  int baseline_offset;
463 464 465 466 467

  /* If a fontset is specified for this frame instead of font, this
     value contains an ID of the fontset, else -1.  */
  int fontset;

Jim Blandy's avatar
Jim Blandy committed
468 469
  /* Pixel values used for various purposes.
     border_pixel may be -1 meaning use a gray tile.  */
470 471 472 473 474 475
  unsigned long background_pixel;
  unsigned long foreground_pixel;
  unsigned long cursor_pixel;
  unsigned long border_pixel;
  unsigned long mouse_pixel;
  unsigned long cursor_foreground_pixel;
Jim Blandy's avatar
Jim Blandy committed
476

477 478 479 480 481 482 483 484 485
  /* Foreground color for scroll bars.  A value of -1 means use the
     default (black for non-toolkit scroll bars).  */
  unsigned long scroll_bar_foreground_pixel;
  
  /* Background color for scroll bars.  A value of -1 means use the
     default (background color of the frame for non-toolkit scroll
     bars).  */
  unsigned long scroll_bar_background_pixel;

486 487 488 489 490
  /* Top and bottom shadow colors for 3d toolkit scrollbars.  -1 means
     let the scroll compute them itself.  */
  unsigned long scroll_bar_top_shadow_pixel;
  unsigned long scroll_bar_bottom_shadow_pixel;

Jim Blandy's avatar
Jim Blandy committed
491 492 493 494
  /* Descriptor for the cursor in use for this window.  */
  Cursor text_cursor;
  Cursor nontext_cursor;
  Cursor modeline_cursor;
495
  Cursor cross_cursor;
496
  Cursor hourglass_cursor;
497
  Cursor horizontal_drag_cursor;
498

499 500 501
  /* Window whose cursor is hourglass_cursor.  This window is temporarily
     mapped to display an hourglass cursor.  */
  Window hourglass_window;
502
  
503 504
  /* Non-zero means hourglass cursor is currently displayed.  */
  unsigned hourglass_p : 1;
Jim Blandy's avatar
Jim Blandy committed
505

506
  /* Flag to set when the X window needs to be completely repainted.  */
Jim Blandy's avatar
Jim Blandy committed
507 508
  int needs_exposure;

Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515
  /* What kind of text cursor is drawn in this window right now?
     (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
  enum text_cursor_kinds current_cursor;

  /* What kind of text cursor should we draw in the future?
     This should always be filled_box_cursor or bar_cursor.  */
  enum text_cursor_kinds desired_cursor;
Jim Blandy's avatar
Jim Blandy committed
516

517 518 519
  /* Width of bar cursor (if we are using that).  */
  int cursor_width;

Jim Blandy's avatar
Jim Blandy committed
520 521 522 523 524 525 526 527 528 529 530 531
  /* These are the current window manager hints.  It seems that
     XSetWMHints, when presented with an unset bit in the `flags'
     member of the hints structure, does not leave the corresponding
     attribute unchanged; rather, it resets that attribute to its
     default value.  For example, unless you set the `icon_pixmap'
     field and the `IconPixmapHint' bit, XSetWMHints will forget what
     your icon pixmap was.  This is rather troublesome, since some of
     the members (for example, `input' and `icon_pixmap') want to stay
     the same throughout the execution of Emacs.  So, we keep this
     structure around, just leaving values in it and adding new bits
     to the mask as we go.  */
  XWMHints wm_hints;
532 533

  /* The size of the extra width currently allotted for vertical
534 535
     scroll bars, in pixels.  */
  int vertical_scroll_bar_extra;
536

537 538 539
  /* The extra width currently allotted for the areas in which
     truncation marks, continuation marks, and overlay arrows are
     displayed.  */
Kim F. Storm's avatar
Kim F. Storm committed
540
  int fringes_extra;
541 542 543

  /* This is the gravity value for the specified window position.  */
  int win_gravity;
544 545 546

  /* The geometry flags for this window.  */
  int size_hint_flags;
547 548

  /* This is the Emacs structure for the X display this frame is on.  */
549
  struct x_display_info *display_info;
550

551
  /* This is a button event that wants to activate the menubar.
552 553
     We save it here until the command loop gets to think about it.  */
  XEvent *saved_menu_event;
554 555 556 557 558 559

  /* This is the widget id used for this frame's menubar in lwlib.  */
#ifdef USE_X_TOOLKIT
  int id;
#endif

560 561 562
  /* Nonzero means our parent is another application's window
     and was explicitly specified.  */
  char explicit_parent;
563 564 565

  /* Nonzero means tried already to make this frame visible.  */
  char asked_for_visible;
566

567 568 569
  /* Nonzero if this frame was ever previously visible.  */
  char has_been_visible;

570 571 572
#ifdef HAVE_X_I18N
  /* Input context (currently, this means Compose key handler setup).  */
  XIC xic;
573 574
  XIMStyle xic_style;
  XFontSet xic_xfs;
575
#endif
576

577 578 579 580 581 582 583 584 585 586 587 588
  /* Relief GCs, colors etc.  */
  struct relief
  {
    GC gc;
    unsigned long pixel;
    int allocated_p;
  }
  black_relief, white_relief;

  /* The background for which the above relief GCs were set up.
     They are changed only when a different background is involved.  */
  unsigned long relief_background;
589 590 591 592 593 594 595

  /* Xt waits for a ConfigureNotify event from the window manager in
     EmacsFrameSetCharSize when the shell widget is resized.  For some
     window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
     arrive for an unknown reason and Emacs hangs in Xt.  If this is
     zero, tell Xt not to wait.  */
  int wait_for_wm;
596
};
597

598
/* Return the X window used for displaying data in frame F.  */
599
#define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
Jim Blandy's avatar
Jim Blandy committed
600

601 602 603 604 605 606 607
/* Return the outermost X window associated with the frame F.  */
#ifdef USE_X_TOOLKIT
#define FRAME_OUTER_WINDOW(f) (XtWindow ((f)->output_data.x->widget))
#else
#define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
#endif

608
#define FRAME_FONT(f) ((f)->output_data.x->font)
609
#define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
610
#define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
611
#define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
612
#define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
613

614 615 616 617
/* Width of the default font of frame F.  Must be defined by each
   terminal specific header.  */
#define FRAME_DEFAULT_FONT_WIDTH(F) 	FONT_WIDTH (FRAME_FONT (F))

618
/* This gives the x_display_info structure for the display F is on.  */
619
#define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
620 621

/* This is the `Display *' which frame F is on.  */
622 623 624 625
#define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)

/* This is the `Screen *' which frame F is on.  */
#define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
626
#define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
627

628 629 630 631 632 633
/* This is the Visual which frame F is on.  */
#define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual

/* This is the Colormap which frame F uses.  */
#define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap

634 635 636
/* This is the 'font_info *' which frame F has.  */
#define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)

Jim Blandy's avatar
Jim Blandy committed
637
/* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
638 639
#define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
#define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
Jim Blandy's avatar
Jim Blandy committed
640

641
#define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
Jim Blandy's avatar
Jim Blandy committed
642

643
#define FRAME_XIC(f) ((f)->output_data.x->xic)
644 645 646 647
#define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
#define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
#define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
#define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

/* Value is the smallest width of any character in any font on frame F.  */

#define FRAME_SMALLEST_CHAR_WIDTH(F) \
     FRAME_X_DISPLAY_INFO(F)->smallest_char_width

/* Value is the smallest height of any font on frame F.  */

#define FRAME_SMALLEST_FONT_HEIGHT(F) \
     FRAME_X_DISPLAY_INFO(F)->smallest_font_height

/* Return a pointer to the image cache of frame F.  */

#define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache


Kim F. Storm's avatar
Kim F. Storm committed
664
/* Pixel width of the fringe bitmaps drawn to indicate truncation,
665 666
   continuation etc.  */

Kim F. Storm's avatar
Kim F. Storm committed
667 668
#define FRAME_FRINGE_BITMAP_WIDTH(f)	8
#define FRAME_FRINGE_BITMAP_HEIGHT(f)	8
669

Kim F. Storm's avatar
Kim F. Storm committed
670
/* Total width of fringes reserved for drawing truncation bitmaps,
671 672 673 674 675
   continuation bitmaps and alike.  The width is in canonical char
   units of the frame.  This must currently be the case because window
   sizes aren't pixel values.  If it weren't the case, we wouldn't be
   able to split windows horizontally nicely.  */

Kim F. Storm's avatar
Kim F. Storm committed
676 677
#define FRAME_X_FRINGE_COLS(F)					\
     ((2 * FRAME_FRINGE_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1)	\
678 679
      / CANON_X_UNIT ((F)))

Kim F. Storm's avatar
Kim F. Storm committed
680
/* Total width of fringes in pixels.  */
681

Kim F. Storm's avatar
Kim F. Storm committed
682 683
#define FRAME_X_FRINGE_WIDTH(F) \
     (FRAME_X_FRINGE_COLS ((F)) * CANON_X_UNIT ((F)))
684

Kim F. Storm's avatar
Kim F. Storm committed
685
/* Pixel-width of the left fringe.  */
686

Kim F. Storm's avatar
Kim F. Storm committed
687 688
#define FRAME_X_LEFT_FRINGE_WIDTH(F) \
     (FRAME_X_FRINGE_WIDTH (F) / 2)
689

Kim F. Storm's avatar
Kim F. Storm committed
690
/* Pixel-width of the right fringe.  Note that we are doing
691 692 693
   integer arithmetic here, so don't loose a pixel if the total
   width is an odd number.  */

Kim F. Storm's avatar
Kim F. Storm committed
694 695
#define FRAME_X_RIGHT_FRINGE_WIDTH(F) 	\
     (FRAME_X_FRINGE_WIDTH (F) - FRAME_X_FRINGE_WIDTH (F) / 2)
696 697


698

699
/* X-specific scroll bar stuff.  */
700

701
/* We represent scroll bars as lisp vectors.  This allows us to place
702
   references to them in windows without worrying about whether we'll
703
   end up with windows referring to dead scroll bars; the garbage
704 705
   collector will free it when its time comes.

706
   We use struct scroll_bar as a template for accessing fields of the
707 708
   vector.  */

709 710
struct scroll_bar
{
711
  /* These fields are shared by all vectors.  */
712
  EMACS_INT size_from_Lisp_Vector_struct;
713 714
  struct Lisp_Vector *next_from_Lisp_Vector_struct;

715
  /* The window we're a scroll bar for.  */
716
  Lisp_Object window;
717

718
  /* The next and previous in the chain of scroll bars in this frame.  */
719
  Lisp_Object next, prev;
720

721
  /* The X window representing this scroll bar.  Since this is a full
722 723
     32-bit quantity, we store it split into two 32-bit values.  */
  Lisp_Object x_window_low, x_window_high;
724

725
  /* The position and size of the scroll bar in pixels, relative to the
726
     frame.  */
727
  Lisp_Object top, left, width, height;
728

729 730
  /* The starting and ending positions of the handle, relative to the
     handle area (i.e. zero is the top position, not
731
     SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
732
     hasn't been drawn yet.
733

734 735 736
     These are not actually the locations where the beginning and end
     are drawn; in order to keep handles from becoming invisible when
     editing large files, we establish a minimum height by always
737
     drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
738 739 740
     where they would be normally; the bottom and top are in a
     different co-ordinate system.  */
  Lisp_Object start, end;
741

742
  /* If the scroll bar handle is currently being dragged by the user,
743 744
     this is the number of pixels from the top of the handle to the
     place where the user grabbed it.  If the handle isn't currently
745 746
     being dragged, this is Qnil.  */
  Lisp_Object dragging;
747 748
};

749
/* The number of elements a vector holding a struct scroll_bar needs.  */
750 751 752
#define SCROLL_BAR_VEC_SIZE					\
  ((sizeof (struct scroll_bar)					\
    - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))	\
753 754
   / sizeof (Lisp_Object))

755
/* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
756
#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
757 758 759


/* Building a 32-bit C integer from two 16-bit lisp integers.  */
760
#define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
761 762

/* Setting two lisp integers to the low and high words of a 32-bit C int.  */
763
#define SCROLL_BAR_UNPACK(low, high, int32) \
764 765
  (XSETINT ((low),   (int32)        & 0xffff), \
   XSETINT ((high), ((int32) >> 16) & 0xffff))
766 767


768 769 770
/* Extract the X window id of the scroll bar from a struct scroll_bar.  */
#define SCROLL_BAR_X_WINDOW(ptr) \
  ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
771

772 773 774
/* Store a window id in a struct scroll_bar.  */
#define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
  (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
775

776 777 778 779 780 781
/* Extract the X widget of the scroll bar from a struct scroll_bar.
   XtWindowToWidget should be fast enough since Xt uses a hash table
   to map windows to widgets.  */

#define SCROLL_BAR_X_WIDGET(dpy, ptr) \
  XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
782 783

/* Store a widget id in a struct scroll_bar.  */
784 785 786 787 788 789

#define SET_SCROLL_BAR_X_WIDGET(ptr, w)		\
  do {						\
    Window window = XtWindow (w);		\
    SET_SCROLL_BAR_X_WINDOW (ptr, window);	\
} while (0)
790

791

792
/* Return the inside width of a vertical scroll bar, given the outside
793
   width.  */
794 795 796 797
#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
  ((width) \
   - VERTICAL_SCROLL_BAR_LEFT_BORDER \
   - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
798
   - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
799

800 801
/* Return the length of the rectangle within which the top of the
   handle must stay.  This isn't equivalent to the inside height,
802
   because the scroll bar handle has a minimum height.  
803

804 805 806
   This is the real range of motion for the scroll bar, so when we're
   scaling buffer positions to scroll bar positions, we use this, not
   VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
807 808
#define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
809

810 811
/* Return the inside height of vertical scroll bar, given the outside
   height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
812
#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
813
  ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
814 815


816
/* Border widths for scroll bars.
817

818
   Scroll bar windows don't have any X borders; their border width is
819 820 821
   set to zero, and we redraw borders ourselves.  This makes the code
   a bit cleaner, since we don't have to convert between outside width
   (used when relating to the rest of the screen) and inside width
822
   (used when sizing and drawing the scroll bar window itself).
823

824
   The handle moves up and down/back and forth in a rectangle inset
825 826 827
   from the edges of the scroll bar.  These are widths by which we
   inset the handle boundaries from the scroll bar edges.  */
#define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
828
#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
829 830
#define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
831

832 833
/* Minimum lengths for scroll bar handles, in pixels.  */
#define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
834

835
/* Trimming off a few pixels from each side prevents
836
   text from glomming up against the scroll bar */
837
#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
838

839 840 841 842 843

/* Manipulating pixel sizes and character sizes.
   Knowledge of which factors affect the overall size of the window should
   be hidden in these macros, if that's possible.

Karl Heuer's avatar
Karl Heuer committed
844
   Return the upper/left pixel position of the character cell on frame F
845 846
   at ROW/COL.  */
#define CHAR_TO_PIXEL_ROW(f, row) \
847 848
  ((f)->output_data.x->internal_border_width \
   + (row) * (f)->output_data.x->line_height)
849
#define CHAR_TO_PIXEL_COL(f, col) \
850 851
  ((f)->output_data.x->internal_border_width \
   + (col) * FONT_WIDTH ((f)->output_data.x->font))
852 853 854

/* Return the pixel width/height of frame F if it has
   WIDTH columns/HEIGHT rows.  */
855
#define CHAR_TO_PIXEL_WIDTH(f, width) \
856
  (CHAR_TO_PIXEL_COL (f, width) \
857
   + (f)->output_data.x->vertical_scroll_bar_extra \
Kim F. Storm's avatar
Kim F. Storm committed
858
   + (f)->output_data.x->fringes_extra \
859
   + (f)->output_data.x->internal_border_width)
860
#define CHAR_TO_PIXEL_HEIGHT(f, height) \
861
  (CHAR_TO_PIXEL_ROW (f, height) \
862
   + (f)->output_data.x->internal_border_width)
863 864


865 866
/* Return the row/column (zero-based) of the character cell containing 
   the pixel on FRAME at ROW/COL.  */
867
#define PIXEL_TO_CHAR_ROW(f, row) \
868 869
  (((row) - (f)->output_data.x->internal_border_width) \
   / (f)->output_data.x->line_height)
870
#define PIXEL_TO_CHAR_COL(f, col) \
871 872
  (((col) - (f)->output_data.x->internal_border_width) \
   / FONT_WIDTH ((f)->output_data.x->font))
873

874 875 876 877
/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
   frame F?  */
#define PIXEL_TO_CHAR_WIDTH(f, width) \
  (PIXEL_TO_CHAR_COL (f, ((width) \
878
			  - (f)->output_data.x->internal_border_width \
Kim F. Storm's avatar
Kim F. Storm committed
879
			  - (f)->output_data.x->fringes_extra \
880
			  - (f)->output_data.x->vertical_scroll_bar_extra)))
881 882
#define PIXEL_TO_CHAR_HEIGHT(f, height) \
  (PIXEL_TO_CHAR_ROW (f, ((height) \
883
			  - (f)->output_data.x->internal_border_width)))
884

885 886 887 888 889 890

/* If a struct input_event has a kind which is selection_request_event
   or selection_clear_event, then its contents are really described
   by this structure.  */

/* For an event of kind selection_request_event,
Richard M. Stallman's avatar
Richard M. Stallman committed
891 892 893 894
   this structure really describes the contents.
   **Don't make this struct longer!**
   If it overlaps the frame_or_window field of struct input_event,
   that will cause GC to crash.  */
895 896 897 898
struct selection_input_event
{
  int kind;
  Display *display;
Richard M. Stallman's avatar
Richard M. Stallman committed
899 900
  /* We spell it with an "o" here because X does.  */
  Window requestor;
901 902 903 904 905 906
  Atom selection, target, property;
  Time time;
};

#define SELECTION_EVENT_DISPLAY(eventp)	\
  (((struct selection_input_event *) (eventp))->display)
Richard M. Stallman's avatar
Richard M. Stallman committed
907 908 909
/* We spell it with an "o" here because X does.  */
#define SELECTION_EVENT_REQUESTOR(eventp)	\
  (((struct selection_input_event *) (eventp))->requestor)
910 911 912 913 914 915 916 917
#define SELECTION_EVENT_SELECTION(eventp)	\
  (((struct selection_input_event *) (eventp))->selection)
#define SELECTION_EVENT_TARGET(eventp)	\
  (((struct selection_input_event *) (eventp))->target)
#define SELECTION_EVENT_PROPERTY(eventp)	\
  (((struct selection_input_event *) (eventp))->property)
#define SELECTION_EVENT_TIME(eventp)	\
  (((struct selection_input_event *) (eventp))->time)
918 919


Andreas Schwab's avatar
Andreas Schwab committed
920
struct window;
921 922
struct glyph_matrix;
struct frame;
Andreas Schwab's avatar
Andreas Schwab committed
923
struct input_event;
924 925
struct face;
struct image;
Andreas Schwab's avatar
Andreas Schwab committed
926

927 928 929 930 931 932 933 934 935 936 937 938 939
/* From xselect.c.  */

void x_handle_selection_notify P_ ((XSelectionEvent *));
void x_handle_property_notify P_ ((XPropertyEvent *));

/* From xfns.c.  */

Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
					Lisp_Object, Lisp_Object,
					Lisp_Object, Lisp_Object));
struct frame *check_x_frame P_ ((Lisp_Object));
EXFUN (Fx_display_color_p, 1);
EXFUN (Fx_display_grayscale_p, 1);
940
int image_ascent P_ ((struct image *, struct face *));
Gerd Moellmann's avatar
Gerd Moellmann committed
941
extern void x_free_gcs P_ ((struct frame *));
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963

/* From xrdb.c.  */

char *x_get_string_resource P_ ((XrmDatabase, char *, char *));
char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
int x_get_resource P_ ((XrmDatabase, char *, char *,
			XrmRepresentation, XrmValue *));
void x_delete_display P_ ((struct x_display_info *));
void x_make_frame_visible P_ ((struct frame *));
void x_iconify_frame P_ ((struct frame *));
void x_wm_set_size_hint P_ ((struct frame *, long, int));
void x_set_offset P_ ((struct frame *, int, int, int));
void x_wm_set_icon_position P_ ((struct frame *, int, int));
int x_catch_errors P_ ((Display *));
int x_had_errors_p P_ ((Display *));
void x_uncatch_errors P_ ((Display *, int));
void x_check_errors P_ ((Display *, char *));
int x_text_icon P_ ((struct frame *, char *));
int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
void x_set_window_size P_ ((struct frame *, int, int, int));
void x_wm_set_window_state P_ ((struct frame *, int));
964
int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
965 966 967

extern void pixel_to_glyph_coords P_ ((struct frame *, int, int,
				       int *, int *, XRectangle *, int));
Andreas Schwab's avatar
Andreas Schwab committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

/* Defined in xterm.c */

extern void cancel_mouse_face P_ ((struct frame *));
extern void x_scroll_bar_clear P_ ((struct frame *));
extern void x_start_queuing_selection_requests P_ ((Display *));
extern void x_stop_queuing_selection_requests P_ ((Display *));
extern void x_update_cursor P_ ((struct frame *, int));
extern int x_text_icon P_ ((struct frame *, char *));
extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
extern int x_catch_errors P_ ((Display *));
extern void x_check_errors P_ ((Display *, char *));
extern int x_had_errors_p P_ ((Display *));
extern void x_uncatch_errors P_ ((Display *, int));
extern Lisp_Object x_new_font P_ ((struct frame *, char *));
extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
extern void x_set_offset P_ ((struct frame *, int, int, int));
extern void x_set_window_size P_ ((struct frame *, int, int, int));
extern void x_set_mouse_position P_ ((struct frame *, int, int));
extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
extern void x_raise_frame P_ ((struct frame *));
extern void x_lower_frame P_ ((struct frame *));
extern void x_make_frame_visible P_ ((struct frame *));
extern void x_make_frame_invisible P_ ((struct frame *));
extern void x_iconify_frame P_ ((struct frame *));
993
extern void x_free_frame_resources P_ ((struct frame *));
Andreas Schwab's avatar
Andreas Schwab committed
994 995 996 997 998 999 1000
extern void x_destroy_window P_ ((struct frame *));
extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
extern void x_wm_set_window_state P_ ((struct frame *, int));
extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
extern void x_delete_display P_ ((struct x_display_info *));
extern void x_initialize P_ ((void));
1001 1002
extern void x_display_cursor P_ ((struct window *, int, int, int, int, int));
extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));