xterm.h 38.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions and headers for communication with X protocol.
Kim F. Storm's avatar
Kim F. Storm committed
2
   Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000,01,02,03,04
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

#include <X11/Xlib.h>
#include <X11/cursorfont.h>
Kim F. Storm's avatar
Kim F. Storm committed
24 25 26 27

/* Include Xutil.h after keysym.h to work around a bug that prevents
   correct recognition of AltGr key in some X versions.  */

Jim Blandy's avatar
Jim Blandy committed
28
#include <X11/keysym.h>
29
#include <X11/Xutil.h>
Kim F. Storm's avatar
Kim F. Storm committed
30

Jim Blandy's avatar
Jim Blandy committed
31 32 33
#include <X11/Xatom.h>
#include <X11/Xresource.h>

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
38
				   window inside a widget instead of one
39 40
				   that Xt creates... */
#include <X11/StringDefs.h>
Jan Djärv's avatar
Jan Djärv committed
41 42 43 44 45 46 47 48 49 50 51

typedef Widget xt_or_gtk_widget;
#endif

#ifdef USE_GTK
#include <gtk/gtk.h>
#include <gdk/gdkx.h>

/* Some definitions to reduce conditionals.  */
typedef GtkWidget *xt_or_gtk_widget;
#define XtParent(x) (gtk_widget_get_parent (x))
52
#undef XSync
53 54
#define XSync(d, b) do { gdk_window_process_all_updates (); \
                         XSync (d, b);  } while (0)
55

Jan Djärv's avatar
Jan Djärv committed
56

57
#endif /* USE_GTK */
58

59 60

/* Bookkeeping to distinguish X versions.  */
Jim Blandy's avatar
Jim Blandy committed
61

Jim Blandy's avatar
Jim Blandy committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
/* 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
82 83 84
   with X11R3 or X11R4 by looking for the flag macros for R4 structure
   members that R3 doesn't have.  */
#ifdef PBaseSize
85 86
/* AIX 3.1's X is somewhere between X11R3 and X11R4.  It has
   PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
87
   XSetWMIconName.
88 89
   AIX 3.2 is at least X11R4.  */
#if (!defined AIX) || (defined AIX3_2)
Jim Blandy's avatar
Jim Blandy committed
90 91
#define HAVE_X11R4
#endif
92
#endif
Jim Blandy's avatar
Jim Blandy committed
93

94
#ifdef HAVE_X11R5
95 96 97
/* In case someone has X11R5 on AIX 3.1,
   make sure HAVE_X11R4 is defined as well as HAVE_X11R5.  */
#define HAVE_X11R4
98
#endif
99

100
#ifdef HAVE_X_I18N
101 102
#include <X11/Xlocale.h>
#endif
103 104 105 106 107

#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
108 109 110 111

#define FONT_WIDTH(f)	((f)->max_bounds.width)
#define FONT_HEIGHT(f)	((f)->ascent + (f)->descent)
#define FONT_BASE(f)    ((f)->ascent)
112
#define FONT_DESCENT(f) ((f)->descent)
Jim Blandy's avatar
Jim Blandy committed
113 114

/* The mask of events that text windows always want to receive.  This
115 116
   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
117 118 119 120 121

#define STANDARD_EVENT_SET      \
  (KeyPressMask			\
   | ExposureMask		\
   | ButtonPressMask		\
Jim Blandy's avatar
Jim Blandy committed
122 123
   | ButtonReleaseMask		\
   | PointerMotionMask		\
Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129
   | StructureNotifyMask	\
   | FocusChangeMask		\
   | LeaveWindowMask		\
   | EnterWindowMask		\
   | VisibilityChangeMask)

Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134 135
/* 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;
136
  int have_mask;
137
  Pixmap mask;
Richard M. Stallman's avatar
Richard M. Stallman committed
138 139 140 141 142
  char *file;
  int refcount;
  /* Record some info about this pixmap.  */
  int height, width, depth;
};
143 144 145

/* For each X display, we have a structure that records
   information about it.  */
Jim Blandy's avatar
Jim Blandy committed
146

