1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000, 2001, 2001
3 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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <X11/cursorfont.h>
24 #include <X11/Xutil.h>
25 #include <X11/keysym.h>
26 #include <X11/Xatom.h>
27 #include <X11/Xresource.h>
30 #include <X11/StringDefs.h>
31 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
32 #include <X11/CoreP.h> /* foul, but we need this to use our own
33 window inside a widget instead of one
35 #include <X11/StringDefs.h>
37 typedef Widget xt_or_gtk_widget
;
44 /* Some definitions to reduce conditionals. */
45 typedef GtkWidget
*xt_or_gtk_widget
;
46 #define XtParent(x) (gtk_widget_get_parent (x))
48 #define XSync(d, b) gdk_window_process_all_updates ()
52 /* The class of this X application. */
53 #define EMACS_CLASS "Emacs"
55 /* Bookkeeping to distinguish X versions. */
57 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
58 be defined when we're using X11R5, since X11R5 has the features of
59 X11R4. If, in the future, we find we need more of these flags
60 (HAVE_X11R5, for example), code should always be written to test
61 the most recent flag first:
71 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
72 looks a lot like another one, consider moving the text into a macro
73 whose definition is configuration-dependent, but whose usage is
74 universal - like the stuff in systime.h.
76 It turns out that we can auto-detect whether we're being compiled
77 with X11R3 or X11R4 by looking for the flag macros for R4 structure
78 members that R3 doesn't have. */
80 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
81 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
83 AIX 3.2 is at least X11R4. */
84 #if (!defined AIX) || (defined AIX3_2)
90 /* In case someone has X11R5 on AIX 3.1,
91 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
96 #include <X11/Xlocale.h>
99 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
100 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
101 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
102 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
104 #define FONT_WIDTH(f) ((f)->max_bounds.width)
105 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
106 #define FONT_BASE(f) ((f)->ascent)
107 #define FONT_DESCENT(f) ((f)->descent)
109 /* The mask of events that text windows always want to receive. This
110 includes mouse movement events, since handling the mouse-font text property
111 means that we must track mouse motion all the time. */
113 #define STANDARD_EVENT_SET \
117 | ButtonReleaseMask \
118 | PointerMotionMask \
119 | StructureNotifyMask \
123 | VisibilityChangeMask)
125 /* Structure recording X pixmap and reference count.
126 If REFCOUNT is 0 then this record is free to be reused. */
128 struct x_bitmap_record
133 /* Record some info about this pixmap. */
134 int height
, width
, depth
;
137 /* For each X display, we have a structure that records
138 information about it. */
140 struct x_display_info
142 /* Chain of all x_display_info structures. */
143 struct x_display_info
*next
;
145 /* Connection number (normally a file descriptor number). */
148 /* This says how to access this display in Xlib. */
151 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
152 The same cons cell also appears in x_display_name_list. */
153 Lisp_Object name_list_element
;
155 /* Number of frames that are on this display. */
158 /* The Screen this connection is connected to. */
161 /* Dots per inch of the screen. */
164 /* The Visual being used for this display. */
167 /* The colormap being used. */
170 /* Number of panes on this screen. */
173 /* Dimensions of this screen. */
176 /* Mask of things that cause the mouse to be grabbed. */
179 /* Emacs bitmap-id of the default icon bitmap for this frame.
180 Or -1 if none has been allocated yet. */
183 /* The root window of this screen. */
186 /* The cursor to use for vertical scroll bars. */
187 Cursor vertical_scroll_bar_cursor
;
189 /* X Resource data base */
192 /* A table of all the fonts we have already loaded. */
193 struct font_info
*font_table
;
195 /* The current capacity of x_font_table. */
198 /* Minimum width over all characters in all fonts in font_table. */
199 int smallest_char_width
;
201 /* Minimum font height over all fonts in font_table. */
202 int smallest_font_height
;
204 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
205 GC scratch_cursor_gc
;
207 /* These variables describe the range of text currently shown in its
208 mouse-face, together with the window they apply to. As long as
209 the mouse stays within this range, we need not redraw anything on
210 its account. Rows and columns are glyph matrix positions in
211 MOUSE_FACE_WINDOW. */
212 int mouse_face_beg_row
, mouse_face_beg_col
;
213 int mouse_face_beg_x
, mouse_face_beg_y
;
214 int mouse_face_end_row
, mouse_face_end_col
;
215 int mouse_face_end_x
, mouse_face_end_y
;
216 int mouse_face_past_end
;
217 Lisp_Object mouse_face_window
;
218 int mouse_face_face_id
;
219 Lisp_Object mouse_face_overlay
;
221 /* 1 if a mouse motion event came and we didn't handle it right away because
222 gc was in progress. */
223 int mouse_face_deferred_gc
;
225 /* FRAME and X, Y position of mouse when last checked for
226 highlighting. X and Y can be negative or out of range for the frame. */
227 struct frame
*mouse_face_mouse_frame
;
228 int mouse_face_mouse_x
, mouse_face_mouse_y
;
230 /* Nonzero means defer mouse-motion highlighting. */
231 int mouse_face_defer
;
233 /* Nonzero means that the mouse highlight should not be shown. */
234 int mouse_face_hidden
;
236 int mouse_face_image_state
;
240 /* The number of fonts actually stored in x_font_table.
241 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
242 n_fonts <= font_table_size and font_table[i].name != 0. */
245 /* Pointer to bitmap records. */
246 struct x_bitmap_record
*bitmaps
;
248 /* Allocated size of bitmaps field. */
251 /* Last used bitmap index. */
254 /* Which modifier keys are on which modifier bits?
256 With each keystroke, X returns eight bits indicating which modifier
257 keys were held down when the key was pressed. The interpretation
258 of the top five modifier bits depends on what keys are attached
259 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
262 meta_mod_mask is a mask containing the bits used for the meta key.
263 It may have more than one bit set, if more than one modifier bit
264 has meta keys on it. Basically, if EVENT is a KeyPress event,
265 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
267 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
268 lock modifier bit, or zero otherwise. Non-alphabetic keys should
269 only be affected by the lock modifier bit if XK_Shift_Lock is in
270 use; XK_Caps_Lock should only affect alphabetic keys. With this
271 arrangement, the lock modifier should shift the character if
272 (EVENT.state & shift_lock_mask) != 0. */
273 int meta_mod_mask
, shift_lock_mask
;
275 /* These are like meta_mod_mask, but for different modifiers. */
276 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
278 /* Communication with window managers. */
279 Atom Xatom_wm_protocols
;
281 /* Kinds of protocol things we may receive. */
282 Atom Xatom_wm_take_focus
;
283 Atom Xatom_wm_save_yourself
;
284 Atom Xatom_wm_delete_window
;
286 /* Atom for indicating window state to the window manager. */
287 Atom Xatom_wm_change_state
;
289 /* Other WM communication */
290 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
291 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
293 /* EditRes protocol */
296 /* More atoms, which are selection types. */
297 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
298 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
299 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
302 /* More atoms for font properties. The last three are private
303 properties, see the comments in src/fontset.h. */
304 Atom Xatom_PIXEL_SIZE
,
305 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
306 Xatom_MULE_DEFAULT_ASCENT
;
308 /* More atoms for Ghostscript support. */
309 Atom Xatom_DONE
, Xatom_PAGE
;
311 /* Atom used in toolkit scroll bar client messages. */
312 Atom Xatom_Scrollbar
;
315 struct kboard
*kboard
;
317 int cut_buffers_initialized
; /* Whether we're sure they all exist */
319 /* The frame (if any) which has the X window that has keyboard focus.
320 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
321 that a mere EnterNotify event can set this; if you need to know the
322 last frame specified in a FocusIn or FocusOut event, use
323 x_focus_event_frame. */
324 struct frame
*x_focus_frame
;
326 /* The last frame mentioned in a FocusIn or FocusOut event. This is
327 separate from x_focus_frame, because whether or not LeaveNotify
328 events cause us to lose focus depends on whether or not we have
329 received a FocusIn event for it. */
330 struct frame
*x_focus_event_frame
;
332 /* The frame which currently has the visual highlight, and should get
333 keyboard input (other sorts of input have the frame encoded in the
334 event). It points to the X focus frame's selected window's
335 frame. It differs from x_focus_frame when we're using a global
337 struct frame
*x_highlight_frame
;
339 /* The null pixel used for filling a character background with
340 background color of a gc. */
343 /* The gray pixmap. */
346 /* Cache of images. */
347 struct image_cache
*image_cache
;
350 /* XIM (X Input method). */
352 XIMStyles
*xim_styles
;
355 /* If non-null, a cache of the colors in the color map. Don't
356 use this directly, call x_color_cells instead. */
361 /* This checks to make sure we have a display. */
362 extern void check_x
P_ ((void));
364 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
366 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
367 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
368 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
369 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
372 /* This is a chain of structures for all the X displays currently in use. */
373 extern struct x_display_info
*x_display_list
;
375 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
376 one for each element of x_display_list and in the same order.
377 NAME is the name of the frame.
378 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
379 extern Lisp_Object x_display_name_list
;
381 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
382 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
384 /* A flag to control how to display unibyte 8-bit character. */
385 extern int unibyte_display_via_language_environment
;
387 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
388 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
390 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
392 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
393 extern void select_visual
P_ ((struct x_display_info
*));
394 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
395 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
396 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
397 extern void x_find_ccl_program
P_ ((struct font_info
*));
399 /* Each X frame object points to its own struct x_output object
400 in the output_data.x field. The x_output structure contains
401 the information that is specific to X windows. */
405 /* Position of the X window (x and y offsets in root window). */
409 /* Border width of the X window as known by the X window system. */
412 /* Size of the X window in pixels. */
413 int pixel_height
, pixel_width
;
415 /* Height of menu bar widget, in pixels.
416 Zero if not using the X toolkit.
417 When using the toolkit, this value is not meaningful
418 if the menubar is turned off. */
421 /* Height of tool bar widget, in pixels.
422 Zero if not using an external tool bar. */
425 /* Height of a line, in pixels. */
428 /* The tiled border used when the mouse is out of the frame. */
431 /* Here are the Graphics Contexts for the default font. */
432 GC normal_gc
; /* Normal video */
433 GC reverse_gc
; /* Reverse video */
434 GC cursor_gc
; /* cursor drawing */
436 /* Width of the internal border. This is a line of background color
437 just inside the window's border. When the frame is selected,
438 a highlighting is displayed inside the internal border. */
439 int internal_border_width
;
441 /* The X window used for this frame.
442 May be zero while the frame object is being created
443 and the X window has not yet been created. */
446 /* The X window used for the bitmap icon;
447 or 0 if we don't have a bitmap icon. */
450 /* The X window that is the parent of this X window.
451 Usually this is a window that was made by the window manager,
452 but it can be the root window, and it can be explicitly specified
453 (see the explicit_parent field, below). */
457 /* The widget of this screen. This is the window of a "shell" widget. */
459 /* The XmPanedWindows... */
460 Widget column_widget
;
461 /* The widget of the edit portion of this screen; the window in
462 "window_desc" is inside of this. */
465 Widget menubar_widget
;
469 /* The widget of this screen. This is the window of a top widget. */
471 /* The widget of the edit portion of this screen; the window in
472 "window_desc" is inside of this. */
473 GtkWidget
*edit_widget
;
474 /* The widget used for laying out widgets vertically. */
475 GtkWidget
*vbox_widget
;
476 /* The menubar in this frame. */
477 GtkWidget
*menubar_widget
;
478 /* The tool bar in this frame */
479 GtkWidget
*toolbar_widget
;
480 /* The handle box that makes the tool bar detachable. */
481 GtkWidget
*handlebox_widget
;
483 /* The last size hints set. */
484 GdkGeometry size_hints
;
488 /* If >=0, a bitmap index. The indicated bitmap is used for the
492 /* Default ASCII font of this frame. */
495 /* The baseline offset of the default ASCII font. */
498 /* If a fontset is specified for this frame instead of font, this
499 value contains an ID of the fontset, else -1. */
502 /* Pixel values used for various purposes.
503 border_pixel may be -1 meaning use a gray tile. */
504 unsigned long background_pixel
;
505 unsigned long foreground_pixel
;
506 unsigned long cursor_pixel
;
507 unsigned long border_pixel
;
508 unsigned long mouse_pixel
;
509 unsigned long cursor_foreground_pixel
;
511 /* Foreground color for scroll bars. A value of -1 means use the
512 default (black for non-toolkit scroll bars). */
513 unsigned long scroll_bar_foreground_pixel
;
515 /* Background color for scroll bars. A value of -1 means use the
516 default (background color of the frame for non-toolkit scroll
518 unsigned long scroll_bar_background_pixel
;
520 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
521 let the scroll compute them itself. */
522 unsigned long scroll_bar_top_shadow_pixel
;
523 unsigned long scroll_bar_bottom_shadow_pixel
;
525 /* Descriptor for the cursor in use for this window. */
527 Cursor nontext_cursor
;
528 Cursor modeline_cursor
;
530 Cursor hourglass_cursor
;
531 Cursor horizontal_drag_cursor
;
533 /* Window whose cursor is hourglass_cursor. This window is temporarily
534 mapped to display an hourglass cursor. */
535 Window hourglass_window
;
537 /* Non-zero means hourglass cursor is currently displayed. */
538 unsigned hourglass_p
: 1;
540 /* Flag to set when the X window needs to be completely repainted. */
543 /* These are the current window manager hints. It seems that
544 XSetWMHints, when presented with an unset bit in the `flags'
545 member of the hints structure, does not leave the corresponding
546 attribute unchanged; rather, it resets that attribute to its
547 default value. For example, unless you set the `icon_pixmap'
548 field and the `IconPixmapHint' bit, XSetWMHints will forget what
549 your icon pixmap was. This is rather troublesome, since some of
550 the members (for example, `input' and `icon_pixmap') want to stay
551 the same throughout the execution of Emacs. So, we keep this
552 structure around, just leaving values in it and adding new bits
553 to the mask as we go. */
556 /* The size of the extra width currently allotted for vertical
557 scroll bars, in pixels. */
558 int vertical_scroll_bar_extra
;
560 /* The extra width currently allotted for the areas in which
561 truncation marks, continuation marks, and overlay arrows are
563 int left_fringe_width
, right_fringe_width
;
564 int fringe_cols
, fringes_extra
;
566 /* This is the gravity value for the specified window position. */
569 /* The geometry flags for this window. */
572 /* This is the Emacs structure for the X display this frame is on. */
573 struct x_display_info
*display_info
;
575 /* This is a button event that wants to activate the menubar.
576 We save it here until the command loop gets to think about it. */
577 XEvent
*saved_menu_event
;
579 /* This is the widget id used for this frame's menubar in lwlib. */
584 /* Nonzero means our parent is another application's window
585 and was explicitly specified. */
586 char explicit_parent
;
588 /* Nonzero means tried already to make this frame visible. */
589 char asked_for_visible
;
591 /* Nonzero if this frame was ever previously visible. */
592 char has_been_visible
;
595 /* Input context (currently, this means Compose key handler setup). */
601 /* Relief GCs, colors etc. */
608 black_relief
, white_relief
;
610 /* The background for which the above relief GCs were set up.
611 They are changed only when a different background is involved. */
612 unsigned long relief_background
;
614 /* Xt waits for a ConfigureNotify event from the window manager in
615 EmacsFrameSetCharSize when the shell widget is resized. For some
616 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
617 arrive for an unknown reason and Emacs hangs in Xt. If this is
618 zero, tell Xt not to wait. */
624 /* This many pixels are the difference between the outer window (i.e. the
625 left of the window manager decoration) and FRAME_X_WINDOW. */
628 /* This many pixels are the difference between the outer window (i.e. the
629 top of the window manager titlebar) and FRAME_X_WINDOW. */
632 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
633 two might differ by a pixel, depending on WM */
634 int x_pixels_outer_diff
;
636 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
637 these may differ because this does not take into account possible
638 menubar. y_pixels_diff is with menubar height included */
639 int y_pixels_outer_diff
;
641 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
642 frame, or IMPLICIT if we received an EnterNotify.
643 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
649 /* Values used as a bit mask, BOTH == WIDTH | HEIGHT. */
651 FULLSCREEN_WIDTH
= 1,
652 FULLSCREEN_HEIGHT
= 2,
655 FULLSCREEN_MOVE_WAIT
= 8,
660 /* Values for focus_state, used as bit mask.
661 EXPLICIT means we received a FocusIn for the frame and know it has
662 the focus. IMPLICIT means we recevied an EnterNotify and the frame
663 may have the focus if no window manager is running.
664 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
671 /* Return the X output data for frame F. */
672 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
674 /* Return the X window used for displaying data in frame F. */
675 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
677 /* Return the outermost X window associated with the frame F. */
679 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
680 XtWindow ((f)->output_data.x->widget) : \
684 #define GTK_WIDGET_TO_X_WIN(w) \
685 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
687 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
688 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
689 #define FRAME_OUTER_WINDOW(f) \
690 (FRAME_GTK_OUTER_WIDGET (f) ? \
691 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
695 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
696 #endif /* !USE_GTK */
700 #define FRAME_FONT(f) ((f)->output_data.x->font)
701 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
702 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
703 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
704 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
705 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
707 /* Width of the default font of frame F. Must be defined by each
708 terminal specific header. */
709 #define FRAME_DEFAULT_FONT_WIDTH(F) FONT_WIDTH (FRAME_FONT (F))
710 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
712 /* This gives the x_display_info structure for the display F is on. */
713 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
715 /* This is the `Display *' which frame F is on. */
716 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
718 /* This is the `Screen *' which frame F is on. */
719 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
720 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
722 /* This is the Visual which frame F is on. */
723 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
725 /* This is the Colormap which frame F uses. */
726 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
728 /* This is the 'font_info *' which frame F has. */
729 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
731 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
732 #define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
733 #define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
735 /* The difference in pixels between the top left corner of the
736 Emacs window (including possible window manager decorations)
737 and FRAME_X_WINDOW (f). */
738 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
739 ((f)->output_data.x->x_pixels_outer_diff)
740 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
741 ((f)->output_data.x->y_pixels_outer_diff \
742 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
745 #define FRAME_XIC(f) ((f)->output_data.x->xic)
746 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
747 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
748 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
749 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
751 /* Value is the smallest width of any character in any font on frame F. */
753 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
754 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
756 /* Value is the smallest height of any font on frame F. */
758 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
759 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
761 /* Return a pointer to the image cache of frame F. */
763 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
766 /* Total width of fringes reserved for drawing truncation bitmaps,
767 continuation bitmaps and alike. The width is in canonical char
768 units of the frame. This must currently be the case because window
769 sizes aren't pixel values. If it weren't the case, we wouldn't be
770 able to split windows horizontally nicely. */
772 #define FRAME_X_FRINGE_COLS(F) ((F)->output_data.x->fringe_cols)
774 /* Total width of fringes in pixels. */
776 #define FRAME_X_FRINGE_WIDTH(F) ((F)->output_data.x->fringes_extra)
778 /* Pixel-width of the left and right fringe. */
780 #define FRAME_X_LEFT_FRINGE_WIDTH(F) ((F)->output_data.x->left_fringe_width)
781 #define FRAME_X_RIGHT_FRINGE_WIDTH(F) ((F)->output_data.x->right_fringe_width)
785 /* X-specific scroll bar stuff. */
787 /* We represent scroll bars as lisp vectors. This allows us to place
788 references to them in windows without worrying about whether we'll
789 end up with windows referring to dead scroll bars; the garbage
790 collector will free it when its time comes.
792 We use struct scroll_bar as a template for accessing fields of the
797 /* These fields are shared by all vectors. */
798 EMACS_INT size_from_Lisp_Vector_struct
;
799 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
801 /* The window we're a scroll bar for. */
804 /* The next and previous in the chain of scroll bars in this frame. */
805 Lisp_Object next
, prev
;
807 /* The X window representing this scroll bar. Since this is a full
808 32-bit quantity, we store it split into two 32-bit values. */
809 Lisp_Object x_window_low
, x_window_high
;
811 /* The position and size of the scroll bar in pixels, relative to the
813 Lisp_Object top
, left
, width
, height
;
815 /* The starting and ending positions of the handle, relative to the
816 handle area (i.e. zero is the top position, not
817 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
818 hasn't been drawn yet.
820 These are not actually the locations where the beginning and end
821 are drawn; in order to keep handles from becoming invisible when
822 editing large files, we establish a minimum height by always
823 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
824 where they would be normally; the bottom and top are in a
825 different co-ordinate system. */
826 Lisp_Object start
, end
;
828 /* If the scroll bar handle is currently being dragged by the user,
829 this is the number of pixels from the top of the handle to the
830 place where the user grabbed it. If the handle isn't currently
831 being dragged, this is Qnil. */
832 Lisp_Object dragging
;
835 /* The number of elements a vector holding a struct scroll_bar needs. */
836 #define SCROLL_BAR_VEC_SIZE \
837 ((sizeof (struct scroll_bar) \
838 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
839 / sizeof (Lisp_Object))
841 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
842 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
845 /* Building a 32-bit C integer from two 16-bit lisp integers. */
846 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
848 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
849 #define SCROLL_BAR_UNPACK(low, high, int32) \
850 (XSETINT ((low), (int32) & 0xffff), \
851 XSETINT ((high), ((int32) >> 16) & 0xffff))
854 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
855 #define SCROLL_BAR_X_WINDOW(ptr) \
856 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
858 /* Store a window id in a struct scroll_bar. */
859 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
860 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
862 /* Extract the X widget of the scroll bar from a struct scroll_bar.
863 XtWindowToWidget should be fast enough since Xt uses a hash table
864 to map windows to widgets. */
866 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
867 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
869 /* Store a widget id in a struct scroll_bar. */
871 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
873 Window window = XtWindow (w); \
874 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
878 /* Return the inside width of a vertical scroll bar, given the outside
880 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
882 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
883 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
884 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
886 /* Return the length of the rectangle within which the top of the
887 handle must stay. This isn't equivalent to the inside height,
888 because the scroll bar handle has a minimum height.
890 This is the real range of motion for the scroll bar, so when we're
891 scaling buffer positions to scroll bar positions, we use this, not
892 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
893 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
894 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
896 /* Return the inside height of vertical scroll bar, given the outside
897 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
898 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
899 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
902 /* Border widths for scroll bars.
904 Scroll bar windows don't have any X borders; their border width is
905 set to zero, and we redraw borders ourselves. This makes the code
906 a bit cleaner, since we don't have to convert between outside width
907 (used when relating to the rest of the screen) and inside width
908 (used when sizing and drawing the scroll bar window itself).
910 The handle moves up and down/back and forth in a rectangle inset
911 from the edges of the scroll bar. These are widths by which we
912 inset the handle boundaries from the scroll bar edges. */
913 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
914 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
915 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
916 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
918 /* Minimum lengths for scroll bar handles, in pixels. */
919 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
921 /* Trimming off a few pixels from each side prevents
922 text from glomming up against the scroll bar */
923 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
926 /* Manipulating pixel sizes and character sizes.
927 Knowledge of which factors affect the overall size of the window should
928 be hidden in these macros, if that's possible.
930 Return the upper/left pixel position of the character cell on frame F
932 #define CHAR_TO_PIXEL_ROW(f, row) \
933 ((f)->output_data.x->internal_border_width \
934 + (row) * (f)->output_data.x->line_height)
935 #define CHAR_TO_PIXEL_COL(f, col) \
936 ((f)->output_data.x->internal_border_width \
937 + (col) * FONT_WIDTH ((f)->output_data.x->font))
939 /* Return the pixel width/height of frame F if it has
940 WIDTH columns/HEIGHT rows. */
941 #define CHAR_TO_PIXEL_WIDTH(f, width) \
942 (CHAR_TO_PIXEL_COL (f, width) \
943 + (f)->output_data.x->vertical_scroll_bar_extra \
944 + (f)->output_data.x->fringes_extra \
945 + (f)->output_data.x->internal_border_width)
946 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
947 (CHAR_TO_PIXEL_ROW (f, height) \
948 + (f)->output_data.x->internal_border_width)
951 /* Return the row/column (zero-based) of the character cell containing
952 the pixel on FRAME at ROW/COL. */
953 #define PIXEL_TO_CHAR_ROW(f, row) \
954 (((row) - (f)->output_data.x->internal_border_width) \
955 / (f)->output_data.x->line_height)
956 #define PIXEL_TO_CHAR_COL(f, col) \
957 (((col) - (f)->output_data.x->internal_border_width) \
958 / FONT_WIDTH ((f)->output_data.x->font))
960 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
962 #define PIXEL_TO_CHAR_WIDTH(f, width) \
963 (PIXEL_TO_CHAR_COL (f, ((width) \
964 - (f)->output_data.x->internal_border_width \
965 - (f)->output_data.x->fringes_extra \
966 - (f)->output_data.x->vertical_scroll_bar_extra)))
967 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
968 (PIXEL_TO_CHAR_ROW (f, ((height) \
969 - (f)->output_data.x->internal_border_width)))
972 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
973 or SELECTION_CLEAR_EVENT, then its contents are really described
974 by this structure. */
976 /* For an event of kind SELECTION_REQUEST_EVENT,
977 this structure really describes the contents.
978 **Don't make this struct longer!**
979 If it overlaps the frame_or_window field of struct input_event,
980 that will cause GC to crash. */
981 struct selection_input_event
985 /* We spell it with an "o" here because X does. */
987 Atom selection
, target
, property
;
991 #define SELECTION_EVENT_DISPLAY(eventp) \
992 (((struct selection_input_event *) (eventp))->display)
993 /* We spell it with an "o" here because X does. */
994 #define SELECTION_EVENT_REQUESTOR(eventp) \
995 (((struct selection_input_event *) (eventp))->requestor)
996 #define SELECTION_EVENT_SELECTION(eventp) \
997 (((struct selection_input_event *) (eventp))->selection)
998 #define SELECTION_EVENT_TARGET(eventp) \
999 (((struct selection_input_event *) (eventp))->target)
1000 #define SELECTION_EVENT_PROPERTY(eventp) \
1001 (((struct selection_input_event *) (eventp))->property)
1002 #define SELECTION_EVENT_TIME(eventp) \
1003 (((struct selection_input_event *) (eventp))->time)
1007 struct glyph_matrix
;
1013 /* From xselect.c. */
1015 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
1016 void x_handle_property_notify
P_ ((XPropertyEvent
*));
1020 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
1021 Lisp_Object
, Lisp_Object
,
1022 Lisp_Object
, Lisp_Object
));
1023 struct frame
*check_x_frame
P_ ((Lisp_Object
));
1024 EXFUN (Fx_display_color_p
, 1);
1025 EXFUN (Fx_display_grayscale_p
, 1);
1026 int image_ascent
P_ ((struct image
*, struct face
*));
1027 extern void x_free_gcs
P_ ((struct frame
*));
1031 char *x_get_string_resource
P_ ((XrmDatabase
, char *, char *));
1032 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
1033 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
1034 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
1035 XrmRepresentation
, XrmValue
*));
1036 void x_delete_display
P_ ((struct x_display_info
*));
1037 void x_make_frame_visible
P_ ((struct frame
*));
1038 void x_iconify_frame
P_ ((struct frame
*));
1039 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
1040 void x_set_offset
P_ ((struct frame
*, int, int, int));
1041 void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
1042 int x_catch_errors
P_ ((Display
*));
1043 int x_had_errors_p
P_ ((Display
*));
1044 void x_uncatch_errors
P_ ((Display
*, int));
1045 void x_check_errors
P_ ((Display
*, char *));
1046 int x_text_icon
P_ ((struct frame
*, char *));
1047 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
1048 void x_set_window_size
P_ ((struct frame
*, int, int, int));
1049 void x_wm_set_window_state
P_ ((struct frame
*, int));
1050 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
1052 extern void pixel_to_glyph_coords
P_ ((struct frame
*, int, int,
1053 int *, int *, XRectangle
*, int));
1055 /* Defined in xterm.c */
1057 extern void cancel_mouse_face
P_ ((struct frame
*));
1058 extern void x_scroll_bar_clear
P_ ((struct frame
*));
1059 extern void x_start_queuing_selection_requests
P_ ((Display
*));
1060 extern void x_stop_queuing_selection_requests
P_ ((Display
*));
1061 extern void x_update_cursor
P_ ((struct frame
*, int));
1062 extern int x_text_icon
P_ ((struct frame
*, char *));
1063 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
1064 extern int x_catch_errors
P_ ((Display
*));
1065 extern void x_check_errors
P_ ((Display
*, char *));
1066 extern int x_had_errors_p
P_ ((Display
*));
1067 extern void x_uncatch_errors
P_ ((Display
*, int));
1068 extern Lisp_Object x_new_font
P_ ((struct frame
*, char *));
1069 extern Lisp_Object x_new_fontset
P_ ((struct frame
*, char *));
1070 extern void x_set_offset
P_ ((struct frame
*, int, int, int));
1071 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
1072 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
1073 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
1074 extern void x_raise_frame
P_ ((struct frame
*));
1075 extern void x_lower_frame
P_ ((struct frame
*));
1076 extern void x_make_frame_visible
P_ ((struct frame
*));
1077 extern void x_make_frame_invisible
P_ ((struct frame
*));
1078 extern void x_iconify_frame
P_ ((struct frame
*));
1079 extern void x_free_frame_resources
P_ ((struct frame
*));
1080 extern void x_destroy_window
P_ ((struct frame
*));
1081 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
1082 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
1083 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
1084 extern void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
1085 extern void x_delete_display
P_ ((struct x_display_info
*));
1086 extern void x_initialize
P_ ((void));
1087 extern void x_display_cursor
P_ ((struct window
*, int, int, int, int, int));
1088 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
1089 #ifdef USE_X_TOOLKIT
1090 extern XtAppContext Xt_app_con
;
1092 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
1093 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
1094 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
1096 extern void x_fullscreen_adjust
P_ ((struct frame
*f
, int *, int *,
1099 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
1101 /* Defined in xselect.c */
1103 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
1104 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
1105 extern void x_handle_selection_request
P_ ((struct input_event
*));
1106 extern void x_handle_selection_clear
P_ ((struct input_event
*));
1107 extern void x_clear_frame_selections
P_ ((struct frame
*));
1109 /* Defined in xfns.c */
1111 extern int have_menus_p
P_ ((void));
1112 extern int x_bitmap_height
P_ ((struct frame
*, int));
1113 extern int x_bitmap_width
P_ ((struct frame
*, int));
1114 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
1115 extern void x_reference_bitmap
P_ ((struct frame
*, int));
1116 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
1117 unsigned int, unsigned int));
1118 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
1119 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
1120 extern void x_set_frame_parameters
P_ ((struct frame
*, Lisp_Object
));
1121 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1122 extern void x_report_frame_params
P_ ((struct frame
*, Lisp_Object
*));
1123 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1124 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1125 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1126 extern unsigned char * x_encode_text
P_ ((Lisp_Object
, Lisp_Object
, int,
1128 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1129 extern void create_frame_xic
P_ ((struct frame
*));
1130 extern void destroy_frame_xic
P_ ((struct frame
*));
1131 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1132 extern void xic_set_statusarea
P_ ((struct frame
*));
1133 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1134 extern int x_pixel_width
P_ ((struct frame
*));
1135 extern int x_pixel_height
P_ ((struct frame
*));
1136 extern int x_char_width
P_ ((struct frame
*));
1137 extern int x_char_height
P_ ((struct frame
*));
1138 extern int x_screen_planes
P_ ((struct frame
*));
1139 extern void x_sync
P_ ((struct frame
*));
1140 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1142 extern void free_frame_xic
P_ ((struct frame
*));
1144 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1146 /* Defined in xfaces.c */
1148 extern int frame_update_line_height
P_ ((struct frame
*));
1149 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1150 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1151 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1152 unsigned long *, int));
1154 /* Defined in xmenu.c */
1156 extern void x_activate_menubar
P_ ((struct frame
*));
1157 extern int popup_activated
P_ ((void));
1158 extern void initialize_frame_menubar
P_ ((struct frame
*));
1160 /* Defined in widget.c */
1162 #ifdef USE_X_TOOLKIT
1163 extern void widget_store_internal_border
P_ ((Widget
));
1166 /* Defined in xsmfns.c */
1168 extern void x_session_initialize
P_ ((void));
1169 extern int x_session_check_input
P_ ((struct input_event
*bufp
,
1171 extern int x_session_have_connection
P_ ((void));
1174 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1175 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1177 #define STORE_XCHAR2B(chp, b1, b2) \
1178 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1180 #define XCHAR2B_BYTE1(chp) \
1183 #define XCHAR2B_BYTE2(chp) \