Document changes made in 2010-10-13T14:50:06Z!lekktu@gmail.com.
[emacs.git] / src / xterm.h
blobd884945f9854171eb688f9f55b329b5e31626844
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, 2008, 2009, 2010 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 3 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
20 #include <X11/Xlib.h>
21 #include <X11/cursorfont.h>
23 /* Include Xutil.h after keysym.h to work around a bug that prevents
24 correct recognition of AltGr key in some X versions. */
26 #include <X11/keysym.h>
27 #include <X11/Xutil.h>
29 #include <X11/Xatom.h>
30 #include <X11/Xresource.h>
32 #ifdef USE_X_TOOLKIT
33 #include <X11/StringDefs.h>
34 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
35 #include <X11/CoreP.h> /* foul, but we need this to use our own
36 window inside a widget instead of one
37 that Xt creates... */
38 #include <X11/StringDefs.h>
40 typedef Widget xt_or_gtk_widget;
41 #endif
43 #ifdef USE_GTK
44 #include <gtk/gtk.h>
45 #include <gdk/gdkx.h>
47 /* Some definitions to reduce conditionals. */
48 typedef GtkWidget *xt_or_gtk_widget;
49 #define XtParent(x) (gtk_widget_get_parent (x))
50 #undef XSync
51 #define XSync(d, b) do { gdk_window_process_all_updates (); \
52 XSync (d, b); } while (0)
54 /* The GtkTooltip API came in 2.12, but gtk-enable-tooltips in 2.14. */
55 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 13
56 #define USE_GTK_TOOLTIP
57 #endif
59 #endif /* USE_GTK */
62 /* Bookkeeping to distinguish X versions. */
65 #ifdef HAVE_X_I18N
66 #include <X11/Xlocale.h>
67 #endif
69 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
70 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
71 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
72 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
74 #define FONT_WIDTH(f) ((f)->max_width)
75 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
76 #define FONT_BASE(f) ((f)->ascent)
77 #define FONT_DESCENT(f) ((f)->descent)
79 /* The mask of events that text windows always want to receive. This
80 includes mouse movement events, since handling the mouse-font text property
81 means that we must track mouse motion all the time. */
83 #define STANDARD_EVENT_SET \
84 (KeyPressMask \
85 | ExposureMask \
86 | ButtonPressMask \
87 | ButtonReleaseMask \
88 | PointerMotionMask \
89 | StructureNotifyMask \
90 | FocusChangeMask \
91 | LeaveWindowMask \
92 | EnterWindowMask \
93 | VisibilityChangeMask)
95 #ifdef HAVE_X11R6_XIM
96 /* Data structure passed to xim_instantiate_callback. */
97 struct xim_inst_t
99 struct x_display_info *dpyinfo;
100 char *resource_name;
102 #endif /* HAVE_X11R6_XIM */
104 /* Structure recording X pixmap and reference count.
105 If REFCOUNT is 0 then this record is free to be reused. */
107 struct x_bitmap_record
109 Pixmap pixmap;
110 int have_mask;
111 Pixmap mask;
112 char *file;
113 int refcount;
114 /* Record some info about this pixmap. */
115 int height, width, depth;
118 /* For each X display, we have a structure that records
119 information about it. */
121 struct x_display_info
123 /* Chain of all x_display_info structures. */
124 struct x_display_info *next;
126 /* The generic display parameters corresponding to this X display. */
127 struct terminal *terminal;
129 /* Connection number (normally a file descriptor number). */
130 int connection;
132 /* This says how to access this display in Xlib. */
133 Display *display;
135 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
136 The same cons cell also appears in x_display_name_list. */
137 Lisp_Object name_list_element;
139 /* Number of frames that are on this display. */
140 int reference_count;
142 /* The Screen this connection is connected to. */
143 Screen *screen;
145 /* Dots per inch of the screen. */
146 double resx, resy;
148 /* The Visual being used for this display. */
149 Visual *visual;
151 /* The colormap being used. */
152 Colormap cmap;
154 /* Number of planes on this screen. */
155 int n_planes;
157 /* Mask of things that cause the mouse to be grabbed. */
158 int grabbed;
160 /* Emacs bitmap-id of the default icon bitmap for this frame.
161 Or -1 if none has been allocated yet. */
162 int icon_bitmap_id;
164 /* The root window of this screen. */
165 Window root_window;
167 /* Client leader window. */
168 Window client_leader_window;
170 /* The cursor to use for vertical scroll bars. */
171 Cursor vertical_scroll_bar_cursor;
173 /* The invisible cursor used for pointer blanking. */
174 Cursor invisible_cursor;
176 #ifdef USE_GTK
177 /* The GDK cursor for scroll bars and popup menus. */
178 GdkCursor *xg_cursor;
179 #endif
181 /* X Resource data base */
182 XrmDatabase xrdb;
184 /* Minimum width over all characters in all fonts in font_table. */
185 int smallest_char_width;
187 /* Minimum font height over all fonts in font_table. */
188 int smallest_font_height;
190 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
191 GC scratch_cursor_gc;
193 /* These variables describe the range of text currently shown in its
194 mouse-face, together with the window they apply to. As long as
195 the mouse stays within this range, we need not redraw anything on
196 its account. Rows and columns are glyph matrix positions in
197 MOUSE_FACE_WINDOW. */
198 int mouse_face_beg_row, mouse_face_beg_col;
199 int mouse_face_beg_x, mouse_face_beg_y;
200 int mouse_face_end_row, mouse_face_end_col;
201 int mouse_face_end_x, mouse_face_end_y;
202 int mouse_face_past_end;
203 Lisp_Object mouse_face_window;
204 int mouse_face_face_id;
205 Lisp_Object mouse_face_overlay;
207 /* 1 if a mouse motion event came and we didn't handle it right away because
208 gc was in progress. */
209 int mouse_face_deferred_gc;
211 /* FRAME and X, Y position of mouse when last checked for
212 highlighting. X and Y can be negative or out of range for the frame. */
213 struct frame *mouse_face_mouse_frame;
214 int mouse_face_mouse_x, mouse_face_mouse_y;
216 /* Nonzero means defer mouse-motion highlighting. */
217 int mouse_face_defer;
219 /* Nonzero means that the mouse highlight should not be shown. */
220 int mouse_face_hidden;
222 int mouse_face_image_state;
224 char *x_id_name;
226 /* The number of fonts opened for this display. */
227 int n_fonts;
229 /* Pointer to bitmap records. */
230 struct x_bitmap_record *bitmaps;
232 /* Allocated size of bitmaps field. */
233 int bitmaps_size;
235 /* Last used bitmap index. */
236 int bitmaps_last;
238 /* Which modifier keys are on which modifier bits?
240 With each keystroke, X returns eight bits indicating which modifier
241 keys were held down when the key was pressed. The interpretation
242 of the top five modifier bits depends on what keys are attached
243 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
244 is the meta bit.
246 meta_mod_mask is a mask containing the bits used for the meta key.
247 It may have more than one bit set, if more than one modifier bit
248 has meta keys on it. Basically, if EVENT is a KeyPress event,
249 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
251 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
252 lock modifier bit, or zero otherwise. Non-alphabetic keys should
253 only be affected by the lock modifier bit if XK_Shift_Lock is in
254 use; XK_Caps_Lock should only affect alphabetic keys. With this
255 arrangement, the lock modifier should shift the character if
256 (EVENT.state & shift_lock_mask) != 0. */
257 int meta_mod_mask, shift_lock_mask;
259 /* These are like meta_mod_mask, but for different modifiers. */
260 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
262 /* Communication with window managers. */
263 Atom Xatom_wm_protocols;
265 /* Kinds of protocol things we may receive. */
266 Atom Xatom_wm_take_focus;
267 Atom Xatom_wm_save_yourself;
268 Atom Xatom_wm_delete_window;
270 /* Atom for indicating window state to the window manager. */
271 Atom Xatom_wm_change_state;
273 /* Other WM communication */
274 Atom Xatom_wm_configure_denied; /* When our config request is denied */
275 Atom Xatom_wm_window_moved; /* When the WM moves us. */
276 Atom Xatom_wm_client_leader; /* Id of client leader window. */
278 /* EditRes protocol */
279 Atom Xatom_editres;
281 /* More atoms, which are selection types. */
282 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
283 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
284 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
285 Xatom_ATOM_PAIR;
287 /* More atoms for font properties. The last three are private
288 properties, see the comments in src/fontset.h. */
289 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
290 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
291 Xatom_MULE_DEFAULT_ASCENT;
293 /* More atoms for Ghostscript support. */
294 Atom Xatom_DONE, Xatom_PAGE;
296 /* Atom used in toolkit scroll bar client messages. */
297 Atom Xatom_Scrollbar;
299 /* Atom used in XEmbed client messages. */
300 Atom Xatom_XEMBED;
302 /* The frame (if any) which has the X window that has keyboard focus.
303 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
304 that a mere EnterNotify event can set this; if you need to know the
305 last frame specified in a FocusIn or FocusOut event, use
306 x_focus_event_frame. */
307 struct frame *x_focus_frame;
309 /* The last frame mentioned in a FocusIn or FocusOut event. This is
310 separate from x_focus_frame, because whether or not LeaveNotify
311 events cause us to lose focus depends on whether or not we have
312 received a FocusIn event for it. */
313 struct frame *x_focus_event_frame;
315 /* The frame which currently has the visual highlight, and should get
316 keyboard input (other sorts of input have the frame encoded in the
317 event). It points to the X focus frame's selected window's
318 frame. It differs from x_focus_frame when we're using a global
319 minibuffer. */
320 struct frame *x_highlight_frame;
322 /* The gray pixmap. */
323 Pixmap gray;
325 #ifdef HAVE_X_I18N
326 /* XIM (X Input method). */
327 XIM xim;
328 XIMStyles *xim_styles;
329 struct xim_inst_t *xim_callback_data;
330 #endif
332 /* If non-null, a cache of the colors in the color map. Don't
333 use this directly, call x_color_cells instead. */
334 XColor *color_cells;
335 int ncolor_cells;
337 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
338 int red_bits, blue_bits, green_bits;
339 int red_offset, blue_offset, green_offset;
341 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
342 to x/y 0/0, some window managers (type A) puts the window manager
343 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
344 Other window managers (type B) puts the window including decorations
345 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
346 Record the type of WM in use so we can compensate for type A WMs. */
347 enum
349 X_WMTYPE_UNKNOWN,
350 X_WMTYPE_A,
351 X_WMTYPE_B
352 } wm_type;
355 /* Atoms that are drag and drop atoms */
356 Atom *x_dnd_atoms;
357 size_t x_dnd_atoms_size;
358 size_t x_dnd_atoms_length;
360 /* Extended window manager hints, Atoms supported by the window manager and
361 atoms for settig the window type. */
362 Atom *net_supported_atoms;
363 int nr_net_supported_atoms;
364 Window net_supported_window;
365 Atom Xatom_net_window_type, Xatom_net_window_type_tooltip;
367 /* Atoms dealing with maximization and fullscreen */
368 Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen_atom,
369 Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
370 Xatom_net_wm_state_sticky;
372 /* XSettings atoms and windows. */
373 Atom Xatom_xsettings_sel, Xatom_xsettings_prop, Xatom_xsettings_mgr;
374 Window xsettings_window;
376 /* Frame name and icon name */
377 Atom Xatom_net_wm_name, Xatom_net_wm_icon_name;
380 #ifdef HAVE_X_I18N
381 /* Whether or not to use XIM if we have it. */
382 extern int use_xim;
383 #endif
385 /* This checks to make sure we have a display. */
387 extern void check_x (void);
389 extern struct frame *x_window_to_frame (struct x_display_info *, int);
391 extern struct frame *x_any_window_to_frame (struct x_display_info *, int);
392 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
393 XEvent *);
395 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
397 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
398 #define x_any_window_to_frame x_window_to_frame
399 #define x_top_window_to_frame x_window_to_frame
400 #endif
402 /* This is a chain of structures for all the X displays currently in use. */
403 extern struct x_display_info *x_display_list;
405 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
406 one for each element of x_display_list and in the same order.
407 NAME is the name of the frame.
408 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
409 extern Lisp_Object x_display_name_list;
411 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
412 extern Lisp_Object Vx_pixel_size_width_font_regexp;
414 extern struct x_display_info *x_display_info_for_display (Display *);
415 extern struct x_display_info *x_display_info_for_name (Lisp_Object);
416 extern void x_set_frame_alpha (struct frame *);
418 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
419 extern int x_display_ok (const char *);
421 extern void select_visual (struct x_display_info *);
424 struct font;
426 /* Each X frame object points to its own struct x_output object
427 in the output_data.x field. The x_output structure contains
428 the information that is specific to X windows. */
430 struct x_output
432 /* Height of menu bar widget, in pixels.
433 Zero if not using the X toolkit.
434 When using the toolkit, this value is not meaningful
435 if the menubar is turned off. */
436 int menubar_height;
438 /* Height of tool bar widget, in pixels. top_height is used if tool bar
439 at top, bottom_height if tool bar is at the bottom.
440 Zero if not using an external tool bar or if tool bar is vertical. */
441 int toolbar_top_height, toolbar_bottom_height;
443 /* Width of tool bar widget, in pixels. left_width is used if tool bar
444 at left, right_width if tool bar is at the right.
445 Zero if not using an external tool bar or if tool bar is horizontal. */
446 int toolbar_left_width, toolbar_right_width;
448 /* The tiled border used when the mouse is out of the frame. */
449 Pixmap border_tile;
451 /* Here are the Graphics Contexts for the default font. */
452 GC normal_gc; /* Normal video */
453 GC reverse_gc; /* Reverse video */
454 GC cursor_gc; /* cursor drawing */
456 /* The X window used for this frame.
457 May be zero while the frame object is being created
458 and the X window has not yet been created. */
459 Window window_desc;
461 /* The X window used for the bitmap icon;
462 or 0 if we don't have a bitmap icon. */
463 Window icon_desc;
465 /* The X window that is the parent of this X window.
466 Usually this is a window that was made by the window manager,
467 but it can be the root window, and it can be explicitly specified
468 (see the explicit_parent field, below). */
469 Window parent_desc;
471 #ifdef USE_X_TOOLKIT
472 /* The widget of this screen. This is the window of a "shell" widget. */
473 Widget widget;
474 /* The XmPanedWindows... */
475 Widget column_widget;
476 /* The widget of the edit portion of this screen; the window in
477 "window_desc" is inside of this. */
478 Widget edit_widget;
480 Widget menubar_widget;
481 #endif
483 #ifdef USE_GTK
484 /* The widget of this screen. This is the window of a top widget. */
485 GtkWidget *widget;
486 /* The widget of the edit portion of this screen; the window in
487 "window_desc" is inside of this. */
488 GtkWidget *edit_widget;
489 /* The widget used for laying out widgets vertically. */
490 GtkWidget *vbox_widget;
491 /* The widget used for laying out widgets horizontally. */
492 GtkWidget *hbox_widget;
493 /* The menubar in this frame. */
494 GtkWidget *menubar_widget;
495 /* The tool bar in this frame */
496 GtkWidget *toolbar_widget;
497 /* The handle box that makes the tool bar detachable. */
498 GtkWidget *handlebox_widget;
499 /* Non-zero if the tool bar is detached. */
500 int toolbar_detached;
501 /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical). */
502 int toolbar_in_hbox;
504 /* The last size hints set. */
505 GdkGeometry size_hints;
506 long hint_flags;
508 #ifdef USE_GTK_TOOLTIP
509 GtkTooltip *ttip_widget;
510 GtkWidget *ttip_lbl;
511 GtkWindow *ttip_window;
512 #endif /* USE_GTK_TOOLTIP */
514 #endif /* USE_GTK */
516 /* If >=0, a bitmap index. The indicated bitmap is used for the
517 icon. */
518 int icon_bitmap;
520 /* Default ASCII font of this frame. */
521 struct font *font;
523 /* The baseline offset of the default ASCII font. */
524 int baseline_offset;
526 /* If a fontset is specified for this frame instead of font, this
527 value contains an ID of the fontset, else -1. */
528 int fontset;
530 /* Pixel values used for various purposes.
531 border_pixel may be -1 meaning use a gray tile. */
532 #if 0 /* These are also defined in struct frame. Use that instead. */
533 unsigned long background_pixel;
534 unsigned long foreground_pixel;
535 #endif
536 unsigned long cursor_pixel;
537 unsigned long border_pixel;
538 unsigned long mouse_pixel;
539 unsigned long cursor_foreground_pixel;
541 /* Foreground color for scroll bars. A value of -1 means use the
542 default (black for non-toolkit scroll bars). */
543 unsigned long scroll_bar_foreground_pixel;
545 /* Background color for scroll bars. A value of -1 means use the
546 default (background color of the frame for non-toolkit scroll
547 bars). */
548 unsigned long scroll_bar_background_pixel;
550 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
551 let the scroll compute them itself. */
552 unsigned long scroll_bar_top_shadow_pixel;
553 unsigned long scroll_bar_bottom_shadow_pixel;
555 /* Descriptor for the cursor in use for this window. */
556 Cursor text_cursor;
557 Cursor nontext_cursor;
558 Cursor modeline_cursor;
559 Cursor hand_cursor;
560 Cursor hourglass_cursor;
561 Cursor horizontal_drag_cursor;
562 Cursor current_cursor;
564 /* Window whose cursor is hourglass_cursor. This window is temporarily
565 mapped to display an hourglass cursor. */
566 Window hourglass_window;
568 /* Non-zero means hourglass cursor is currently displayed. */
569 unsigned hourglass_p : 1;
571 /* Flag to set when the X window needs to be completely repainted. */
572 int needs_exposure;
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;
587 /* This is the Emacs structure for the X display this frame is on. */
588 struct x_display_info *display_info;
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;
594 /* This is the widget id used for this frame's menubar in lwlib. */
595 #ifdef USE_X_TOOLKIT
596 int id;
597 #endif
599 /* Nonzero means our parent is another application's window
600 and was explicitly specified. */
601 char explicit_parent;
603 /* Nonzero means tried already to make this frame visible. */
604 char asked_for_visible;
606 /* Nonzero if this frame was ever previously visible. */
607 char has_been_visible;
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
617 /* Relief GCs, colors etc. */
618 struct relief
620 GC gc;
621 unsigned long pixel;
622 int allocated_p;
624 black_relief, white_relief;
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;
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;
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;
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;
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;
651 /* The offset we need to add to compensate for type A WMs. */
652 int move_offset_top;
653 int move_offset_left;
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;
661 #define No_Cursor (None)
663 enum
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
676 /* Return the X output data for frame F. */
677 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
679 /* Return the X window used for displaying data in frame F. */
680 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
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 /* Functions not present in older Gtk+ */
691 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
692 #define gtk_widget_get_window(w) ((w)->window)
693 #endif
694 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
695 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
696 #endif
697 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
698 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
699 #define gtk_adjustment_get_upper(w) ((w)->upper)
700 #endif
702 #define GTK_WIDGET_TO_X_WIN(w) \
703 ((w) && gtk_widget_get_window (w) \
704 ? GDK_WINDOW_XWINDOW (gtk_widget_get_window (w)) : 0)
706 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
707 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
708 #define FRAME_OUTER_WINDOW(f) \
709 (FRAME_GTK_OUTER_WIDGET (f) ? \
710 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
711 FRAME_X_WINDOW (f))
713 #else /* !USE_GTK */
714 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
715 #endif /* !USE_GTK */
716 #endif
719 #define FRAME_FONT(f) ((f)->output_data.x->font)
720 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
721 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
722 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
723 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
724 ((f)->output_data.x->toolbar_bottom_height)
725 #define FRAME_TOOLBAR_HEIGHT(f) \
726 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
727 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
728 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
729 #define FRAME_TOOLBAR_WIDTH(f) \
730 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
731 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
733 /* This gives the x_display_info structure for the display F is on. */
734 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
736 /* This is the `Display *' which frame F is on. */
737 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
739 /* This is the `Screen *' which frame F is on. */
740 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
741 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
743 /* This is the Visual which frame F is on. */
744 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
746 /* This is the Colormap which frame F uses. */
747 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
749 /* This is the 'font_info *' which frame F has. */
750 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
752 /* The difference in pixels between the top left corner of the
753 Emacs window (including possible window manager decorations)
754 and FRAME_X_WINDOW (f). */
755 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
756 ((f)->output_data.x->x_pixels_outer_diff)
757 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
758 ((f)->output_data.x->y_pixels_outer_diff \
759 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
762 #define FRAME_XIC(f) ((f)->output_data.x->xic)
763 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
764 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
765 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
766 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
767 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
769 /* Value is the smallest width of any character in any font on frame F. */
771 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
772 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
774 /* Value is the smallest height of any font on frame F. */
776 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
777 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
779 /* X-specific scroll bar stuff. */
781 /* We represent scroll bars as lisp vectors. This allows us to place
782 references to them in windows without worrying about whether we'll
783 end up with windows referring to dead scroll bars; the garbage
784 collector will free it when its time comes.
786 We use struct scroll_bar as a template for accessing fields of the
787 vector. */
789 struct scroll_bar
791 /* These fields are shared by all vectors. */
792 EMACS_INT size_from_Lisp_Vector_struct;
793 struct Lisp_Vector *next_from_Lisp_Vector_struct;
795 /* The window we're a scroll bar for. */
796 Lisp_Object window;
798 /* The next and previous in the chain of scroll bars in this frame. */
799 Lisp_Object next, prev;
801 /* Fields from `x_window' down will not be traced by the GC. */
803 /* The X window representing this scroll bar. */
804 Window x_window;
806 /* The position and size of the scroll bar in pixels, relative to the
807 frame. */
808 int top, left, width, height;
810 /* The starting and ending positions of the handle, relative to the
811 handle area (i.e. zero is the top position, not
812 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
813 hasn't been drawn yet.
815 These are not actually the locations where the beginning and end
816 are drawn; in order to keep handles from becoming invisible when
817 editing large files, we establish a minimum height by always
818 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
819 where they would be normally; the bottom and top are in a
820 different co-ordinate system. */
821 int start, end;
823 /* If the scroll bar handle is currently being dragged by the user,
824 this is the number of pixels from the top of the handle to the
825 place where the user grabbed it. If the handle isn't currently
826 being dragged, this is Qnil. */
827 Lisp_Object dragging;
829 /* 1 if the background of the fringe that is adjacent to a scroll
830 bar is extended to the gap between the fringe and the bar. */
831 unsigned int fringe_extended_p : 1;
834 /* The number of elements a vector holding a struct scroll_bar needs. */
835 #define SCROLL_BAR_VEC_SIZE \
836 ((sizeof (struct scroll_bar) \
837 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
838 / sizeof (Lisp_Object))
840 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
841 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
844 /* Extract the X widget of the scroll bar from a struct scroll_bar.
845 XtWindowToWidget should be fast enough since Xt uses a hash table
846 to map windows to widgets. */
848 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
849 XtWindowToWidget (dpy, ptr->x_window)
851 /* Store a widget id in a struct scroll_bar. */
853 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
854 do { \
855 Window window = XtWindow (w); \
856 ptr->x_window = window; \
857 } while (0)
860 /* Return the inside width of a vertical scroll bar, given the outside
861 width. */
862 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
863 ((width) \
864 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
865 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
866 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
868 /* Return the length of the rectangle within which the top of the
869 handle must stay. This isn't equivalent to the inside height,
870 because the scroll bar handle has a minimum height.
872 This is the real range of motion for the scroll bar, so when we're
873 scaling buffer positions to scroll bar positions, we use this, not
874 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
875 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
876 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
878 /* Return the inside height of vertical scroll bar, given the outside
879 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
880 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
881 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
884 /* Border widths for scroll bars.
886 Scroll bar windows don't have any X borders; their border width is
887 set to zero, and we redraw borders ourselves. This makes the code
888 a bit cleaner, since we don't have to convert between outside width
889 (used when relating to the rest of the screen) and inside width
890 (used when sizing and drawing the scroll bar window itself).
892 The handle moves up and down/back and forth in a rectangle inset
893 from the edges of the scroll bar. These are widths by which we
894 inset the handle boundaries from the scroll bar edges. */
895 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
896 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
897 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
898 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
900 /* Minimum lengths for scroll bar handles, in pixels. */
901 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
903 /* Trimming off a few pixels from each side prevents
904 text from glomming up against the scroll bar */
905 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
908 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
909 or SELECTION_CLEAR_EVENT, then its contents are really described
910 by this structure. */
912 /* For an event of kind SELECTION_REQUEST_EVENT,
913 this structure really describes the contents.
914 **Don't make this struct longer!**
915 If it overlaps the frame_or_window field of struct input_event,
916 that will cause GC to crash. */
917 struct selection_input_event
919 int kind;
920 Display *display;
921 /* We spell it with an "o" here because X does. */
922 Window requestor;
923 Atom selection, target, property;
924 Time time;
927 #define SELECTION_EVENT_DISPLAY(eventp) \
928 (((struct selection_input_event *) (eventp))->display)
929 /* We spell it with an "o" here because X does. */
930 #define SELECTION_EVENT_REQUESTOR(eventp) \
931 (((struct selection_input_event *) (eventp))->requestor)
932 #define SELECTION_EVENT_SELECTION(eventp) \
933 (((struct selection_input_event *) (eventp))->selection)
934 #define SELECTION_EVENT_TARGET(eventp) \
935 (((struct selection_input_event *) (eventp))->target)
936 #define SELECTION_EVENT_PROPERTY(eventp) \
937 (((struct selection_input_event *) (eventp))->property)
938 #define SELECTION_EVENT_TIME(eventp) \
939 (((struct selection_input_event *) (eventp))->time)
942 struct window;
943 struct glyph_matrix;
944 struct frame;
945 struct input_event;
946 struct face;
947 struct image;
949 /* From xselect.c. */
951 void x_handle_selection_notify (XSelectionEvent *);
952 void x_handle_property_notify (XPropertyEvent *);
954 /* From xfns.c. */
956 Lisp_Object display_x_get_resource (struct x_display_info *,
957 Lisp_Object, Lisp_Object,
958 Lisp_Object, Lisp_Object);
959 struct frame *check_x_frame (Lisp_Object);
960 EXFUN (Fx_display_color_p, 1);
961 EXFUN (Fx_display_grayscale_p, 1);
962 extern void x_free_gcs (struct frame *);
963 extern int gray_bitmap_width, gray_bitmap_height;
964 extern char *gray_bitmap_bits;
966 /* From xrdb.c. */
968 char *x_get_customization_string (XrmDatabase, const char *, const char *);
969 XrmDatabase x_load_resources (Display *, const char *, const char *,
970 const char *);
971 int x_get_resource (XrmDatabase, const char *, const char *,
972 XrmRepresentation, XrmValue *);
973 void x_delete_display (struct x_display_info *);
974 void x_make_frame_visible (struct frame *);
975 void x_iconify_frame (struct frame *);
976 void x_wm_set_size_hint (struct frame *, long, int);
977 int x_text_icon (struct frame *, const char *);
978 int x_bitmap_icon (struct frame *, Lisp_Object);
979 void x_set_window_size (struct frame *, int, int, int);
980 void x_wm_set_window_state (struct frame *, int);
981 int x_alloc_nearest_color (struct frame *, Colormap, XColor *);
983 /* Defined in xterm.c */
985 extern void cancel_mouse_face (struct frame *);
986 extern void x_scroll_bar_clear (struct frame *);
987 extern int x_text_icon (struct frame *, const char *);
988 extern int x_bitmap_icon (struct frame *, Lisp_Object);
989 extern void x_catch_errors (Display *);
990 extern void x_check_errors (Display *, const char *);
991 extern int x_had_errors_p (Display *);
992 extern int x_catching_errors (void);
993 extern void x_uncatch_errors (void);
994 extern void x_clear_errors (Display *);
995 extern void x_set_window_size (struct frame *, int, int, int);
996 extern void x_set_mouse_position (struct frame *, int, int);
997 extern void x_set_mouse_pixel_position (struct frame *, int, int);
998 extern void x_ewmh_activate_frame (struct frame *);
999 extern void x_raise_frame (struct frame *);
1000 extern void x_lower_frame (struct frame *);
1001 extern void x_make_frame_visible (struct frame *);
1002 extern void x_make_frame_invisible (struct frame *);
1003 extern void x_iconify_frame (struct frame *);
1004 extern void x_free_frame_resources (struct frame *);
1005 extern void x_destroy_window (struct frame *);
1006 extern void x_wm_set_size_hint (struct frame *, long, int);
1007 extern void x_wm_set_window_state (struct frame *, int);
1008 extern void x_wm_set_icon_pixmap (struct frame *, int);
1009 extern void x_delete_display (struct x_display_info *);
1010 extern void x_delete_terminal (struct terminal *terminal);
1011 extern void x_initialize (void);
1012 extern unsigned long x_copy_color (struct frame *, unsigned long);
1013 #ifdef USE_X_TOOLKIT
1014 extern XtAppContext Xt_app_con;
1015 extern int x_alloc_lighter_color_for_widget (Widget, Display*, Colormap,
1016 unsigned long *,
1017 double, int);
1018 extern void x_activate_timeout_atimer (void);
1019 #endif
1020 extern void x_query_colors (struct frame *f, XColor *, int);
1021 extern void x_query_color (struct frame *f, XColor *);
1022 extern void x_clear_area (Display *, Window, int, int, int, int, int);
1023 extern void set_vertical_scroll_bar (struct window *);
1025 extern int x_dispatch_event (XEvent *, Display *);
1026 extern unsigned int x_x_to_emacs_modifiers (struct x_display_info *,
1027 unsigned);
1028 extern int x_display_pixel_height (struct x_display_info *);
1029 extern int x_display_pixel_width (struct x_display_info *);
1031 extern void x_set_sticky (struct frame *, Lisp_Object, Lisp_Object);
1032 extern void x_wait_for_event (struct frame *, int);
1034 /* Defined in xselect.c */
1036 extern void x_handle_property_notify (XPropertyEvent *);
1037 extern void x_handle_selection_notify (XSelectionEvent *);
1038 extern void x_handle_selection_event (struct input_event *);
1039 extern void x_clear_frame_selections (struct frame *);
1041 extern int x_handle_dnd_message (struct frame *,
1042 XClientMessageEvent *,
1043 struct x_display_info *,
1044 struct input_event *bufp);
1045 extern int x_check_property_data (Lisp_Object);
1046 extern void x_fill_property_data (Display *,
1047 Lisp_Object,
1048 void *,
1049 int);
1050 extern Lisp_Object x_property_data_to_lisp (struct frame *,
1051 const unsigned char *,
1052 Atom,
1053 int,
1054 unsigned long);
1056 /* Defined in xfns.c */
1058 extern struct x_display_info * check_x_display_info (Lisp_Object frame);
1059 extern Lisp_Object x_get_focus_frame (struct frame *);
1061 #ifdef USE_GTK
1062 extern int xg_set_icon (struct frame *, Lisp_Object);
1063 extern int xg_set_icon_from_xpm_data (struct frame *, const char**);
1064 #endif /* USE_GTK */
1066 extern void x_real_positions (struct frame *, int *, int *);
1067 extern int defined_color (struct frame *, const char *, XColor *, int);
1068 extern void x_set_border_pixel (struct frame *, int);
1069 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1070 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1071 extern void xic_free_xfontset (struct frame *);
1072 extern void create_frame_xic (struct frame *);
1073 extern void destroy_frame_xic (struct frame *);
1074 extern void xic_set_preeditarea (struct window *, int, int);
1075 extern void xic_set_statusarea (struct frame *);
1076 extern void xic_set_xfontset (struct frame *, const char *);
1077 extern int x_pixel_width (struct frame *);
1078 extern int x_pixel_height (struct frame *);
1079 extern int x_char_width (struct frame *);
1080 extern int x_char_height (struct frame *);
1081 extern int x_screen_planes (struct frame *);
1082 extern void x_sync (struct frame *);
1083 extern int x_defined_color (struct frame *, const char *, XColor *, int);
1084 #ifdef HAVE_X_I18N
1085 extern void free_frame_xic (struct frame *);
1086 extern char * xic_create_fontsetname (const char *base_fontname, int motif);
1087 #endif
1088 extern void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1090 /* Defined in xfaces.c */
1092 extern int compute_glyph_face (struct frame *, int, int);
1093 extern int compute_glyph_face_1 (struct frame *, Lisp_Object, int);
1094 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1095 unsigned long *, int);
1097 /* Defined in xmenu.c */
1099 extern void x_menu_set_in_use (int);
1100 extern void x_menu_wait_for_event (void *data);
1101 extern void x_activate_menubar (struct frame *);
1102 extern int popup_activated (void);
1103 extern void initialize_frame_menubar (struct frame *);
1104 extern void free_frame_menubar (struct frame *);
1106 /* Defined in widget.c */
1108 #ifdef USE_X_TOOLKIT
1109 extern void widget_store_internal_border (Widget);
1110 #endif
1112 /* Defined in xsmfns.c */
1113 #ifdef HAVE_X_SM
1114 extern void x_session_initialize (struct x_display_info *dpyinfo);
1115 extern int x_session_check_input (struct input_event *bufp);
1116 extern int x_session_have_connection (void);
1117 extern void x_session_close (void);
1118 #endif
1120 /* XEmbed implementation. */
1122 #define XEMBED_VERSION 0
1124 enum xembed_info
1126 XEMBED_MAPPED = 1 << 0
1129 enum xembed_message
1131 XEMBED_EMBEDDED_NOTIFY = 0,
1132 XEMBED_WINDOW_ACTIVATE = 1,
1133 XEMBED_WINDOW_DEACTIVATE = 2,
1134 XEMBED_REQUEST_FOCUS = 3,
1135 XEMBED_FOCUS_IN = 4,
1136 XEMBED_FOCUS_OUT = 5,
1137 XEMBED_FOCUS_NEXT = 6,
1138 XEMBED_FOCUS_PREV = 7,
1140 XEMBED_MODALITY_ON = 10,
1141 XEMBED_MODALITY_OFF = 11,
1142 XEMBED_REGISTER_ACCELERATOR = 12,
1143 XEMBED_UNREGISTER_ACCELERATOR = 13,
1144 XEMBED_ACTIVATE_ACCELERATOR = 14
1147 enum xembed_focus
1149 XEMBED_FOCUS_CURRENT = 0,
1150 XEMBED_FOCUS_FIRST = 1,
1151 XEMBED_FOCUS_LAST = 2
1154 enum xembed_modifier
1156 XEMBED_MODIFIER_SHIFT = 1 << 0,
1157 XEMBED_MODIFIER_CONTROL = 1 << 1,
1158 XEMBED_MODIFIER_ALT = 1 << 2,
1159 XEMBED_MODIFIER_SUPER = 1 << 3,
1160 XEMBED_MODIFIER_HYPER = 1 << 4
1163 enum xembed_accelerator
1165 XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1168 /* Defined in xterm.c */
1170 extern Lisp_Object Qx_gtk_map_stock;
1171 extern void xembed_set_info (struct frame *f, enum xembed_info flags);
1172 extern void xembed_send_message (struct frame *f, Time time,
1173 enum xembed_message message,
1174 long detail, long data1, long data2);
1176 /* Is the frame embedded into another application? */
1178 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1181 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1182 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1184 #define STORE_XCHAR2B(chp, b1, b2) \
1185 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1187 #define XCHAR2B_BYTE1(chp) \
1188 ((chp)->byte1)
1190 #define XCHAR2B_BYTE2(chp) \
1191 ((chp)->byte2)
1194 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1195 ((nr).x = (rx), \
1196 (nr).y = (ry), \
1197 (nr).width = (rwidth), \
1198 (nr).height = (rheight))
1200 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1201 (do not change this comment) */