147
struct x_display_info
148
{
Richard M. Stallman's avatar
Richard M. Stallman committed
149
  /* Chain of all x_display_info structures.  */
150
  struct x_display_info *next;
151

152 153
  /* Connection number (normally a file descriptor number).  */
  int connection;
154

155
  /* This says how to access this display in Xlib.  */
156
  Display *display;
157

Richard M. Stallman's avatar
Richard M. Stallman committed
158 159 160
  /* 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;
161

162 163
  /* Number of frames that are on this display.  */
  int reference_count;
164

165 166
  /* The Screen this connection is connected to.  */
  Screen *screen;
167 168 169

  /* Dots per inch of the screen.  */
  double resx, resy;
170

171 172
  /* The Visual being used for this display.  */
  Visual *visual;
173

Pavel Janík's avatar
Pavel Janík committed
174
  /* The colormap being used.  */
175
  Colormap cmap;
176

177
  /* Number of planes on this screen.  */
178
  int n_planes;
179

180 181
  /* Dimensions of this screen.  */
  int height, width;
182

183 184
  /* Mask of things that cause the mouse to be grabbed.  */
  int grabbed;
185

186 187 188
  /* Emacs bitmap-id of the default icon bitmap for this frame.
     Or -1 if none has been allocated yet.  */
  int icon_bitmap_id;
189

190 191
  /* The root window of this screen.  */
  Window root_window;
192

193 194 195
  /* Client leader window.  */
  Window client_leader_window;

Richard M. Stallman's avatar
Richard M. Stallman committed
196 197
  /* The cursor to use for vertical scroll bars.  */
  Cursor vertical_scroll_bar_cursor;
198

199 200 201 202 203
#ifdef USE_GTK
  /* The GDK cursor for scroll bars and popup menus.  */
  GdkCursor *xg_cursor;
#endif

204 205 206
  /* X Resource data base */
  XrmDatabase xrdb;

Richard M. Stallman's avatar
Richard M. Stallman committed
207 208 209 210 211 212
  /* 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;

213 214 215 216 217 218
  /* 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
219 220 221
  /* Reusable Graphics Context for drawing a cursor in a non-default face. */
  GC scratch_cursor_gc;

222 223 224 225 226
  /* 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
227
  int mouse_face_beg_row, mouse_face_beg_col;
228
  int mouse_face_beg_x, mouse_face_beg_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
229
  int mouse_face_end_row, mouse_face_end_col;
230
  int mouse_face_end_x, mouse_face_end_y;
Richard M. Stallman's avatar
Richard M. Stallman committed
231 232 233
  int mouse_face_past_end;
  Lisp_Object mouse_face_window;
  int mouse_face_face_id;
234
  Lisp_Object mouse_face_overlay;
Richard M. Stallman's avatar
Richard M. Stallman committed
235 236 237 238 239 240 241 242 243 244 245 246 247

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

248 249 250
  /* Nonzero means that the mouse highlight should not be shown.  */
  int mouse_face_hidden;

251 252
  int mouse_face_image_state;

Richard M. Stallman's avatar
Richard M. Stallman committed
253 254 255
  char *x_id_name;

  /* The number of fonts actually stored in x_font_table.
256 257
     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
258 259 260 261 262 263 264 265 266 267 268
  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;

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  /* 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;
295

296 297 298 299
  /* Kinds of protocol things we may receive.  */
  Atom Xatom_wm_take_focus;
  Atom Xatom_wm_save_yourself;
  Atom Xatom_wm_delete_window;
300

301 302
  /* Atom for indicating window state to the window manager.  */
  Atom Xatom_wm_change_state;
303

304 305 306
  /* Other WM communication */
  Atom Xatom_wm_configure_denied; /* When our config request is denied */
  Atom Xatom_wm_window_moved;     /* When the WM moves us.  */
307
  Atom Xatom_wm_client_leader;    /* Id of client leader window.  */
308

309 310 311 312 313
  /* EditRes protocol */
  Atom Xatom_editres;

  /* More atoms, which are selection types.  */
  Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
314
  Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
315 316
  Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
  Xatom_ATOM_PAIR;
317

318
  /* More atoms for font properties.  The last three are private
319
     properties, see the comments in src/fontset.h.  */
320
  Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
321 322
  Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
  Xatom_MULE_DEFAULT_ASCENT;
323

324 325 326 327 328 329
  /* More atoms for Ghostscript support.  */
  Atom Xatom_DONE, Xatom_PAGE;

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

330
#ifdef MULTI_KBOARD
331
  struct kboard *kboard;
332
#endif
333
  int cut_buffers_initialized; /* Whether we're sure they all exist */
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

  /* 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;
354 355 356 357

  /* The null pixel used for filling a character background with
     background color of a gc.  */
  Pixmap null_pixel;
358 359 360 361 362 363

  /* The gray pixmap.  */
  Pixmap gray;

  /* Cache of images.  */
  struct image_cache *image_cache;
364 365 366 367 368 369

#ifdef HAVE_X_I18N
  /* XIM (X Input method).  */
  XIM xim;
  XIMStyles *xim_styles;
#endif
370 371 372 373 374

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

376
  /* Bits and shifts to use to compose pixel values on TrueColor visuals.  */
377 378
  int red_bits, blue_bits, green_bits;
  int red_offset, blue_offset, green_offset;
379 380 381 382 383 384 385 386 387 388 389 390 391

  /* The type of window manager we have.  If we move FRAME_OUTER_WINDOW
     to x/y 0/0, some window managers (type A) puts the window manager
     decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
     Other window managers (type B) puts the window including decorations
     at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
     Record the type of WM in use so we can compensate for type A WMs.  */
  enum
    {
      X_WMTYPE_UNKNOWN,
      X_WMTYPE_A,
      X_WMTYPE_B
    } wm_type;
392
};
393

