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)
58 /* Bookkeeping to distinguish X versions. */
62 #include <X11/Xlocale.h>
65 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
66 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
67 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
68 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
70 #define FONT_WIDTH(f) ((f)->max_width)
71 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
72 #define FONT_BASE(f) ((f)->ascent)
73 #define FONT_DESCENT(f) ((f)->descent)
75 /* The mask of events that text windows always want to receive. This
76 includes mouse movement events, since handling the mouse-font text property
77 means that we must track mouse motion all the time. */
79 #define STANDARD_EVENT_SET \
85 | StructureNotifyMask \
89 | VisibilityChangeMask)
92 /* Data structure passed to xim_instantiate_callback. */
95 struct x_display_info
*dpyinfo
;
98 #endif /* HAVE_X11R6_XIM */
100 /* Structure recording X pixmap and reference count.
101 If REFCOUNT is 0 then this record is free to be reused. */
103 struct x_bitmap_record
110 /* Record some info about this pixmap. */
111 int height
, width
, depth
;
114 /* For each X display, we have a structure that records
115 information about it. */
117 struct x_display_info
119 /* Chain of all x_display_info structures. */
120 struct x_display_info
*next
;
122 /* The generic display parameters corresponding to this X display. */
123 struct terminal
*terminal
;
125 /* Connection number (normally a file descriptor number). */
128 /* This says how to access this display in Xlib. */
131 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
132 The same cons cell also appears in x_display_name_list. */
133 Lisp_Object name_list_element
;
135 /* Number of frames that are on this display. */
138 /* The Screen this connection is connected to. */
141 /* Dots per inch of the screen. */
144 /* The Visual being used for this display. */
147 /* The colormap being used. */
150 /* Number of planes on this screen. */
153 /* Mask of things that cause the mouse to be grabbed. */
156 /* Emacs bitmap-id of the default icon bitmap for this frame.
157 Or -1 if none has been allocated yet. */
160 /* The root window of this screen. */
163 /* Client leader window. */
164 Window client_leader_window
;
166 /* The cursor to use for vertical scroll bars. */
167 Cursor vertical_scroll_bar_cursor
;
169 /* The invisible cursor used for pointer blanking. */
170 Cursor invisible_cursor
;
173 /* The GDK cursor for scroll bars and popup menus. */
174 GdkCursor
*xg_cursor
;
177 /* X Resource data base */
180 /* Minimum width over all characters in all fonts in font_table. */
181 int smallest_char_width
;
183 /* Minimum font height over all fonts in font_table. */
184 int smallest_font_height
;
186 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
187 GC scratch_cursor_gc
;
189 /* These variables describe the range of text currently shown in its
190 mouse-face, together with the window they apply to. As long as
191 the mouse stays within this range, we need not redraw anything on
192 its account. Rows and columns are glyph matrix positions in
193 MOUSE_FACE_WINDOW. */
194 int mouse_face_beg_row
, mouse_face_beg_col
;
195 int mouse_face_beg_x
, mouse_face_beg_y
;
196 int mouse_face_end_row
, mouse_face_end_col
;
197 int mouse_face_end_x
, mouse_face_end_y
;
198 int mouse_face_past_end
;
199 Lisp_Object mouse_face_window
;
200 int mouse_face_face_id
;
201 Lisp_Object mouse_face_overlay
;
203 /* 1 if a mouse motion event came and we didn't handle it right away because
204 gc was in progress. */
205 int mouse_face_deferred_gc
;
207 /* FRAME and X, Y position of mouse when last checked for
208 highlighting. X and Y can be negative or out of range for the frame. */
209 struct frame
*mouse_face_mouse_frame
;
210 int mouse_face_mouse_x
, mouse_face_mouse_y
;
212 /* Nonzero means defer mouse-motion highlighting. */
213 int mouse_face_defer
;
215 /* Nonzero means that the mouse highlight should not be shown. */
216 int mouse_face_hidden
;
218 int mouse_face_image_state
;
222 /* The number of fonts opened for this display. */
225 /* Pointer to bitmap records. */
226 struct x_bitmap_record
*bitmaps
;
228 /* Allocated size of bitmaps field. */
231 /* Last used bitmap index. */
234 /* Which modifier keys are on which modifier bits?
236 With each keystroke, X returns eight bits indicating which modifier
237 keys were held down when the key was pressed. The interpretation
238 of the top five modifier bits depends on what keys are attached
239 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
242 meta_mod_mask is a mask containing the bits used for the meta key.
243 It may have more than one bit set, if more than one modifier bit
244 has meta keys on it. Basically, if EVENT is a KeyPress event,
245 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
247 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
248 lock modifier bit, or zero otherwise. Non-alphabetic keys should
249 only be affected by the lock modifier bit if XK_Shift_Lock is in
250 use; XK_Caps_Lock should only affect alphabetic keys. With this
251 arrangement, the lock modifier should shift the character if
252 (EVENT.state & shift_lock_mask) != 0. */
253 int meta_mod_mask
, shift_lock_mask
;
255 /* These are like meta_mod_mask, but for different modifiers. */
256 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
258 /* Communication with window managers. */
259 Atom Xatom_wm_protocols
;
261 /* Kinds of protocol things we may receive. */
262 Atom Xatom_wm_take_focus
;
263 Atom Xatom_wm_save_yourself
;
264 Atom Xatom_wm_delete_window
;
266 /* Atom for indicating window state to the window manager. */
267 Atom Xatom_wm_change_state
;
269 /* Other WM communication */
270 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
271 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
272 Atom Xatom_wm_client_leader
; /* Id of client leader window. */
274 /* EditRes protocol */
277 /* More atoms, which are selection types. */
278 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
279 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
280 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
283 /* More atoms for font properties. The last three are private
284 properties, see the comments in src/fontset.h. */
285 Atom Xatom_PIXEL_SIZE
, Xatom_AVERAGE_WIDTH
,
286 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
287 Xatom_MULE_DEFAULT_ASCENT
;
289 /* More atoms for Ghostscript support. */
290 Atom Xatom_DONE
, Xatom_PAGE
;
292 /* Atom used in toolkit scroll bar client messages. */
293 Atom Xatom_Scrollbar
;
295 /* Atom used in XEmbed client messages. */
298 int cut_buffers_initialized
; /* Whether we're sure they all exist */
300 /* The frame (if any) which has the X window that has keyboard focus.
301 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
302 that a mere EnterNotify event can set this; if you need to know the
303 last frame specified in a FocusIn or FocusOut event, use
304 x_focus_event_frame. */
305 struct frame
*x_focus_frame
;
307 /* The last frame mentioned in a FocusIn or FocusOut event. This is
308 separate from x_focus_frame, because whether or not LeaveNotify
309 events cause us to lose focus depends on whether or not we have
310 received a FocusIn event for it. */
311 struct frame
*x_focus_event_frame
;
313 /* The frame which currently has the visual highlight, and should get
314 keyboard input (other sorts of input have the frame encoded in the
315 event). It points to the X focus frame's selected window's
316 frame. It differs from x_focus_frame when we're using a global
318 struct frame
*x_highlight_frame
;
320 /* The gray pixmap. */
324 /* XIM (X Input method). */
326 XIMStyles
*xim_styles
;
327 struct xim_inst_t
*xim_callback_data
;
330 /* If non-null, a cache of the colors in the color map. Don't
331 use this directly, call x_color_cells instead. */
335 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
336 int red_bits
, blue_bits
, green_bits
;
337 int red_offset
, blue_offset
, green_offset
;
339 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
340 to x/y 0/0, some window managers (type A) puts the window manager
341 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
342 Other window managers (type B) puts the window including decorations
343 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
344 Record the type of WM in use so we can compensate for type A WMs. */
353 /* Atoms that are drag and drop atoms */
355 size_t x_dnd_atoms_size
;
356 size_t x_dnd_atoms_length
;
358 /* Extended window manager hints, Atoms supported by the window manager and
359 atoms for settig the window type. */
360 Atom
*net_supported_atoms
;
361 int nr_net_supported_atoms
;
362 Window net_supported_window
;
363 Atom Xatom_net_window_type
, Xatom_net_window_type_tooltip
;
365 /* Atoms dealing with maximization and fullscreen */
366 Atom Xatom_net_wm_state
, Xatom_net_wm_state_fullscreen_atom
,
367 Xatom_net_wm_state_maximized_horz
, Xatom_net_wm_state_maximized_vert
,
368 Xatom_net_wm_state_sticky
;
370 /* XSettings atoms and windows. */
371 Atom Xatom_xsettings_sel
, Xatom_xsettings_prop
, Xatom_xsettings_mgr
;
372 Window xsettings_window
;
374 /* Frame name and icon name */
375 Atom Xatom_net_wm_name
, Xatom_net_wm_icon_name
;
379 /* Whether or not to use XIM if we have it. */
383 /* This checks to make sure we have a display. */
385 extern void check_x (void);
387 extern struct frame
*x_window_to_frame (struct x_display_info
*, int);
389 extern struct frame
*x_any_window_to_frame (struct x_display_info
*, int);
390 extern struct frame
*x_menubar_window_to_frame (struct x_display_info
*,
393 extern struct frame
*x_top_window_to_frame (struct x_display_info
*, int);
395 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
396 #define x_any_window_to_frame x_window_to_frame
397 #define x_top_window_to_frame x_window_to_frame
400 /* This is a chain of structures for all the X displays currently in use. */
401 extern struct x_display_info
*x_display_list
;
403 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
404 one for each element of x_display_list and in the same order.
405 NAME is the name of the frame.
406 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
407 extern Lisp_Object x_display_name_list
;
409 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
410 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
412 extern struct x_display_info
*x_display_info_for_display (Display
*);
413 extern struct x_display_info
*x_display_info_for_name (Lisp_Object
);
414 extern void x_set_frame_alpha (struct frame
*);
416 extern struct x_display_info
*x_term_init (Lisp_Object
, char *, char *);
417 extern int x_display_ok (const char *);
419 extern void select_visual (struct x_display_info
*);
424 /* Each X frame object points to its own struct x_output object
425 in the output_data.x field. The x_output structure contains
426 the information that is specific to X windows. */
430 /* Height of menu bar widget, in pixels.
431 Zero if not using the X toolkit.
432 When using the toolkit, this value is not meaningful
433 if the menubar is turned off. */
436 /* Height of tool bar widget, in pixels. top_height is used if tool bar
437 at top, bottom_height if tool bar is at the bottom.
438 Zero if not using an external tool bar or if tool bar is vertical. */
439 int toolbar_top_height
, toolbar_bottom_height
;
441 /* Width of tool bar widget, in pixels. left_width is used if tool bar
442 at left, right_width if tool bar is at the right.
443 Zero if not using an external tool bar or if tool bar is horizontal. */
444 int toolbar_left_width
, toolbar_right_width
;
446 /* The tiled border used when the mouse is out of the frame. */
449 /* Here are the Graphics Contexts for the default font. */
450 GC normal_gc
; /* Normal video */
451 GC reverse_gc
; /* Reverse video */
452 GC cursor_gc
; /* cursor drawing */
454 /* The X window used for this frame.
455 May be zero while the frame object is being created
456 and the X window has not yet been created. */
459 /* The X window used for the bitmap icon;
460 or 0 if we don't have a bitmap icon. */
463 /* The X window that is the parent of this X window.
464 Usually this is a window that was made by the window manager,
465 but it can be the root window, and it can be explicitly specified
466 (see the explicit_parent field, below). */
470 /* The widget of this screen. This is the window of a "shell" widget. */
472 /* The XmPanedWindows... */
473 Widget column_widget
;
474 /* The widget of the edit portion of this screen; the window in
475 "window_desc" is inside of this. */
478 Widget menubar_widget
;
482 /* The widget of this screen. This is the window of a top widget. */
484 /* The widget of the edit portion of this screen; the window in
485 "window_desc" is inside of this. */
486 GtkWidget
*edit_widget
;
487 /* The widget used for laying out widgets vertically. */
488 GtkWidget
*vbox_widget
;
489 /* The widget used for laying out widgets horizontally. */
490 GtkWidget
*hbox_widget
;
491 /* The menubar in this frame. */
492 GtkWidget
*menubar_widget
;
493 /* The tool bar in this frame */
494 GtkWidget
*toolbar_widget
;
495 /* The handle box that makes the tool bar detachable. */
496 GtkWidget
*handlebox_widget
;
497 /* Non-zero if the tool bar is detached. */
498 int toolbar_detached
;
499 /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical). */
502 /* The last size hints set. */
503 GdkGeometry size_hints
;
507 /* If >=0, a bitmap index. The indicated bitmap is used for the
511 /* Default ASCII font of this frame. */
514 /* The baseline offset of the default ASCII font. */
517 /* If a fontset is specified for this frame instead of font, this
518 value contains an ID of the fontset, else -1. */
521 /* Pixel values used for various purposes.
522 border_pixel may be -1 meaning use a gray tile. */
523 #if 0 /* These are also defined in struct frame. Use that instead. */
524 unsigned long background_pixel
;
525 unsigned long foreground_pixel
;
527 unsigned long cursor_pixel
;
528 unsigned long border_pixel
;
529 unsigned long mouse_pixel
;
530 unsigned long cursor_foreground_pixel
;
532 /* Foreground color for scroll bars. A value of -1 means use the
533 default (black for non-toolkit scroll bars). */
534 unsigned long scroll_bar_foreground_pixel
;
536 /* Background color for scroll bars. A value of -1 means use the
537 default (background color of the frame for non-toolkit scroll
539 unsigned long scroll_bar_background_pixel
;
541 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
542 let the scroll compute them itself. */
543 unsigned long scroll_bar_top_shadow_pixel
;
544 unsigned long scroll_bar_bottom_shadow_pixel
;
546 /* Descriptor for the cursor in use for this window. */
548 Cursor nontext_cursor
;
549 Cursor modeline_cursor
;
551 Cursor hourglass_cursor
;
552 Cursor horizontal_drag_cursor
;
553 Cursor current_cursor
;
555 /* Window whose cursor is hourglass_cursor. This window is temporarily
556 mapped to display an hourglass cursor. */
557 Window hourglass_window
;
559 /* Non-zero means hourglass cursor is currently displayed. */
560 unsigned hourglass_p
: 1;
562 /* Flag to set when the X window needs to be completely repainted. */
565 /* These are the current window manager hints. It seems that
566 XSetWMHints, when presented with an unset bit in the `flags'
567 member of the hints structure, does not leave the corresponding
568 attribute unchanged; rather, it resets that attribute to its
569 default value. For example, unless you set the `icon_pixmap'
570 field and the `IconPixmapHint' bit, XSetWMHints will forget what
571 your icon pixmap was. This is rather troublesome, since some of
572 the members (for example, `input' and `icon_pixmap') want to stay
573 the same throughout the execution of Emacs. So, we keep this
574 structure around, just leaving values in it and adding new bits
575 to the mask as we go. */
578 /* This is the Emacs structure for the X display this frame is on. */
579 struct x_display_info
*display_info
;
581 /* This is a button event that wants to activate the menubar.
582 We save it here until the command loop gets to think about it. */
583 XEvent
*saved_menu_event
;
585 /* This is the widget id used for this frame's menubar in lwlib. */
590 /* Nonzero means our parent is another application's window
591 and was explicitly specified. */
592 char explicit_parent
;
594 /* Nonzero means tried already to make this frame visible. */
595 char asked_for_visible
;
597 /* Nonzero if this frame was ever previously visible. */
598 char has_been_visible
;
601 /* Input context (currently, this means Compose key handler setup). */
605 char *xic_base_fontname
;
608 /* Relief GCs, colors etc. */
615 black_relief
, white_relief
;
617 /* The background for which the above relief GCs were set up.
618 They are changed only when a different background is involved. */
619 unsigned long relief_background
;
621 /* Xt waits for a ConfigureNotify event from the window manager in
622 EmacsFrameSetCharSize when the shell widget is resized. For some
623 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
624 arrive for an unknown reason and Emacs hangs in Xt. If this is
625 zero, tell Xt not to wait. */
628 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
629 two might differ by a pixel, depending on WM */
630 int x_pixels_outer_diff
;
632 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
633 these may differ because this does not take into account possible
634 menubar. y_pixels_diff is with menubar height included */
635 int y_pixels_outer_diff
;
637 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
638 frame, or IMPLICIT if we received an EnterNotify.
639 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
642 /* The offset we need to add to compensate for type A WMs. */
644 int move_offset_left
;
646 /* The frame's left/top offsets before we call XMoveWindow. See
647 x_check_expected_move. */
648 int left_before_move
;
652 #define No_Cursor (None)
656 /* Values for focus_state, used as bit mask.
657 EXPLICIT means we received a FocusIn for the frame and know it has
658 the focus. IMPLICIT means we recevied an EnterNotify and the frame
659 may have the focus if no window manager is running.
660 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
667 /* Return the X output data for frame F. */
668 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
670 /* Return the X window used for displaying data in frame F. */
671 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
673 /* Return the outermost X window associated with the frame F. */
675 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
676 XtWindow ((f)->output_data.x->widget) : \
680 /* Functions not present in older Gtk+ */
682 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
683 #define gtk_widget_get_window(w) ((w)->window)
685 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
686 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
688 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
689 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
690 #define gtk_adjustment_get_upper(w) ((w)->upper)
693 #define GTK_WIDGET_TO_X_WIN(w) \
694 ((w) && gtk_widget_get_window (w) \
695 ? GDK_WINDOW_XWINDOW (gtk_widget_get_window (w)) : 0)
697 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
698 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
699 #define FRAME_OUTER_WINDOW(f) \
700 (FRAME_GTK_OUTER_WIDGET (f) ? \
701 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
705 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
706 #endif /* !USE_GTK */
710 #define FRAME_FONT(f) ((f)->output_data.x->font)
711 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
712 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
713 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
714 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
715 ((f)->output_data.x->toolbar_bottom_height)
716 #define FRAME_TOOLBAR_HEIGHT(f) \
717 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
718 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
719 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
720 #define FRAME_TOOLBAR_WIDTH(f) \
721 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
722 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
724 /* This gives the x_display_info structure for the display F is on. */
725 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
727 /* This is the `Display *' which frame F is on. */
728 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
730 /* This is the `Screen *' which frame F is on. */
731 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
732 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
734 /* This is the Visual which frame F is on. */
735 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
737 /* This is the Colormap which frame F uses. */
738 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
740 /* This is the 'font_info *' which frame F has. */
741 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
743 /* The difference in pixels between the top left corner of the
744 Emacs window (including possible window manager decorations)
745 and FRAME_X_WINDOW (f). */
746 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
747 ((f)->output_data.x->x_pixels_outer_diff)
748 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
749 ((f)->output_data.x->y_pixels_outer_diff \
750 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
753 #define FRAME_XIC(f) ((f)->output_data.x->xic)
754 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
755 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
756 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
757 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
758 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
760 /* Value is the smallest width of any character in any font on frame F. */
762 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
763 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
765 /* Value is the smallest height of any font on frame F. */
767 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
768 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
770 /* X-specific scroll bar stuff. */
772 /* We represent scroll bars as lisp vectors. This allows us to place
773 references to them in windows without worrying about whether we'll
774 end up with windows referring to dead scroll bars; the garbage
775 collector will free it when its time comes.
777 We use struct scroll_bar as a template for accessing fields of the
782 /* These fields are shared by all vectors. */
783 EMACS_INT size_from_Lisp_Vector_struct
;
784 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
786 /* The window we're a scroll bar for. */
789 /* The next and previous in the chain of scroll bars in this frame. */
790 Lisp_Object next
, prev
;
792 /* Fields from `x_window' down will not be traced by the GC. */
794 /* The X window representing this scroll bar. */
797 /* The position and size of the scroll bar in pixels, relative to the
799 int top
, left
, width
, height
;
801 /* The starting and ending positions of the handle, relative to the
802 handle area (i.e. zero is the top position, not
803 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
804 hasn't been drawn yet.
806 These are not actually the locations where the beginning and end
807 are drawn; in order to keep handles from becoming invisible when
808 editing large files, we establish a minimum height by always
809 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
810 where they would be normally; the bottom and top are in a
811 different co-ordinate system. */
814 /* If the scroll bar handle is currently being dragged by the user,
815 this is the number of pixels from the top of the handle to the
816 place where the user grabbed it. If the handle isn't currently
817 being dragged, this is Qnil. */
818 Lisp_Object dragging
;
820 /* 1 if the background of the fringe that is adjacent to a scroll
821 bar is extended to the gap between the fringe and the bar. */
822 unsigned int fringe_extended_p
: 1;
825 /* The number of elements a vector holding a struct scroll_bar needs. */
826 #define SCROLL_BAR_VEC_SIZE \
827 ((sizeof (struct scroll_bar) \
828 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
829 / sizeof (Lisp_Object))
831 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
832 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
835 /* Extract the X widget of the scroll bar from a struct scroll_bar.
836 XtWindowToWidget should be fast enough since Xt uses a hash table
837 to map windows to widgets. */
839 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
840 XtWindowToWidget (dpy, ptr->x_window)
842 /* Store a widget id in a struct scroll_bar. */
844 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
846 Window window = XtWindow (w); \
847 ptr->x_window = window; \
851 /* Return the inside width of a vertical scroll bar, given the outside
853 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
855 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
856 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
857 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
859 /* Return the length of the rectangle within which the top of the
860 handle must stay. This isn't equivalent to the inside height,
861 because the scroll bar handle has a minimum height.
863 This is the real range of motion for the scroll bar, so when we're
864 scaling buffer positions to scroll bar positions, we use this, not
865 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
866 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
867 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
869 /* Return the inside height of vertical scroll bar, given the outside
870 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
871 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
872 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
875 /* Border widths for scroll bars.
877 Scroll bar windows don't have any X borders; their border width is
878 set to zero, and we redraw borders ourselves. This makes the code
879 a bit cleaner, since we don't have to convert between outside width
880 (used when relating to the rest of the screen) and inside width
881 (used when sizing and drawing the scroll bar window itself).
883 The handle moves up and down/back and forth in a rectangle inset
884 from the edges of the scroll bar. These are widths by which we
885 inset the handle boundaries from the scroll bar edges. */
886 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
887 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
888 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
889 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
891 /* Minimum lengths for scroll bar handles, in pixels. */
892 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
894 /* Trimming off a few pixels from each side prevents
895 text from glomming up against the scroll bar */
896 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
899 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
900 or SELECTION_CLEAR_EVENT, then its contents are really described
901 by this structure. */
903 /* For an event of kind SELECTION_REQUEST_EVENT,
904 this structure really describes the contents.
905 **Don't make this struct longer!**
906 If it overlaps the frame_or_window field of struct input_event,
907 that will cause GC to crash. */
908 struct selection_input_event
912 /* We spell it with an "o" here because X does. */
914 Atom selection
, target
, property
;
918 #define SELECTION_EVENT_DISPLAY(eventp) \
919 (((struct selection_input_event *) (eventp))->display)
920 /* We spell it with an "o" here because X does. */
921 #define SELECTION_EVENT_REQUESTOR(eventp) \
922 (((struct selection_input_event *) (eventp))->requestor)
923 #define SELECTION_EVENT_SELECTION(eventp) \
924 (((struct selection_input_event *) (eventp))->selection)
925 #define SELECTION_EVENT_TARGET(eventp) \
926 (((struct selection_input_event *) (eventp))->target)
927 #define SELECTION_EVENT_PROPERTY(eventp) \
928 (((struct selection_input_event *) (eventp))->property)
929 #define SELECTION_EVENT_TIME(eventp) \
930 (((struct selection_input_event *) (eventp))->time)
940 /* From xselect.c. */
942 void x_handle_selection_notify (XSelectionEvent
*);
943 void x_handle_property_notify (XPropertyEvent
*);
947 Lisp_Object
display_x_get_resource (struct x_display_info
*,
948 Lisp_Object
, Lisp_Object
,
949 Lisp_Object
, Lisp_Object
);
950 struct frame
*check_x_frame (Lisp_Object
);
951 EXFUN (Fx_display_color_p
, 1);
952 EXFUN (Fx_display_grayscale_p
, 1);
953 extern void x_free_gcs (struct frame
*);
954 extern int gray_bitmap_width
, gray_bitmap_height
;
955 extern char *gray_bitmap_bits
;
959 char *x_get_customization_string (XrmDatabase
, const char *, const char *);
960 XrmDatabase
x_load_resources (Display
*, const char *, const char *,
962 int x_get_resource (XrmDatabase
, const char *, const char *,
963 XrmRepresentation
, XrmValue
*);
964 void x_delete_display (struct x_display_info
*);
965 void x_make_frame_visible (struct frame
*);
966 void x_iconify_frame (struct frame
*);
967 void x_wm_set_size_hint (struct frame
*, long, int);
968 int x_text_icon (struct frame
*, const char *);
969 int x_bitmap_icon (struct frame
*, Lisp_Object
);
970 void x_set_window_size (struct frame
*, int, int, int);
971 void x_wm_set_window_state (struct frame
*, int);
972 int x_alloc_nearest_color (struct frame
*, Colormap
, XColor
*);
974 /* Defined in xterm.c */
976 extern void cancel_mouse_face (struct frame
*);
977 extern void x_scroll_bar_clear (struct frame
*);
978 extern int x_text_icon (struct frame
*, const char *);
979 extern int x_bitmap_icon (struct frame
*, Lisp_Object
);
980 extern void x_catch_errors (Display
*);
981 extern void x_check_errors (Display
*, const char *);
982 extern int x_had_errors_p (Display
*);
983 extern int x_catching_errors (void);
984 extern void x_uncatch_errors (void);
985 extern void x_clear_errors (Display
*);
986 extern void x_set_window_size (struct frame
*, int, int, int);
987 extern void x_set_mouse_position (struct frame
*, int, int);
988 extern void x_set_mouse_pixel_position (struct frame
*, int, int);
989 extern void x_ewmh_activate_frame (struct frame
*);
990 extern void x_raise_frame (struct frame
*);
991 extern void x_lower_frame (struct frame
*);
992 extern void x_make_frame_visible (struct frame
*);
993 extern void x_make_frame_invisible (struct frame
*);
994 extern void x_iconify_frame (struct frame
*);
995 extern void x_free_frame_resources (struct frame
*);
996 extern void x_destroy_window (struct frame
*);
997 extern void x_wm_set_size_hint (struct frame
*, long, int);
998 extern void x_wm_set_window_state (struct frame
*, int);
999 extern void x_wm_set_icon_pixmap (struct frame
*, int);
1000 extern void x_delete_display (struct x_display_info
*);
1001 extern void x_delete_terminal (struct terminal
*terminal
);
1002 extern void x_initialize (void);
1003 extern unsigned long x_copy_color (struct frame
*, unsigned long);
1004 #ifdef USE_X_TOOLKIT
1005 extern XtAppContext Xt_app_con
;
1006 extern int x_alloc_lighter_color_for_widget (Widget
, Display
*, Colormap
,
1009 extern void x_activate_timeout_atimer (void);
1011 extern void x_query_colors (struct frame
*f
, XColor
*, int);
1012 extern void x_query_color (struct frame
*f
, XColor
*);
1013 extern void x_clear_area (Display
*, Window
, int, int, int, int, int);
1014 extern void set_vertical_scroll_bar (struct window
*);
1016 extern int x_dispatch_event (XEvent
*, Display
*);
1017 extern unsigned int x_x_to_emacs_modifiers (struct x_display_info
*,
1019 extern int x_display_pixel_height (struct x_display_info
*);
1020 extern int x_display_pixel_width (struct x_display_info
*);
1022 extern void x_set_sticky (struct frame
*, Lisp_Object
, Lisp_Object
);
1023 extern void x_wait_for_event (struct frame
*, int);
1025 /* Defined in xselect.c */
1027 extern void x_handle_property_notify (XPropertyEvent
*);
1028 extern void x_handle_selection_notify (XSelectionEvent
*);
1029 extern void x_handle_selection_event (struct input_event
*);
1030 extern void x_clear_frame_selections (struct frame
*);
1032 extern int x_handle_dnd_message (struct frame
*,
1033 XClientMessageEvent
*,
1034 struct x_display_info
*,
1035 struct input_event
*bufp
);
1036 extern int x_check_property_data (Lisp_Object
);
1037 extern void x_fill_property_data (Display
*,
1041 extern Lisp_Object
x_property_data_to_lisp (struct frame
*,
1042 const unsigned char *,
1047 /* Defined in xfns.c */
1049 extern struct x_display_info
* check_x_display_info (Lisp_Object frame
);
1052 extern int xg_set_icon (struct frame
*, Lisp_Object
);
1053 extern int xg_set_icon_from_xpm_data (struct frame
*, char**);
1054 #endif /* USE_GTK */
1056 extern void x_real_positions (struct frame
*, int *, int *);
1057 extern int defined_color (struct frame
*, const char *, XColor
*, int);
1058 extern void x_set_border_pixel (struct frame
*, int);
1059 extern void x_set_menu_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1060 extern void x_implicitly_set_name (struct frame
*, Lisp_Object
, Lisp_Object
);
1061 extern void xic_free_xfontset (struct frame
*);
1062 extern void create_frame_xic (struct frame
*);
1063 extern void destroy_frame_xic (struct frame
*);
1064 extern void xic_set_preeditarea (struct window
*, int, int);
1065 extern void xic_set_statusarea (struct frame
*);
1066 extern void xic_set_xfontset (struct frame
*, const char *);
1067 extern int x_pixel_width (struct frame
*);
1068 extern int x_pixel_height (struct frame
*);
1069 extern int x_char_width (struct frame
*);
1070 extern int x_char_height (struct frame
*);
1071 extern int x_screen_planes (struct frame
*);
1072 extern void x_sync (struct frame
*);
1073 extern int x_defined_color (struct frame
*, const char *, XColor
*, int);
1075 extern void free_frame_xic (struct frame
*);
1076 extern char * xic_create_fontsetname (const char *base_fontname
, int motif
);
1078 extern void x_set_tool_bar_lines (struct frame
*, Lisp_Object
, Lisp_Object
);
1080 /* Defined in xfaces.c */
1082 extern int compute_glyph_face (struct frame
*, int, int);
1083 extern int compute_glyph_face_1 (struct frame
*, Lisp_Object
, int);
1084 extern void x_free_dpy_colors (Display
*, Screen
*, Colormap
,
1085 unsigned long *, int);
1087 /* Defined in xmenu.c */
1089 extern void x_menu_set_in_use (int);
1090 extern void x_menu_wait_for_event (void *data
);
1091 extern void x_activate_menubar (struct frame
*);
1092 extern int popup_activated (void);
1093 extern void initialize_frame_menubar (struct frame
*);
1094 extern void free_frame_menubar (struct frame
*);
1096 /* Defined in widget.c */
1098 #ifdef USE_X_TOOLKIT
1099 extern void widget_store_internal_border (Widget
);
1102 /* Defined in xsmfns.c */
1104 extern void x_session_initialize (struct x_display_info
*dpyinfo
);
1105 extern int x_session_check_input (struct input_event
*bufp
);
1106 extern int x_session_have_connection (void);
1107 extern void x_session_close (void);
1110 /* XEmbed implementation. */
1112 #define XEMBED_VERSION 0
1116 XEMBED_MAPPED
= 1 << 0
1121 XEMBED_EMBEDDED_NOTIFY
= 0,
1122 XEMBED_WINDOW_ACTIVATE
= 1,
1123 XEMBED_WINDOW_DEACTIVATE
= 2,
1124 XEMBED_REQUEST_FOCUS
= 3,
1125 XEMBED_FOCUS_IN
= 4,
1126 XEMBED_FOCUS_OUT
= 5,
1127 XEMBED_FOCUS_NEXT
= 6,
1128 XEMBED_FOCUS_PREV
= 7,
1130 XEMBED_MODALITY_ON
= 10,
1131 XEMBED_MODALITY_OFF
= 11,
1132 XEMBED_REGISTER_ACCELERATOR
= 12,
1133 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1134 XEMBED_ACTIVATE_ACCELERATOR
= 14
1139 XEMBED_FOCUS_CURRENT
= 0,
1140 XEMBED_FOCUS_FIRST
= 1,
1141 XEMBED_FOCUS_LAST
= 2
1144 enum xembed_modifier
1146 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1147 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1148 XEMBED_MODIFIER_ALT
= 1 << 2,
1149 XEMBED_MODIFIER_SUPER
= 1 << 3,
1150 XEMBED_MODIFIER_HYPER
= 1 << 4
1153 enum xembed_accelerator
1155 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1158 /* Defined in xterm.c */
1160 extern void xembed_set_info (struct frame
*f
, enum xembed_info flags
);
1161 extern void xembed_send_message (struct frame
*f
, Time time
,
1162 enum xembed_message message
,
1163 long detail
, long data1
, long data2
);
1165 /* Is the frame embedded into another application? */
1167 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1170 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1171 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1173 #define STORE_XCHAR2B(chp, b1, b2) \
1174 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1176 #define XCHAR2B_BYTE1(chp) \
1179 #define XCHAR2B_BYTE2(chp) \
1183 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1186 (nr).width = (rwidth), \
1187 (nr).height = (rheight))
1189 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1190 (do not change this comment) */