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 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 2, 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. */
62 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
63 be defined when we're using X11R5, since X11R5 has the features of
64 X11R4. If, in the future, we find we need more of these flags
65 (HAVE_X11R5, for example), code should always be written to test
66 the most recent flag first:
76 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
77 looks a lot like another one, consider moving the text into a macro
78 whose definition is configuration-dependent, but whose usage is
79 universal - like the stuff in systime.h.
81 It turns out that we can auto-detect whether we're being compiled
82 with X11R3 or X11R4 by looking for the flag macros for R4 structure
83 members that R3 doesn't have. */
85 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
86 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
88 AIX 3.2 is at least X11R4. */
89 #if (!defined AIX) || (defined AIX3_2)
95 /* In case someone has X11R5 on AIX 3.1,
96 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
101 #include <X11/Xlocale.h>
104 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
105 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
106 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
107 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
109 #define FONT_WIDTH(f) ((f)->max_bounds.width)
110 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
111 #define FONT_BASE(f) ((f)->ascent)
112 #define FONT_DESCENT(f) ((f)->descent)
114 /* The mask of events that text windows always want to receive. This
115 includes mouse movement events, since handling the mouse-font text property
116 means that we must track mouse motion all the time. */
118 #define STANDARD_EVENT_SET \
122 | ButtonReleaseMask \
123 | PointerMotionMask \
124 | StructureNotifyMask \
128 | VisibilityChangeMask)
130 /* Structure recording X pixmap and reference count.
131 If REFCOUNT is 0 then this record is free to be reused. */
133 struct x_bitmap_record
140 /* Record some info about this pixmap. */
141 int height
, width
, depth
;
144 /* For each X display, we have a structure that records
145 information about it. */
147 struct x_display_info
149 /* Chain of all x_display_info structures. */
150 struct x_display_info
*next
;
152 /* The generic display parameters corresponding to this X display. */
153 struct terminal
*terminal
;
155 /* Connection number (normally a file descriptor number). */
158 /* This says how to access this display in Xlib. */
161 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
162 The same cons cell also appears in x_display_name_list. */
163 Lisp_Object name_list_element
;
165 /* Number of frames that are on this display. */
168 /* The Screen this connection is connected to. */
171 /* Dots per inch of the screen. */
174 /* The Visual being used for this display. */
177 /* The colormap being used. */
180 /* Number of planes on this screen. */
183 /* Dimensions of this screen. */
186 /* Mask of things that cause the mouse to be grabbed. */
189 /* Emacs bitmap-id of the default icon bitmap for this frame.
190 Or -1 if none has been allocated yet. */
193 /* The root window of this screen. */
196 /* Client leader window. */
197 Window client_leader_window
;
199 /* The cursor to use for vertical scroll bars. */
200 Cursor vertical_scroll_bar_cursor
;
203 /* The GDK cursor for scroll bars and popup menus. */
204 GdkCursor
*xg_cursor
;
207 /* X Resource data base */
210 /* A table of all the fonts we have already loaded. */
211 struct font_info
*font_table
;
213 /* The current capacity of x_font_table. */
216 /* Minimum width over all characters in all fonts in font_table. */
217 int smallest_char_width
;
219 /* Minimum font height over all fonts in font_table. */
220 int smallest_font_height
;
222 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
223 GC scratch_cursor_gc
;
225 /* These variables describe the range of text currently shown in its
226 mouse-face, together with the window they apply to. As long as
227 the mouse stays within this range, we need not redraw anything on
228 its account. Rows and columns are glyph matrix positions in
229 MOUSE_FACE_WINDOW. */
230 int mouse_face_beg_row
, mouse_face_beg_col
;
231 int mouse_face_beg_x
, mouse_face_beg_y
;
232 int mouse_face_end_row
, mouse_face_end_col
;
233 int mouse_face_end_x
, mouse_face_end_y
;
234 int mouse_face_past_end
;
235 Lisp_Object mouse_face_window
;
236 int mouse_face_face_id
;
237 Lisp_Object mouse_face_overlay
;
239 /* 1 if a mouse motion event came and we didn't handle it right away because
240 gc was in progress. */
241 int mouse_face_deferred_gc
;
243 /* FRAME and X, Y position of mouse when last checked for
244 highlighting. X and Y can be negative or out of range for the frame. */
245 struct frame
*mouse_face_mouse_frame
;
246 int mouse_face_mouse_x
, mouse_face_mouse_y
;
248 /* Nonzero means defer mouse-motion highlighting. */
249 int mouse_face_defer
;
251 /* Nonzero means that the mouse highlight should not be shown. */
252 int mouse_face_hidden
;
254 int mouse_face_image_state
;
258 /* The number of fonts actually stored in x_font_table.
259 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
260 n_fonts <= font_table_size and font_table[i].name != 0. */
263 /* Pointer to bitmap records. */
264 struct x_bitmap_record
*bitmaps
;
266 /* Allocated size of bitmaps field. */
269 /* Last used bitmap index. */
272 /* Which modifier keys are on which modifier bits?
274 With each keystroke, X returns eight bits indicating which modifier
275 keys were held down when the key was pressed. The interpretation
276 of the top five modifier bits depends on what keys are attached
277 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
280 meta_mod_mask is a mask containing the bits used for the meta key.
281 It may have more than one bit set, if more than one modifier bit
282 has meta keys on it. Basically, if EVENT is a KeyPress event,
283 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
285 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
286 lock modifier bit, or zero otherwise. Non-alphabetic keys should
287 only be affected by the lock modifier bit if XK_Shift_Lock is in
288 use; XK_Caps_Lock should only affect alphabetic keys. With this
289 arrangement, the lock modifier should shift the character if
290 (EVENT.state & shift_lock_mask) != 0. */
291 int meta_mod_mask
, shift_lock_mask
;
293 /* These are like meta_mod_mask, but for different modifiers. */
294 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
296 /* Communication with window managers. */
297 Atom Xatom_wm_protocols
;
299 /* Kinds of protocol things we may receive. */
300 Atom Xatom_wm_take_focus
;
301 Atom Xatom_wm_save_yourself
;
302 Atom Xatom_wm_delete_window
;
304 /* Atom for indicating window state to the window manager. */
305 Atom Xatom_wm_change_state
;
307 /* Other WM communication */
308 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
309 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
310 Atom Xatom_wm_client_leader
; /* Id of client leader window. */
312 /* EditRes protocol */
315 /* More atoms, which are selection types. */
316 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
317 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
318 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
321 /* More atoms for font properties. The last three are private
322 properties, see the comments in src/fontset.h. */
323 Atom Xatom_PIXEL_SIZE
, Xatom_AVERAGE_WIDTH
,
324 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
325 Xatom_MULE_DEFAULT_ASCENT
;
327 /* More atoms for Ghostscript support. */
328 Atom Xatom_DONE
, Xatom_PAGE
;
330 /* Atom used in toolkit scroll bar client messages. */
331 Atom Xatom_Scrollbar
;
333 int cut_buffers_initialized
; /* Whether we're sure they all exist */
335 /* The frame (if any) which has the X window that has keyboard focus.
336 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
337 that a mere EnterNotify event can set this; if you need to know the
338 last frame specified in a FocusIn or FocusOut event, use
339 x_focus_event_frame. */
340 struct frame
*x_focus_frame
;
342 /* The last frame mentioned in a FocusIn or FocusOut event. This is
343 separate from x_focus_frame, because whether or not LeaveNotify
344 events cause us to lose focus depends on whether or not we have
345 received a FocusIn event for it. */
346 struct frame
*x_focus_event_frame
;
348 /* The frame which currently has the visual highlight, and should get
349 keyboard input (other sorts of input have the frame encoded in the
350 event). It points to the X focus frame's selected window's
351 frame. It differs from x_focus_frame when we're using a global
353 struct frame
*x_highlight_frame
;
355 /* The null pixel used for filling a character background with
356 background color of a gc. */
359 /* The gray pixmap. */
362 /* Cache of images. */
363 struct image_cache
*image_cache
;
366 /* XIM (X Input method). */
368 XIMStyles
*xim_styles
;
371 /* If non-null, a cache of the colors in the color map. Don't
372 use this directly, call x_color_cells instead. */
376 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
377 int red_bits
, blue_bits
, green_bits
;
378 int red_offset
, blue_offset
, green_offset
;
380 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
381 to x/y 0/0, some window managers (type A) puts the window manager
382 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
383 Other window managers (type B) puts the window including decorations
384 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
385 Record the type of WM in use so we can compensate for type A WMs. */
394 /* Atoms that are drag and drop atoms */
396 size_t x_dnd_atoms_size
;
397 size_t x_dnd_atoms_length
;
403 /* Whether or not to use XIM if we have it. */
407 /* This checks to make sure we have a display. */
408 extern void check_x
P_ ((void));
410 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
412 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
413 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
414 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
415 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
418 /* This is a chain of structures for all the X displays currently in use. */
419 extern struct x_display_info
*x_display_list
;
421 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
422 one for each element of x_display_list and in the same order.
423 NAME is the name of the frame.
424 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
425 extern Lisp_Object x_display_name_list
;
427 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
428 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
430 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
431 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
433 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
434 extern int x_display_ok
P_ ((const char *));
436 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
437 extern void select_visual
P_ ((struct x_display_info
*));
438 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
439 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
440 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
441 extern void x_find_ccl_program
P_ ((struct font_info
*));
443 /* Each X frame object points to its own struct x_output object
444 in the output_data.x field. The x_output structure contains
445 the information that is specific to X windows. */
449 /* Height of menu bar widget, in pixels.
450 Zero if not using the X toolkit.
451 When using the toolkit, this value is not meaningful
452 if the menubar is turned off. */
455 /* Height of tool bar widget, in pixels.
456 Zero if not using an external tool bar. */
459 /* The tiled border used when the mouse is out of the frame. */
462 /* Here are the Graphics Contexts for the default font. */
463 GC normal_gc
; /* Normal video */
464 GC reverse_gc
; /* Reverse video */
465 GC cursor_gc
; /* cursor drawing */
467 /* The X window used for this frame.
468 May be zero while the frame object is being created
469 and the X window has not yet been created. */
472 /* The X window used for the bitmap icon;
473 or 0 if we don't have a bitmap icon. */
476 /* The X window that is the parent of this X window.
477 Usually this is a window that was made by the window manager,
478 but it can be the root window, and it can be explicitly specified
479 (see the explicit_parent field, below). */
483 /* The widget of this screen. This is the window of a "shell" widget. */
485 /* The XmPanedWindows... */
486 Widget column_widget
;
487 /* The widget of the edit portion of this screen; the window in
488 "window_desc" is inside of this. */
491 Widget menubar_widget
;
495 /* The widget of this screen. This is the window of a top widget. */
497 /* The widget of the edit portion of this screen; the window in
498 "window_desc" is inside of this. */
499 GtkWidget
*edit_widget
;
500 /* The widget used for laying out widgets vertically. */
501 GtkWidget
*vbox_widget
;
502 /* The menubar in this frame. */
503 GtkWidget
*menubar_widget
;
504 /* The tool bar in this frame */
505 GtkWidget
*toolbar_widget
;
506 /* The handle box that makes the tool bar detachable. */
507 GtkWidget
*handlebox_widget
;
508 /* Non-zero if the tool bar is detached. */
509 int toolbar_detached
;
511 /* The last size hints set. */
512 GdkGeometry size_hints
;
516 /* If >=0, a bitmap index. The indicated bitmap is used for the
520 /* Default ASCII font of this frame. */
523 /* The baseline offset of the default ASCII font. */
526 /* If a fontset is specified for this frame instead of font, this
527 value contains an ID of the fontset, else -1. */
530 /* Pixel values used for various purposes.
531 border_pixel may be -1 meaning use a gray tile. */
532 #if 0 /* These are also defined in struct frame. Use that instead. */
533 unsigned long background_pixel
;
534 unsigned long foreground_pixel
;
536 unsigned long cursor_pixel
;
537 unsigned long border_pixel
;
538 unsigned long mouse_pixel
;
539 unsigned long cursor_foreground_pixel
;
541 /* Foreground color for scroll bars. A value of -1 means use the
542 default (black for non-toolkit scroll bars). */
543 unsigned long scroll_bar_foreground_pixel
;
545 /* Background color for scroll bars. A value of -1 means use the
546 default (background color of the frame for non-toolkit scroll
548 unsigned long scroll_bar_background_pixel
;
550 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
551 let the scroll compute them itself. */
552 unsigned long scroll_bar_top_shadow_pixel
;
553 unsigned long scroll_bar_bottom_shadow_pixel
;
555 /* Descriptor for the cursor in use for this window. */
557 Cursor nontext_cursor
;
558 Cursor modeline_cursor
;
560 Cursor hourglass_cursor
;
561 Cursor horizontal_drag_cursor
;
563 /* Window whose cursor is hourglass_cursor. This window is temporarily
564 mapped to display an hourglass cursor. */
565 Window hourglass_window
;
567 /* Non-zero means hourglass cursor is currently displayed. */
568 unsigned hourglass_p
: 1;
570 /* Flag to set when the X window needs to be completely repainted. */
573 /* These are the current window manager hints. It seems that
574 XSetWMHints, when presented with an unset bit in the `flags'
575 member of the hints structure, does not leave the corresponding
576 attribute unchanged; rather, it resets that attribute to its
577 default value. For example, unless you set the `icon_pixmap'
578 field and the `IconPixmapHint' bit, XSetWMHints will forget what
579 your icon pixmap was. This is rather troublesome, since some of
580 the members (for example, `input' and `icon_pixmap') want to stay
581 the same throughout the execution of Emacs. So, we keep this
582 structure around, just leaving values in it and adding new bits
583 to the mask as we go. */
586 /* This is the Emacs structure for the X display this frame is on. */
587 struct x_display_info
*display_info
;
589 /* This is a button event that wants to activate the menubar.
590 We save it here until the command loop gets to think about it. */
591 XEvent
*saved_menu_event
;
593 /* This is the widget id used for this frame's menubar in lwlib. */
598 /* Nonzero means our parent is another application's window
599 and was explicitly specified. */
600 char explicit_parent
;
602 /* Nonzero means tried already to make this frame visible. */
603 char asked_for_visible
;
605 /* Nonzero if this frame was ever previously visible. */
606 char has_been_visible
;
609 /* Input context (currently, this means Compose key handler setup). */
613 char *xic_base_fontname
;
616 /* Relief GCs, colors etc. */
623 black_relief
, white_relief
;
625 /* The background for which the above relief GCs were set up.
626 They are changed only when a different background is involved. */
627 unsigned long relief_background
;
629 /* Xt waits for a ConfigureNotify event from the window manager in
630 EmacsFrameSetCharSize when the shell widget is resized. For some
631 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
632 arrive for an unknown reason and Emacs hangs in Xt. If this is
633 zero, tell Xt not to wait. */
636 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
637 two might differ by a pixel, depending on WM */
638 int x_pixels_outer_diff
;
640 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
641 these may differ because this does not take into account possible
642 menubar. y_pixels_diff is with menubar height included */
643 int y_pixels_outer_diff
;
645 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
646 frame, or IMPLICIT if we received an EnterNotify.
647 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
650 /* The offset we need to add to compensate for type A WMs. */
652 int move_offset_left
;
654 /* The frame's left/top offsets before we call XMoveWindow. See
655 x_check_expected_move. */
656 int left_before_move
;
660 #define No_Cursor (None)
664 /* Values for focus_state, used as bit mask.
665 EXPLICIT means we received a FocusIn for the frame and know it has
666 the focus. IMPLICIT means we recevied an EnterNotify and the frame
667 may have the focus if no window manager is running.
668 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
675 /* Return the X output data for frame F. */
676 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
678 /* Return the X window used for displaying data in frame F. */
679 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
681 /* Return the outermost X window associated with the frame F. */
683 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
684 XtWindow ((f)->output_data.x->widget) : \
688 #define GTK_WIDGET_TO_X_WIN(w) \
689 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
691 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
692 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
693 #define FRAME_OUTER_WINDOW(f) \
694 (FRAME_GTK_OUTER_WIDGET (f) ? \
695 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
699 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
700 #endif /* !USE_GTK */
704 #define FRAME_FONT(f) ((f)->output_data.x->font)
705 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
706 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
707 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
708 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
710 /* This gives the x_display_info structure for the display F is on. */
711 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
713 /* This is the `Display *' which frame F is on. */
714 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
716 /* This is the `Screen *' which frame F is on. */
717 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
718 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
720 /* This is the Visual which frame F is on. */
721 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
723 /* This is the Colormap which frame F uses. */
724 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
726 /* This is the 'font_info *' which frame F has. */
727 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
729 /* The difference in pixels between the top left corner of the
730 Emacs window (including possible window manager decorations)
731 and FRAME_X_WINDOW (f). */
732 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
733 ((f)->output_data.x->x_pixels_outer_diff)
734 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
735 ((f)->output_data.x->y_pixels_outer_diff \
736 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
739 #define FRAME_XIC(f) ((f)->output_data.x->xic)
740 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
741 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
742 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
743 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
744 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
746 /* Value is the smallest width of any character in any font on frame F. */
748 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
749 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
751 /* Value is the smallest height of any font on frame F. */
753 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
754 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
756 /* Return a pointer to the image cache of frame F. */
758 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
761 /* X-specific scroll bar stuff. */
763 /* We represent scroll bars as lisp vectors. This allows us to place
764 references to them in windows without worrying about whether we'll
765 end up with windows referring to dead scroll bars; the garbage
766 collector will free it when its time comes.
768 We use struct scroll_bar as a template for accessing fields of the
773 /* These fields are shared by all vectors. */
774 EMACS_INT size_from_Lisp_Vector_struct
;
775 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
777 /* The window we're a scroll bar for. */
780 /* The next and previous in the chain of scroll bars in this frame. */
781 Lisp_Object next
, prev
;
783 /* The X window representing this scroll bar. Since this is a full
784 32-bit quantity, we store it split into two 32-bit values. */
785 Lisp_Object x_window_low
, x_window_high
;
787 /* The position and size of the scroll bar in pixels, relative to the
789 Lisp_Object top
, left
, width
, height
;
791 /* The starting and ending positions of the handle, relative to the
792 handle area (i.e. zero is the top position, not
793 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
794 hasn't been drawn yet.
796 These are not actually the locations where the beginning and end
797 are drawn; in order to keep handles from becoming invisible when
798 editing large files, we establish a minimum height by always
799 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
800 where they would be normally; the bottom and top are in a
801 different co-ordinate system. */
802 Lisp_Object start
, end
;
804 /* If the scroll bar handle is currently being dragged by the user,
805 this is the number of pixels from the top of the handle to the
806 place where the user grabbed it. If the handle isn't currently
807 being dragged, this is Qnil. */
808 Lisp_Object dragging
;
811 /* The number of elements a vector holding a struct scroll_bar needs. */
812 #define SCROLL_BAR_VEC_SIZE \
813 ((sizeof (struct scroll_bar) \
814 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
815 / sizeof (Lisp_Object))
817 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
818 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
821 /* Building a 32-bit C integer from two 16-bit lisp integers. */
822 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
824 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
825 #define SCROLL_BAR_UNPACK(low, high, int32) \
826 (XSETINT ((low), (int32) & 0xffff), \
827 XSETINT ((high), ((int32) >> 16) & 0xffff))
830 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
831 #define SCROLL_BAR_X_WINDOW(ptr) \
832 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
834 /* Store a window id in a struct scroll_bar. */
835 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
836 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
838 /* Extract the X widget of the scroll bar from a struct scroll_bar.
839 XtWindowToWidget should be fast enough since Xt uses a hash table
840 to map windows to widgets. */
842 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
843 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
845 /* Store a widget id in a struct scroll_bar. */
847 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
849 Window window = XtWindow (w); \
850 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
854 /* Return the inside width of a vertical scroll bar, given the outside
856 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
858 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
859 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
860 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
862 /* Return the length of the rectangle within which the top of the
863 handle must stay. This isn't equivalent to the inside height,
864 because the scroll bar handle has a minimum height.
866 This is the real range of motion for the scroll bar, so when we're
867 scaling buffer positions to scroll bar positions, we use this, not
868 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
869 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
870 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
872 /* Return the inside height of vertical scroll bar, given the outside
873 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
874 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
875 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
878 /* Border widths for scroll bars.
880 Scroll bar windows don't have any X borders; their border width is
881 set to zero, and we redraw borders ourselves. This makes the code
882 a bit cleaner, since we don't have to convert between outside width
883 (used when relating to the rest of the screen) and inside width
884 (used when sizing and drawing the scroll bar window itself).
886 The handle moves up and down/back and forth in a rectangle inset
887 from the edges of the scroll bar. These are widths by which we
888 inset the handle boundaries from the scroll bar edges. */
889 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
890 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
891 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
892 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
894 /* Minimum lengths for scroll bar handles, in pixels. */
895 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
897 /* Trimming off a few pixels from each side prevents
898 text from glomming up against the scroll bar */
899 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
902 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
903 or SELECTION_CLEAR_EVENT, then its contents are really described
904 by this structure. */
906 /* For an event of kind SELECTION_REQUEST_EVENT,
907 this structure really describes the contents.
908 **Don't make this struct longer!**
909 If it overlaps the frame_or_window field of struct input_event,
910 that will cause GC to crash. */
911 struct selection_input_event
915 /* We spell it with an "o" here because X does. */
917 Atom selection
, target
, property
;
921 #define SELECTION_EVENT_DISPLAY(eventp) \
922 (((struct selection_input_event *) (eventp))->display)
923 /* We spell it with an "o" here because X does. */
924 #define SELECTION_EVENT_REQUESTOR(eventp) \
925 (((struct selection_input_event *) (eventp))->requestor)
926 #define SELECTION_EVENT_SELECTION(eventp) \
927 (((struct selection_input_event *) (eventp))->selection)
928 #define SELECTION_EVENT_TARGET(eventp) \
929 (((struct selection_input_event *) (eventp))->target)
930 #define SELECTION_EVENT_PROPERTY(eventp) \
931 (((struct selection_input_event *) (eventp))->property)
932 #define SELECTION_EVENT_TIME(eventp) \
933 (((struct selection_input_event *) (eventp))->time)
943 /* From xselect.c. */
945 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
946 void x_handle_property_notify
P_ ((XPropertyEvent
*));
950 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
951 Lisp_Object
, Lisp_Object
,
952 Lisp_Object
, Lisp_Object
));
953 struct frame
*check_x_frame
P_ ((Lisp_Object
));
954 EXFUN (Fx_display_color_p
, 1);
955 EXFUN (Fx_display_grayscale_p
, 1);
956 extern void x_free_gcs
P_ ((struct frame
*));
960 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
961 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
962 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
963 XrmRepresentation
, XrmValue
*));
964 void x_delete_display
P_ ((struct x_display_info
*));
965 void x_make_frame_visible
P_ ((struct frame
*));
966 void x_iconify_frame
P_ ((struct frame
*));
967 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
968 int x_text_icon
P_ ((struct frame
*, char *));
969 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
970 void x_set_window_size
P_ ((struct frame
*, int, int, int));
971 void x_wm_set_window_state
P_ ((struct frame
*, int));
972 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
974 /* Defined in xterm.c */
976 extern void cancel_mouse_face
P_ ((struct frame
*));
977 extern void x_scroll_bar_clear
P_ ((struct frame
*));
978 extern int x_text_icon
P_ ((struct frame
*, char *));
979 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
980 extern void x_catch_errors
P_ ((Display
*));
981 extern void x_check_errors
P_ ((Display
*, char *));
982 extern int x_had_errors_p
P_ ((Display
*));
983 extern int x_catching_errors
P_ ((void));
984 extern void x_uncatch_errors
P_ ((void));
985 extern void x_clear_errors
P_ ((Display
*));
986 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
987 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
988 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
989 extern void x_raise_frame
P_ ((struct frame
*));
990 extern void x_lower_frame
P_ ((struct frame
*));
991 extern void x_make_frame_visible
P_ ((struct frame
*));
992 extern void x_make_frame_invisible
P_ ((struct frame
*));
993 extern void x_iconify_frame
P_ ((struct frame
*));
994 extern void x_free_frame_resources
P_ ((struct frame
*));
995 extern void x_destroy_window
P_ ((struct frame
*));
996 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
997 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
998 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
999 extern void x_delete_display
P_ ((struct x_display_info
*));
1000 extern void x_delete_terminal
P_ ((struct terminal
*terminal
));
1001 extern void x_initialize
P_ ((void));
1002 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
1003 #ifdef USE_X_TOOLKIT
1004 extern XtAppContext Xt_app_con
;
1005 extern int x_alloc_lighter_color_for_widget
__P ((Widget
, Display
*, Colormap
,
1008 extern void x_activate_timeout_atimer
P_ ((void));
1010 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
1011 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
1012 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
1013 extern void set_vertical_scroll_bar
P_ ((struct window
*));
1015 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
1016 extern unsigned int x_x_to_emacs_modifiers
P_ ((struct x_display_info
*,
1019 /* Defined in xselect.c */
1021 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
1022 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
1023 extern void x_handle_selection_event
P_ ((struct input_event
*));
1024 extern void x_clear_frame_selections
P_ ((struct frame
*));
1026 extern int x_handle_dnd_message
P_ ((struct frame
*,
1027 XClientMessageEvent
*,
1028 struct x_display_info
*,
1029 struct input_event
*bufp
));
1030 extern int x_check_property_data
P_ ((Lisp_Object
));
1031 extern void x_fill_property_data
P_ ((Display
*,
1035 extern Lisp_Object x_property_data_to_lisp
P_ ((struct frame
*,
1041 /* Defined in xfns.c */
1043 extern struct x_display_info
* check_x_display_info
P_ ((Lisp_Object frame
));
1044 extern int have_menus_p
P_ ((void));
1047 extern int xg_set_icon
P_ ((struct frame
*, Lisp_Object
));
1048 extern int xg_set_icon_from_xpm_data
P_ ((struct frame
*, char**));
1049 #endif /* USE_GTK */
1051 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1052 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1053 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1054 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1055 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1056 extern void xic_free_xfontset
P_ ((struct frame
*));
1057 extern void create_frame_xic
P_ ((struct frame
*));
1058 extern void destroy_frame_xic
P_ ((struct frame
*));
1059 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1060 extern void xic_set_statusarea
P_ ((struct frame
*));
1061 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1062 extern int x_pixel_width
P_ ((struct frame
*));
1063 extern int x_pixel_height
P_ ((struct frame
*));
1064 extern int x_char_width
P_ ((struct frame
*));
1065 extern int x_char_height
P_ ((struct frame
*));
1066 extern int x_screen_planes
P_ ((struct frame
*));
1067 extern void x_sync
P_ ((struct frame
*));
1068 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1070 extern void free_frame_xic
P_ ((struct frame
*));
1072 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1074 /* Defined in xfaces.c */
1076 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1077 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1078 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1079 unsigned long *, int));
1081 /* Defined in xmenu.c */
1083 extern void x_menu_set_in_use
P_ ((int));
1084 extern void x_menu_wait_for_event
P_ ((void *data
));
1085 extern void x_activate_menubar
P_ ((struct frame
*));
1086 extern int popup_activated
P_ ((void));
1087 extern void initialize_frame_menubar
P_ ((struct frame
*));
1088 extern void free_frame_menubar
P_ ((struct frame
*));
1090 /* Defined in widget.c */
1092 #ifdef USE_X_TOOLKIT
1093 extern void widget_store_internal_border
P_ ((Widget
));
1096 /* Defined in xsmfns.c */
1098 extern void x_session_initialize
P_ ((struct x_display_info
*dpyinfo
));
1099 extern int x_session_check_input
P_ ((struct input_event
*bufp
));
1100 extern int x_session_have_connection
P_ ((void));
1101 extern void x_session_close
P_ ((void));
1104 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1105 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1107 #define STORE_XCHAR2B(chp, b1, b2) \
1108 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1110 #define XCHAR2B_BYTE1(chp) \
1113 #define XCHAR2B_BYTE2(chp) \
1117 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1120 (nr).width = (rwidth), \
1121 (nr).height = (rheight))
1123 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1124 (do not change this comment) */