Dave Love's avatar
Dave Love committed
394 395 396 397 398
#ifdef HAVE_X_I18N
/* Whether or not to use XIM if we have it.  */
extern int use_xim;
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401 402 403
/* 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));

Jan Djärv's avatar
Jan Djärv committed
404
#if defined (USE_X_TOOLKIT) || defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
405 406 407 408 409
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

410 411 412
/* 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
413 414 415 416 417 418
/* 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;

419 420 421
/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
extern Lisp_Object Vx_pixel_size_width_font_regexp;

422
/* A flag to control how to display unibyte 8-bit character.  */
423
extern int unibyte_display_via_language_environment;
424

Gerd Moellmann's avatar
Gerd Moellmann committed
425 426
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));
427

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

430
extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
431
extern void select_visual P_ ((struct x_display_info *));
Gerd Moellmann's avatar
Gerd Moellmann committed
432 433 434 435
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 *));
436

437 438
/* 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
439 440
   the information that is specific to X windows.  */

441
struct x_output
Jim Blandy's avatar
Jim Blandy committed
442
{
443 444 445 446 447 448
  /* 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;

Jan Djärv's avatar
Jan Djärv committed
449 450 451 452
  /* Height of tool bar widget, in pixels.
     Zero if not using an external tool bar.  */
  int toolbar_height;

453
  /* The tiled border used when the mouse is out of the frame.  */
Jim Blandy's avatar
Jim Blandy committed
454 455
  Pixmap border_tile;

456
  /* Here are the Graphics Contexts for the default font.  */
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460
  GC normal_gc;				/* Normal video */
  GC reverse_gc;			/* Reverse video */
  GC cursor_gc;				/* cursor drawing */

Jim Blandy's avatar
Jim Blandy committed
461 462
  /* The X window used for this frame.
     May be zero while the frame object is being created
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468 469 470
     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.
471 472 473
     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
474 475
  Window parent_desc;

476 477 478 479 480 481 482 483 484 485 486 487
#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

Jan Djärv's avatar
Jan Djärv committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501
#ifdef USE_GTK
  /* The widget of this screen.  This is the window of a top widget.  */
  GtkWidget *widget;
  /* The widget of the edit portion of this screen; the window in
     "window_desc" is inside of this.  */
  GtkWidget *edit_widget;
  /* The widget used for laying out widgets vertically.  */
  GtkWidget *vbox_widget;
  /* The menubar in this frame.  */
  GtkWidget *menubar_widget;
  /* The tool bar in this frame  */
  GtkWidget *toolbar_widget;
  /* The handle box that makes the tool bar detachable.  */
  GtkWidget *handlebox_widget;
502

Jan Djärv's avatar
Jan Djärv committed
503 504 505 506 507
  /* The last size hints set.  */
  GdkGeometry size_hints;
  long hint_flags;
#endif

508 509 510
  /* If >=0, a bitmap index.  The indicated bitmap is used for the
     icon. */
  int icon_bitmap;
Jim Blandy's avatar
Jim Blandy committed
511

512
  /* Default ASCII font of this frame.  */
513
  XFontStruct *font;
Jim Blandy's avatar
Jim Blandy committed
514

515 516
  /* The baseline offset of the default ASCII font.  */
  int baseline_offset;
517 518 519 520 521

  /* 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
522 523
  /* Pixel values used for various purposes.
     border_pixel may be -1 meaning use a gray tile.  */
524 525 526 527 528 529
  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
530

531 532 533
  /* 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;
534

535 536 537 538 539
  /* 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;

540 541 542 543 544
  /* 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
545 546 547 548
  /* Descriptor for the cursor in use for this window.  */
  Cursor text_cursor;
  Cursor nontext_cursor;
  Cursor modeline_cursor;
549
  Cursor hand_cursor;
550
  Cursor hourglass_cursor;
551
  Cursor horizontal_drag_cursor;
552

553 554 555
  /* Window whose cursor is hourglass_cursor.  This window is temporarily
     mapped to display an hourglass cursor.  */
  Window hourglass_window;
556

557 558
  /* Non-zero means hourglass cursor is currently displayed.  */
  unsigned hourglass_p : 1;
Jim Blandy's avatar
Jim Blandy committed
559

560
  /* Flag to set when the X window needs to be completely repainted.  */
Jim Blandy's avatar
Jim Blandy committed
561 562
  int needs_exposure;

Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567 568 569 570 571 572 573 574
  /* 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;
575

576
  /* This is the Emacs structure for the X display this frame is on.  */
577
  struct x_display_info *display_info;
578

579
  /* This is a button event that wants to activate the menubar.
580 581
     We save it here until the command loop gets to think about it.  */
  XEvent *saved_menu_event;
582 583 584 585 586 587

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

588 589 590
  /* Nonzero means our parent is another application's window
     and was explicitly specified.  */
  char explicit_parent;
591 592 593

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

595 596 597
  /* Nonzero if this frame was ever previously visible.  */
  char has_been_visible;

598 599 600
#ifdef HAVE_X_I18N
  /* Input context (currently, this means Compose key handler setup).  */
  XIC xic;
601 602
  XIMStyle xic_style;
  XFontSet xic_xfs;
603
  char *xic_base_fontname;
604
#endif
605

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

  /* 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;
625 626 627 628

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

630 631 632 633
  /* 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;
634 635 636 637 638

  /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
     frame, or IMPLICIT if we received an EnterNotify.
     FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
  int focus_state;
639 640

  /* The latest move we made to FRAME_OUTER_WINDOW.  Saved so we can
641
     compensate for type A WMs (see wm_type in dpyinfo above).  */
642 643 644
  int expected_top;
  int expected_left;

645 646 647 648
  /* The offset we need to add to compensate for type A WMs.  */
  int move_offset_top;
  int move_offset_left;

649 650 651
  /* Nonzero if we have made a move and needs to check if the WM placed us
     at the right position.  */
  int check_expected_move;
652 653
};

