xterm.h 39.6 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
enum text_cursor_kinds
{
  NO_CURSOR = -1,
  FILLED_BOX_CURSOR,
  HOLLOW_BOX_CURSOR,
115 116
  BAR_CURSOR,
  HBAR_CURSOR
Jim Blandy's avatar
Jim Blandy committed
117
};
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119 120 121 122 123 124 125 126 127 128 129

/* 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;
};
130 131 132

/* For each X display, we have a structure that records
   information about it.  */
Jim Blandy's avatar
Jim Blandy committed
133

134
struct x_display_info
135
{
Richard M. Stallman's avatar
Richard M. Stallman committed
136
  /* Chain of all x_display_info structures.  */
137
  struct x_display_info *next;
138
  
139 140
  /* Connection number (normally a file descriptor number).  */
  int connection;
141
  
142
  /* This says how to access this display in Xlib.  */
143
  Display *display;
144
  
Richard M. Stallman's avatar
Richard M. Stallman committed
145 146 147
  /* 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;
148
  
149 150
  /* Number of frames that are on this display.  */
  int reference_count;
151
  
152 153
  /* The Screen this connection is connected to.  */
  Screen *screen;
154 155 156 157

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
186 187 188 189 190 191
  /* 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;

192 193 194 195 196 197
  /* 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
198 199 200
  /* Reusable Graphics Context for drawing a cursor in a non-default face. */
  GC scratch_cursor_gc;

201 202 203 204 205
  /* 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
206
  int mouse_face_beg_row, mouse_face_beg_col;
207
  int mouse_face_beg_x, mouse_face_beg_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
208
  int mouse_face_end_row, mouse_face_end_col;
209
  int mouse_face_end_x, mouse_face_end_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211 212
  int mouse_face_past_end;
  Lisp_Object mouse_face_window;
  int mouse_face_face_id;
213
  Lisp_Object mouse_face_overlay;
Richard M. Stallman's avatar
Richard M. Stallman committed
214 215 216 217 218 219 220 221 222 223 224 225 226

  /* 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;

227 228 229
  /* Nonzero means that the mouse highlight should not be shown.  */
  int mouse_face_hidden;

230 231
  int mouse_face_image_state;

Richard M. Stallman's avatar
Richard M. Stallman committed
232 233 234
  char *x_id_name;

  /* The number of fonts actually stored in x_font_table.
235 236
     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
237 238 239 240 241 242 243 244 245 246 247
  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;

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
  /* 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;
274
  
275 276 277 278
  /* Kinds of protocol things we may receive.  */
  Atom Xatom_wm_take_focus;
  Atom Xatom_wm_save_yourself;
  Atom Xatom_wm_delete_window;
279
  
280 281
  /* Atom for indicating window state to the window manager.  */
  Atom Xatom_wm_change_state;
282
  
283 284 285
  /* Other WM communication */
  Atom Xatom_wm_configure_denied; /* When our config request is denied */
  Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
286
  
287 288 289 290 291
  /* EditRes protocol */
  Atom Xatom_editres;

  /* More atoms, which are selection types.  */
  Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
292
  Xatom_COMPOUND_TEXT,
293 294
  Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
  Xatom_ATOM_PAIR;
295

296
  /* More atoms for font properties.  The last three are private
297 298
     properties, see the comments in src/fontset.h.  */
  Atom Xatom_PIXEL_SIZE,
299 300
  Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
  Xatom_MULE_DEFAULT_ASCENT;
301

302 303 304 305 306 307
  /* More atoms for Ghostscript support.  */
  Atom Xatom_DONE, Xatom_PAGE;

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

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

  /* 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;
332 333 334 335

  /* The null pixel used for filling a character background with
     background color of a gc.  */
  Pixmap null_pixel;
336 337 338 339 340 341

  /* The gray pixmap.  */
  Pixmap gray;

  /* Cache of images.  */
  struct image_cache *image_cache;
342 343 344 345 346 347

#ifdef HAVE_X_I18N
  /* XIM (X Input method).  */
  XIM xim;
  XIMStyles *xim_styles;
#endif
348 349 350 351 352

  /* 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;
353
};
354

Gerd Moellmann's avatar
Gerd Moellmann committed
355 356 357 358 359 360 361 362 363 364 365
/* 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

366 367 368
/* 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
369 370 371 372 373 374
/* 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;

375 376 377
/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
extern Lisp_Object Vx_pixel_size_width_font_regexp;

378
/* A flag to control how to display unibyte 8-bit character.  */
379
extern int unibyte_display_via_language_environment;
380

Gerd Moellmann's avatar
Gerd Moellmann committed
381 382
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));
383

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

386
extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
387
extern void select_visual P_ ((struct x_display_info *));
Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390 391
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 *));
392

