1/* Definitions and headers for communication with X protocol. 2 Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003, 3 2004, 2005, 2006, 2007 Free Software Foundation, Inc. 4 5This file is part of GNU Emacs. 6 7GNU Emacs is free software; you can redistribute it and/or modify 8it under the terms of the GNU General Public License as published by 9the Free Software Foundation; either version 2, or (at your option) 10any later version. 11 12GNU Emacs is distributed in the hope that it will be useful, 13but WITHOUT ANY WARRANTY; without even the implied warranty of 14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15GNU General Public License for more details. 16 17You should have received a copy of the GNU General Public License 18along with GNU Emacs; see the file COPYING. If not, write to 19the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 20Boston, MA 02110-1301, USA. */ 21 22#include <X11/Xlib.h> 23#include <X11/cursorfont.h> 24 25/* Include Xutil.h after keysym.h to work around a bug that prevents 26 correct recognition of AltGr key in some X versions. */ 27 28#include <X11/keysym.h> 29#include <X11/Xutil.h> 30 31#include <X11/Xatom.h> 32#include <X11/Xresource.h> 33 34#ifdef USE_X_TOOLKIT 35#include <X11/StringDefs.h> 36#include <X11/IntrinsicP.h> /* CoreP.h needs this */ 37#include <X11/CoreP.h> /* foul, but we need this to use our own 38 window inside a widget instead of one 39 that Xt creates... */ 40#include <X11/StringDefs.h> 41 42typedef Widget xt_or_gtk_widget; 43#endif 44 45#ifdef USE_GTK 46#include <gtk/gtk.h> 47#include <gdk/gdkx.h> 48 49/* Some definitions to reduce conditionals. */ 50typedef GtkWidget *xt_or_gtk_widget; 51#define XtParent(x) (gtk_widget_get_parent (x)) 52#undef XSync 53#define XSync(d, b) do { gdk_window_process_all_updates (); \ 54 XSync (d, b); } while (0) 55 56 57#endif /* USE_GTK */ 58 59 60/* Bookkeeping to distinguish X versions. */ 61 62/* HAVE_X11R4 is defined if we have the features of X11R4. It should 63 be defined when we're using X11R5, since X11R5 has the features of 64 X11R4. If, in the future, we find we need more of these flags 65 (HAVE_X11R5, for example), code should always be written to test 66 the most recent flag first: 67 68 #ifdef HAVE_X11R5 69 ... 70 #elif HAVE_X11R4 71 ... 72 #elif HAVE_X11 73 ... 74 #endif 75 76 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that 77 looks a lot like another one, consider moving the text into a macro 78 whose definition is configuration-dependent, but whose usage is 79 universal - like the stuff in systime.h. 80 81 It turns out that we can auto-detect whether we're being compiled 82 with X11R3 or X11R4 by looking for the flag macros for R4 structure 83 members that R3 doesn't have. */ 84#ifdef PBaseSize 85/* AIX 3.1's X is somewhere between X11R3 and X11R4. It has 86 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints, 87 XSetWMIconName. 88 AIX 3.2 is at least X11R4. */ 89#if (!defined AIX) || (defined AIX3_2) 90#define HAVE_X11R4 91#endif 92#endif 93 94#ifdef HAVE_X11R5 95/* In case someone has X11R5 on AIX 3.1, 96 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */ 97#define HAVE_X11R4 98#endif 99 100#ifdef HAVE_X_I18N 101#include <X11/Xlocale.h> 102#endif 103 104#define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \ 105 XScreenNumberOfScreen (FRAME_X_SCREEN (f))) 106#define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \ 107 XScreenNumberOfScreen (FRAME_X_SCREEN (f))) 108 109#define FONT_WIDTH(f) ((f)->max_bounds.width) 110#define FONT_HEIGHT(f) ((f)->ascent + (f)->descent) 111#define FONT_BASE(f) ((f)->ascent) 112#define FONT_DESCENT(f) ((f)->descent) 113 114/* The mask of events that text windows always want to receive. This 115 includes mouse movement events, since handling the mouse-font text property 116 means that we must track mouse motion all the time. */ 117 118#define STANDARD_EVENT_SET \ 119 (KeyPressMask \ 120 | ExposureMask \ 121 | ButtonPressMask \ 122 | ButtonReleaseMask \ 123 | PointerMotionMask \ 124 | StructureNotifyMask \ 125 | FocusChangeMask \ 126 | LeaveWindowMask \ 127 | EnterWindowMask \ 128 | VisibilityChangeMask) 129 130/* Structure recording X pixmap and reference count. 131 If REFCOUNT is 0 then this record is free to be reused. */ 132 133struct x_bitmap_record 134{ 135 Pixmap pixmap; 136 int have_mask; 137 Pixmap mask; 138 char *file; 139 int refcount; 140 /* Record some info about this pixmap. */ 141 int height, width, depth; 142}; 143 144/* For each X display, we have a structure that records 145 information about it. */ 146 147struct x_display_info 148{ 149 /* Chain of all x_display_info structures. */ 150 struct x_display_info *next; 151 152 /* Connection number (normally a file descriptor number). */ 153 int connection; 154 155 /* This says how to access this display in Xlib. */ 156 Display *display; 157 158 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE). 159 The same cons cell also appears in x_display_name_list. */ 160 Lisp_Object name_list_element; 161 162 /* Number of frames that are on this display. */ 163 int reference_count; 164 165 /* The Screen this connection is connected to. */ 166 Screen *screen; 167 168 /* Dots per inch of the screen. */ 169 double resx, resy; 170 171 /* The Visual being used for this display. */ 172 Visual *visual; 173 174 /* The colormap being used. */ 175 Colormap cmap; 176 177 /* Number of planes on this screen. */ 178 int n_planes; 179 180 /* Dimensions of this screen. */ 181 int height, width; 182 183 /* Mask of things that cause the mouse to be grabbed. */ 184 int grabbed; 185 186 /* Emacs bitmap-id of the default icon bitmap for this frame. 187 Or -1 if none has been allocated yet. */ 188 int icon_bitmap_id; 189 190 /* The root window of this screen. */ 191 Window root_window; 192 193 /* Client leader window. */ 194 Window client_leader_window; 195 196 /* The cursor to use for vertical scroll bars. */ 197 Cursor vertical_scroll_bar_cursor; 198 199#ifdef USE_GTK 200 /* The GDK cursor for scroll bars and popup menus. */ 201 GdkCursor *xg_cursor; 202#endif 203 204 /* X Resource data base */ 205 XrmDatabase xrdb; 206 207 /* A table of all the fonts we have already loaded. */ 208 struct font_info *font_table; 209 210 /* The current capacity of x_font_table. */ 211 int font_table_size; 212 213 /* Minimum width over all characters in all fonts in font_table. */ 214 int smallest_char_width; 215 216 /* Minimum font height over all fonts in font_table. */ 217 int smallest_font_height; 218 219 /* Reusable Graphics Context for drawing a cursor in a non-default face. */ 220 GC scratch_cursor_gc; 221 222 /* These variables describe the range of text currently shown in its 223 mouse-face, together with the window they apply to. As long as 224 the mouse stays within this range, we need not redraw anything on 225 its account. Rows and columns are glyph matrix positions in 226 MOUSE_FACE_WINDOW. */ 227 int mouse_face_beg_row, mouse_face_beg_col; 228 int mouse_face_beg_x, mouse_face_beg_y; 229 int mouse_face_end_row, mouse_face_end_col; 230 int mouse_face_end_x, mouse_face_end_y; 231 int mouse_face_past_end; 232 Lisp_Object mouse_face_window; 233 int mouse_face_face_id; 234 Lisp_Object mouse_face_overlay; 235 236 /* 1 if a mouse motion event came and we didn't handle it right away because 237 gc was in progress. */ 238 int mouse_face_deferred_gc; 239 240 /* FRAME and X, Y position of mouse when last checked for 241 highlighting. X and Y can be negative or out of range for the frame. */ 242 struct frame *mouse_face_mouse_frame; 243 int mouse_face_mouse_x, mouse_face_mouse_y; 244 245 /* Nonzero means defer mouse-motion highlighting. */ 246 int mouse_face_defer; 247 248 /* Nonzero means that the mouse highlight should not be shown. */ 249 int mouse_face_hidden; 250 251 int mouse_face_image_state; 252 253 char *x_id_name; 254 255 /* The number of fonts actually stored in x_font_table. 256 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <= 257 n_fonts <= font_table_size and font_table[i].name != 0. */ 258 int n_fonts; 259 260 /* Pointer to bitmap records. */ 261 struct x_bitmap_record *bitmaps; 262 263 /* Allocated size of bitmaps field. */ 264 int bitmaps_size; 265 266 /* Last used bitmap index. */ 267 int bitmaps_last; 268 269 /* Which modifier keys are on which modifier bits? 270 271 With each keystroke, X returns eight bits indicating which modifier 272 keys were held down when the key was pressed. The interpretation 273 of the top five modifier bits depends on what keys are attached 274 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5 275 is the meta bit. 276 277 meta_mod_mask is a mask containing the bits used for the meta key. 278 It may have more than one bit set, if more than one modifier bit 279 has meta keys on it. Basically, if EVENT is a KeyPress event, 280 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0. 281 282 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the 283 lock modifier bit, or zero otherwise. Non-alphabetic keys should 284 only be affected by the lock modifier bit if XK_Shift_Lock is in 285 use; XK_Caps_Lock should only affect alphabetic keys. With this 286 arrangement, the lock modifier should shift the character if 287 (EVENT.state & shift_lock_mask) != 0. */ 288 int meta_mod_mask, shift_lock_mask; 289 290 /* These are like meta_mod_mask, but for different modifiers. */ 291 int alt_mod_mask, super_mod_mask, hyper_mod_mask; 292 293 /* Communication with window managers. */ 294 Atom Xatom_wm_protocols; 295 296 /* Kinds of protocol things we may receive. */ 297 Atom Xatom_wm_take_focus; 298 Atom Xatom_wm_save_yourself; 299 Atom Xatom_wm_delete_window; 300 301 /* Atom for indicating window state to the window manager. */ 302 Atom Xatom_wm_change_state; 303 304 /* Other WM communication */ 305 Atom Xatom_wm_configure_denied; /* When our config request is denied */ 306 Atom Xatom_wm_window_moved; /* When the WM moves us. */ 307 Atom Xatom_wm_client_leader; /* Id of client leader window. */ 308 309 /* EditRes protocol */ 310 Atom Xatom_editres; 311 312 /* More atoms, which are selection types. */ 313 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE, 314 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING, 315 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL, 316 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 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE, 322 Xatom_MULE_DEFAULT_ASCENT; 323 324 /* More atoms for Ghostscript support. */ 325 Atom Xatom_DONE, Xatom_PAGE; 326 327 /* Atom used in toolkit scroll bar client messages. */ 328 Atom Xatom_Scrollbar; 329 330#ifdef MULTI_KBOARD 331 struct kboard *kboard; 332#endif 333 int cut_buffers_initialized; /* Whether we're sure they all exist */ 334 335 /* The frame (if any) which has the X window that has keyboard focus. 336 Zero if none. This is examined by Ffocus_frame in xfns.c. Note 337 that a mere EnterNotify event can set this; if you need to know the 338 last frame specified in a FocusIn or FocusOut event, use 339 x_focus_event_frame. */ 340 struct frame *x_focus_frame; 341 342 /* The last frame mentioned in a FocusIn or FocusOut event. This is 343 separate from x_focus_frame, because whether or not LeaveNotify 344 events cause us to lose focus depends on whether or not we have 345 received a FocusIn event for it. */ 346 struct frame *x_focus_event_frame; 347 348 /* The frame which currently has the visual highlight, and should get 349 keyboard input (other sorts of input have the frame encoded in the 350 event). It points to the X focus frame's selected window's 351 frame. It differs from x_focus_frame when we're using a global 352 minibuffer. */ 353 struct frame *x_highlight_frame; 354 355 /* The null pixel used for filling a character background with 356 background color of a gc. */ 357 Pixmap null_pixel; 358 359 /* The gray pixmap. */ 360 Pixmap gray; 361 362 /* Cache of images. */ 363 struct image_cache *image_cache; 364 365#ifdef HAVE_X_I18N 366 /* XIM (X Input method). */ 367 XIM xim; 368 XIMStyles *xim_styles; 369#endif 370 371 /* If non-null, a cache of the colors in the color map. Don't 372 use this directly, call x_color_cells instead. */ 373 XColor *color_cells; 374 int ncolor_cells; 375 376 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */ 377 int red_bits, blue_bits, green_bits; 378 int red_offset, blue_offset, green_offset; 379 380 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW 381 to x/y 0/0, some window managers (type A) puts the window manager 382 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0. 383 Other window managers (type B) puts the window including decorations 384 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0. 385 Record the type of WM in use so we can compensate for type A WMs. */ 386 enum 387 { 388 X_WMTYPE_UNKNOWN, 389 X_WMTYPE_A, 390 X_WMTYPE_B 391 } wm_type; 392 393 394 /* Atoms that are drag and drop atoms */ 395 Atom *x_dnd_atoms; 396 size_t x_dnd_atoms_size; 397 size_t x_dnd_atoms_length; 398 399 /* Extended window manager hints, Atoms supported by the window manager */ 400 Atom *net_supported_atoms; 401 int nr_net_supported_atoms; 402 Window net_supported_window; 403}; 404 405#ifdef HAVE_X_I18N 406/* Whether or not to use XIM if we have it. */ 407extern int use_xim; 408#endif 409 410/* This checks to make sure we have a display. */ 411extern void check_x P_ ((void)); 412 413extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int)); 414 415#if defined (USE_X_TOOLKIT) || defined (USE_GTK) 416extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int)); 417extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int)); 418extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int)); 419#endif 420 421/* This is a chain of structures for all the X displays currently in use. */ 422extern struct x_display_info *x_display_list; 423 424/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE), 425 one for each element of x_display_list and in the same order. 426 NAME is the name of the frame. 427 FONT-LIST-CACHE records previous values returned by x-list-fonts. */ 428extern Lisp_Object x_display_name_list; 429 430/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */ 431extern Lisp_Object Vx_pixel_size_width_font_regexp; 432 433extern struct x_display_info *x_display_info_for_display P_ ((Display *)); 434extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object)); 435 436extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *)); 437extern int x_display_ok P_ ((const char *)); 438 439extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int)); 440extern void select_visual P_ ((struct x_display_info *)); 441extern struct font_info *x_get_font_info P_ ((struct frame *f, int)); 442extern struct font_info *x_load_font P_ ((struct frame *, char *, int)); 443extern struct font_info *x_query_font P_ ((struct frame *, char *)); 444extern void x_find_ccl_program P_ ((struct font_info *)); 445 446/* Each X frame object points to its own struct x_output object 447 in the output_data.x field. The x_output structure contains 448 the information that is specific to X windows. */ 449 450struct x_output 451{ 452 /* Height of menu bar widget, in pixels. 453 Zero if not using the X toolkit. 454 When using the toolkit, this value is not meaningful 455 if the menubar is turned off. */ 456 int menubar_height; 457 458 /* Height of tool bar widget, in pixels. 459 Zero if not using an external tool bar. */ 460 int toolbar_height; 461 462 /* The tiled border used when the mouse is out of the frame. */ 463 Pixmap border_tile; 464 465 /* Here are the Graphics Contexts for the default font. */ 466 GC normal_gc; /* Normal video */ 467 GC reverse_gc; /* Reverse video */ 468 GC cursor_gc; /* cursor drawing */ 469 470 /* The X window used for this frame. 471 May be zero while the frame object is being created 472 and the X window has not yet been created. */ 473 Window window_desc; 474 475 /* The X window used for the bitmap icon; 476 or 0 if we don't have a bitmap icon. */ 477 Window icon_desc; 478 479 /* The X window that is the parent of this X window. 480 Usually this is a window that was made by the window manager, 481 but it can be the root window, and it can be explicitly specified 482 (see the explicit_parent field, below). */ 483 Window parent_desc; 484 485#ifdef USE_X_TOOLKIT 486 /* The widget of this screen. This is the window of a "shell" widget. */ 487 Widget widget; 488 /* The XmPanedWindows... */ 489 Widget column_widget; 490 /* The widget of the edit portion of this screen; the window in 491 "window_desc" is inside of this. */ 492 Widget edit_widget; 493 494 Widget menubar_widget; 495#endif 496 497#ifdef USE_GTK 498 /* The widget of this screen. This is the window of a top widget. */ 499 GtkWidget *widget; 500 /* The widget of the edit portion of this screen; the window in 501 "window_desc" is inside of this. */ 502 GtkWidget *edit_widget; 503 /* The widget used for laying out widgets vertically. */ 504 GtkWidget *vbox_widget; 505 /* The menubar in this frame. */ 506 GtkWidget *menubar_widget; 507 /* The tool bar in this frame */ 508 GtkWidget *toolbar_widget; 509 /* The handle box that makes the tool bar detachable. */ 510 GtkWidget *handlebox_widget; 511 /* Non-zero if the tool bar is detached. */ 512 int toolbar_detached; 513 514 /* The last size hints set. */ 515 GdkGeometry size_hints; 516 long hint_flags; 517#endif 518 519 /* If >=0, a bitmap index. The indicated bitmap is used for the 520 icon. */ 521 int icon_bitmap; 522 523 /* Default ASCII font of this frame. */ 524 XFontStruct *font; 525 526 /* The baseline offset of the default ASCII font. */ 527 int baseline_offset; 528 529 /* If a fontset is specified for this frame instead of font, this 530 value contains an ID of the fontset, else -1. */ 531 int fontset; 532 533 /* Pixel values used for various purposes. 534 border_pixel may be -1 meaning use a gray tile. */ 535 unsigned long background_pixel; 536 unsigned long foreground_pixel; 537 unsigned long cursor_pixel; 538 unsigned long border_pixel; 539 unsigned long mouse_pixel; 540 unsigned long cursor_foreground_pixel; 541 542 /* Foreground color for scroll bars. A value of -1 means use the 543 default (black for non-toolkit scroll bars). */ 544 unsigned long scroll_bar_foreground_pixel; 545 546 /* Background color for scroll bars. A value of -1 means use the 547 default (background color of the frame for non-toolkit scroll 548 bars). */ 549 unsigned long scroll_bar_background_pixel; 550 551 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means 552 let the scroll compute them itself. */ 553 unsigned long scroll_bar_top_shadow_pixel; 554 unsigned long scroll_bar_bottom_shadow_pixel; 555 556 /* Descriptor for the cursor in use for this window. */ 557 Cursor text_cursor; 558 Cursor nontext_cursor; 559 Cursor modeline_cursor; 560 Cursor hand_cursor; 561 Cursor hourglass_cursor; 562 Cursor horizontal_drag_cursor; 563 564 /* Window whose cursor is hourglass_cursor. This window is temporarily 565 mapped to display an hourglass cursor. */ 566 Window hourglass_window; 567 568 /* Non-zero means hourglass cursor is currently displayed. */ 569 unsigned hourglass_p : 1; 570 571 /* Flag to set when the X window needs to be completely repainted. */ 572 int needs_exposure; 573 574 /* These are the current window manager hints. It seems that 575 XSetWMHints, when presented with an unset bit in the `flags' 576 member of the hints structure, does not leave the corresponding 577 attribute unchanged; rather, it resets that attribute to its 578 default value. For example, unless you set the `icon_pixmap' 579 field and the `IconPixmapHint' bit, XSetWMHints will forget what 580 your icon pixmap was. This is rather troublesome, since some of 581 the members (for example, `input' and `icon_pixmap') want to stay 582 the same throughout the execution of Emacs. So, we keep this 583 structure around, just leaving values in it and adding new bits 584 to the mask as we go. */ 585 XWMHints wm_hints; 586 587 /* This is the Emacs structure for the X display this frame is on. */ 588 struct x_display_info *display_info; 589 590 /* This is a button event that wants to activate the menubar. 591 We save it here until the command loop gets to think about it. */ 592 XEvent *saved_menu_event; 593 594 /* This is the widget id used for this frame's menubar in lwlib. */ 595#ifdef USE_X_TOOLKIT 596 int id; 597#endif 598 599 /* Nonzero means our parent is another application's window 600 and was explicitly specified. */ 601 char explicit_parent; 602 603 /* Nonzero means tried already to make this frame visible. */ 604 char asked_for_visible; 605 606 /* Nonzero if this frame was ever previously visible. */ 607 char has_been_visible; 608 609#ifdef HAVE_X_I18N 610 /* Input context (currently, this means Compose key handler setup). */ 611 XIC xic; 612 XIMStyle xic_style; 613 XFontSet xic_xfs; 614 char *xic_base_fontname; 615#endif 616 617 /* Relief GCs, colors etc. */ 618 struct relief 619 { 620 GC gc; 621 unsigned long pixel; 622 int allocated_p; 623 } 624 black_relief, white_relief; 625 626 /* The background for which the above relief GCs were set up. 627 They are changed only when a different background is involved. */ 628 unsigned long relief_background; 629 630 /* Xt waits for a ConfigureNotify event from the window manager in 631 EmacsFrameSetCharSize when the shell widget is resized. For some 632 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't 633 arrive for an unknown reason and Emacs hangs in Xt. If this is 634 zero, tell Xt not to wait. */ 635 int wait_for_wm; 636 637 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the 638 two might differ by a pixel, depending on WM */ 639 int x_pixels_outer_diff; 640 641 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version, 642 these may differ because this does not take into account possible 643 menubar. y_pixels_diff is with menubar height included */ 644 int y_pixels_outer_diff; 645 646 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this 647 frame, or IMPLICIT if we received an EnterNotify. 648 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */ 649 int focus_state; 650 651 /* The offset we need to add to compensate for type A WMs. */ 652 int move_offset_top; 653 int move_offset_left; 654 655 /* The frame's left/top offsets before we call XMoveWindow. See 656 x_check_expected_move. */ 657 int left_before_move; 658 int top_before_move; 659}; 660 661#define No_Cursor (None) 662 663enum 664{ 665 /* Values for focus_state, used as bit mask. 666 EXPLICIT means we received a FocusIn for the frame and know it has 667 the focus. IMPLICIT means we recevied an EnterNotify and the frame 668 may have the focus if no window manager is running. 669 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */ 670 FOCUS_NONE = 0, 671 FOCUS_IMPLICIT = 1, 672 FOCUS_EXPLICIT = 2 673}; 674 675 676/* Return the X output data for frame F. */ 677#define FRAME_X_OUTPUT(f) ((f)->output_data.x) 678 679/* Return the X window used for displaying data in frame F. */ 680#define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc) 681 682/* Return the outermost X window associated with the frame F. */ 683#ifdef USE_X_TOOLKIT 684#define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \ 685 XtWindow ((f)->output_data.x->widget) : \ 686 FRAME_X_WINDOW (f)) 687#else 688#ifdef USE_GTK 689#define GTK_WIDGET_TO_X_WIN(w) \ 690 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0) 691 692#define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget) 693#define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget) 694#define FRAME_OUTER_WINDOW(f) \ 695 (FRAME_GTK_OUTER_WIDGET (f) ? \ 696 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \ 697 FRAME_X_WINDOW (f)) 698 699#else /* !USE_GTK */ 700#define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f)) 701#endif /* !USE_GTK */ 702#endif 703 704 705#define FRAME_FONT(f) ((f)->output_data.x->font) 706#define FRAME_FONTSET(f) ((f)->output_data.x->fontset) 707#define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height) 708#define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height) 709#define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset) 710 711/* This gives the x_display_info structure for the display F is on. */ 712#define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info) 713 714/* This is the `Display *' which frame F is on. */ 715#define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display) 716 717/* This is the `Screen *' which frame F is on. */ 718#define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen) 719#define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f)) 720 721/* This is the Visual which frame F is on. */ 722#define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual 723 724/* This is the Colormap which frame F uses. */ 725#define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap 726 727/* This is the 'font_info *' which frame F has. */ 728#define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table) 729 730/* The difference in pixels between the top left corner of the 731 Emacs window (including possible window manager decorations) 732 and FRAME_X_WINDOW (f). */ 733#define FRAME_OUTER_TO_INNER_DIFF_X(f) \ 734 ((f)->output_data.x->x_pixels_outer_diff) 735#define FRAME_OUTER_TO_INNER_DIFF_Y(f) \ 736 ((f)->output_data.x->y_pixels_outer_diff \ 737 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f)) 738 739 740#define FRAME_XIC(f) ((f)->output_data.x->xic) 741#define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim) 742#define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles) 743#define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style) 744#define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs) 745#define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname) 746 747/* Value is the smallest width of any character in any font on frame F. */ 748 749#define FRAME_SMALLEST_CHAR_WIDTH(F) \ 750 FRAME_X_DISPLAY_INFO(F)->smallest_char_width 751 752/* Value is the smallest height of any font on frame F. */ 753 754#define FRAME_SMALLEST_FONT_HEIGHT(F) \ 755 FRAME_X_DISPLAY_INFO(F)->smallest_font_height 756 757/* Return a pointer to the image cache of frame F. */ 758 759#define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache 760 761 762/* X-specific scroll bar stuff. */ 763 764/* We represent scroll bars as lisp vectors. This allows us to place 765 references to them in windows without worrying about whether we'll 766 end up with windows referring to dead scroll bars; the garbage 767 collector will free it when its time comes. 768 769 We use struct scroll_bar as a template for accessing fields of the 770 vector. */ 771 772struct scroll_bar 773{ 774 /* These fields are shared by all vectors. */ 775 EMACS_INT size_from_Lisp_Vector_struct; 776 struct Lisp_Vector *next_from_Lisp_Vector_struct; 777 778 /* The window we're a scroll bar for. */ 779 Lisp_Object window; 780 781 /* The next and previous in the chain of scroll bars in this frame. */ 782 Lisp_Object next, prev; 783 784 /* The X window representing this scroll bar. Since this is a full 785 32-bit quantity, we store it split into two 32-bit values. */ 786 Lisp_Object x_window_low, x_window_high; 787 788 /* The position and size of the scroll bar in pixels, relative to the 789 frame. */ 790 Lisp_Object top, left, width, height; 791 792 /* The starting and ending positions of the handle, relative to the 793 handle area (i.e. zero is the top position, not 794 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle 795 hasn't been drawn yet. 796 797 These are not actually the locations where the beginning and end 798 are drawn; in order to keep handles from becoming invisible when 799 editing large files, we establish a minimum height by always 800 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below 801 where they would be normally; the bottom and top are in a 802 different co-ordinate system. */ 803 Lisp_Object start, end; 804 805 /* If the scroll bar handle is currently being dragged by the user, 806 this is the number of pixels from the top of the handle to the 807 place where the user grabbed it. If the handle isn't currently 808 being dragged, this is Qnil. */ 809 Lisp_Object dragging; 810}; 811 812/* The number of elements a vector holding a struct scroll_bar needs. */ 813#define SCROLL_BAR_VEC_SIZE \ 814 ((sizeof (struct scroll_bar) \ 815 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \ 816 / sizeof (Lisp_Object)) 817 818/* Turning a lisp vector value into a pointer to a struct scroll_bar. */ 819#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec)) 820 821 822/* Building a 32-bit C integer from two 16-bit lisp integers. */ 823#define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low)) 824 825/* Setting two lisp integers to the low and high words of a 32-bit C int. */ 826#define SCROLL_BAR_UNPACK(low, high, int32) \ 827 (XSETINT ((low), (int32) & 0xffff), \ 828 XSETINT ((high), ((int32) >> 16) & 0xffff)) 829 830 831/* Extract the X window id of the scroll bar from a struct scroll_bar. */ 832#define SCROLL_BAR_X_WINDOW(ptr) \ 833 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high)) 834 835/* Store a window id in a struct scroll_bar. */ 836#define SET_SCROLL_BAR_X_WINDOW(ptr, id) \ 837 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id)) 838 839/* Extract the X widget of the scroll bar from a struct scroll_bar. 840 XtWindowToWidget should be fast enough since Xt uses a hash table 841 to map windows to widgets. */ 842 843#define SCROLL_BAR_X_WIDGET(dpy, ptr) \ 844 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr)) 845 846/* Store a widget id in a struct scroll_bar. */ 847 848#define SET_SCROLL_BAR_X_WIDGET(ptr, w) \ 849 do { \ 850 Window window = XtWindow (w); \ 851 SET_SCROLL_BAR_X_WINDOW (ptr, window); \ 852} while (0) 853 854 855/* Return the inside width of a vertical scroll bar, given the outside 856 width. */ 857#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \ 858 ((width) \ 859 - VERTICAL_SCROLL_BAR_LEFT_BORDER \ 860 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \ 861 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2) 862 863/* Return the length of the rectangle within which the top of the 864 handle must stay. This isn't equivalent to the inside height, 865 because the scroll bar handle has a minimum height. 866 867 This is the real range of motion for the scroll bar, so when we're 868 scaling buffer positions to scroll bar positions, we use this, not 869 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */ 870#define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \ 871 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE) 872 873/* Return the inside height of vertical scroll bar, given the outside 874 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */ 875#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \ 876 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER) 877 878 879/* Border widths for scroll bars. 880 881 Scroll bar windows don't have any X borders; their border width is 882 set to zero, and we redraw borders ourselves. This makes the code 883 a bit cleaner, since we don't have to convert between outside width 884 (used when relating to the rest of the screen) and inside width 885 (used when sizing and drawing the scroll bar window itself). 886 887 The handle moves up and down/back and forth in a rectangle inset 888 from the edges of the scroll bar. These are widths by which we 889 inset the handle boundaries from the scroll bar edges. */ 890#define VERTICAL_SCROLL_BAR_LEFT_BORDER (2) 891#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2) 892#define VERTICAL_SCROLL_BAR_TOP_BORDER (2) 893#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2) 894 895/* Minimum lengths for scroll bar handles, in pixels. */ 896#define VERTICAL_SCROLL_BAR_MIN_HANDLE (5) 897 898/* Trimming off a few pixels from each side prevents 899 text from glomming up against the scroll bar */ 900#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0) 901 902 903/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT 904 or SELECTION_CLEAR_EVENT, then its contents are really described 905 by this structure. */ 906 907/* For an event of kind SELECTION_REQUEST_EVENT, 908 this structure really describes the contents. 909 **Don't make this struct longer!** 910 If it overlaps the frame_or_window field of struct input_event, 911 that will cause GC to crash. */ 912struct selection_input_event 913{ 914 int kind; 915 Display *display; 916 /* We spell it with an "o" here because X does. */ 917 Window requestor; 918 Atom selection, target, property; 919 Time time; 920}; 921 922#define SELECTION_EVENT_DISPLAY(eventp) \ 923 (((struct selection_input_event *) (eventp))->display) 924/* We spell it with an "o" here because X does. */ 925#define SELECTION_EVENT_REQUESTOR(eventp) \ 926 (((struct selection_input_event *) (eventp))->requestor) 927#define SELECTION_EVENT_SELECTION(eventp) \ 928 (((struct selection_input_event *) (eventp))->selection) 929#define SELECTION_EVENT_TARGET(eventp) \ 930 (((struct selection_input_event *) (eventp))->target) 931#define SELECTION_EVENT_PROPERTY(eventp) \ 932 (((struct selection_input_event *) (eventp))->property) 933#define SELECTION_EVENT_TIME(eventp) \ 934 (((struct selection_input_event *) (eventp))->time) 935 936 937struct window; 938struct glyph_matrix; 939struct frame; 940struct input_event; 941struct face; 942struct image; 943 944/* From xselect.c. */ 945 946void x_handle_selection_notify P_ ((XSelectionEvent *)); 947void x_handle_property_notify P_ ((XPropertyEvent *)); 948 949/* From xfns.c. */ 950 951Lisp_Object display_x_get_resource P_ ((struct x_display_info *, 952 Lisp_Object, Lisp_Object, 953 Lisp_Object, Lisp_Object)); 954struct frame *check_x_frame P_ ((Lisp_Object)); 955EXFUN (Fx_display_color_p, 1); 956EXFUN (Fx_display_grayscale_p, 1); 957extern void x_free_gcs P_ ((struct frame *)); 958 959/* From xrdb.c. */ 960 961char *x_get_customization_string P_ ((XrmDatabase, char *, char *)); 962XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *)); 963int x_get_resource P_ ((XrmDatabase, char *, char *, 964 XrmRepresentation, XrmValue *)); 965void x_delete_display P_ ((struct x_display_info *)); 966void x_make_frame_visible P_ ((struct frame *)); 967void x_iconify_frame P_ ((struct frame *)); 968void x_wm_set_size_hint P_ ((struct frame *, long, int)); 969int x_text_icon P_ ((struct frame *, char *)); 970int x_bitmap_icon P_ ((struct frame *, Lisp_Object)); 971void x_set_window_size P_ ((struct frame *, int, int, int)); 972void x_wm_set_window_state P_ ((struct frame *, int)); 973int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *)); 974 975/* Defined in xterm.c */ 976 977extern void cancel_mouse_face P_ ((struct frame *)); 978extern void x_scroll_bar_clear P_ ((struct frame *)); 979extern int x_text_icon P_ ((struct frame *, char *)); 980extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object)); 981extern void x_catch_errors P_ ((Display *)); 982extern void x_check_errors P_ ((Display *, char *)); 983extern int x_had_errors_p P_ ((Display *)); 984extern int x_catching_errors P_ ((void)); 985extern void x_uncatch_errors P_ ((void)); 986extern void x_clear_errors P_ ((Display *)); 987extern void x_fully_uncatch_errors P_ ((void)); 988extern void x_set_window_size P_ ((struct frame *, int, int, int)); 989extern void x_set_mouse_position P_ ((struct frame *, int, int)); 990extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int)); 991extern void x_raise_frame P_ ((struct frame *)); 992extern void x_lower_frame P_ ((struct frame *)); 993extern void x_make_frame_visible P_ ((struct frame *)); 994extern void x_make_frame_invisible P_ ((struct frame *)); 995extern void x_iconify_frame P_ ((struct frame *)); 996extern void x_free_frame_resources P_ ((struct frame *)); 997extern void x_destroy_window P_ ((struct frame *)); 998extern void x_wm_set_size_hint P_ ((struct frame *, long, int)); 999extern void x_wm_set_window_state P_ ((struct frame *, int)); 1000extern void x_wm_set_icon_pixmap P_ ((struct frame *, int)); 1001extern void x_delete_display P_ ((struct x_display_info *)); 1002extern void x_initialize P_ ((void)); 1003extern unsigned long x_copy_color P_ ((struct frame *, unsigned long)); 1004#ifdef USE_X_TOOLKIT 1005extern XtAppContext Xt_app_con; 1006extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap, 1007 unsigned long *, 1008 double, int)); 1009extern void x_activate_timeout_atimer P_ ((void)); 1010#endif 1011extern void x_query_colors P_ ((struct frame *f, XColor *, int)); 1012extern void x_query_color P_ ((struct frame *f, XColor *)); 1013extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int)); 1014extern void set_vertical_scroll_bar P_ ((struct window *)); 1015 1016extern int x_dispatch_event P_ ((XEvent *, Display *)); 1017extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *, 1018 unsigned)); 1019 1020/* Defined in xselect.c */ 1021 1022extern void x_handle_property_notify P_ ((XPropertyEvent *)); 1023extern void x_handle_selection_notify P_ ((XSelectionEvent *)); 1024extern void x_handle_selection_event P_ ((struct input_event *)); 1025extern void x_clear_frame_selections P_ ((struct frame *)); 1026 1027extern int x_handle_dnd_message P_ ((struct frame *, 1028 XClientMessageEvent *, 1029 struct x_display_info *, 1030 struct input_event *bufp)); 1031extern int x_check_property_data P_ ((Lisp_Object)); 1032extern void x_fill_property_data P_ ((Display *, 1033 Lisp_Object, 1034 void *, 1035 int)); 1036extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *, 1037 unsigned char *, 1038 Atom, 1039 int, 1040 unsigned long)); 1041 1042/* Defined in xfns.c */ 1043 1044extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame)); 1045extern int have_menus_p P_ ((void)); 1046 1047#ifdef USE_GTK 1048extern int xg_set_icon P_ ((struct frame *, Lisp_Object)); 1049extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**)); 1050#endif /* USE_GTK */ 1051 1052extern void x_real_positions P_ ((struct frame *, int *, int *)); 1053extern int defined_color P_ ((struct frame *, char *, XColor *, int)); 1054extern void x_set_border_pixel P_ ((struct frame *, int)); 1055extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object)); 1056extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object)); 1057extern void xic_free_xfontset P_ ((struct frame *)); 1058extern void create_frame_xic P_ ((struct frame *)); 1059extern void destroy_frame_xic P_ ((struct frame *)); 1060extern void xic_set_preeditarea P_ ((struct window *, int, int)); 1061extern void xic_set_statusarea P_ ((struct frame *)); 1062extern void xic_set_xfontset P_ ((struct frame *, char *)); 1063extern int x_pixel_width P_ ((struct frame *)); 1064extern int x_pixel_height P_ ((struct frame *)); 1065extern int x_char_width P_ ((struct frame *)); 1066extern int x_char_height P_ ((struct frame *)); 1067extern int x_screen_planes P_ ((struct frame *)); 1068extern void x_sync P_ ((struct frame *)); 1069extern int x_defined_color P_ ((struct frame *, char *, XColor *, int)); 1070#ifdef HAVE_X_I18N 1071extern void free_frame_xic P_ ((struct frame *)); 1072#endif 1073extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object)); 1074 1075/* Defined in xfaces.c */ 1076 1077extern int compute_glyph_face P_ ((struct frame *, int, int)); 1078extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int)); 1079extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap, 1080 unsigned long *, int)); 1081 1082/* Defined in xmenu.c */ 1083 1084extern void x_menu_set_in_use P_ ((int)); 1085extern void x_menu_wait_for_event P_ ((void *data)); 1086extern void x_activate_menubar P_ ((struct frame *)); 1087extern int popup_activated P_ ((void)); 1088extern void initialize_frame_menubar P_ ((struct frame *)); 1089extern void free_frame_menubar P_ ((struct frame *)); 1090 1091/* Defined in widget.c */ 1092 1093#ifdef USE_X_TOOLKIT 1094extern void widget_store_internal_border P_ ((Widget)); 1095#endif 1096 1097/* Defined in xsmfns.c */ 1098#ifdef HAVE_X_SM 1099extern void x_session_initialize P_ ((struct x_display_info *dpyinfo)); 1100extern int x_session_check_input P_ ((struct input_event *bufp)); 1101extern int x_session_have_connection P_ ((void)); 1102#endif 1103 1104#define FONT_TYPE_FOR_UNIBYTE(font, ch) 0 1105#define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0 1106 1107#define STORE_XCHAR2B(chp, b1, b2) \ 1108 ((chp)->byte1 = (b1), (chp)->byte2 = (b2)) 1109 1110#define XCHAR2B_BYTE1(chp) \ 1111 ((chp)->byte1) 1112 1113#define XCHAR2B_BYTE2(chp) \ 1114 ((chp)->byte2) 1115 1116 1117#define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \ 1118 ((nr).x = (rx), \ 1119 (nr).y = (ry), \ 1120 (nr).width = (rwidth), \ 1121 (nr).height = (rheight)) 1122 1123/* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e 1124 (do not change this comment) */ 1125