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 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 */
359 Atom
*net_supported_atoms
;
360 int nr_net_supported_atoms
;
361 Window net_supported_window
;
363 /* Atoms dealing with maximization and fullscreen */
364 Atom Xatom_net_wm_state
, Xatom_net_wm_state_fullscreen_atom
,
365 Xatom_net_wm_state_maximized_horz
, Xatom_net_wm_state_maximized_vert
,
366 Xatom_net_wm_state_sticky
;
368 /* XSettings atoms and windows. */
369 Atom Xatom_xsettings_sel
, Xatom_xsettings_prop
, Xatom_xsettings_mgr
;
370 Window xsettings_window
;
374 /* Whether or not to use XIM if we have it. */
378 /* This checks to make sure we have a display. */
379 extern void check_x
P_ ((void));
381 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
383 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
384 extern struct frame
*x_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
385 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
387 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
388 #define x_any_window_to_frame x_window_to_frame
389 #define x_top_window_to_frame x_window_to_frame
392 /* This is a chain of structures for all the X displays currently in use. */
393 extern struct x_display_info
*x_display_list
;
395 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
396 one for each element of x_display_list and in the same order.
397 NAME is the name of the frame.
398 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
399 extern Lisp_Object x_display_name_list
;
401 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
402 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
404 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
405 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
406 extern void x_set_frame_alpha
P_ ((struct frame
*));
408 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
409 extern int x_display_ok
P_ ((const char *));
411 extern void select_visual
P_ ((struct x_display_info
*));
416 /* Each X frame object points to its own struct x_output object
417 in the output_data.x field. The x_output structure contains
418 the information that is specific to X windows. */
422 /* Height of menu bar widget, in pixels.
423 Zero if not using the X toolkit.
424 When using the toolkit, this value is not meaningful
425 if the menubar is turned off. */
428 /* Height of tool bar widget, in pixels.
429 Zero if not using an external tool bar. */
432 /* The tiled border used when the mouse is out of the frame. */
435 /* Here are the Graphics Contexts for the default font. */
436 GC normal_gc
; /* Normal video */
437 GC reverse_gc
; /* Reverse video */
438 GC cursor_gc
; /* cursor drawing */
440 /* The X window used for this frame.
441 May be zero while the frame object is being created
442 and the X window has not yet been created. */
445 /* The X window used for the bitmap icon;
446 or 0 if we don't have a bitmap icon. */
449 /* The X window that is the parent of this X window.
450 Usually this is a window that was made by the window manager,
451 but it can be the root window, and it can be explicitly specified
452 (see the explicit_parent field, below). */
456 /* The widget of this screen. This is the window of a "shell" widget. */
458 /* The XmPanedWindows... */
459 Widget column_widget
;
460 /* The widget of the edit portion of this screen; the window in
461 "window_desc" is inside of this. */
464 Widget menubar_widget
;
468 /* The widget of this screen. This is the window of a top widget. */
470 /* The widget of the edit portion of this screen; the window in
471 "window_desc" is inside of this. */
472 GtkWidget
*edit_widget
;
473 /* The widget used for laying out widgets vertically. */
474 GtkWidget
*vbox_widget
;
475 /* The menubar in this frame. */
476 GtkWidget
*menubar_widget
;
477 /* The tool bar in this frame */
478 GtkWidget
*toolbar_widget
;
479 /* The handle box that makes the tool bar detachable. */
480 GtkWidget
*handlebox_widget
;
481 /* Non-zero if the tool bar is detached. */
482 int toolbar_detached
;
484 /* The last size hints set. */
485 GdkGeometry size_hints
;
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 #define GTK_WIDGET_TO_X_WIN(w) \
663 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
665 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
666 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
667 #define FRAME_OUTER_WINDOW(f) \
668 (FRAME_GTK_OUTER_WIDGET (f) ? \
669 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
673 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
674 #endif /* !USE_GTK */
678 #define FRAME_FONT(f) ((f)->output_data.x->font)
679 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
680 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
681 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
682 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
684 /* This gives the x_display_info structure for the display F is on. */
685 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
687 /* This is the `Display *' which frame F is on. */
688 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
690 /* This is the `Screen *' which frame F is on. */
691 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
692 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
694 /* This is the Visual which frame F is on. */
695 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
697 /* This is the Colormap which frame F uses. */
698 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
700 /* This is the 'font_info *' which frame F has. */
701 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
703 /* The difference in pixels between the top left corner of the
704 Emacs window (including possible window manager decorations)
705 and FRAME_X_WINDOW (f). */
706 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
707 ((f)->output_data.x->x_pixels_outer_diff)
708 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
709 ((f)->output_data.x->y_pixels_outer_diff \
710 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
713 #define FRAME_XIC(f) ((f)->output_data.x->xic)
714 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
715 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
716 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
717 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
718 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
720 /* Value is the smallest width of any character in any font on frame F. */
722 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
723 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
725 /* Value is the smallest height of any font on frame F. */
727 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
728 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
730 /* X-specific scroll bar stuff. */
732 /* We represent scroll bars as lisp vectors. This allows us to place
733 references to them in windows without worrying about whether we'll
734 end up with windows referring to dead scroll bars; the garbage
735 collector will free it when its time comes.
737 We use struct scroll_bar as a template for accessing fields of the
742 /* These fields are shared by all vectors. */
743 EMACS_INT size_from_Lisp_Vector_struct
;
744 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
746 /* The window we're a scroll bar for. */
749 /* The next and previous in the chain of scroll bars in this frame. */
750 Lisp_Object next
, prev
;
752 /* Fields from `x_window' down will not be traced by the GC. */
754 /* The X window representing this scroll bar. */
757 /* The position and size of the scroll bar in pixels, relative to the
759 int top
, left
, width
, height
;
761 /* The starting and ending positions of the handle, relative to the
762 handle area (i.e. zero is the top position, not
763 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
764 hasn't been drawn yet.
766 These are not actually the locations where the beginning and end
767 are drawn; in order to keep handles from becoming invisible when
768 editing large files, we establish a minimum height by always
769 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
770 where they would be normally; the bottom and top are in a
771 different co-ordinate system. */
774 /* If the scroll bar handle is currently being dragged by the user,
775 this is the number of pixels from the top of the handle to the
776 place where the user grabbed it. If the handle isn't currently
777 being dragged, this is Qnil. */
778 Lisp_Object dragging
;
780 /* 1 if the background of the fringe that is adjacent to a scroll
781 bar is extended to the gap between the fringe and the bar. */
782 unsigned int fringe_extended_p
: 1;
785 /* The number of elements a vector holding a struct scroll_bar needs. */
786 #define SCROLL_BAR_VEC_SIZE \
787 ((sizeof (struct scroll_bar) \
788 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
789 / sizeof (Lisp_Object))
791 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
792 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
795 /* Extract the X widget of the scroll bar from a struct scroll_bar.
796 XtWindowToWidget should be fast enough since Xt uses a hash table
797 to map windows to widgets. */
799 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
800 XtWindowToWidget (dpy, ptr->x_window)
802 /* Store a widget id in a struct scroll_bar. */
804 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
806 Window window = XtWindow (w); \
807 ptr->x_window = window; \
811 /* Return the inside width of a vertical scroll bar, given the outside
813 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
815 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
816 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
817 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
819 /* Return the length of the rectangle within which the top of the
820 handle must stay. This isn't equivalent to the inside height,
821 because the scroll bar handle has a minimum height.
823 This is the real range of motion for the scroll bar, so when we're
824 scaling buffer positions to scroll bar positions, we use this, not
825 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
826 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
827 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
829 /* Return the inside height of vertical scroll bar, given the outside
830 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
831 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
832 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
835 /* Border widths for scroll bars.
837 Scroll bar windows don't have any X borders; their border width is
838 set to zero, and we redraw borders ourselves. This makes the code
839 a bit cleaner, since we don't have to convert between outside width
840 (used when relating to the rest of the screen) and inside width
841 (used when sizing and drawing the scroll bar window itself).
843 The handle moves up and down/back and forth in a rectangle inset
844 from the edges of the scroll bar. These are widths by which we
845 inset the handle boundaries from the scroll bar edges. */
846 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
847 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
848 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
849 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
851 /* Minimum lengths for scroll bar handles, in pixels. */
852 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
854 /* Trimming off a few pixels from each side prevents
855 text from glomming up against the scroll bar */
856 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
859 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
860 or SELECTION_CLEAR_EVENT, then its contents are really described
861 by this structure. */
863 /* For an event of kind SELECTION_REQUEST_EVENT,
864 this structure really describes the contents.
865 **Don't make this struct longer!**
866 If it overlaps the frame_or_window field of struct input_event,
867 that will cause GC to crash. */
868 struct selection_input_event
872 /* We spell it with an "o" here because X does. */
874 Atom selection
, target
, property
;
878 #define SELECTION_EVENT_DISPLAY(eventp) \
879 (((struct selection_input_event *) (eventp))->display)
880 /* We spell it with an "o" here because X does. */
881 #define SELECTION_EVENT_REQUESTOR(eventp) \
882 (((struct selection_input_event *) (eventp))->requestor)
883 #define SELECTION_EVENT_SELECTION(eventp) \
884 (((struct selection_input_event *) (eventp))->selection)
885 #define SELECTION_EVENT_TARGET(eventp) \
886 (((struct selection_input_event *) (eventp))->target)
887 #define SELECTION_EVENT_PROPERTY(eventp) \
888 (((struct selection_input_event *) (eventp))->property)
889 #define SELECTION_EVENT_TIME(eventp) \
890 (((struct selection_input_event *) (eventp))->time)
900 /* From xselect.c. */
902 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
903 void x_handle_property_notify
P_ ((XPropertyEvent
*));
907 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
908 Lisp_Object
, Lisp_Object
,
909 Lisp_Object
, Lisp_Object
));
910 struct frame
*check_x_frame
P_ ((Lisp_Object
));
911 EXFUN (Fx_display_color_p
, 1);
912 EXFUN (Fx_display_grayscale_p
, 1);
913 extern void x_free_gcs
P_ ((struct frame
*));
917 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
918 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
919 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
920 XrmRepresentation
, XrmValue
*));
921 void x_delete_display
P_ ((struct x_display_info
*));
922 void x_make_frame_visible
P_ ((struct frame
*));
923 void x_iconify_frame
P_ ((struct frame
*));
924 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
925 int x_text_icon
P_ ((struct frame
*, char *));
926 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
927 void x_set_window_size
P_ ((struct frame
*, int, int, int));
928 void x_wm_set_window_state
P_ ((struct frame
*, int));
929 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
931 /* Defined in xterm.c */
933 extern void cancel_mouse_face
P_ ((struct frame
*));
934 extern void x_scroll_bar_clear
P_ ((struct frame
*));
935 extern int x_text_icon
P_ ((struct frame
*, char *));
936 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
937 extern void x_catch_errors
P_ ((Display
*));
938 extern void x_check_errors
P_ ((Display
*, char *));
939 extern int x_had_errors_p
P_ ((Display
*));
940 extern int x_catching_errors
P_ ((void));
941 extern void x_uncatch_errors
P_ ((void));
942 extern void x_clear_errors
P_ ((Display
*));
943 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
944 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
945 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
946 extern void x_ewmh_activate_frame
P_ ((struct frame
*));
947 extern void x_raise_frame
P_ ((struct frame
*));
948 extern void x_lower_frame
P_ ((struct frame
*));
949 extern void x_make_frame_visible
P_ ((struct frame
*));
950 extern void x_make_frame_invisible
P_ ((struct frame
*));
951 extern void x_iconify_frame
P_ ((struct frame
*));
952 extern void x_free_frame_resources
P_ ((struct frame
*));
953 extern void x_destroy_window
P_ ((struct frame
*));
954 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
955 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
956 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
957 extern void x_delete_display
P_ ((struct x_display_info
*));
958 extern void x_delete_terminal
P_ ((struct terminal
*terminal
));
959 extern void x_initialize
P_ ((void));
960 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
962 extern XtAppContext Xt_app_con
;
963 extern int x_alloc_lighter_color_for_widget
__P ((Widget
, Display
*, Colormap
,
966 extern void x_activate_timeout_atimer
P_ ((void));
968 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
969 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
970 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
971 extern void set_vertical_scroll_bar
P_ ((struct window
*));
973 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
974 extern unsigned int x_x_to_emacs_modifiers
P_ ((struct x_display_info
*,
976 extern int x_display_pixel_height
P_ ((struct x_display_info
*));
977 extern int x_display_pixel_width
P_ ((struct x_display_info
*));
979 extern void x_set_sticky
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
980 extern void x_wait_for_event
P_ ((struct frame
*, int));
982 /* Defined in xselect.c */
984 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
985 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
986 extern void x_handle_selection_event
P_ ((struct input_event
*));
987 extern void x_clear_frame_selections
P_ ((struct frame
*));
989 extern int x_handle_dnd_message
P_ ((struct frame
*,
990 XClientMessageEvent
*,
991 struct x_display_info
*,
992 struct input_event
*bufp
));
993 extern int x_check_property_data
P_ ((Lisp_Object
));
994 extern void x_fill_property_data
P_ ((Display
*,
998 extern Lisp_Object x_property_data_to_lisp
P_ ((struct frame
*,
1004 /* Defined in xfns.c */
1006 extern struct x_display_info
* check_x_display_info
P_ ((Lisp_Object frame
));
1009 extern int xg_set_icon
P_ ((struct frame
*, Lisp_Object
));
1010 extern int xg_set_icon_from_xpm_data
P_ ((struct frame
*, char**));
1011 #endif /* USE_GTK */
1013 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1014 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1015 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1016 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1017 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1018 extern void xic_free_xfontset
P_ ((struct frame
*));
1019 extern void create_frame_xic
P_ ((struct frame
*));
1020 extern void destroy_frame_xic
P_ ((struct frame
*));
1021 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1022 extern void xic_set_statusarea
P_ ((struct frame
*));
1023 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1024 extern int x_pixel_width
P_ ((struct frame
*));
1025 extern int x_pixel_height
P_ ((struct frame
*));
1026 extern int x_char_width
P_ ((struct frame
*));
1027 extern int x_char_height
P_ ((struct frame
*));
1028 extern int x_screen_planes
P_ ((struct frame
*));
1029 extern void x_sync
P_ ((struct frame
*));
1030 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1032 extern void free_frame_xic
P_ ((struct frame
*));
1034 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1036 /* Defined in xfaces.c */
1038 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1039 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1040 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1041 unsigned long *, int));
1043 /* Defined in xmenu.c */
1045 extern void x_menu_set_in_use
P_ ((int));
1046 extern void x_menu_wait_for_event
P_ ((void *data
));
1047 extern void x_activate_menubar
P_ ((struct frame
*));
1048 extern int popup_activated
P_ ((void));
1049 extern void initialize_frame_menubar
P_ ((struct frame
*));
1050 extern void free_frame_menubar
P_ ((struct frame
*));
1052 /* Defined in widget.c */
1054 #ifdef USE_X_TOOLKIT
1055 extern void widget_store_internal_border
P_ ((Widget
));
1058 /* Defined in xsmfns.c */
1060 extern void x_session_initialize
P_ ((struct x_display_info
*dpyinfo
));
1061 extern int x_session_check_input
P_ ((struct input_event
*bufp
));
1062 extern int x_session_have_connection
P_ ((void));
1063 extern void x_session_close
P_ ((void));
1066 /* XEmbed implementation. */
1068 #define XEMBED_VERSION 0
1072 XEMBED_MAPPED
= 1 << 0
1077 XEMBED_EMBEDDED_NOTIFY
= 0,
1078 XEMBED_WINDOW_ACTIVATE
= 1,
1079 XEMBED_WINDOW_DEACTIVATE
= 2,
1080 XEMBED_REQUEST_FOCUS
= 3,
1081 XEMBED_FOCUS_IN
= 4,
1082 XEMBED_FOCUS_OUT
= 5,
1083 XEMBED_FOCUS_NEXT
= 6,
1084 XEMBED_FOCUS_PREV
= 7,
1086 XEMBED_MODALITY_ON
= 10,
1087 XEMBED_MODALITY_OFF
= 11,
1088 XEMBED_REGISTER_ACCELERATOR
= 12,
1089 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1090 XEMBED_ACTIVATE_ACCELERATOR
= 14
1095 XEMBED_FOCUS_CURRENT
= 0,
1096 XEMBED_FOCUS_FIRST
= 1,
1097 XEMBED_FOCUS_LAST
= 2
1100 enum xembed_modifier
1102 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1103 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1104 XEMBED_MODIFIER_ALT
= 1 << 2,
1105 XEMBED_MODIFIER_SUPER
= 1 << 3,
1106 XEMBED_MODIFIER_HYPER
= 1 << 4
1109 enum xembed_accelerator
1111 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1114 /* Defined in xterm.c */
1116 extern void xembed_set_info
P_ ((struct frame
*f
, enum xembed_info flags
));
1117 extern void xembed_send_message
P_ ((struct frame
*f
, Time time
,
1118 enum xembed_message message
,
1119 long detail
, long data1
, long data2
));
1121 /* Is the frame embedded into another application? */
1123 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1126 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1127 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1129 #define STORE_XCHAR2B(chp, b1, b2) \
1130 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1132 #define XCHAR2B_BYTE1(chp) \
1135 #define XCHAR2B_BYTE2(chp) \
1139 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1142 (nr).width = (rwidth), \
1143 (nr).height = (rheight))
1145 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1146 (do not change this comment) */