393 394
/* 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
395 396
   the information that is specific to X windows.  */

397
struct x_output
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402 403 404 405
{
  /* 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;

406
  /* Size of the X window in pixels.  */
Jim Blandy's avatar
Jim Blandy committed
407 408
  int pixel_height, pixel_width;

409 410 411 412 413 414
  /* 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;

415 416 417
  /* Height of a line, in pixels.  */
  int line_height;

418
  /* The tiled border used when the mouse is out of the frame.  */
Jim Blandy's avatar
Jim Blandy committed
419 420
  Pixmap border_tile;

421
  /* Here are the Graphics Contexts for the default font.  */
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426
  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
427
     just inside the window's border.  When the frame is selected,
Jim Blandy's avatar
Jim Blandy committed
428 429 430
     a highlighting is displayed inside the internal border.  */
  int internal_border_width;

Jim Blandy's avatar
Jim Blandy committed
431 432
  /* The X window used for this frame.
     May be zero while the frame object is being created
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438 439 440
     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.
441 442 443
     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
444 445
  Window parent_desc;

446 447 448 449 450 451 452 453 454 455 456 457
#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

458 459 460
  /* If >=0, a bitmap index.  The indicated bitmap is used for the
     icon. */
  int icon_bitmap;
Jim Blandy's avatar
Jim Blandy committed
461

462
  /* Default ASCII font of this frame.  */
463
  XFontStruct *font;
Jim Blandy's avatar
Jim Blandy committed
464

465 466
  /* The baseline offset of the default ASCII font.  */
  int baseline_offset;
467 468 469 470 471

  /* 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
472 473
  /* Pixel values used for various purposes.
     border_pixel may be -1 meaning use a gray tile.  */
474 475 476 477 478 479
  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
480

481 482 483 484 485 486 487 488 489
  /* 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;

490 491 492 493 494
  /* 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
495 496 497 498
  /* Descriptor for the cursor in use for this window.  */
  Cursor text_cursor;
  Cursor nontext_cursor;
  Cursor modeline_cursor;
499
  Cursor cross_cursor;
500
  Cursor hourglass_cursor;
501
  Cursor horizontal_drag_cursor;
502

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

510
  /* Flag to set when the X window needs to be completely repainted.  */
Jim Blandy's avatar
Jim Blandy committed
511 512
  int needs_exposure;

Jim Blandy's avatar
Jim Blandy committed
513 514 515 516 517 518 519
  /* 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
520

521 522 523
  /* Width of bar cursor (if we are using that).  */
  int cursor_width;

Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528 529 530 531 532 533 534 535
  /* 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;
536 537

  /* The size of the extra width currently allotted for vertical
538 539
     scroll bars, in pixels.  */
  int vertical_scroll_bar_extra;
540

541 542 543
  /* The extra width currently allotted for the areas in which
     truncation marks, continuation marks, and overlay arrows are
     displayed.  */
544 545
  int left_fringe_width, right_fringe_width;
  int fringe_cols, fringes_extra;
546 547 548

  /* This is the gravity value for the specified window position.  */
  int win_gravity;
549 550 551

  /* The geometry flags for this window.  */
  int size_hint_flags;
552 553

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

556
  /* This is a button event that wants to activate the menubar.
557 558
     We save it here until the command loop gets to think about it.  */
  XEvent *saved_menu_event;
559 560 561 562 563 564

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

565 566 567
  /* Nonzero means our parent is another application's window
     and was explicitly specified.  */
  char explicit_parent;
568 569 570

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

572 573 574
  /* Nonzero if this frame was ever previously visible.  */
  char has_been_visible;

575 576 577
#ifdef HAVE_X_I18N
  /* Input context (currently, this means Compose key handler setup).  */
  XIC xic;
578 579
  XIMStyle xic_style;
  XFontSet xic_xfs;
580
#endif
581

582 583 584 585 586 587 588 589 590 591 592 593
  /* 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;
594 595 596 597 598 599 600

  /* 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;
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624

  /* See enum below */
  int want_fullscreen;

  /* This many pixels are the difference between the outer window (i.e. the
     left of the window manager decoration) and FRAME_X_WINDOW. */
  int x_pixels_diff;

  /* This many pixels are the difference between the outer window (i.e. the
     top of the window manager titlebar) and FRAME_X_WINDOW. */
  int y_pixels_diff;

  /* As x_pixels_diff, but to FRAME_OUTER_WINDOW.  For some reason the
     two might differ by a pixel, depending on WM */
  int x_pixels_outer_diff;
  
  /* As y_pixels_diff, but to FRAME_OUTER_WINDOW.  In the toolkit version,
     these may differ because this does not take into account possible
     menubar.  y_pixels_diff is with menubar height included */
  int y_pixels_outer_diff;
};