654 655
#define No_Cursor (None)

656 657 658
enum
{
  /* Values for focus_state, used as bit mask.
Jan Djärv's avatar
Jan Djärv committed
659
     EXPLICIT means we received a FocusIn for the frame and know it has
660 661 662 663 664 665 666 667 668
     the focus.  IMPLICIT means we recevied an EnterNotify and the frame
     may have the focus if no window manager is running.
     FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
  FOCUS_NONE     = 0,
  FOCUS_IMPLICIT = 1,
  FOCUS_EXPLICIT = 2
};


669 670 671
/* Return the X output data for frame F.  */
#define FRAME_X_OUTPUT(f) ((f)->output_data.x)

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

675 676
/* Return the outermost X window associated with the frame F.  */
#ifdef USE_X_TOOLKIT
677 678 679
#define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ?             \
                               XtWindow ((f)->output_data.x->widget) :  \
                               FRAME_X_WINDOW (f))
680
#else
Jan Djärv's avatar
Jan Djärv committed
681 682 683 684 685 686 687 688 689 690 691 692
#ifdef USE_GTK
#define GTK_WIDGET_TO_X_WIN(w) \
  ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)

#define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
#define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
#define FRAME_OUTER_WINDOW(f)                                   \
       (FRAME_GTK_OUTER_WIDGET (f) ?                            \
        GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) :      \
         FRAME_X_WINDOW (f))

