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 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, or (at your option)
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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #include <X11/cursorfont.h>
25 /* Include Xutil.h after keysym.h to work around a bug that prevents
26 correct recognition of AltGr key in some X versions. */
28 #include <X11/keysym.h>
29 #include <X11/Xutil.h>
31 #include <X11/Xatom.h>
32 #include <X11/Xresource.h>
35 #include <X11/StringDefs.h>
36 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
37 #include <X11/CoreP.h> /* foul, but we need this to use our own
38 window inside a widget instead of one
40 #include <X11/StringDefs.h>
42 typedef Widget xt_or_gtk_widget
;
49 /* Some definitions to reduce conditionals. */
50 typedef GtkWidget
*xt_or_gtk_widget
;
51 #define XtParent(x) (gtk_widget_get_parent (x))
53 #define XSync(d, b) do { gdk_window_process_all_updates (); \
54 XSync (d, b); } while (0)
60 /* Bookkeeping to distinguish X versions. */
64 #include <X11/Xlocale.h>
67 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
68 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
69 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
70 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
72 #define FONT_WIDTH(f) ((f)->max_bounds.width)
73 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
74 #define FONT_BASE(f) ((f)->ascent)
75 #define FONT_DESCENT(f) ((f)->descent)
77 /* The mask of events that text windows always want to receive. This
78 includes mouse movement events, since handling the mouse-font text property
79 means that we must track mouse motion all the time. */
81 #define STANDARD_EVENT_SET \
87 | StructureNotifyMask \
91 | VisibilityChangeMask)
93 /* Structure recording X pixmap and reference count.
94 If REFCOUNT is 0 then this record is free to be reused. */
96 struct x_bitmap_record
103 /* Record some info about this pixmap. */
104 int height
, width
, depth
;
107 /* For each X display, we have a structure that records
108 information about it. */
110 struct x_display_info
112 /* Chain of all x_display_info structures. */
113 struct x_display_info
*next
;
115 /* The generic display parameters corresponding to this X display. */
116 struct terminal
*terminal
;
118 /* Connection number (normally a file descriptor number). */
121 /* This says how to access this display in Xlib. */
124 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
125 The same cons cell also appears in x_display_name_list. */
126 Lisp_Object name_list_element
;
128 /* Number of frames that are on this display. */
131 /* The Screen this connection is connected to. */
134 /* Dots per inch of the screen. */
137 /* The Visual being used for this display. */
140 /* The colormap being used. */
143 /* Number of planes on this screen. */
146 /* Dimensions of this screen. */
149 /* Mask of things that cause the mouse to be grabbed. */
152 /* Emacs bitmap-id of the default icon bitmap for this frame.
153 Or -1 if none has been allocated yet. */
156 /* The root window of this screen. */
159 /* Client leader window. */
160 Window client_leader_window
;
162 /* The cursor to use for vertical scroll bars. */
163 Cursor vertical_scroll_bar_cursor
;
166 /* The GDK cursor for scroll bars and popup menus. */
167 GdkCursor
*xg_cursor
;
170 /* X Resource data base */
173 /* A table of all the fonts we have already loaded. */
174 struct font_info
*font_table
;
176 /* The current capacity of x_font_table. */
179 #ifdef USE_FONT_BACKEND
180 /* This provides a commonly used Font ID on this display. */
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 actually stored in x_font_table.
227 font_table[n] is used and valid if 0 <= n < n_fonts. 0 <=
228 n_fonts <= font_table_size and font_table[i].name != 0. */
231 /* Pointer to bitmap records. */
232 struct x_bitmap_record
*bitmaps
;
234 /* Allocated size of bitmaps field. */
237 /* Last used bitmap index. */
240 /* Which modifier keys are on which modifier bits?
242 With each keystroke, X returns eight bits indicating which modifier
243 keys were held down when the key was pressed. The interpretation
244 of the top five modifier bits depends on what keys are attached
245 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
248 meta_mod_mask is a mask containing the bits used for the meta key.
249 It may have more than one bit set, if more than one modifier bit
250 has meta keys on it. Basically, if EVENT is a KeyPress event,
251 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
253 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
254 lock modifier bit, or zero otherwise. Non-alphabetic keys should
255 only be affected by the lock modifier bit if XK_Shift_Lock is in
256 use; XK_Caps_Lock should only affect alphabetic keys. With this
257 arrangement, the lock modifier should shift the character if
258 (EVENT.state & shift_lock_mask) != 0. */
259 int meta_mod_mask
, shift_lock_mask
;
261 /* These are like meta_mod_mask, but for different modifiers. */
262 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
264 /* Communication with window managers. */
265 Atom Xatom_wm_protocols
;
267 /* Kinds of protocol things we may receive. */
268 Atom Xatom_wm_take_focus
;
269 Atom Xatom_wm_save_yourself
;
270 Atom Xatom_wm_delete_window
;
272 /* Atom for indicating window state to the window manager. */
273 Atom Xatom_wm_change_state
;
275 /* Other WM communication */
276 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
277 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
278 Atom Xatom_wm_client_leader
; /* Id of client leader window. */
280 /* EditRes protocol */
283 /* More atoms, which are selection types. */
284 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
285 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
286 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
289 /* More atoms for font properties. The last three are private
290 properties, see the comments in src/fontset.h. */
291 Atom Xatom_PIXEL_SIZE
, Xatom_AVERAGE_WIDTH
,
292 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
293 Xatom_MULE_DEFAULT_ASCENT
;
295 /* More atoms for Ghostscript support. */
296 Atom Xatom_DONE
, Xatom_PAGE
;
298 /* Atom used in toolkit scroll bar client messages. */
299 Atom Xatom_Scrollbar
;
301 /* Atom used in XEmbed client messages. */
304 int cut_buffers_initialized
; /* Whether we're sure they all exist */
306 /* The frame (if any) which has the X window that has keyboard focus.
307 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
308 that a mere EnterNotify event can set this; if you need to know the
309 last frame specified in a FocusIn or FocusOut event, use
310 x_focus_event_frame. */
311 struct frame
*x_focus_frame
;
313 /* The last frame mentioned in a FocusIn or FocusOut event. This is
314 separate from x_focus_frame, because whether or not LeaveNotify
315 events cause us to lose focus depends on whether or not we have
316 received a FocusIn event for it. */
317 struct frame
*x_focus_event_frame
;
319 /* The frame which currently has the visual highlight, and should get
320 keyboard input (other sorts of input have the frame encoded in the
321 event). It points to the X focus frame's selected window's
322 frame. It differs from x_focus_frame when we're using a global
324 struct frame
*x_highlight_frame
;
326 /* The null pixel used for filling a character background with
327 background color of a gc. */
330 /* The gray pixmap. */
333 /* Cache of images. */
334 struct image_cache
*image_cache
;
337 /* XIM (X Input method). */
339 XIMStyles
*xim_styles
;
342 /* If non-null, a cache of the colors in the color map. Don't
343 use this directly, call x_color_cells instead. */
347 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
348 int red_bits
, blue_bits
, green_bits
;
349 int red_offset
, blue_offset
, green_offset
;
351 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
352 to x/y 0/0, some window managers (type A) puts the window manager
353 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
354 Other window managers (type B) puts the window including decorations
355 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
356 Record the type of WM in use so we can compensate for type A WMs. */
365 /* Atoms that are drag and drop atoms */
367 size_t x_dnd_atoms_size
;
368 size_t x_dnd_atoms_length
;
370 /* Extended window manager hints, Atoms supported by the window manager */
371 Atom
*net_supported_atoms
;
372 int nr_net_supported_atoms
;
373 Window net_supported_window
;
377 /* Whether or not to use XIM if we have it. */
381 /* This checks to make sure we have a display. */
382 extern void check_x
P_ ((void));
384 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
386 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
387 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
388 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
389 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
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
));
407 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
408 extern int x_display_ok
P_ ((const char *));
410 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
411 extern void select_visual
P_ ((struct x_display_info
*));
412 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
413 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
414 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
415 extern void x_find_ccl_program
P_ ((struct font_info
*));
416 extern Lisp_Object x_get_font_repertory
P_ ((struct frame
*,
417 struct font_info
*));
420 /* Each X frame object points to its own struct x_output object
421 in the output_data.x field. The x_output structure contains
422 the information that is specific to X windows. */
426 /* Height of menu bar widget, in pixels.
427 Zero if not using the X toolkit.
428 When using the toolkit, this value is not meaningful
429 if the menubar is turned off. */
432 /* Height of tool bar widget, in pixels.
433 Zero if not using an external tool bar. */
436 /* The tiled border used when the mouse is out of the frame. */
439 /* Here are the Graphics Contexts for the default font. */
440 GC normal_gc
; /* Normal video */
441 GC reverse_gc
; /* Reverse video */
442 GC cursor_gc
; /* cursor drawing */
444 /* The X window used for this frame.
445 May be zero while the frame object is being created
446 and the X window has not yet been created. */
449 /* The X window used for the bitmap icon;
450 or 0 if we don't have a bitmap icon. */
453 /* The X window that is the parent of this X window.
454 Usually this is a window that was made by the window manager,
455 but it can be the root window, and it can be explicitly specified
456 (see the explicit_parent field, below). */
460 /* The widget of this screen. This is the window of a "shell" widget. */
462 /* The XmPanedWindows... */
463 Widget column_widget
;
464 /* The widget of the edit portion of this screen; the window in
465 "window_desc" is inside of this. */
468 Widget menubar_widget
;
472 /* The widget of this screen. This is the window of a top widget. */
474 /* The widget of the edit portion of this screen; the window in
475 "window_desc" is inside of this. */
476 GtkWidget
*edit_widget
;
477 /* The widget used for laying out widgets vertically. */
478 GtkWidget
*vbox_widget
;
479 /* The menubar in this frame. */
480 GtkWidget
*menubar_widget
;
481 /* The tool bar in this frame */
482 GtkWidget
*toolbar_widget
;
483 /* The handle box that makes the tool bar detachable. */
484 GtkWidget
*handlebox_widget
;
485 /* Non-zero if the tool bar is detached. */
486 int toolbar_detached
;
488 /* The last size hints set. */
489 GdkGeometry size_hints
;
493 /* If >=0, a bitmap index. The indicated bitmap is used for the
497 /* Default ASCII font of this frame. */
500 #ifdef USE_FONT_BACKEND
502 #endif /* USE_FONT_BACKEND */
504 /* The baseline offset of the default ASCII font. */
507 /* If a fontset is specified for this frame instead of font, this
508 value contains an ID of the fontset, else -1. */
511 /* Pixel values used for various purposes.
512 border_pixel may be -1 meaning use a gray tile. */
513 #if 0 /* These are also defined in struct frame. Use that instead. */
514 unsigned long background_pixel
;
515 unsigned long foreground_pixel
;
517 unsigned long cursor_pixel
;
518 unsigned long border_pixel
;
519 unsigned long mouse_pixel
;
520 unsigned long cursor_foreground_pixel
;
522 /* Foreground color for scroll bars. A value of -1 means use the
523 default (black for non-toolkit scroll bars). */
524 unsigned long scroll_bar_foreground_pixel
;
526 /* Background color for scroll bars. A value of -1 means use the
527 default (background color of the frame for non-toolkit scroll
529 unsigned long scroll_bar_background_pixel
;
531 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
532 let the scroll compute them itself. */
533 unsigned long scroll_bar_top_shadow_pixel
;
534 unsigned long scroll_bar_bottom_shadow_pixel
;
536 /* Descriptor for the cursor in use for this window. */
538 Cursor nontext_cursor
;
539 Cursor modeline_cursor
;
541 Cursor hourglass_cursor
;
542 Cursor horizontal_drag_cursor
;
544 /* Window whose cursor is hourglass_cursor. This window is temporarily
545 mapped to display an hourglass cursor. */
546 Window hourglass_window
;
548 /* Non-zero means hourglass cursor is currently displayed. */
549 unsigned hourglass_p
: 1;
551 /* Flag to set when the X window needs to be completely repainted. */
554 /* These are the current window manager hints. It seems that
555 XSetWMHints, when presented with an unset bit in the `flags'
556 member of the hints structure, does not leave the corresponding
557 attribute unchanged; rather, it resets that attribute to its
558 default value. For example, unless you set the `icon_pixmap'
559 field and the `IconPixmapHint' bit, XSetWMHints will forget what
560 your icon pixmap was. This is rather troublesome, since some of
561 the members (for example, `input' and `icon_pixmap') want to stay
562 the same throughout the execution of Emacs. So, we keep this
563 structure around, just leaving values in it and adding new bits
564 to the mask as we go. */
567 /* This is the Emacs structure for the X display this frame is on. */
568 struct x_display_info
*display_info
;
570 /* This is a button event that wants to activate the menubar.
571 We save it here until the command loop gets to think about it. */
572 XEvent
*saved_menu_event
;
574 /* This is the widget id used for this frame's menubar in lwlib. */
579 /* Nonzero means our parent is another application's window
580 and was explicitly specified. */
581 char explicit_parent
;
583 /* Nonzero means tried already to make this frame visible. */
584 char asked_for_visible
;
586 /* Nonzero if this frame was ever previously visible. */
587 char has_been_visible
;
590 /* Input context (currently, this means Compose key handler setup). */
594 char *xic_base_fontname
;
597 /* Relief GCs, colors etc. */
604 black_relief
, white_relief
;
606 /* The background for which the above relief GCs were set up.
607 They are changed only when a different background is involved. */
608 unsigned long relief_background
;
610 /* Xt waits for a ConfigureNotify event from the window manager in
611 EmacsFrameSetCharSize when the shell widget is resized. For some
612 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
613 arrive for an unknown reason and Emacs hangs in Xt. If this is
614 zero, tell Xt not to wait. */
617 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
618 two might differ by a pixel, depending on WM */
619 int x_pixels_outer_diff
;
621 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
622 these may differ because this does not take into account possible
623 menubar. y_pixels_diff is with menubar height included */
624 int y_pixels_outer_diff
;
626 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
627 frame, or IMPLICIT if we received an EnterNotify.
628 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
631 /* The offset we need to add to compensate for type A WMs. */
633 int move_offset_left
;
635 /* The frame's left/top offsets before we call XMoveWindow. See
636 x_check_expected_move. */
637 int left_before_move
;
641 #define No_Cursor (None)
645 /* Values for focus_state, used as bit mask.
646 EXPLICIT means we received a FocusIn for the frame and know it has
647 the focus. IMPLICIT means we recevied an EnterNotify and the frame
648 may have the focus if no window manager is running.
649 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
656 /* Return the X output data for frame F. */
657 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
659 /* Return the X window used for displaying data in frame F. */
660 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
662 /* Return the outermost X window associated with the frame F. */
664 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
665 XtWindow ((f)->output_data.x->widget) : \
669 #define GTK_WIDGET_TO_X_WIN(w) \
670 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
672 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
673 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
674 #define FRAME_OUTER_WINDOW(f) \
675 (FRAME_GTK_OUTER_WIDGET (f) ? \
676 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
680 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
681 #endif /* !USE_GTK */
685 #define FRAME_FONT(f) ((f)->output_data.x->font)
686 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
687 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
688 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
689 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
691 #ifdef USE_FONT_BACKEND
692 #define FRAME_FONT_OBJECT(f) ((f)->output_data.x->fontp)
693 #endif /* USE_FONT_BACKEND */
695 /* This gives the x_display_info structure for the display F is on. */
696 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
698 /* This is the `Display *' which frame F is on. */
699 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
701 /* This is the `Screen *' which frame F is on. */
702 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
703 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
705 /* This is the Visual which frame F is on. */
706 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
708 /* This is the Colormap which frame F uses. */
709 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
711 /* This is the 'font_info *' which frame F has. */
712 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
714 /* The difference in pixels between the top left corner of the
715 Emacs window (including possible window manager decorations)
716 and FRAME_X_WINDOW (f). */
717 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
718 ((f)->output_data.x->x_pixels_outer_diff)
719 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
720 ((f)->output_data.x->y_pixels_outer_diff \
721 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
724 #define FRAME_XIC(f) ((f)->output_data.x->xic)
725 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
726 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
727 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
728 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
729 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
731 /* Value is the smallest width of any character in any font on frame F. */
733 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
734 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
736 /* Value is the smallest height of any font on frame F. */
738 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
739 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
741 /* Return a pointer to the image cache of frame F. */
743 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
746 /* X-specific scroll bar stuff. */
748 /* We represent scroll bars as lisp vectors. This allows us to place
749 references to them in windows without worrying about whether we'll
750 end up with windows referring to dead scroll bars; the garbage
751 collector will free it when its time comes.
753 We use struct scroll_bar as a template for accessing fields of the
758 /* These fields are shared by all vectors. */
759 EMACS_INT size_from_Lisp_Vector_struct
;
760 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
762 /* The window we're a scroll bar for. */
765 /* The next and previous in the chain of scroll bars in this frame. */
766 Lisp_Object next
, prev
;
768 /* Fields from `x_window' down will not be traced by the GC. */
770 /* The X window representing this scroll bar. */
773 /* The position and size of the scroll bar in pixels, relative to the
775 int top
, left
, width
, height
;
777 /* The starting and ending positions of the handle, relative to the
778 handle area (i.e. zero is the top position, not
779 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
780 hasn't been drawn yet.
782 These are not actually the locations where the beginning and end
783 are drawn; in order to keep handles from becoming invisible when
784 editing large files, we establish a minimum height by always
785 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
786 where they would be normally; the bottom and top are in a
787 different co-ordinate system. */
790 /* If the scroll bar handle is currently being dragged by the user,
791 this is the number of pixels from the top of the handle to the
792 place where the user grabbed it. If the handle isn't currently
793 being dragged, this is Qnil. */
794 Lisp_Object dragging
;
796 /* 1 if the background of the fringe that is adjacent to a scroll
797 bar is extended to the gap between the fringe and the bar. */
798 unsigned int fringe_extended_p
: 1;
801 /* The number of elements a vector holding a struct scroll_bar needs. */
802 #define SCROLL_BAR_VEC_SIZE \
803 ((sizeof (struct scroll_bar) \
804 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
805 / sizeof (Lisp_Object))
807 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
808 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
811 /* Extract the X widget of the scroll bar from a struct scroll_bar.
812 XtWindowToWidget should be fast enough since Xt uses a hash table
813 to map windows to widgets. */
815 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
816 XtWindowToWidget (dpy, ptr->x_window)
818 /* Store a widget id in a struct scroll_bar. */
820 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
822 Window window = XtWindow (w); \
823 ptr->x_window = window; \
827 /* Return the inside width of a vertical scroll bar, given the outside
829 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
831 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
832 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
833 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
835 /* Return the length of the rectangle within which the top of the
836 handle must stay. This isn't equivalent to the inside height,
837 because the scroll bar handle has a minimum height.
839 This is the real range of motion for the scroll bar, so when we're
840 scaling buffer positions to scroll bar positions, we use this, not
841 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
842 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
843 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
845 /* Return the inside height of vertical scroll bar, given the outside
846 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
847 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
848 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
851 /* Border widths for scroll bars.
853 Scroll bar windows don't have any X borders; their border width is
854 set to zero, and we redraw borders ourselves. This makes the code
855 a bit cleaner, since we don't have to convert between outside width
856 (used when relating to the rest of the screen) and inside width
857 (used when sizing and drawing the scroll bar window itself).
859 The handle moves up and down/back and forth in a rectangle inset
860 from the edges of the scroll bar. These are widths by which we
861 inset the handle boundaries from the scroll bar edges. */
862 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
863 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
864 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
865 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
867 /* Minimum lengths for scroll bar handles, in pixels. */
868 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
870 /* Trimming off a few pixels from each side prevents
871 text from glomming up against the scroll bar */
872 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
875 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
876 or SELECTION_CLEAR_EVENT, then its contents are really described
877 by this structure. */
879 /* For an event of kind SELECTION_REQUEST_EVENT,
880 this structure really describes the contents.
881 **Don't make this struct longer!**
882 If it overlaps the frame_or_window field of struct input_event,
883 that will cause GC to crash. */
884 struct selection_input_event
888 /* We spell it with an "o" here because X does. */
890 Atom selection
, target
, property
;
894 #define SELECTION_EVENT_DISPLAY(eventp) \
895 (((struct selection_input_event *) (eventp))->display)
896 /* We spell it with an "o" here because X does. */
897 #define SELECTION_EVENT_REQUESTOR(eventp) \
898 (((struct selection_input_event *) (eventp))->requestor)
899 #define SELECTION_EVENT_SELECTION(eventp) \
900 (((struct selection_input_event *) (eventp))->selection)
901 #define SELECTION_EVENT_TARGET(eventp) \
902 (((struct selection_input_event *) (eventp))->target)
903 #define SELECTION_EVENT_PROPERTY(eventp) \
904 (((struct selection_input_event *) (eventp))->property)
905 #define SELECTION_EVENT_TIME(eventp) \
906 (((struct selection_input_event *) (eventp))->time)
916 /* From xselect.c. */
918 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
919 void x_handle_property_notify
P_ ((XPropertyEvent
*));
923 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
924 Lisp_Object
, Lisp_Object
,
925 Lisp_Object
, Lisp_Object
));
926 struct frame
*check_x_frame
P_ ((Lisp_Object
));
927 EXFUN (Fx_display_color_p
, 1);
928 EXFUN (Fx_display_grayscale_p
, 1);
929 extern void x_free_gcs
P_ ((struct frame
*));
933 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
934 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
935 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
936 XrmRepresentation
, XrmValue
*));
937 void x_delete_display
P_ ((struct x_display_info
*));
938 void x_make_frame_visible
P_ ((struct frame
*));
939 void x_iconify_frame
P_ ((struct frame
*));
940 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
941 int x_text_icon
P_ ((struct frame
*, char *));
942 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
943 void x_set_window_size
P_ ((struct frame
*, int, int, int));
944 void x_wm_set_window_state
P_ ((struct frame
*, int));
945 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
947 /* Defined in xterm.c */
949 extern void cancel_mouse_face
P_ ((struct frame
*));
950 extern void x_scroll_bar_clear
P_ ((struct frame
*));
951 extern int x_text_icon
P_ ((struct frame
*, char *));
952 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
953 extern void x_catch_errors
P_ ((Display
*));
954 extern void x_check_errors
P_ ((Display
*, char *));
955 extern int x_had_errors_p
P_ ((Display
*));
956 extern int x_catching_errors
P_ ((void));
957 extern void x_uncatch_errors
P_ ((void));
958 extern void x_clear_errors
P_ ((Display
*));
959 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
960 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
961 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
962 extern void x_ewmh_activate_frame
P_ ((struct frame
*));
963 extern void x_raise_frame
P_ ((struct frame
*));
964 extern void x_lower_frame
P_ ((struct frame
*));
965 extern void x_make_frame_visible
P_ ((struct frame
*));
966 extern void x_make_frame_invisible
P_ ((struct frame
*));
967 extern void x_iconify_frame
P_ ((struct frame
*));
968 extern void x_free_frame_resources
P_ ((struct frame
*));
969 extern void x_destroy_window
P_ ((struct frame
*));
970 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
971 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
972 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
973 extern void x_delete_display
P_ ((struct x_display_info
*));
974 extern void x_delete_terminal
P_ ((struct terminal
*terminal
));
975 extern void x_initialize
P_ ((void));
976 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
978 extern XtAppContext Xt_app_con
;
979 extern int x_alloc_lighter_color_for_widget
__P ((Widget
, Display
*, Colormap
,
982 extern void x_activate_timeout_atimer
P_ ((void));
984 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
985 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
986 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
987 extern void set_vertical_scroll_bar
P_ ((struct window
*));
989 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
990 extern unsigned int x_x_to_emacs_modifiers
P_ ((struct x_display_info
*,
993 /* Defined in xselect.c */
995 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
996 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
997 extern void x_handle_selection_event
P_ ((struct input_event
*));
998 extern void x_clear_frame_selections
P_ ((struct frame
*));
1000 extern int x_handle_dnd_message
P_ ((struct frame
*,
1001 XClientMessageEvent
*,
1002 struct x_display_info
*,
1003 struct input_event
*bufp
));
1004 extern int x_check_property_data
P_ ((Lisp_Object
));
1005 extern void x_fill_property_data
P_ ((Display
*,
1009 extern Lisp_Object x_property_data_to_lisp
P_ ((struct frame
*,
1015 /* Defined in xfns.c */
1017 extern struct x_display_info
* check_x_display_info
P_ ((Lisp_Object frame
));
1020 extern int xg_set_icon
P_ ((struct frame
*, Lisp_Object
));
1021 extern int xg_set_icon_from_xpm_data
P_ ((struct frame
*, char**));
1022 #endif /* USE_GTK */
1024 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1025 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1026 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1027 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1028 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1029 extern void xic_free_xfontset
P_ ((struct frame
*));
1030 extern void create_frame_xic
P_ ((struct frame
*));
1031 extern void destroy_frame_xic
P_ ((struct frame
*));
1032 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1033 extern void xic_set_statusarea
P_ ((struct frame
*));
1034 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1035 extern int x_pixel_width
P_ ((struct frame
*));
1036 extern int x_pixel_height
P_ ((struct frame
*));
1037 extern int x_char_width
P_ ((struct frame
*));
1038 extern int x_char_height
P_ ((struct frame
*));
1039 extern int x_screen_planes
P_ ((struct frame
*));
1040 extern void x_sync
P_ ((struct frame
*));
1041 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1043 extern void free_frame_xic
P_ ((struct frame
*));
1045 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1047 /* Defined in xfaces.c */
1049 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1050 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1051 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1052 unsigned long *, int));
1054 /* Defined in xmenu.c */
1056 extern void x_menu_set_in_use
P_ ((int));
1057 extern void x_menu_wait_for_event
P_ ((void *data
));
1058 extern void x_activate_menubar
P_ ((struct frame
*));
1059 extern int popup_activated
P_ ((void));
1060 extern void initialize_frame_menubar
P_ ((struct frame
*));
1061 extern void free_frame_menubar
P_ ((struct frame
*));
1063 /* Defined in widget.c */
1065 #ifdef USE_X_TOOLKIT
1066 extern void widget_store_internal_border
P_ ((Widget
));
1069 /* Defined in xsmfns.c */
1071 extern void x_session_initialize
P_ ((struct x_display_info
*dpyinfo
));
1072 extern int x_session_check_input
P_ ((struct input_event
*bufp
));
1073 extern int x_session_have_connection
P_ ((void));
1074 extern void x_session_close
P_ ((void));
1077 /* XEmbed implementation. */
1079 #define XEMBED_VERSION 0
1083 XEMBED_MAPPED
= 1 << 0
1088 XEMBED_EMBEDDED_NOTIFY
= 0,
1089 XEMBED_WINDOW_ACTIVATE
= 1,
1090 XEMBED_WINDOW_DEACTIVATE
= 2,
1091 XEMBED_REQUEST_FOCUS
= 3,
1092 XEMBED_FOCUS_IN
= 4,
1093 XEMBED_FOCUS_OUT
= 5,
1094 XEMBED_FOCUS_NEXT
= 6,
1095 XEMBED_FOCUS_PREV
= 7,
1097 XEMBED_MODALITY_ON
= 10,
1098 XEMBED_MODALITY_OFF
= 11,
1099 XEMBED_REGISTER_ACCELERATOR
= 12,
1100 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1101 XEMBED_ACTIVATE_ACCELERATOR
= 14
1106 XEMBED_FOCUS_CURRENT
= 0,
1107 XEMBED_FOCUS_FIRST
= 1,
1108 XEMBED_FOCUS_LAST
= 2
1111 enum xembed_modifier
1113 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1114 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1115 XEMBED_MODIFIER_ALT
= 1 << 2,
1116 XEMBED_MODIFIER_SUPER
= 1 << 3,
1117 XEMBED_MODIFIER_HYPER
= 1 << 4
1120 enum xembed_accelerator
1122 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1125 /* Defined in xterm.c */
1127 extern void xembed_set_info
P_ ((struct frame
*f
, enum xembed_info flags
));
1128 extern void xembed_send_message
P_ ((struct frame
*f
, Time time
,
1129 enum xembed_message message
,
1130 long detail
, long data1
, long data2
));
1132 /* Is the frame embedded into another application? */
1134 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1137 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1138 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1140 #define STORE_XCHAR2B(chp, b1, b2) \
1141 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1143 #define XCHAR2B_BYTE1(chp) \
1146 #define XCHAR2B_BYTE2(chp) \
1150 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1153 (nr).width = (rwidth), \
1154 (nr).height = (rheight))
1156 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1157 (do not change this comment) */