Merge from emacs--devo--0
[emacs/old-mirror.git] / src / xterm.h
blobc607080a5dc2cee6323f4aa83b2feba9c6f16a0e
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.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 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)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #include <X11/Xlib.h>
23 #include <X11/cursorfont.h>
25 /* Include Xutil.h after keysym.h to work around a bug that prevents
26 correct recognition of AltGr key in some X versions. */
28 #include <X11/keysym.h>
29 #include <X11/Xutil.h>
31 #include <X11/Xatom.h>
32 #include <X11/Xresource.h>
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>
42 typedef Widget xt_or_gtk_widget;
43 #endif
45 #ifdef USE_GTK
46 #include <gtk/gtk.h>
47 #include <gdk/gdkx.h>
49 /* Some definitions to reduce conditionals. */
50 typedef 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)
57 #endif /* USE_GTK */
60 /* Bookkeeping to distinguish X versions. */
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:
68 #ifdef HAVE_X11R5
69 ...
70 #elif HAVE_X11R4
71 ...
72 #elif HAVE_X11
73 ...
74 #endif
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.
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
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
100 #ifdef HAVE_X_I18N
101 #include <X11/Xlocale.h>
102 #endif
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)))
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)
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. */
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)
130 /* Structure recording X pixmap and reference count.
131 If REFCOUNT is 0 then this record is free to be reused. */
133 struct x_bitmap_record
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;
144 /* For each X display, we have a structure that records
145 information about it. */
147 struct x_display_info
149 /* Chain of all x_display_info structures. */
150 struct x_display_info *next;
152 /* Connection number (normally a file descriptor number). */
153 int connection;
155 /* This says how to access this display in Xlib. */
156 Display *display;
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;
162 /* Number of frames that are on this display. */
163 int reference_count;
165 /* The Screen this connection is connected to. */
166 Screen *screen;
168 /* Dots per inch of the screen. */
169 double resx, resy;
171 /* The Visual being used for this display. */
172 Visual *visual;
174 /* The colormap being used. */
175 Colormap cmap;
177 /* Number of planes on this screen. */
178 int n_planes;
180 /* Dimensions of this screen. */
181 int height, width;
183 /* Mask of things that cause the mouse to be grabbed. */
184 int grabbed;
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;
190 /* The root window of this screen. */
191 Window root_window;
193 /* Client leader window. */
194 Window client_leader_window;
196 /* The cursor to use for vertical scroll bars. */
197 Cursor vertical_scroll_bar_cursor;
199 #ifdef USE_GTK
200 /* The GDK cursor for scroll bars and popup menus. */
201 GdkCursor *xg_cursor;
202 #endif
204 /* X Resource data base */
205 XrmDatabase xrdb;
207 /* A table of all the fonts we have already loaded. */
208 struct font_info *font_table;
210 /* The current capacity of x_font_table. */
211 int font_table_size;
213 /* Minimum width over all characters in all fonts in font_table. */
214 int smallest_char_width;
216 /* Minimum font height over all fonts in font_table. */
217 int smallest_font_height;
219 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
220 GC scratch_cursor_gc;
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;
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;
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;
245 /* Nonzero means defer mouse-motion highlighting. */
246 int mouse_face_defer;
248 /* Nonzero means that the mouse highlight should not be shown. */
249 int mouse_face_hidden;
251 int mouse_face_image_state;
253 char *x_id_name;
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;
260 /* Pointer to bitmap records. */
261 struct x_bitmap_record *bitmaps;
263 /* Allocated size of bitmaps field. */
264 int bitmaps_size;
266 /* Last used bitmap index. */
267 int bitmaps_last;
269 /* Which modifier keys are on which modifier bits?
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.
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.
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;
290 /* These are like meta_mod_mask, but for different modifiers. */
291 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
293 /* Communication with window managers. */
294 Atom Xatom_wm_protocols;
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;
301 /* Atom for indicating window state to the window manager. */
302 Atom Xatom_wm_change_state;
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. */
309 /* EditRes protocol */
310 Atom Xatom_editres;
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;
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;
324 /* More atoms for Ghostscript support. */
325 Atom Xatom_DONE, Xatom_PAGE;
327 /* Atom used in toolkit scroll bar client messages. */
328 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 */
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;
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;
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;
355 /* The null pixel used for filling a character background with
356 background color of a gc. */
357 Pixmap null_pixel;
359 /* The gray pixmap. */
360 Pixmap gray;
362 /* Cache of images. */
363 struct image_cache *image_cache;
365 #ifdef HAVE_X_I18N
366 /* XIM (X Input method). */
367 XIM xim;
368 XIMStyles *xim_styles;
369 #endif
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;
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;
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
388 X_WMTYPE_UNKNOWN,
389 X_WMTYPE_A,
390 X_WMTYPE_B
391 } wm_type;
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;
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;
405 #ifdef HAVE_X_I18N
406 /* Whether or not to use XIM if we have it. */
407 extern int use_xim;
408 #endif
410 /* This checks to make sure we have a display. */
411 extern void check_x P_ ((void));
413 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
415 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
416 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
417 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
418 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
419 #endif
421 /* This is a chain of structures for all the X displays currently in use. */
422 extern struct x_display_info *x_display_list;
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. */
428 extern Lisp_Object x_display_name_list;
430 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
431 extern Lisp_Object Vx_pixel_size_width_font_regexp;
433 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
434 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
436 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
437 extern int x_display_ok P_ ((const char *));
439 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
440 extern void select_visual P_ ((struct x_display_info *));
441 extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
442 extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
443 extern struct font_info *x_query_font P_ ((struct frame *, char *));
444 extern void x_find_ccl_program P_ ((struct font_info *));
445 extern Lisp_Object x_get_font_repertory P_ ((struct frame *,
446 struct font_info *));
449 /* Each X frame object points to its own struct x_output object
450 in the output_data.x field. The x_output structure contains
451 the information that is specific to X windows. */
453 struct x_output
455 /* Height of menu bar widget, in pixels.
456 Zero if not using the X toolkit.
457 When using the toolkit, this value is not meaningful
458 if the menubar is turned off. */
459 int menubar_height;
461 /* Height of tool bar widget, in pixels.
462 Zero if not using an external tool bar. */
463 int toolbar_height;
465 /* The tiled border used when the mouse is out of the frame. */
466 Pixmap border_tile;
468 /* Here are the Graphics Contexts for the default font. */
469 GC normal_gc; /* Normal video */
470 GC reverse_gc; /* Reverse video */
471 GC cursor_gc; /* cursor drawing */
473 /* The X window used for this frame.
474 May be zero while the frame object is being created
475 and the X window has not yet been created. */
476 Window window_desc;
478 /* The X window used for the bitmap icon;
479 or 0 if we don't have a bitmap icon. */
480 Window icon_desc;
482 /* The X window that is the parent of this X window.
483 Usually this is a window that was made by the window manager,
484 but it can be the root window, and it can be explicitly specified
485 (see the explicit_parent field, below). */
486 Window parent_desc;
488 #ifdef USE_X_TOOLKIT
489 /* The widget of this screen. This is the window of a "shell" widget. */
490 Widget widget;
491 /* The XmPanedWindows... */
492 Widget column_widget;
493 /* The widget of the edit portion of this screen; the window in
494 "window_desc" is inside of this. */
495 Widget edit_widget;
497 Widget menubar_widget;
498 #endif
500 #ifdef USE_GTK
501 /* The widget of this screen. This is the window of a top widget. */
502 GtkWidget *widget;
503 /* The widget of the edit portion of this screen; the window in
504 "window_desc" is inside of this. */
505 GtkWidget *edit_widget;
506 /* The widget used for laying out widgets vertically. */
507 GtkWidget *vbox_widget;
508 /* The menubar in this frame. */
509 GtkWidget *menubar_widget;
510 /* The tool bar in this frame */
511 GtkWidget *toolbar_widget;
512 /* The handle box that makes the tool bar detachable. */
513 GtkWidget *handlebox_widget;
514 /* Non-zero if the tool bar is detached. */
515 int toolbar_detached;
517 /* The last size hints set. */
518 GdkGeometry size_hints;
519 long hint_flags;
520 #endif
522 /* If >=0, a bitmap index. The indicated bitmap is used for the
523 icon. */
524 int icon_bitmap;
526 /* Default ASCII font of this frame. */
527 XFontStruct *font;
529 #ifdef USE_FONT_BACKEND
530 struct font *fontp;
531 #endif /* USE_FONT_BACKEND */
533 /* The baseline offset of the default ASCII font. */
534 int baseline_offset;
536 /* If a fontset is specified for this frame instead of font, this
537 value contains an ID of the fontset, else -1. */
538 int fontset;
540 /* Pixel values used for various purposes.
541 border_pixel may be -1 meaning use a gray tile. */
542 unsigned long background_pixel;
543 unsigned long foreground_pixel;
544 unsigned long cursor_pixel;
545 unsigned long border_pixel;
546 unsigned long mouse_pixel;
547 unsigned long cursor_foreground_pixel;
549 /* Foreground color for scroll bars. A value of -1 means use the
550 default (black for non-toolkit scroll bars). */
551 unsigned long scroll_bar_foreground_pixel;
553 /* Background color for scroll bars. A value of -1 means use the
554 default (background color of the frame for non-toolkit scroll
555 bars). */
556 unsigned long scroll_bar_background_pixel;
558 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
559 let the scroll compute them itself. */
560 unsigned long scroll_bar_top_shadow_pixel;
561 unsigned long scroll_bar_bottom_shadow_pixel;
563 /* Descriptor for the cursor in use for this window. */
564 Cursor text_cursor;
565 Cursor nontext_cursor;
566 Cursor modeline_cursor;
567 Cursor hand_cursor;
568 Cursor hourglass_cursor;
569 Cursor horizontal_drag_cursor;
571 /* Window whose cursor is hourglass_cursor. This window is temporarily
572 mapped to display an hourglass cursor. */
573 Window hourglass_window;
575 /* Non-zero means hourglass cursor is currently displayed. */
576 unsigned hourglass_p : 1;
578 /* Flag to set when the X window needs to be completely repainted. */
579 int needs_exposure;
581 /* These are the current window manager hints. It seems that
582 XSetWMHints, when presented with an unset bit in the `flags'
583 member of the hints structure, does not leave the corresponding
584 attribute unchanged; rather, it resets that attribute to its
585 default value. For example, unless you set the `icon_pixmap'
586 field and the `IconPixmapHint' bit, XSetWMHints will forget what
587 your icon pixmap was. This is rather troublesome, since some of
588 the members (for example, `input' and `icon_pixmap') want to stay
589 the same throughout the execution of Emacs. So, we keep this
590 structure around, just leaving values in it and adding new bits
591 to the mask as we go. */
592 XWMHints wm_hints;
594 /* This is the Emacs structure for the X display this frame is on. */
595 struct x_display_info *display_info;
597 /* This is a button event that wants to activate the menubar.
598 We save it here until the command loop gets to think about it. */
599 XEvent *saved_menu_event;
601 /* This is the widget id used for this frame's menubar in lwlib. */
602 #ifdef USE_X_TOOLKIT
603 int id;
604 #endif
606 /* Nonzero means our parent is another application's window
607 and was explicitly specified. */
608 char explicit_parent;
610 /* Nonzero means tried already to make this frame visible. */
611 char asked_for_visible;
613 /* Nonzero if this frame was ever previously visible. */
614 char has_been_visible;
616 #ifdef HAVE_X_I18N
617 /* Input context (currently, this means Compose key handler setup). */
618 XIC xic;
619 XIMStyle xic_style;
620 XFontSet xic_xfs;
621 char *xic_base_fontname;
622 #endif
624 /* Relief GCs, colors etc. */
625 struct relief
627 GC gc;
628 unsigned long pixel;
629 int allocated_p;
631 black_relief, white_relief;
633 /* The background for which the above relief GCs were set up.
634 They are changed only when a different background is involved. */
635 unsigned long relief_background;
637 /* Xt waits for a ConfigureNotify event from the window manager in
638 EmacsFrameSetCharSize when the shell widget is resized. For some
639 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
640 arrive for an unknown reason and Emacs hangs in Xt. If this is
641 zero, tell Xt not to wait. */
642 int wait_for_wm;
644 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
645 two might differ by a pixel, depending on WM */
646 int x_pixels_outer_diff;
648 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
649 these may differ because this does not take into account possible
650 menubar. y_pixels_diff is with menubar height included */
651 int y_pixels_outer_diff;
653 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
654 frame, or IMPLICIT if we received an EnterNotify.
655 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
656 int focus_state;
658 /* The offset we need to add to compensate for type A WMs. */
659 int move_offset_top;
660 int move_offset_left;
662 /* The frame's left/top offsets before we call XMoveWindow. See
663 x_check_expected_move. */
664 int left_before_move;
665 int top_before_move;
668 #define No_Cursor (None)
670 enum
672 /* Values for focus_state, used as bit mask.
673 EXPLICIT means we received a FocusIn for the frame and know it has
674 the focus. IMPLICIT means we recevied an EnterNotify and the frame
675 may have the focus if no window manager is running.
676 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
677 FOCUS_NONE = 0,
678 FOCUS_IMPLICIT = 1,
679 FOCUS_EXPLICIT = 2
683 /* Return the X output data for frame F. */
684 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
686 /* Return the X window used for displaying data in frame F. */
687 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
689 /* Return the outermost X window associated with the frame F. */
690 #ifdef USE_X_TOOLKIT
691 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
692 XtWindow ((f)->output_data.x->widget) : \
693 FRAME_X_WINDOW (f))
694 #else
695 #ifdef USE_GTK
696 #define GTK_WIDGET_TO_X_WIN(w) \
697 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
699 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
700 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
701 #define FRAME_OUTER_WINDOW(f) \
702 (FRAME_GTK_OUTER_WIDGET (f) ? \
703 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
704 FRAME_X_WINDOW (f))
706 #else /* !USE_GTK */
707 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
708 #endif /* !USE_GTK */
709 #endif
712 #define FRAME_FONT(f) ((f)->output_data.x->font)
713 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
714 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
715 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
716 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
718 #ifdef USE_FONT_BACKEND
719 #define FRAME_FONT_OBJECT(f) ((f)->output_data.x->fontp)
720 #endif /* USE_FONT_BACKEND */
722 /* This gives the x_display_info structure for the display F is on. */
723 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
725 /* This is the `Display *' which frame F is on. */
726 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
728 /* This is the `Screen *' which frame F is on. */
729 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
730 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
732 /* This is the Visual which frame F is on. */
733 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
735 /* This is the Colormap which frame F uses. */
736 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
738 /* This is the 'font_info *' which frame F has. */
739 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
741 /* The difference in pixels between the top left corner of the
742 Emacs window (including possible window manager decorations)
743 and FRAME_X_WINDOW (f). */
744 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
745 ((f)->output_data.x->x_pixels_outer_diff)
746 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
747 ((f)->output_data.x->y_pixels_outer_diff \
748 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
751 #define FRAME_XIC(f) ((f)->output_data.x->xic)
752 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
753 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
754 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
755 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
756 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
758 /* Value is the smallest width of any character in any font on frame F. */
760 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
761 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
763 /* Value is the smallest height of any font on frame F. */
765 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
766 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
768 /* Return a pointer to the image cache of frame F. */
770 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
773 /* X-specific scroll bar stuff. */
775 /* We represent scroll bars as lisp vectors. This allows us to place
776 references to them in windows without worrying about whether we'll
777 end up with windows referring to dead scroll bars; the garbage
778 collector will free it when its time comes.
780 We use struct scroll_bar as a template for accessing fields of the
781 vector. */
783 struct scroll_bar
785 /* These fields are shared by all vectors. */
786 EMACS_INT size_from_Lisp_Vector_struct;
787 struct Lisp_Vector *next_from_Lisp_Vector_struct;
789 /* The window we're a scroll bar for. */
790 Lisp_Object window;
792 /* The next and previous in the chain of scroll bars in this frame. */
793 Lisp_Object next, prev;
795 /* The X window representing this scroll bar. Since this is a full
796 32-bit quantity, we store it split into two 32-bit values. */
797 Lisp_Object x_window_low, x_window_high;
799 /* The position and size of the scroll bar in pixels, relative to the
800 frame. */
801 Lisp_Object top, left, width, height;
803 /* The starting and ending positions of the handle, relative to the
804 handle area (i.e. zero is the top position, not
805 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
806 hasn't been drawn yet.
808 These are not actually the locations where the beginning and end
809 are drawn; in order to keep handles from becoming invisible when
810 editing large files, we establish a minimum height by always
811 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
812 where they would be normally; the bottom and top are in a
813 different co-ordinate system. */
814 Lisp_Object start, end;
816 /* If the scroll bar handle is currently being dragged by the user,
817 this is the number of pixels from the top of the handle to the
818 place where the user grabbed it. If the handle isn't currently
819 being dragged, this is Qnil. */
820 Lisp_Object dragging;
823 /* The number of elements a vector holding a struct scroll_bar needs. */
824 #define SCROLL_BAR_VEC_SIZE \
825 ((sizeof (struct scroll_bar) \
826 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
827 / sizeof (Lisp_Object))
829 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
830 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
833 /* Building a 32-bit C integer from two 16-bit lisp integers. */
834 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
836 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
837 #define SCROLL_BAR_UNPACK(low, high, int32) \
838 (XSETINT ((low), (int32) & 0xffff), \
839 XSETINT ((high), ((int32) >> 16) & 0xffff))
842 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
843 #define SCROLL_BAR_X_WINDOW(ptr) \
844 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
846 /* Store a window id in a struct scroll_bar. */
847 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
848 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
850 /* Extract the X widget of the scroll bar from a struct scroll_bar.
851 XtWindowToWidget should be fast enough since Xt uses a hash table
852 to map windows to widgets. */
854 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
855 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
857 /* Store a widget id in a struct scroll_bar. */
859 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
860 do { \
861 Window window = XtWindow (w); \
862 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
863 } while (0)
866 /* Return the inside width of a vertical scroll bar, given the outside
867 width. */
868 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
869 ((width) \
870 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
871 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
872 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
874 /* Return the length of the rectangle within which the top of the
875 handle must stay. This isn't equivalent to the inside height,
876 because the scroll bar handle has a minimum height.
878 This is the real range of motion for the scroll bar, so when we're
879 scaling buffer positions to scroll bar positions, we use this, not
880 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
881 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
882 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
884 /* Return the inside height of vertical scroll bar, given the outside
885 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
886 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
887 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
890 /* Border widths for scroll bars.
892 Scroll bar windows don't have any X borders; their border width is
893 set to zero, and we redraw borders ourselves. This makes the code
894 a bit cleaner, since we don't have to convert between outside width
895 (used when relating to the rest of the screen) and inside width
896 (used when sizing and drawing the scroll bar window itself).
898 The handle moves up and down/back and forth in a rectangle inset
899 from the edges of the scroll bar. These are widths by which we
900 inset the handle boundaries from the scroll bar edges. */
901 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
902 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
903 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
904 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
906 /* Minimum lengths for scroll bar handles, in pixels. */
907 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
909 /* Trimming off a few pixels from each side prevents
910 text from glomming up against the scroll bar */
911 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
914 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
915 or SELECTION_CLEAR_EVENT, then its contents are really described
916 by this structure. */
918 /* For an event of kind SELECTION_REQUEST_EVENT,
919 this structure really describes the contents.
920 **Don't make this struct longer!**
921 If it overlaps the frame_or_window field of struct input_event,
922 that will cause GC to crash. */
923 struct selection_input_event
925 int kind;
926 Display *display;
927 /* We spell it with an "o" here because X does. */
928 Window requestor;
929 Atom selection, target, property;
930 Time time;
933 #define SELECTION_EVENT_DISPLAY(eventp) \
934 (((struct selection_input_event *) (eventp))->display)
935 /* We spell it with an "o" here because X does. */
936 #define SELECTION_EVENT_REQUESTOR(eventp) \
937 (((struct selection_input_event *) (eventp))->requestor)
938 #define SELECTION_EVENT_SELECTION(eventp) \
939 (((struct selection_input_event *) (eventp))->selection)
940 #define SELECTION_EVENT_TARGET(eventp) \
941 (((struct selection_input_event *) (eventp))->target)
942 #define SELECTION_EVENT_PROPERTY(eventp) \
943 (((struct selection_input_event *) (eventp))->property)
944 #define SELECTION_EVENT_TIME(eventp) \
945 (((struct selection_input_event *) (eventp))->time)
948 struct window;
949 struct glyph_matrix;
950 struct frame;
951 struct input_event;
952 struct face;
953 struct image;
955 /* From xselect.c. */
957 void x_handle_selection_notify P_ ((XSelectionEvent *));
958 void x_handle_property_notify P_ ((XPropertyEvent *));
960 /* From xfns.c. */
962 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
963 Lisp_Object, Lisp_Object,
964 Lisp_Object, Lisp_Object));
965 struct frame *check_x_frame P_ ((Lisp_Object));
966 EXFUN (Fx_display_color_p, 1);
967 EXFUN (Fx_display_grayscale_p, 1);
968 extern void x_free_gcs P_ ((struct frame *));
970 /* From xrdb.c. */
972 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
973 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
974 int x_get_resource P_ ((XrmDatabase, char *, char *,
975 XrmRepresentation, XrmValue *));
976 void x_delete_display P_ ((struct x_display_info *));
977 void x_make_frame_visible P_ ((struct frame *));
978 void x_iconify_frame P_ ((struct frame *));
979 void x_wm_set_size_hint P_ ((struct frame *, long, int));
980 int x_text_icon P_ ((struct frame *, char *));
981 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
982 void x_set_window_size P_ ((struct frame *, int, int, int));
983 void x_wm_set_window_state P_ ((struct frame *, int));
984 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
986 /* Defined in xterm.c */
988 extern void cancel_mouse_face P_ ((struct frame *));
989 extern void x_scroll_bar_clear P_ ((struct frame *));
990 extern int x_text_icon P_ ((struct frame *, char *));
991 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
992 extern void x_catch_errors P_ ((Display *));
993 extern void x_check_errors P_ ((Display *, char *));
994 extern int x_had_errors_p P_ ((Display *));
995 extern int x_catching_errors P_ ((void));
996 extern void x_uncatch_errors P_ ((void));
997 extern void x_clear_errors P_ ((Display *));
998 extern void x_fully_uncatch_errors P_ ((void));
999 extern void x_set_window_size P_ ((struct frame *, int, int, int));
1000 extern void x_set_mouse_position P_ ((struct frame *, int, int));
1001 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
1002 extern void x_ewmh_activate_frame P_ ((struct frame *));
1003 extern void x_raise_frame P_ ((struct frame *));
1004 extern void x_lower_frame P_ ((struct frame *));
1005 extern void x_make_frame_visible P_ ((struct frame *));
1006 extern void x_make_frame_invisible P_ ((struct frame *));
1007 extern void x_iconify_frame P_ ((struct frame *));
1008 extern void x_free_frame_resources P_ ((struct frame *));
1009 extern void x_destroy_window P_ ((struct frame *));
1010 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
1011 extern void x_wm_set_window_state P_ ((struct frame *, int));
1012 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
1013 extern void x_delete_display P_ ((struct x_display_info *));
1014 extern void x_initialize P_ ((void));
1015 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
1016 #ifdef USE_X_TOOLKIT
1017 extern XtAppContext Xt_app_con;
1018 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
1019 unsigned long *,
1020 double, int));
1021 extern void x_activate_timeout_atimer P_ ((void));
1022 #endif
1023 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
1024 extern void x_query_color P_ ((struct frame *f, XColor *));
1025 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
1026 extern void set_vertical_scroll_bar P_ ((struct window *));
1028 extern int x_dispatch_event P_ ((XEvent *, Display *));
1029 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
1030 unsigned));
1032 /* Defined in xselect.c */
1034 extern void x_handle_property_notify P_ ((XPropertyEvent *));
1035 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
1036 extern void x_handle_selection_event P_ ((struct input_event *));
1037 extern void x_clear_frame_selections P_ ((struct frame *));
1039 extern int x_handle_dnd_message P_ ((struct frame *,
1040 XClientMessageEvent *,
1041 struct x_display_info *,
1042 struct input_event *bufp));
1043 extern int x_check_property_data P_ ((Lisp_Object));
1044 extern void x_fill_property_data P_ ((Display *,
1045 Lisp_Object,
1046 void *,
1047 int));
1048 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
1049 unsigned char *,
1050 Atom,
1051 int,
1052 unsigned long));
1054 /* Defined in xfns.c */
1056 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
1057 extern int have_menus_p P_ ((void));
1059 #ifdef USE_GTK
1060 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
1061 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
1062 #endif /* USE_GTK */
1064 extern void x_real_positions P_ ((struct frame *, int *, int *));
1065 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
1066 extern void x_set_border_pixel P_ ((struct frame *, int));
1067 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1068 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
1069 extern void xic_free_xfontset P_ ((struct frame *));
1070 extern void create_frame_xic P_ ((struct frame *));
1071 extern void destroy_frame_xic P_ ((struct frame *));
1072 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1073 extern void xic_set_statusarea P_ ((struct frame *));
1074 extern void xic_set_xfontset P_ ((struct frame *, char *));
1075 extern int x_pixel_width P_ ((struct frame *));
1076 extern int x_pixel_height P_ ((struct frame *));
1077 extern int x_char_width P_ ((struct frame *));
1078 extern int x_char_height P_ ((struct frame *));
1079 extern int x_screen_planes P_ ((struct frame *));
1080 extern void x_sync P_ ((struct frame *));
1081 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1082 #ifdef HAVE_X_I18N
1083 extern void free_frame_xic P_ ((struct frame *));
1084 #endif
1085 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1087 /* Defined in xfaces.c */
1089 extern int compute_glyph_face P_ ((struct frame *, int, int));
1090 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1091 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1092 unsigned long *, int));
1094 /* Defined in xmenu.c */
1096 extern void x_menu_set_in_use P_ ((int));
1097 extern void x_menu_wait_for_event P_ ((void *data));
1098 extern void x_activate_menubar P_ ((struct frame *));
1099 extern int popup_activated P_ ((void));
1100 extern void initialize_frame_menubar P_ ((struct frame *));
1101 extern void free_frame_menubar P_ ((struct frame *));
1103 /* Defined in widget.c */
1105 #ifdef USE_X_TOOLKIT
1106 extern void widget_store_internal_border P_ ((Widget));
1107 #endif
1109 /* Defined in xsmfns.c */
1110 #ifdef HAVE_X_SM
1111 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1112 extern int x_session_check_input P_ ((struct input_event *bufp));
1113 extern int x_session_have_connection P_ ((void));
1114 #endif
1116 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1117 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1119 #define STORE_XCHAR2B(chp, b1, b2) \
1120 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1122 #define XCHAR2B_BYTE1(chp) \
1123 ((chp)->byte1)
1125 #define XCHAR2B_BYTE2(chp) \
1126 ((chp)->byte2)
1129 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1130 ((nr).x = (rx), \
1131 (nr).y = (ry), \
1132 (nr).width = (rwidth), \
1133 (nr).height = (rheight))
1135 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1136 (do not change this comment) */