#else /* !USE_GTK */
693
#define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
Jan Djärv's avatar
Jan Djärv committed
694
#endif /* !USE_GTK */
695 696
#endif

Jan Djärv's avatar
Jan Djärv committed
697

698
#define FRAME_FONT(f) ((f)->output_data.x->font)
699
#define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
700
#define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
Jan Djärv's avatar
Jan Djärv committed
701
#define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
702
#define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
703

704
/* This gives the x_display_info structure for the display F is on.  */
705
#define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
706 707

/* This is the `Display *' which frame F is on.  */
708 709 710 711
#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)
712
#define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
713

714 715 716 717 718 719
/* 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

720 721 722
/* This is the 'font_info *' which frame F has.  */
#define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)

Jan Djärv's avatar
Jan Djärv committed
723 724 725 726 727 728 729
/* The difference in pixels between the top left corner of the
   Emacs window (including possible window manager decorations)
   and FRAME_X_WINDOW (f).  */
#define FRAME_OUTER_TO_INNER_DIFF_X(f) \
     ((f)->output_data.x->x_pixels_outer_diff)
#define FRAME_OUTER_TO_INNER_DIFF_Y(f)          \
     ((f)->output_data.x->y_pixels_outer_diff   \
Jan Djärv's avatar
Jan Djärv committed
730
      + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
Jan Djärv's avatar
Jan Djärv committed
731 732


733
#define FRAME_XIC(f) ((f)->output_data.x->xic)
734 735 736 737
#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)
738
#define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753

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

754

755
/* X-specific scroll bar stuff.  */
756

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

762
   We use struct scroll_bar as a template for accessing fields of the
763 764
   vector.  */

765 766
struct scroll_bar
{
767
  /* These fields are shared by all vectors.  */
768
  EMACS_INT size_from_Lisp_Vector_struct;
769 770
  struct Lisp_Vector *next_from_Lisp_Vector_struct;

771
  /* The window we're a scroll bar for.  */
772
  Lisp_Object window;
773

774
  /* The next and previous in the chain of scroll bars in this frame.  */
775
  Lisp_Object next, prev;
776

777
  /* The X window representing this scroll bar.  Since this is a full
778 779
     32-bit quantity, we store it split into two 32-bit values.  */
  Lisp_Object x_window_low, x_window_high;
780

781
  /* The position and size of the scroll bar in pixels, relative to the
782
     frame.  */
783
  Lisp_Object top, left, width, height;
784

785 786
  /* The starting and ending positions of the handle, relative to the
     handle area (i.e. zero is the top position, not
787
     SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
788
     hasn't been drawn yet.
789

790 791 792
     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
793
     drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
794 795 796
     where they would be normally; the bottom and top are in a
     different co-ordinate system.  */
  Lisp_Object start, end;
797

798
  /* If the scroll bar handle is currently being dragged by the user,
799 800
     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
801 802
     being dragged, this is Qnil.  */
  Lisp_Object dragging;
803 804
};

805
/* The number of elements a vector holding a struct scroll_bar needs.  */
806 807 808
#define SCROLL_BAR_VEC_SIZE					\
  ((sizeof (struct scroll_bar)					\
    - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))	\
809 810
   / sizeof (Lisp_Object))

