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/>. */
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>
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
38 #include <X11/StringDefs.h>
40 typedef Widget xt_or_gtk_widget
;
47 /* Some definitions to reduce conditionals. */
48 typedef GtkWidget
*xt_or_gtk_widget
;
49 #define XtParent(x) (gtk_widget_get_parent (x))
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
62 /* Bookkeeping to distinguish X versions. */
66 #include <X11/Xlocale.h>
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 \
89 | StructureNotifyMask \
93 | VisibilityChangeMask)
96 /* Data structure passed to xim_instantiate_callback. */
99 struct x_display_info
*dpyinfo
;
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
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). */
132 /* This says how to access this display in Xlib. */
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. */
142 /* The Screen this connection is connected to. */
145 /* Dots per inch of the screen. */
148 /* The Visual being used for this display. */
151 /* The colormap being used. */
154 /* Number of planes on this screen. */
157 /* Mask of things that cause the mouse to be grabbed. */
160 /* Emacs bitmap-id of the default icon bitmap for this frame.
161 Or -1 if none has been allocated yet. */
164 /* The root window of this screen. */
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
;
177 /* The GDK cursor for scroll bars and popup menus. */
178 GdkCursor
*xg_cursor
;
181 /* X Resource data base */
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 /* Information about the range of text currently shown in
195 Mouse_HLInfo mouse_highlight
;
199 /* The number of fonts opened for this display. */
202 /* Pointer to bitmap records. */
203 struct x_bitmap_record
*bitmaps
;
205 /* Allocated size of bitmaps field. */
208 /* Last used bitmap index. */
211 /* Which modifier keys are on which modifier bits?
213 With each keystroke, X returns eight bits indicating which modifier
214 keys were held down when the key was pressed. The interpretation
215 of the top five modifier bits depends on what keys are attached
216 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
219 meta_mod_mask is a mask containing the bits used for the meta key.
220 It may have more than one bit set, if more than one modifier bit
221 has meta keys on it. Basically, if EVENT is a KeyPress event,
222 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
224 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
225 lock modifier bit, or zero otherwise. Non-alphabetic keys should
226 only be affected by the lock modifier bit if XK_Shift_Lock is in
227 use; XK_Caps_Lock should only affect alphabetic keys. With this
228 arrangement, the lock modifier should shift the character if
229 (EVENT.state & shift_lock_mask) != 0. */
230 int meta_mod_mask
, shift_lock_mask
;
232 /* These are like meta_mod_mask, but for different modifiers. */
233 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
235 /* Communication with window managers. */
236 Atom Xatom_wm_protocols
;
238 /* Kinds of protocol things we may receive. */
239 Atom Xatom_wm_take_focus
;
240 Atom Xatom_wm_save_yourself
;
241 Atom Xatom_wm_delete_window
;
243 /* Atom for indicating window state to the window manager. */
244 Atom Xatom_wm_change_state
;
246 /* Other WM communication */
247 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
248 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
249 Atom Xatom_wm_client_leader
; /* Id of client leader window. */
251 /* EditRes protocol */
254 /* More atoms, which are selection types. */
255 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
256 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
257 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
260 /* More atoms for font properties. The last three are private
261 properties, see the comments in src/fontset.h. */
262 Atom Xatom_PIXEL_SIZE
, Xatom_AVERAGE_WIDTH
,
263 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
264 Xatom_MULE_DEFAULT_ASCENT
;
266 /* More atoms for Ghostscript support. */
267 Atom Xatom_DONE
, Xatom_PAGE
;
269 /* Atom used in toolkit scroll bar client messages. */
270 Atom Xatom_Scrollbar
;
272 /* Atom used in XEmbed client messages. */
275 /* The frame (if any) which has the X window that has keyboard focus.
276 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
277 that a mere EnterNotify event can set this; if you need to know the
278 last frame specified in a FocusIn or FocusOut event, use
279 x_focus_event_frame. */
280 struct frame
*x_focus_frame
;
282 /* The last frame mentioned in a FocusIn or FocusOut event. This is
283 separate from x_focus_frame, because whether or not LeaveNotify
284 events cause us to lose focus depends on whether or not we have
285 received a FocusIn event for it. */
286 struct frame
*x_focus_event_frame
;
288 /* The frame which currently has the visual highlight, and should get
289 keyboard input (other sorts of input have the frame encoded in the
290 event). It points to the X focus frame's selected window's
291 frame. It differs from x_focus_frame when we're using a global
293 struct frame
*x_highlight_frame
;
295 /* The gray pixmap. */
299 /* XIM (X Input method). */
301 XIMStyles
*xim_styles
;
302 struct xim_inst_t
*xim_callback_data
;
305 /* If non-null, a cache of the colors in the color map. Don't
306 use this directly, call x_color_cells instead. */
310 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
311 int red_bits
, blue_bits
, green_bits
;
312 int red_offset
, blue_offset
, green_offset
;
314 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
315 to x/y 0/0, some window managers (type A) puts the window manager
316 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
317 Other window managers (type B) puts the window including decorations
318 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
319 Record the type of WM in use so we can compensate for type A WMs. */
328 /* Atoms that are drag and drop atoms */
330 size_t x_dnd_atoms_size
;
331 size_t x_dnd_atoms_length
;
333 /* Extended window manager hints, Atoms supported by the window manager and
334 atoms for settig the window type. */
335 Atom
*net_supported_atoms
;
336 int nr_net_supported_atoms
;
337 Window net_supported_window
;
338 Atom Xatom_net_window_type
, Xatom_net_window_type_tooltip
;
340 /* Atoms dealing with maximization and fullscreen */
341 Atom Xatom_net_wm_state
, Xatom_net_wm_state_fullscreen_atom
,
342 Xatom_net_wm_state_maximized_horz
, Xatom_net_wm_state_maximized_vert
,
343 Xatom_net_wm_state_sticky
;
345 /* XSettings atoms and windows. */
346 Atom Xatom_xsettings_sel
, Xatom_xsettings_prop
, Xatom_xsettings_mgr
;
347 Window xsettings_window
;
349 /* Frame name and icon name */
350 Atom Xatom_net_wm_name
, Xatom_net_wm_icon_name
;
354 /* Whether or not to use XIM if we have it. */
358 /* This checks to make sure we have a display. */
360 extern void check_x (void);
362 extern struct frame
*x_window_to_frame (struct x_display_info
*, int);
364 extern struct frame
*x_any_window_to_frame (struct x_display_info
*, int);
365 extern struct frame
*x_menubar_window_to_frame (struct x_display_info
*,
368 extern struct frame
*x_top_window_to_frame (struct x_display_info
*, int);
370 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
371 #define x_any_window_to_frame x_window_to_frame
372 #define x_top_window_to_frame x_window_to_frame
375 /* This is a chain of structures for all the X displays currently in use. */
376 extern struct x_display_info
*x_display_list
;
378 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
379 one for each element of x_display_list and in the same order.
380 NAME is the name of the frame.
381 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
382 extern Lisp_Object x_display_name_list
;
384 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
385 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
387 extern struct x_display_info
*x_display_info_for_display (Display
*);
388 extern struct x_display_info
*x_display_info_for_name (Lisp_Object
);
389 extern void x_set_frame_alpha (struct frame
*);
391 extern struct x_display_info
*x_term_init (Lisp_Object
, char *, char *);
392 extern int x_display_ok (const char *);
394 extern void select_visual (struct x_display_info
*);
399 /* Each X frame object points to its own struct x_output object
400 in the output_data.x field. The x_output structure contains
401 the information that is specific to X windows. */
405 /* Height of menu bar widget, in pixels.
406 Zero if not using the X toolkit.
407 When using the toolkit, this value is not meaningful
408 if the menubar is turned off. */
411 /* Height of tool bar widget, in pixels. top_height is used if tool bar
412 at top, bottom_height if tool bar is at the bottom.
413 Zero if not using an external tool bar or if tool bar is vertical. */
414 int toolbar_top_height
, toolbar_bottom_height
;
416 /* Width of tool bar widget, in pixels. left_width is used if tool bar
417 at left, right_width if tool bar is at the right.
418 Zero if not using an external tool bar or if tool bar is horizontal. */
419 int toolbar_left_width
, toolbar_right_width
;
421 /* The tiled border used when the mouse is out of the frame. */
424 /* Here are the Graphics Contexts for the default font. */
425 GC normal_gc
; /* Normal video */
426 GC reverse_gc
; /* Reverse video */
427 GC cursor_gc
; /* cursor drawing */
429 /* The X window used for this frame.
430 May be zero while the frame object is being created
431 and the X window has not yet been created. */
434 /* The X window used for the bitmap icon;
435 or 0 if we don't have a bitmap icon. */
438 /* The X window that is the parent of this X window.
439 Usually this is a window that was made by the window manager,
440 but it can be the root window, and it can be explicitly specified
441 (see the explicit_parent field, below). */
445 /* The widget of this screen. This is the window of a "shell" widget. */
447 /* The XmPanedWindows... */
448 Widget column_widget
;
449 /* The widget of the edit portion of this screen; the window in
450 "window_desc" is inside of this. */
453 Widget menubar_widget
;
457 /* The widget of this screen. This is the window of a top widget. */
459 /* The widget of the edit portion of this screen; the window in
460 "window_desc" is inside of this. */
461 GtkWidget
*edit_widget
;
462 /* The widget used for laying out widgets vertically. */
463 GtkWidget
*vbox_widget
;
464 /* The widget used for laying out widgets horizontally. */
465 GtkWidget
*hbox_widget
;
466 /* The menubar in this frame. */
467 GtkWidget
*menubar_widget
;
468 /* The tool bar in this frame */
469 GtkWidget
*toolbar_widget
;
470 /* The handle box that makes the tool bar detachable. */
471 GtkWidget
*handlebox_widget
;
472 /* Non-zero if the tool bar is detached. */
473 int toolbar_detached
;
474 /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical). */
477 /* The last size hints set. */
478 GdkGeometry size_hints
;
481 #ifdef USE_GTK_TOOLTIP
482 GtkTooltip
*ttip_widget
;
484 GtkWindow
*ttip_window
;
485 #endif /* USE_GTK_TOOLTIP */
489 /* If >=0, a bitmap index. The indicated bitmap is used for the
493 /* Default ASCII font of this frame. */
496 /* The baseline offset of the default ASCII font. */
499 /* If a fontset is specified for this frame instead of font, this
500 value contains an ID of the fontset, else -1. */
503 /* Pixel values used for various purposes.
504 border_pixel may be -1 meaning use a gray tile. */
505 #if 0 /* These are also defined in struct frame. Use that instead. */
506 unsigned long background_pixel
;
507 unsigned long foreground_pixel
;
509 unsigned long cursor_pixel
;
510 unsigned long border_pixel
;
511 unsigned long mouse_pixel
;
512 unsigned long cursor_foreground_pixel
;
514 /* Foreground color for scroll bars. A value of -1 means use the
515 default (black for non-toolkit scroll bars). */
516 unsigned long scroll_bar_foreground_pixel
;
518 /* Background color for scroll bars. A value of -1 means use the
519 default (background color of the frame for non-toolkit scroll
521 unsigned long scroll_bar_background_pixel
;
523 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
524 let the scroll compute them itself. */
525 unsigned long scroll_bar_top_shadow_pixel
;
526 unsigned long scroll_bar_bottom_shadow_pixel
;
528 /* Descriptor for the cursor in use for this window. */
530 Cursor nontext_cursor
;
531 Cursor modeline_cursor
;
533 Cursor hourglass_cursor
;
534 Cursor horizontal_drag_cursor
;
535 Cursor current_cursor
;
537 /* Window whose cursor is hourglass_cursor. This window is temporarily
538 mapped to display an hourglass cursor. */
539 Window hourglass_window
;
541 /* Non-zero means hourglass cursor is currently displayed. */
542 unsigned hourglass_p
: 1;
544 /* Flag to set when the X window needs to be completely repainted. */
547 /* These are the current window manager hints. It seems that
548 XSetWMHints, when presented with an unset bit in the `flags'
549 member of the hints structure, does not leave the corresponding
550 attribute unchanged; rather, it resets that attribute to its
551 default value. For example, unless you set the `icon_pixmap'
552 field and the `IconPixmapHint' bit, XSetWMHints will forget what
553 your icon pixmap was. This is rather troublesome, since some of
554 the members (for example, `input' and `icon_pixmap') want to stay
555 the same throughout the execution of Emacs. So, we keep this
556 structure around, just leaving values in it and adding new bits
557 to the mask as we go. */
560 /* This is the Emacs structure for the X display this frame is on. */
561 struct x_display_info
*display_info
;
563 /* This is a button event that wants to activate the menubar.
564 We save it here until the command loop gets to think about it. */
565 XEvent
*saved_menu_event
;
567 /* This is the widget id used for this frame's menubar in lwlib. */
572 /* Nonzero means our parent is another application's window
573 and was explicitly specified. */
574 char explicit_parent
;
576 /* Nonzero means tried already to make this frame visible. */
577 char asked_for_visible
;
579 /* Nonzero if this frame was ever previously visible. */
580 char has_been_visible
;
583 /* Input context (currently, this means Compose key handler setup). */
587 char *xic_base_fontname
;
590 /* Relief GCs, colors etc. */
597 black_relief
, white_relief
;
599 /* The background for which the above relief GCs were set up.
600 They are changed only when a different background is involved. */
601 unsigned long relief_background
;
603 /* Xt waits for a ConfigureNotify event from the window manager in
604 EmacsFrameSetCharSize when the shell widget is resized. For some
605 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
606 arrive for an unknown reason and Emacs hangs in Xt. If this is
607 zero, tell Xt not to wait. */
610 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
611 two might differ by a pixel, depending on WM */
612 int x_pixels_outer_diff
;
614 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
615 these may differ because this does not take into account possible
616 menubar. y_pixels_diff is with menubar height included */
617 int y_pixels_outer_diff
;
619 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
620 frame, or IMPLICIT if we received an EnterNotify.
621 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
624 /* The offset we need to add to compensate for type A WMs. */
626 int move_offset_left
;
628 /* The frame's left/top offsets before we call XMoveWindow. See
629 x_check_expected_move. */
630 int left_before_move
;
634 #define No_Cursor (None)
638 /* Values for focus_state, used as bit mask.
639 EXPLICIT means we received a FocusIn for the frame and know it has
640 the focus. IMPLICIT means we recevied an EnterNotify and the frame
641 may have the focus if no window manager is running.
642 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
649 /* Return the X output data for frame F. */
650 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
652 /* Return the X window used for displaying data in frame F. */
653 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
655 /* Return the outermost X window associated with the frame F. */
657 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
658 XtWindow ((f)->output_data.x->widget) : \
662 /* Functions not present in older Gtk+ */
664 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
665 #define gtk_widget_get_window(w) ((w)->window)
667 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
668 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
670 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
671 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
672 #define gtk_adjustment_get_upper(w) ((w)->upper)
675 #define GTK_WIDGET_TO_X_WIN(w) \
676 ((w) && gtk_widget_get_window (w) \
677 ? GDK_WINDOW_XWINDOW (gtk_widget_get_window (w)) : 0)
679 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
680 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
681 #define FRAME_OUTER_WINDOW(f) \
682 (FRAME_GTK_OUTER_WIDGET (f) ? \
683 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
687 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
688 #endif /* !USE_GTK */
692 #define FRAME_FONT(f) ((f)->output_data.x->font)
693 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
694 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
695 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
696 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
697 ((f)->output_data.x->toolbar_bottom_height)
698 #define FRAME_TOOLBAR_HEIGHT(f) \
699 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
700 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
701 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
702 #define FRAME_TOOLBAR_WIDTH(f) \
703 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
704 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
706 /* This gives the x_display_info structure for the display F is on. */
707 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
709 /* This is the `Display *' which frame F is on. */
710 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
712 /* This is the `Screen *' which frame F is on. */
713 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
714 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
716 /* This is the Visual which frame F is on. */
717 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
719 /* This is the Colormap which frame F uses. */
720 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
722 /* This is the 'font_info *' which frame F has. */
723 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
725 /* The difference in pixels between the top left corner of the
726 Emacs window (including possible window manager decorations)
727 and FRAME_X_WINDOW (f). */
728 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
729 ((f)->output_data.x->x_pixels_outer_diff)
730 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
731 ((f)->output_data.x->y_pixels_outer_diff \
732 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
735 #define FRAME_XIC(f) ((f)->output_data.x->xic)
736 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
737 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
738 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
739 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
740 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
742 /* Value is the smallest width of any character in any font on frame F. */
744 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
745 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
747 /* Value is the smallest height of any font on frame F. */
749 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
750 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
752 /* X-specific scroll bar stuff. */
754 /* We represent scroll bars as lisp vectors. This allows us to place
755 references to them in windows without worrying about whether we'll
756 end up with windows referring to dead scroll bars; the garbage
757 collector will free it when its time comes.
759 We use struct scroll_bar as a template for accessing fields of the
764 /* These fields are shared by all vectors. */
765 EMACS_INT size_from_Lisp_Vector_struct
;
766 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
768 /* The window we're a scroll bar for. */
771 /* The next and previous in the chain of scroll bars in this frame. */
772 Lisp_Object next
, prev
;
774 /* Fields from `x_window' down will not be traced by the GC. */
776 /* The X window representing this scroll bar. */
779 /* The position and size of the scroll bar in pixels, relative to the
781 int top
, left
, width
, height
;
783 /* The starting and ending positions of the handle, relative to the
784 handle area (i.e. zero is the top position, not
785 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
786 hasn't been drawn yet.
788 These are not actually the locations where the beginning and end
789 are drawn; in order to keep handles from becoming invisible when
790 editing large files, we establish a minimum height by always
791 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
792 where they would be normally; the bottom and top are in a
793 different co-ordinate system. */
796 /* If the scroll bar handle is currently being dragged by the user,
797 this is the number of pixels from the top of the handle to the
798 place where the user grabbed it. If the handle isn't currently
799 being dragged, this is Qnil. */
800 Lisp_Object dragging
;
802 /* 1 if the background of the fringe that is adjacent to a scroll
803 bar is extended to the gap between the fringe and the bar. */
804 unsigned int fringe_extended_p
: 1;
807 /* The number of elements a vector holding a struct scroll_bar needs. */
808 #define SCROLL_BAR_VEC_SIZE \
809 ((sizeof (struct scroll_bar) \
810 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
811 / sizeof (Lisp_Object))
813 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
814 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
817 /* Extract the X widget of the scroll bar from a struct scroll_bar.
818 XtWindowToWidget should be fast enough since Xt uses a hash table
819 to map windows to widgets. */
821 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
822 XtWindowToWidget (dpy, ptr->x_window)
824 /* Store a widget id in a struct scroll_bar. */
826 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
828 Window window = XtWindow (w); \
829 ptr->x_window = window; \
833 /* Return the inside width of a vertical scroll bar, given the outside
835 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
837 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
838 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
839 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
841 /* Return the length of the rectangle within which the top of the
842 handle must stay. This isn't equivalent to the inside height,
843 because the scroll bar handle has a minimum height.
845 This is the real range of motion for the scroll bar, so when we're
846 scaling buffer positions to scroll bar positions, we use this, not
847 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
848 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
849 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
851 /* Return the inside height of vertical scroll bar, given the outside
852 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
853 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
854 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
857 /* Border widths for scroll bars.
859 Scroll bar windows don't have any X borders; their border width is
860 set to zero, and we redraw borders ourselves. This makes the code
861 a bit cleaner, since we don't have to convert between outside width
862 (used when relating to the rest of the screen) and inside width
863 (used when sizing and drawing the scroll bar window itself).
865 The handle moves up and down/back and forth in a rectangle inset
866 from the edges of the scroll bar. These are widths by which we
867 inset the handle boundaries from the scroll bar edges. */
868 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
869 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
870 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
871 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
873 /* Minimum lengths for scroll bar handles, in pixels. */
874 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
876 /* Trimming off a few pixels from each side prevents
877 text from glomming up against the scroll bar */
878 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
881 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
882 or SELECTION_CLEAR_EVENT, then its contents are really described
883 by this structure. */
885 /* For an event of kind SELECTION_REQUEST_EVENT,
886 this structure really describes the contents.
887 **Don't make this struct longer!**
888 If it overlaps the frame_or_window field of struct input_event,
889 that will cause GC to crash. */
890 struct selection_input_event
894 /* We spell it with an "o" here because X does. */
896 Atom selection
, target
, property
;
900 #define SELECTION_EVENT_DISPLAY(eventp) \
901 (((struct selection_input_event *) (eventp))->display)
902 /* We spell it with an "o" here because X does. */
903 #define SELECTION_EVENT_REQUESTOR(eventp) \
904 (((struct selection_input_event *) (eventp))->requestor)
905 #define SELECTION_EVENT_SELECTION(eventp) \
906 (((struct selection_input_event *) (eventp))->selection)
907 #define SELECTION_EVENT_TARGET(eventp) \
908 (((struct selection_input_event *) (eventp))->target)
909 #define SELECTION_EVENT_PROPERTY(eventp) \
910 (((struct selection_input_event *) (eventp))->property)
911 #define SELECTION_EVENT_TIME(eventp) \
912 (((struct selection_input_event *) (eventp))->time)
922 /* From xselect.c. */
924 void x_handle_selection_notify (XSelectionEvent
*);
925 void x_handle_property_notify (XPropertyEvent
*);
929 Lisp_Object
display_x_get_resource (struct x_display_info
*,
930 Lisp_Object
, Lisp_Object
,
931 Lisp_Object
, Lisp_Object
);
932 struct frame
*check_x_frame (Lisp_Object
);
933 EXFUN (Fx_display_color_p
, 1);
934 EXFUN (Fx_display_grayscale_p
, 1);
935 extern void x_free_gcs (struct frame
*);
936 extern int gray_bitmap_width
, gray_bitmap_height
;
937 extern char *gray_bitmap_bits
;
941 char *x_get_customization_string (XrmDatabase
, const char *, const char *);
942 XrmDatabase
x_load_resources (Display
*, const char *, const char *,
944 int x_get_resource (XrmDatabase
, const char *, const char *,
945 XrmRepresentation
, XrmValue
*);
946 void x_delete_display (struct x_display_info
*);
947 void x_make_frame_visible (struct frame
*);
948 void x_iconify_frame (struct frame
*);
949 void x_wm_set_size_hint (struct frame
*, long, int);
950 int x_text_icon (struct frame
*, const char *);
951 int x_bitmap_icon (struct frame
*, Lisp_Object
);
952 void x_set_window_size (struct frame
*, int, int, int);
953 void x_wm_set_window_state (struct frame
*, int);
954 int x_alloc_nearest_color (struct frame
*, Colormap
, XColor
*);
956 /* Defined in xterm.c */
958 extern void cancel_mouse_face (struct frame
*);
959 extern void x_scroll_bar_clear (struct frame
*);
960 extern int x_text_icon (struct frame
*, const char *);
961 extern int x_bitmap_icon (struct frame
*, Lisp_Object
);
962 extern void x_catch_errors (Display
*);
963 extern void x_check_errors (Display
*, const char *);
964 extern int x_had_errors_p (Display
*);
965 extern int x_catching_errors (void);
966 extern void x_uncatch_errors (void);
967 extern void x_clear_errors (Display
*);
968 extern void x_set_window_size (struct frame
*, int, int, int);
969 extern void x_set_mouse_position (struct frame
*, int, int);
970 extern void x_set_mouse_pixel_position (struct frame
*, int, int);
971 extern void x_ewmh_activate_frame (struct frame
*);
972 extern void x_raise_frame (struct frame
*);
973 extern void x_lower_frame (struct frame
*);
974 extern void x_make_frame_visible (struct frame
*);
975 extern void x_make_frame_invisible (struct frame
*);
976 extern void x_iconify_frame (struct frame
*);
977 extern void x_free_frame_resources (struct frame
*);
978 extern void x_destroy_window (struct frame
*);
979 extern void x_wm_set_size_hint (struct frame
*, long, int);
980 extern void x_wm_set_window_state (struct frame
*, int);
981 extern void x_wm_set_icon_pixmap (struct frame
*, int);
982 extern void x_delete_display (struct x_display_info
*);
983 extern void x_delete_terminal (struct terminal
*terminal
);
984 extern void x_initialize (void);
985 extern unsigned long x_copy_color (struct frame
*, unsigned long);
987 extern XtAppContext Xt_app_con
;
988 extern int x_alloc_lighter_color_for_widget (Widget
, Display
*, Colormap
,
991 extern void x_activate_timeout_atimer (void);
993 extern void x_query_colors (struct frame
*f
, XColor
*, int);
994 extern void x_query_color (struct frame
*f
, XColor
*);
995 extern void x_clear_area (Display
*, Window
, int, int, int, int, int);
996 extern void set_vertical_scroll_bar (struct window
*);
998 extern int x_dispatch_event (XEvent
*, Display
*);
999 extern unsigned int x_x_to_emacs_modifiers (struct x_display_info
*,
1001 extern int x_display_pixel_height (struct x_display_info
*);
1002 extern int x_display_pixel_width (struct x_display_info
*);
1004 extern void x_set_sticky (struct frame
*, Lisp_Object
, Lisp_Object
);
1005 extern void x_wait_for_event (struct frame
*, int);
1007 /* Defined in xselect.c */
1009 extern void x_handle_property_notify (XPropertyEvent
*);
1010 extern void x_handle_selection_notify (XSelectionEvent
*);
1011 extern void x_handle_selection_event (struct input_event
*);
1012 extern void x_clear_frame_selections (struct frame
*);
1014 extern int x_handle_dnd_message (struct frame
*,
1015 XClientMessageEvent
*,
1016 struct x_display_info
*,
1017 struct input_event
*bufp
);
1018 extern int x_check_property_data (Lisp_Object
);
1019 extern void x_fill_property_data (Display
*,
1023 extern Lisp_Object
x_property_data_to_lisp (struct frame
*,
1024 const unsigned char *,
1029 /* Defined in xfns.c */
1031 extern struct x_display_info
* check_x_display_info (Lisp_Object frame
);
1032 extern Lisp_Object
x_get_focus_frame (struct frame
*);
1035 extern int xg_set_icon (struct frame
*, Lisp_Object
);
1036 extern int xg_set_icon_from_xpm_data (struct frame
*, const char**);
1037 #endif /* USE_GTK */
1039 extern void x_real_positions (struct frame
*, int *, int *);
1040 extern int defined_color (struct frame
*, const char *, XColor
*, int);
1041 extern void x_set_border_pixel (struct frame
*, int);
1042 extern void x_set_menu_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1043 extern void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
1044 extern void xic_free_xfontset (struct frame
*);
1045 extern void create_frame_xic (struct frame
*);
1046 extern void destroy_frame_xic (struct frame
*);
1047 extern void xic_set_preeditarea (struct window
*, int, int);
1048 extern void xic_set_statusarea (struct frame
*);
1049 extern void xic_set_xfontset (struct frame
*, const char *);
1050 extern int x_pixel_width (struct frame
*);
1051 extern int x_pixel_height (struct frame
*);
1052 extern int x_char_width (struct frame
*);
1053 extern int x_char_height (struct frame
*);
1054 extern int x_screen_planes (struct frame
*);
1055 extern void x_sync (struct frame
*);
1056 extern int x_defined_color (struct frame
*, const char *, XColor
*, int);
1058 extern void free_frame_xic (struct frame
*);
1059 extern char * xic_create_fontsetname (const char *base_fontname
, int motif
);
1061 extern void x_set_tool_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1063 /* Defined in xfaces.c */
1065 extern int compute_glyph_face (struct frame
*, int, int);
1066 extern int compute_glyph_face_1 (struct frame
*, Lisp_Object
, int);
1067 extern void x_free_dpy_colors (Display
*, Screen
*, Colormap
,
1068 unsigned long *, int);
1070 /* Defined in xmenu.c */
1072 extern void x_menu_set_in_use (int);
1073 extern void x_menu_wait_for_event (void *data
);
1074 extern void x_activate_menubar (struct frame
*);
1075 extern int popup_activated (void);
1076 extern void initialize_frame_menubar (struct frame
*);
1077 extern void free_frame_menubar (struct frame
*);
1079 /* Defined in widget.c */
1081 #ifdef USE_X_TOOLKIT
1082 extern void widget_store_internal_border (Widget
);
1085 /* Defined in xsmfns.c */
1087 extern void x_session_initialize (struct x_display_info
*dpyinfo
);
1088 extern int x_session_check_input (struct input_event
*bufp
);
1089 extern int x_session_have_connection (void);
1090 extern void x_session_close (void);
1093 /* XEmbed implementation. */
1095 #define XEMBED_VERSION 0
1099 XEMBED_MAPPED
= 1 << 0
1104 XEMBED_EMBEDDED_NOTIFY
= 0,
1105 XEMBED_WINDOW_ACTIVATE
= 1,
1106 XEMBED_WINDOW_DEACTIVATE
= 2,
1107 XEMBED_REQUEST_FOCUS
= 3,
1108 XEMBED_FOCUS_IN
= 4,
1109 XEMBED_FOCUS_OUT
= 5,
1110 XEMBED_FOCUS_NEXT
= 6,
1111 XEMBED_FOCUS_PREV
= 7,
1113 XEMBED_MODALITY_ON
= 10,
1114 XEMBED_MODALITY_OFF
= 11,
1115 XEMBED_REGISTER_ACCELERATOR
= 12,
1116 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1117 XEMBED_ACTIVATE_ACCELERATOR
= 14
1122 XEMBED_FOCUS_CURRENT
= 0,
1123 XEMBED_FOCUS_FIRST
= 1,
1124 XEMBED_FOCUS_LAST
= 2
1127 enum xembed_modifier
1129 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1130 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1131 XEMBED_MODIFIER_ALT
= 1 << 2,
1132 XEMBED_MODIFIER_SUPER
= 1 << 3,
1133 XEMBED_MODIFIER_HYPER
= 1 << 4
1136 enum xembed_accelerator
1138 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1141 /* Defined in xterm.c */
1143 extern Lisp_Object Qx_gtk_map_stock
;
1144 extern void xembed_set_info (struct frame
*f
, enum xembed_info flags
);
1145 extern void xembed_send_message (struct frame
*f
, Time time
,
1146 enum xembed_message message
,
1147 long detail
, long data1
, long data2
);
1149 /* Is the frame embedded into another application? */
1151 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1154 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1155 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1157 #define STORE_XCHAR2B(chp, b1, b2) \
1158 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1160 #define XCHAR2B_BYTE1(chp) \
1163 #define XCHAR2B_BYTE2(chp) \
1167 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1170 (nr).width = (rwidth), \
1171 (nr).height = (rheight))
1173 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1174 (do not change this comment) */