enum
{
Pavel Janík's avatar
Pavel Janík committed
625
  /* Values used as a bit mask, BOTH == WIDTH | HEIGHT.  */
626 627 628 629 630 631
  FULLSCREEN_NONE       = 0,
  FULLSCREEN_WIDTH      = 1,
  FULLSCREEN_HEIGHT     = 2,
  FULLSCREEN_BOTH       = 3,
  FULLSCREEN_WAIT       = 4,
  FULLSCREEN_MOVE_WAIT  = 8,
632
};
633

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

637 638
/* Return the outermost X window associated with the frame F.  */
#ifdef USE_X_TOOLKIT
639 640 641
#define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ?             \
                               XtWindow ((f)->output_data.x->widget) :  \
                               FRAME_X_WINDOW (f))
642 643 644 645
#else
#define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
#endif

646
#define FRAME_FONT(f) ((f)->output_data.x->font)
647
#define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
648
#define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
649
#define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
650
#define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
651

652 653 654 655
/* 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))

656
/* This gives the x_display_info structure for the display F is on.  */
657
#define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
658 659

/* This is the `Display *' which frame F is on.  */
660 661 662 663
#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)
664
#define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
665

666 667 668 669 670 671
/* 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

672 673 674
/* 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
675
/* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
676 677
#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
678

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

681
#define FRAME_XIC(f) ((f)->output_data.x->xic)
682 683 684 685
#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)
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701

/* 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
702
/* Total width of fringes reserved for drawing truncation bitmaps,
703 704 705 706 707
   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.  */

708
#define FRAME_X_FRINGE_COLS(F)	((F)->output_data.x->fringe_cols)
709

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

712
#define FRAME_X_FRINGE_WIDTH(F) ((F)->output_data.x->fringes_extra)
713

714
/* Pixel-width of the left and right fringe.  */
715

716 717
#define FRAME_X_LEFT_FRINGE_WIDTH(F) ((F)->output_data.x->left_fringe_width)
#define FRAME_X_RIGHT_FRINGE_WIDTH(F) ((F)->output_data.x->right_fringe_width)
718 719


720

721
/* X-specific scroll bar stuff.  */
722

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

728
   We use struct scroll_bar as a template for accessing fields of the
729 730
   vector.  */

731 732
struct scroll_bar
{
733
  /* These fields are shared by all vectors.  */
734
  EMACS_INT size_from_Lisp_Vector_struct;
735 736
  struct Lisp_Vector *next_from_Lisp_Vector_struct;

737
  /* The window we're a scroll bar for.  */
738
  Lisp_Object window;
739

740
  /* The next and previous in the chain of scroll bars in this frame.  */
741
  Lisp_Object next, prev;
742

743
  /* The X window representing this scroll bar.  Since this is a full
744 745
     32-bit quantity, we store it split into two 32-bit values.  */
  Lisp_Object x_window_low, x_window_high;
746

747
  /* The position and size of the scroll bar in pixels, relative to the
748
     frame.  */
749
  Lisp_Object top, left, width, height;
750

751 752
  /* The starting and ending positions of the handle, relative to the
     handle area (i.e. zero is the top position, not
753
     SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
754
     hasn't been drawn yet.
755

756 757 758
     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
759
     drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
760 761 762
     where they would be normally; the bottom and top are in a
     different co-ordinate system.  */
  Lisp_Object start, end;
763

764
  /* If the scroll bar handle is currently being dragged by the user,
765 766
     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
767 768
     being dragged, this is Qnil.  */
  Lisp_Object dragging;
769 770
};

771
/* The number of elements a vector holding a struct scroll_bar needs.  */
772 773 774
#define SCROLL_BAR_VEC_SIZE					\
  ((sizeof (struct scroll_bar)					\
    - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))	\
775 776
   / sizeof (Lisp_Object))

777
/* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
778
#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
779 780 781


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

/* Setting two lisp integers to the low and high words of a 32-bit C int.  */
785
#define SCROLL_BAR_UNPACK(low, high, int32) \
786 787
  (XSETINT ((low),   (int32)        & 0xffff), \
   XSETINT ((high), ((int32) >> 16) & 0xffff))
788 789


790 791 792
/* 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))
793

794 795 796
/* 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))
797

798 799 800 801 802 803
/* 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))
804 805

/* Store a widget id in a struct scroll_bar.  */
806 807 808 809 810 811

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

813

814
/* Return the inside width of a vertical scroll bar, given the outside
815
   width.  */