811
/* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
812
#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
813 814 815


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

/* Setting two lisp integers to the low and high words of a 32-bit C int.  */
819
#define SCROLL_BAR_UNPACK(low, high, int32) \
820 821
  (XSETINT ((low),   (int32)        & 0xffff), \
   XSETINT ((high), ((int32) >> 16) & 0xffff))
822 823


824 825 826
/* 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))
827

828 829 830
/* 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))
831

832 833 834 835 836 837
/* 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))
838 839

/* Store a widget id in a struct scroll_bar.  */
840 841 842 843 844 845

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

847

848
/* Return the inside width of a vertical scroll bar, given the outside
849
   width.  */
850 851 852 853
#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
  ((width) \
   - VERTICAL_SCROLL_BAR_LEFT_BORDER \
   - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
854
   - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
855

856 857
/* Return the length of the rectangle within which the top of the
   handle must stay.  This isn't equivalent to the inside height,
858
   because the scroll bar handle has a minimum height.
859

860 861 862
   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.  */
863 864
#define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
865

866 867
/* Return the inside height of vertical scroll bar, given the outside
   height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
868
#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
869
  ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
870 871


872
/* Border widths for scroll bars.
873

874
   Scroll bar windows don't have any X borders; their border width is
875 876 877
   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
878
   (used when sizing and drawing the scroll bar window itself).
879

880
   The handle moves up and down/back and forth in a rectangle inset
881 882 883
   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)
884
#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
885 886
#define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
887

888 889
/* Minimum lengths for scroll bar handles, in pixels.  */
#define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
890

891
/* Trimming off a few pixels from each side prevents
892
   text from glomming up against the scroll bar */
893
#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
894

895

Pavel Janík's avatar
Pavel Janík committed
896 897
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
898 899
   by this structure.  */

Pavel Janík's avatar
Pavel Janík committed
900
/* For an event of kind SELECTION_REQUEST_EVENT,
Richard M. Stallman's avatar
Richard M. Stallman committed
901 902 903 904
   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.  */
905 906 907 908
struct selection_input_event
{
  int kind;
  Display *display;
Richard M. Stallman's avatar
Richard M. Stallman committed
909 910
  /* We spell it with an "o" here because X does.  */
  Window requestor;
911 912 913 914 915 916
  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
917 918 919
/* We spell it with an "o" here because X does.  */
#define SELECTION_EVENT_REQUESTOR(eventp)	\
  (((struct selection_input_event *) (eventp))->requestor)
920 921 922 923 924 925 926 927
#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)
928 929


Andreas Schwab's avatar
Andreas Schwab committed
930
struct window;
931 932
struct glyph_matrix;
struct frame;
Andreas Schwab's avatar
Andreas Schwab committed
933
struct input_event;
934 935
struct face;
struct image;
Andreas Schwab's avatar
Andreas Schwab committed
936

937 938 939 940 941 942 943 944 945 946 947 948 949
/* 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);
Gerd Moellmann's avatar
Gerd Moellmann committed
950
extern void x_free_gcs P_ ((struct frame *));
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969

/* From xrdb.c.  */

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));
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));
970
int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
971

Andreas Schwab's avatar
Andreas Schwab committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
/* Defined in xterm.c */

extern void cancel_mouse_face P_ ((struct frame *));
extern void x_scroll_bar_clear P_ ((struct frame *));
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 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 *));
990
extern void x_free_frame_resources P_ ((struct frame *));
Andreas Schwab's avatar
Andreas Schwab committed
991 992 993 994 995 996
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_delete_display P_ ((struct x_display_info *));
extern void x_initialize P_ ((void));
997
extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
998 999 1000
#ifdef USE_X_TOOLKIT
extern XtAppContext Xt_app_con;
#endif
1001 1002
extern void x_query_colors P_ ((struct frame *f, XColor *, int));
extern void x_query_color P_ ((struct frame *f, XColor *));
1003
extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
Andreas Schwab's avatar
Andreas Schwab committed
1004