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 /* 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
;
226 /* The number of fonts opened for this display. */
229 /* Pointer to bitmap records. */
230 struct x_bitmap_record
*bitmaps
;
232 /* Allocated size of bitmaps field. */
235 /* Last used bitmap index. */
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
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 */
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
,
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. */
302 int cut_buffers_initialized
; /* Whether we're sure they all exist */
304 /* The frame (if any) which has the X window that has keyboard focus.
305 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
306 that a mere EnterNotify event can set this; if you need to know the
307 last frame specified in a FocusIn or FocusOut event, use
308 x_focus_event_frame. */
309 struct frame
*x_focus_frame
;
311 /* The last frame mentioned in a FocusIn or FocusOut event. This is
312 separate from x_focus_frame, because whether or not LeaveNotify
313 events cause us to lose focus depends on whether or not we have
314 received a FocusIn event for it. */
315 struct frame
*x_focus_event_frame
;
317 /* The frame which currently has the visual highlight, and should get
318 keyboard input (other sorts of input have the frame encoded in the
319 event). It points to the X focus frame's selected window's
320 frame. It differs from x_focus_frame when we're using a global
322 struct frame
*x_highlight_frame
;
324 /* The gray pixmap. */
328 /* XIM (X Input method). */
330 XIMStyles
*xim_styles
;
331 struct xim_inst_t
*xim_callback_data
;
334 /* If non-null, a cache of the colors in the color map. Don't
335 use this directly, call x_color_cells instead. */
339 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
340 int red_bits
, blue_bits
, green_bits
;
341 int red_offset
, blue_offset
, green_offset
;
343 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
344 to x/y 0/0, some window managers (type A) puts the window manager
345 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
346 Other window managers (type B) puts the window including decorations
347 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
348 Record the type of WM in use so we can compensate for type A WMs. */
357 /* Atoms that are drag and drop atoms */
359 size_t x_dnd_atoms_size
;
360 size_t x_dnd_atoms_length
;
362 /* Extended window manager hints, Atoms supported by the window manager and
363 atoms for settig the window type. */
364 Atom
*net_supported_atoms
;
365 int nr_net_supported_atoms
;
366 Window net_supported_window
;
367 Atom Xatom_net_window_type
, Xatom_net_window_type_tooltip
;
369 /* Atoms dealing with maximization and fullscreen */
370 Atom Xatom_net_wm_state
, Xatom_net_wm_state_fullscreen_atom
,
371 Xatom_net_wm_state_maximized_horz
, Xatom_net_wm_state_maximized_vert
,
372 Xatom_net_wm_state_sticky
;
374 /* XSettings atoms and windows. */
375 Atom Xatom_xsettings_sel
, Xatom_xsettings_prop
, Xatom_xsettings_mgr
;
376 Window xsettings_window
;
378 /* Frame name and icon name */
379 Atom Xatom_net_wm_name
, Xatom_net_wm_icon_name
;
383 /* Whether or not to use XIM if we have it. */
387 /* This checks to make sure we have a display. */
389 extern void check_x (void);
391 extern struct frame
*x_window_to_frame (struct x_display_info
*, int);
393 extern struct frame
*x_any_window_to_frame (struct x_display_info
*, int);
394 extern struct frame
*x_menubar_window_to_frame (struct x_display_info
*,
397 extern struct frame
*x_top_window_to_frame (struct x_display_info
*, int);
399 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
400 #define x_any_window_to_frame x_window_to_frame
401 #define x_top_window_to_frame x_window_to_frame
404 /* This is a chain of structures for all the X displays currently in use. */
405 extern struct x_display_info
*x_display_list
;
407 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
408 one for each element of x_display_list and in the same order.
409 NAME is the name of the frame.
410 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
411 extern Lisp_Object x_display_name_list
;
413 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
414 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
416 extern struct x_display_info
*x_display_info_for_display (Display
*);
417 extern struct x_display_info
*x_display_info_for_name (Lisp_Object
);
418 extern void x_set_frame_alpha (struct frame
*);
420 extern struct x_display_info
*x_term_init (Lisp_Object
, char *, char *);
421 extern int x_display_ok (const char *);
423 extern void select_visual (struct x_display_info
*);
428 /* Each X frame object points to its own struct x_output object
429 in the output_data.x field. The x_output structure contains
430 the information that is specific to X windows. */
434 /* Height of menu bar widget, in pixels.
435 Zero if not using the X toolkit.
436 When using the toolkit, this value is not meaningful
437 if the menubar is turned off. */
440 /* Height of tool bar widget, in pixels. top_height is used if tool bar
441 at top, bottom_height if tool bar is at the bottom.
442 Zero if not using an external tool bar or if tool bar is vertical. */
443 int toolbar_top_height
, toolbar_bottom_height
;
445 /* Width of tool bar widget, in pixels. left_width is used if tool bar
446 at left, right_width if tool bar is at the right.
447 Zero if not using an external tool bar or if tool bar is horizontal. */
448 int toolbar_left_width
, toolbar_right_width
;
450 /* The tiled border used when the mouse is out of the frame. */
453 /* Here are the Graphics Contexts for the default font. */
454 GC normal_gc
; /* Normal video */
455 GC reverse_gc
; /* Reverse video */
456 GC cursor_gc
; /* cursor drawing */
458 /* The X window used for this frame.
459 May be zero while the frame object is being created
460 and the X window has not yet been created. */
463 /* The X window used for the bitmap icon;
464 or 0 if we don't have a bitmap icon. */
467 /* The X window that is the parent of this X window.
468 Usually this is a window that was made by the window manager,
469 but it can be the root window, and it can be explicitly specified
470 (see the explicit_parent field, below). */
474 /* The widget of this screen. This is the window of a "shell" widget. */
476 /* The XmPanedWindows... */
477 Widget column_widget
;
478 /* The widget of the edit portion of this screen; the window in
479 "window_desc" is inside of this. */
482 Widget menubar_widget
;
486 /* The widget of this screen. This is the window of a top widget. */
488 /* The widget of the edit portion of this screen; the window in
489 "window_desc" is inside of this. */
490 GtkWidget
*edit_widget
;
491 /* The widget used for laying out widgets vertically. */
492 GtkWidget
*vbox_widget
;
493 /* The widget used for laying out widgets horizontally. */
494 GtkWidget
*hbox_widget
;
495 /* The menubar in this frame. */
496 GtkWidget
*menubar_widget
;
497 /* The tool bar in this frame */
498 GtkWidget
*toolbar_widget
;
499 /* The handle box that makes the tool bar detachable. */
500 GtkWidget
*handlebox_widget
;
501 /* Non-zero if the tool bar is detached. */
502 int toolbar_detached
;
503 /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical). */
506 /* The last size hints set. */
507 GdkGeometry size_hints
;
510 #ifdef USE_GTK_TOOLTIP
511 GtkTooltip
*ttip_widget
;
513 GtkWindow
*ttip_window
;
514 #endif /* USE_GTK_TOOLTIP */
518 /* If >=0, a bitmap index. The indicated bitmap is used for the
522 /* Default ASCII font of this frame. */
525 /* The baseline offset of the default ASCII font. */
528 /* If a fontset is specified for this frame instead of font, this
529 value contains an ID of the fontset, else -1. */
532 /* Pixel values used for various purposes.
533 border_pixel may be -1 meaning use a gray tile. */
534 #if 0 /* These are also defined in struct frame. Use that instead. */
535 unsigned long background_pixel
;
536 unsigned long foreground_pixel
;
538 unsigned long cursor_pixel
;
539 unsigned long border_pixel
;
540 unsigned long mouse_pixel
;
541 unsigned long cursor_foreground_pixel
;
543 /* Foreground color for scroll bars. A value of -1 means use the
544 default (black for non-toolkit scroll bars). */
545 unsigned long scroll_bar_foreground_pixel
;
547 /* Background color for scroll bars. A value of -1 means use the
548 default (background color of the frame for non-toolkit scroll
550 unsigned long scroll_bar_background_pixel
;
552 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
553 let the scroll compute them itself. */
554 unsigned long scroll_bar_top_shadow_pixel
;
555 unsigned long scroll_bar_bottom_shadow_pixel
;
557 /* Descriptor for the cursor in use for this window. */
559 Cursor nontext_cursor
;
560 Cursor modeline_cursor
;
562 Cursor hourglass_cursor
;
563 Cursor horizontal_drag_cursor
;
564 Cursor current_cursor
;
566 /* Window whose cursor is hourglass_cursor. This window is temporarily
567 mapped to display an hourglass cursor. */
568 Window hourglass_window
;
570 /* Non-zero means hourglass cursor is currently displayed. */
571 unsigned hourglass_p
: 1;
573 /* Flag to set when the X window needs to be completely repainted. */
576 /* These are the current window manager hints. It seems that
577 XSetWMHints, when presented with an unset bit in the `flags'
578 member of the hints structure, does not leave the corresponding
579 attribute unchanged; rather, it resets that attribute to its
580 default value. For example, unless you set the `icon_pixmap'
581 field and the `IconPixmapHint' bit, XSetWMHints will forget what
582 your icon pixmap was. This is rather troublesome, since some of
583 the members (for example, `input' and `icon_pixmap') want to stay
584 the same throughout the execution of Emacs. So, we keep this
585 structure around, just leaving values in it and adding new bits
586 to the mask as we go. */
589 /* This is the Emacs structure for the X display this frame is on. */
590 struct x_display_info
*display_info
;
592 /* This is a button event that wants to activate the menubar.
593 We save it here until the command loop gets to think about it. */
594 XEvent
*saved_menu_event
;
596 /* This is the widget id used for this frame's menubar in lwlib. */
601 /* Nonzero means our parent is another application's window
602 and was explicitly specified. */
603 char explicit_parent
;
605 /* Nonzero means tried already to make this frame visible. */
606 char asked_for_visible
;
608 /* Nonzero if this frame was ever previously visible. */
609 char has_been_visible
;
612 /* Input context (currently, this means Compose key handler setup). */
616 char *xic_base_fontname
;
619 /* Relief GCs, colors etc. */
626 black_relief
, white_relief
;
628 /* The background for which the above relief GCs were set up.
629 They are changed only when a different background is involved. */
630 unsigned long relief_background
;
632 /* Xt waits for a ConfigureNotify event from the window manager in
633 EmacsFrameSetCharSize when the shell widget is resized. For some
634 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
635 arrive for an unknown reason and Emacs hangs in Xt. If this is
636 zero, tell Xt not to wait. */
639 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
640 two might differ by a pixel, depending on WM */
641 int x_pixels_outer_diff
;
643 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
644 these may differ because this does not take into account possible
645 menubar. y_pixels_diff is with menubar height included */
646 int y_pixels_outer_diff
;
648 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
649 frame, or IMPLICIT if we received an EnterNotify.
650 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
653 /* The offset we need to add to compensate for type A WMs. */
655 int move_offset_left
;
657 /* The frame's left/top offsets before we call XMoveWindow. See
658 x_check_expected_move. */
659 int left_before_move
;
663 #define No_Cursor (None)
667 /* Values for focus_state, used as bit mask.
668 EXPLICIT means we received a FocusIn for the frame and know it has
669 the focus. IMPLICIT means we recevied an EnterNotify and the frame
670 may have the focus if no window manager is running.
671 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
678 /* Return the X output data for frame F. */
679 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
681 /* Return the X window used for displaying data in frame F. */
682 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
684 /* Return the outermost X window associated with the frame F. */
686 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
687 XtWindow ((f)->output_data.x->widget) : \
691 /* Functions not present in older Gtk+ */
693 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
694 #define gtk_widget_get_window(w) ((w)->window)
696 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
697 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
699 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
700 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
701 #define gtk_adjustment_get_upper(w) ((w)->upper)
704 #define GTK_WIDGET_TO_X_WIN(w) \
705 ((w) && gtk_widget_get_window (w) \
706 ? GDK_WINDOW_XWINDOW (gtk_widget_get_window (w)) : 0)
708 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
709 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
710 #define FRAME_OUTER_WINDOW(f) \
711 (FRAME_GTK_OUTER_WIDGET (f) ? \
712 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
716 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
717 #endif /* !USE_GTK */
721 #define FRAME_FONT(f) ((f)->output_data.x->font)
722 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
723 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
724 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
725 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
726 ((f)->output_data.x->toolbar_bottom_height)
727 #define FRAME_TOOLBAR_HEIGHT(f) \
728 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
729 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
730 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
731 #define FRAME_TOOLBAR_WIDTH(f) \
732 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
733 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
735 /* This gives the x_display_info structure for the display F is on. */
736 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
738 /* This is the `Display *' which frame F is on. */
739 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
741 /* This is the `Screen *' which frame F is on. */
742 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
743 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
745 /* This is the Visual which frame F is on. */
746 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
748 /* This is the Colormap which frame F uses. */
749 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
751 /* This is the 'font_info *' which frame F has. */
752 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
754 /* The difference in pixels between the top left corner of the
755 Emacs window (including possible window manager decorations)
756 and FRAME_X_WINDOW (f). */
757 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
758 ((f)->output_data.x->x_pixels_outer_diff)
759 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
760 ((f)->output_data.x->y_pixels_outer_diff \
761 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
764 #define FRAME_XIC(f) ((f)->output_data.x->xic)
765 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
766 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
767 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
768 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
769 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
771 /* Value is the smallest width of any character in any font on frame F. */
773 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
774 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
776 /* Value is the smallest height of any font on frame F. */
778 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
779 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
781 /* X-specific scroll bar stuff. */
783 /* We represent scroll bars as lisp vectors. This allows us to place
784 references to them in windows without worrying about whether we'll
785 end up with windows referring to dead scroll bars; the garbage
786 collector will free it when its time comes.
788 We use struct scroll_bar as a template for accessing fields of the
793 /* These fields are shared by all vectors. */
794 EMACS_INT size_from_Lisp_Vector_struct
;
795 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
797 /* The window we're a scroll bar for. */
800 /* The next and previous in the chain of scroll bars in this frame. */
801 Lisp_Object next
, prev
;
803 /* Fields from `x_window' down will not be traced by the GC. */
805 /* The X window representing this scroll bar. */
808 /* The position and size of the scroll bar in pixels, relative to the
810 int top
, left
, width
, height
;
812 /* The starting and ending positions of the handle, relative to the
813 handle area (i.e. zero is the top position, not
814 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
815 hasn't been drawn yet.
817 These are not actually the locations where the beginning and end
818 are drawn; in order to keep handles from becoming invisible when
819 editing large files, we establish a minimum height by always
820 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
821 where they would be normally; the bottom and top are in a
822 different co-ordinate system. */
825 /* If the scroll bar handle is currently being dragged by the user,
826 this is the number of pixels from the top of the handle to the
827 place where the user grabbed it. If the handle isn't currently
828 being dragged, this is Qnil. */
829 Lisp_Object dragging
;
831 /* 1 if the background of the fringe that is adjacent to a scroll
832 bar is extended to the gap between the fringe and the bar. */
833 unsigned int fringe_extended_p
: 1;
836 /* The number of elements a vector holding a struct scroll_bar needs. */
837 #define SCROLL_BAR_VEC_SIZE \
838 ((sizeof (struct scroll_bar) \
839 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
840 / sizeof (Lisp_Object))
842 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
843 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
846 /* Extract the X widget of the scroll bar from a struct scroll_bar.
847 XtWindowToWidget should be fast enough since Xt uses a hash table
848 to map windows to widgets. */
850 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
851 XtWindowToWidget (dpy, ptr->x_window)
853 /* Store a widget id in a struct scroll_bar. */
855 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
857 Window window = XtWindow (w); \
858 ptr->x_window = window; \
862 /* Return the inside width of a vertical scroll bar, given the outside
864 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
866 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
867 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
868 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
870 /* Return the length of the rectangle within which the top of the
871 handle must stay. This isn't equivalent to the inside height,
872 because the scroll bar handle has a minimum height.
874 This is the real range of motion for the scroll bar, so when we're
875 scaling buffer positions to scroll bar positions, we use this, not
876 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
877 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
878 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
880 /* Return the inside height of vertical scroll bar, given the outside
881 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
882 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
883 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
886 /* Border widths for scroll bars.
888 Scroll bar windows don't have any X borders; their border width is
889 set to zero, and we redraw borders ourselves. This makes the code
890 a bit cleaner, since we don't have to convert between outside width
891 (used when relating to the rest of the screen) and inside width
892 (used when sizing and drawing the scroll bar window itself).
894 The handle moves up and down/back and forth in a rectangle inset
895 from the edges of the scroll bar. These are widths by which we
896 inset the handle boundaries from the scroll bar edges. */
897 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
898 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
899 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
900 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
902 /* Minimum lengths for scroll bar handles, in pixels. */
903 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
905 /* Trimming off a few pixels from each side prevents
906 text from glomming up against the scroll bar */
907 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
910 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
911 or SELECTION_CLEAR_EVENT, then its contents are really described
912 by this structure. */
914 /* For an event of kind SELECTION_REQUEST_EVENT,
915 this structure really describes the contents.
916 **Don't make this struct longer!**
917 If it overlaps the frame_or_window field of struct input_event,
918 that will cause GC to crash. */
919 struct selection_input_event
923 /* We spell it with an "o" here because X does. */
925 Atom selection
, target
, property
;
929 #define SELECTION_EVENT_DISPLAY(eventp) \
930 (((struct selection_input_event *) (eventp))->display)
931 /* We spell it with an "o" here because X does. */
932 #define SELECTION_EVENT_REQUESTOR(eventp) \
933 (((struct selection_input_event *) (eventp))->requestor)
934 #define SELECTION_EVENT_SELECTION(eventp) \
935 (((struct selection_input_event *) (eventp))->selection)
936 #define SELECTION_EVENT_TARGET(eventp) \
937 (((struct selection_input_event *) (eventp))->target)
938 #define SELECTION_EVENT_PROPERTY(eventp) \
939 (((struct selection_input_event *) (eventp))->property)
940 #define SELECTION_EVENT_TIME(eventp) \
941 (((struct selection_input_event *) (eventp))->time)
951 /* From xselect.c. */
953 void x_handle_selection_notify (XSelectionEvent
*);
954 void x_handle_property_notify (XPropertyEvent
*);
958 Lisp_Object
display_x_get_resource (struct x_display_info
*,
959 Lisp_Object
, Lisp_Object
,
960 Lisp_Object
, Lisp_Object
);
961 struct frame
*check_x_frame (Lisp_Object
);
962 EXFUN (Fx_display_color_p
, 1);
963 EXFUN (Fx_display_grayscale_p
, 1);
964 extern void x_free_gcs (struct frame
*);
965 extern int gray_bitmap_width
, gray_bitmap_height
;
966 extern char *gray_bitmap_bits
;
970 char *x_get_customization_string (XrmDatabase
, const char *, const char *);
971 XrmDatabase
x_load_resources (Display
*, const char *, const char *,
973 int x_get_resource (XrmDatabase
, const char *, const char *,
974 XrmRepresentation
, XrmValue
*);
975 void x_delete_display (struct x_display_info
*);
976 void x_make_frame_visible (struct frame
*);
977 void x_iconify_frame (struct frame
*);
978 void x_wm_set_size_hint (struct frame
*, long, int);
979 int x_text_icon (struct frame
*, const char *);
980 int x_bitmap_icon (struct frame
*, Lisp_Object
);
981 void x_set_window_size (struct frame
*, int, int, int);
982 void x_wm_set_window_state (struct frame
*, int);
983 int x_alloc_nearest_color (struct frame
*, Colormap
, XColor
*);
985 /* Defined in xterm.c */
987 extern void cancel_mouse_face (struct frame
*);
988 extern void x_scroll_bar_clear (struct frame
*);
989 extern int x_text_icon (struct frame
*, const char *);
990 extern int x_bitmap_icon (struct frame
*, Lisp_Object
);
991 extern void x_catch_errors (Display
*);
992 extern void x_check_errors (Display
*, const char *);
993 extern int x_had_errors_p (Display
*);
994 extern int x_catching_errors (void);
995 extern void x_uncatch_errors (void);
996 extern void x_clear_errors (Display
*);
997 extern void x_set_window_size (struct frame
*, int, int, int);
998 extern void x_set_mouse_position (struct frame
*, int, int);
999 extern void x_set_mouse_pixel_position (struct frame
*, int, int);
1000 extern void x_ewmh_activate_frame (struct frame
*);
1001 extern void x_raise_frame (struct frame
*);
1002 extern void x_lower_frame (struct frame
*);
1003 extern void x_make_frame_visible (struct frame
*);
1004 extern void x_make_frame_invisible (struct frame
*);
1005 extern void x_iconify_frame (struct frame
*);
1006 extern void x_free_frame_resources (struct frame
*);
1007 extern void x_destroy_window (struct frame
*);
1008 extern void x_wm_set_size_hint (struct frame
*, long, int);
1009 extern void x_wm_set_window_state (struct frame
*, int);
1010 extern void x_wm_set_icon_pixmap (struct frame
*, int);
1011 extern void x_delete_display (struct x_display_info
*);
1012 extern void x_delete_terminal (struct terminal
*terminal
);
1013 extern void x_initialize (void);
1014 extern unsigned long x_copy_color (struct frame
*, unsigned long);
1015 #ifdef USE_X_TOOLKIT
1016 extern XtAppContext Xt_app_con
;
1017 extern int x_alloc_lighter_color_for_widget (Widget
, Display
*, Colormap
,
1020 extern void x_activate_timeout_atimer (void);
1022 extern void x_query_colors (struct frame
*f
, XColor
*, int);
1023 extern void x_query_color (struct frame
*f
, XColor
*);
1024 extern void x_clear_area (Display
*, Window
, int, int, int, int, int);
1025 extern void set_vertical_scroll_bar (struct window
*);
1027 extern int x_dispatch_event (XEvent
*, Display
*);
1028 extern unsigned int x_x_to_emacs_modifiers (struct x_display_info
*,
1030 extern int x_display_pixel_height (struct x_display_info
*);
1031 extern int x_display_pixel_width (struct x_display_info
*);
1033 extern void x_set_sticky (struct frame
*, Lisp_Object
, Lisp_Object
);
1034 extern void x_wait_for_event (struct frame
*, int);
1036 /* Defined in xselect.c */
1038 extern void x_handle_property_notify (XPropertyEvent
*);
1039 extern void x_handle_selection_notify (XSelectionEvent
*);
1040 extern void x_handle_selection_event (struct input_event
*);
1041 extern void x_clear_frame_selections (struct frame
*);
1043 extern int x_handle_dnd_message (struct frame
*,
1044 XClientMessageEvent
*,
1045 struct x_display_info
*,
1046 struct input_event
*bufp
);
1047 extern int x_check_property_data (Lisp_Object
);
1048 extern void x_fill_property_data (Display
*,
1052 extern Lisp_Object
x_property_data_to_lisp (struct frame
*,
1053 const unsigned char *,
1058 /* Defined in xfns.c */
1060 extern struct x_display_info
* check_x_display_info (Lisp_Object frame
);
1061 extern Lisp_Object
x_get_focus_frame (struct frame
*);
1064 extern int xg_set_icon (struct frame
*, Lisp_Object
);
1065 extern int xg_set_icon_from_xpm_data (struct frame
*, const char**);
1066 #endif /* USE_GTK */
1068 extern void x_real_positions (struct frame
*, int *, int *);
1069 extern int defined_color (struct frame
*, const char *, XColor
*, int);
1070 extern void x_set_border_pixel (struct frame
*, int);
1071 extern void x_set_menu_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1072 extern void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
1073 extern void xic_free_xfontset (struct frame
*);
1074 extern void create_frame_xic (struct frame
*);
1075 extern void destroy_frame_xic (struct frame
*);
1076 extern void xic_set_preeditarea (struct window
*, int, int);
1077 extern void xic_set_statusarea (struct frame
*);
1078 extern void xic_set_xfontset (struct frame
*, const char *);
1079 extern int x_pixel_width (struct frame
*);
1080 extern int x_pixel_height (struct frame
*);
1081 extern int x_char_width (struct frame
*);
1082 extern int x_char_height (struct frame
*);
1083 extern int x_screen_planes (struct frame
*);
1084 extern void x_sync (struct frame
*);
1085 extern int x_defined_color (struct frame
*, const char *, XColor
*, int);
1087 extern void free_frame_xic (struct frame
*);
1088 extern char * xic_create_fontsetname (const char *base_fontname
, int motif
);
1090 extern void x_set_tool_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1092 /* Defined in xfaces.c */
1094 extern int compute_glyph_face (struct frame
*, int, int);
1095 extern int compute_glyph_face_1 (struct frame
*, Lisp_Object
, int);
1096 extern void x_free_dpy_colors (Display
*, Screen
*, Colormap
,
1097 unsigned long *, int);
1099 /* Defined in xmenu.c */
1101 extern void x_menu_set_in_use (int);
1102 extern void x_menu_wait_for_event (void *data
);
1103 extern void x_activate_menubar (struct frame
*);
1104 extern int popup_activated (void);
1105 extern void initialize_frame_menubar (struct frame
*);
1106 extern void free_frame_menubar (struct frame
*);
1108 /* Defined in widget.c */
1110 #ifdef USE_X_TOOLKIT
1111 extern void widget_store_internal_border (Widget
);
1114 /* Defined in xsmfns.c */
1116 extern void x_session_initialize (struct x_display_info
*dpyinfo
);
1117 extern int x_session_check_input (struct input_event
*bufp
);
1118 extern int x_session_have_connection (void);
1119 extern void x_session_close (void);
1122 /* XEmbed implementation. */
1124 #define XEMBED_VERSION 0
1128 XEMBED_MAPPED
= 1 << 0
1133 XEMBED_EMBEDDED_NOTIFY
= 0,
1134 XEMBED_WINDOW_ACTIVATE
= 1,
1135 XEMBED_WINDOW_DEACTIVATE
= 2,
1136 XEMBED_REQUEST_FOCUS
= 3,
1137 XEMBED_FOCUS_IN
= 4,
1138 XEMBED_FOCUS_OUT
= 5,
1139 XEMBED_FOCUS_NEXT
= 6,
1140 XEMBED_FOCUS_PREV
= 7,
1142 XEMBED_MODALITY_ON
= 10,
1143 XEMBED_MODALITY_OFF
= 11,
1144 XEMBED_REGISTER_ACCELERATOR
= 12,
1145 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1146 XEMBED_ACTIVATE_ACCELERATOR
= 14
1151 XEMBED_FOCUS_CURRENT
= 0,
1152 XEMBED_FOCUS_FIRST
= 1,
1153 XEMBED_FOCUS_LAST
= 2
1156 enum xembed_modifier
1158 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1159 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1160 XEMBED_MODIFIER_ALT
= 1 << 2,
1161 XEMBED_MODIFIER_SUPER
= 1 << 3,
1162 XEMBED_MODIFIER_HYPER
= 1 << 4
1165 enum xembed_accelerator
1167 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1170 /* Defined in xterm.c */
1172 extern Lisp_Object Qx_gtk_map_stock
;
1173 extern void xembed_set_info (struct frame
*f
, enum xembed_info flags
);
1174 extern void xembed_send_message (struct frame
*f
, Time time
,
1175 enum xembed_message message
,
1176 long detail
, long data1
, long data2
);
1178 /* Is the frame embedded into another application? */
1180 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1183 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1184 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1186 #define STORE_XCHAR2B(chp, b1, b2) \
1187 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1189 #define XCHAR2B_BYTE1(chp) \
1192 #define XCHAR2B_BYTE2(chp) \
1196 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1199 (nr).width = (rwidth), \
1200 (nr).height = (rheight))
1202 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1203 (do not change this comment) */