816 817 818 819
#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
  ((width) \
   - VERTICAL_SCROLL_BAR_LEFT_BORDER \
   - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
820
   - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
821

822 823
/* Return the length of the rectangle within which the top of the
   handle must stay.  This isn't equivalent to the inside height,
824
   because the scroll bar handle has a minimum height.  
825

826 827 828
   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.  */
829 830
#define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
831

832 833
/* Return the inside height of vertical scroll bar, given the outside
   height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
834
#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
835
  ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
836 837


838
/* Border widths for scroll bars.
839

840
   Scroll bar windows don't have any X borders; their border width is
841 842 843
   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
844
   (used when sizing and drawing the scroll bar window itself).
845

846
   The handle moves up and down/back and forth in a rectangle inset
847 848 849
   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)
850
#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
851 852
#define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
853

854 855
/* Minimum lengths for scroll bar handles, in pixels.  */
#define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
856

857
/* Trimming off a few pixels from each side prevents
858
   text from glomming up against the scroll bar */
859
#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
860

861 862 863 864 865

/* 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
866
   Return the upper/left pixel position of the character cell on frame F
867 868
   at ROW/COL.  */
#define CHAR_TO_PIXEL_ROW(f, row) \
869 870
  ((f)->output_data.x->internal_border_width \
   + (row) * (f)->output_data.x->line_height)
871
#define CHAR_TO_PIXEL_COL(f, col) \
872 873
  ((f)->output_data.x->internal_border_width \
   + (col) * FONT_WIDTH ((f)->output_data.x->font))
874 875 876

/* Return the pixel width/height of frame F if it has
   WIDTH columns/HEIGHT rows.  */
877
#define CHAR_TO_PIXEL_WIDTH(f, width) \
878
  (CHAR_TO_PIXEL_COL (f, width) \
879
   + (f)->output_data.x->vertical_scroll_bar_extra \
Kim F. Storm's avatar
Kim F. Storm committed
880
   + (f)->output_data.x->fringes_extra \
881
   + (f)->output_data.x->internal_border_width)
882
#define CHAR_TO_PIXEL_HEIGHT(f, height) \
883
  (CHAR_TO_PIXEL_ROW (f, height) \
884
   + (f)->output_data.x->internal_border_width)
885 886


887 888
/* Return the row/column (zero-based) of the character cell containing 
   the pixel on FRAME at ROW/COL.  */
889
#define PIXEL_TO_CHAR_ROW(f, row) \
890 891
  (((row) - (f)->output_data.x->internal_border_width) \
   / (f)->output_data.x->line_height)
892
#define PIXEL_TO_CHAR_COL(f, col) \
893 894
  (((col) - (f)->output_data.x->internal_border_width) \
   / FONT_WIDTH ((f)->output_data.x->font))
895

896 897 898 899
/* 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) \
900
			  - (f)->output_data.x->internal_border_width \
Kim F. Storm's avatar
Kim F. Storm committed
901
			  - (f)->output_data.x->fringes_extra \
902
			  - (f)->output_data.x->vertical_scroll_bar_extra)))
903 904
#define PIXEL_TO_CHAR_HEIGHT(f, height) \
  (PIXEL_TO_CHAR_ROW (f, ((height) \
905
			  - (f)->output_data.x->internal_border_width)))
906

907 908 909 910 911 912

/* 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
913 914 915 916
   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.  */
917 918 919 920
struct selection_input_event
{
  int kind;
  Display *display;
Richard M. Stallman's avatar
Richard M. Stallman committed
921 922
  /* We spell it with an "o" here because X does.  */
  Window requestor;
923 924 925 926 927 928
  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
929 930 931
/* We spell it with an "o" here because X does.  */
#define SELECTION_EVENT_REQUESTOR(eventp)	\
  (((struct selection_input_event *) (eventp))->requestor)
932 933 934 935 936 937 938 939
#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)
940 941


Andreas Schwab's avatar
Andreas Schwab committed
942
struct window;
943 944
struct glyph_matrix;
struct frame;
Andreas Schwab's avatar
Andreas Schwab committed
945
struct input_event;
946 947
struct face;
struct image;
Andreas Schwab's avatar
Andreas Schwab committed
948

949 950 951 952 953 954 955 956 957 958 959 960 961
/* 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);
962
int image_ascent P_ ((struct image *, struct face *));
Gerd Moellmann's avatar
Gerd Moellmann committed
963
extern void x_free_gcs P_ ((struct frame *));
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985

/* 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));
986
int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
987 988 989

extern void pixel_to_glyph_coords P_ ((struct frame *, int, int,
				       int *, int *, XRectangle *, int));
Andreas Schwab's avatar
Andreas Schwab committed
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005

/* 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 *));
1006
extern void x_compute_fringe_widths P_ ((struct frame *, int));
Andreas Schwab's avatar
Andreas Schwab committed
1007 1008 1009 1010 1011 1012 1013