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 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <X11/cursorfont.h>
23 /* Include Xutil.h after keysym.h to work around a bug that prevents
24 correct recognition of AltGr key in some X versions. */
26 #include <X11/keysym.h>
27 #include <X11/Xutil.h>
29 #include <X11/Xatom.h>
30 #include <X11/Xresource.h>
33 #include <X11/StringDefs.h>
34 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
35 #include <X11/CoreP.h> /* foul, but we need this to use our own
36 window inside a widget instead of one
38 #include <X11/StringDefs.h>
40 typedef Widget xt_or_gtk_widget
;
47 /* Some definitions to reduce conditionals. */
48 typedef GtkWidget
*xt_or_gtk_widget
;
49 #define XtParent(x) (gtk_widget_get_parent (x))
51 #define XSync(d, b) do { gdk_window_process_all_updates (); \
52 XSync (d, b); } while (0)
58 /* Bookkeeping to distinguish X versions. */
62 #include <X11/Xlocale.h>
65 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
66 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
67 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
68 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
70 #define FONT_WIDTH(f) ((f)->max_width)
71 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
72 #define FONT_BASE(f) ((f)->ascent)
73 #define FONT_DESCENT(f) ((f)->descent)
75 /* The mask of events that text windows always want to receive. This
76 includes mouse movement events, since handling the mouse-font text property
77 means that we must track mouse motion all the time. */
79 #define STANDARD_EVENT_SET \
85 | StructureNotifyMask \
89 | VisibilityChangeMask)
91 /* Structure recording X pixmap and reference count.
92 If REFCOUNT is 0 then this record is free to be reused. */
94 struct x_bitmap_record
101 /* Record some info about this pixmap. */
102 int height
, width
, depth
;
105 /* For each X display, we have a structure that records
106 information about it. */
108 struct x_display_info
110 /* Chain of all x_display_info structures. */
111 struct x_display_info
*next
;
113 /* The generic display parameters corresponding to this X display. */
114 struct terminal
*terminal
;
116 /* Connection number (normally a file descriptor number). */
119 /* This says how to access this display in Xlib. */
122 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
123 The same cons cell also appears in x_display_name_list. */
124 Lisp_Object name_list_element
;
126 /* Number of frames that are on this display. */
129 /* The Screen this connection is connected to. */
132 /* Dots per inch of the screen. */
135 /* The Visual being used for this display. */
138 /* The colormap being used. */
141 /* Number of planes on this screen. */
144 /* Dimensions of this screen. */
147 /* Mask of things that cause the mouse to be grabbed. */
150 /* Emacs bitmap-id of the default icon bitmap for this frame.
151 Or -1 if none has been allocated yet. */
154 /* The root window of this screen. */
157 /* Client leader window. */
158 Window client_leader_window
;
160 /* The cursor to use for vertical scroll bars. */
161 Cursor vertical_scroll_bar_cursor
;
164 /* The GDK cursor for scroll bars and popup menus. */
165 GdkCursor
*xg_cursor
;
168 /* X Resource data base */
171 /* Minimum width over all characters in all fonts in font_table. */
172 int smallest_char_width
;
174 /* Minimum font height over all fonts in font_table. */
175 int smallest_font_height
;
177 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
178 GC scratch_cursor_gc
;
180 /* These variables describe the range of text currently shown in its
181 mouse-face, together with the window they apply to. As long as
182 the mouse stays within this range, we need not redraw anything on
183 its account. Rows and columns are glyph matrix positions in
184 MOUSE_FACE_WINDOW. */
185 int mouse_face_beg_row
, mouse_face_beg_col
;
186 int mouse_face_beg_x
, mouse_face_beg_y
;
187 int mouse_face_end_row
, mouse_face_end_col
;
188 int mouse_face_end_x
, mouse_face_end_y
;
189 int mouse_face_past_end
;
190 Lisp_Object mouse_face_window
;
191 int mouse_face_face_id
;
192 Lisp_Object mouse_face_overlay
;
194 /* 1 if a mouse motion event came and we didn't handle it right away because
195 gc was in progress. */
196 int mouse_face_deferred_gc
;
198 /* FRAME and X, Y position of mouse when last checked for
199 highlighting. X and Y can be negative or out of range for the frame. */
200 struct frame
*mouse_face_mouse_frame
;
201 int mouse_face_mouse_x
, mouse_face_mouse_y
;
203 /* Nonzero means defer mouse-motion highlighting. */
204 int mouse_face_defer
;
206 /* Nonzero means that the mouse highlight should not be shown. */
207 int mouse_face_hidden
;
209 int mouse_face_image_state
;
213 /* The number of fonts opened for this display. */
216 /* Pointer to bitmap records. */
217 struct x_bitmap_record
*bitmaps
;
219 /* Allocated size of bitmaps field. */
222 /* Last used bitmap index. */
225 /* Which modifier keys are on which modifier bits?
227 With each keystroke, X returns eight bits indicating which modifier
228 keys were held down when the key was pressed. The interpretation
229 of the top five modifier bits depends on what keys are attached
230 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
233 meta_mod_mask is a mask containing the bits used for the meta key.
234 It may have more than one bit set, if more than one modifier bit
235 has meta keys on it. Basically, if EVENT is a KeyPress event,
236 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
238 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
239 lock modifier bit, or zero otherwise. Non-alphabetic keys should
240 only be affected by the lock modifier bit if XK_Shift_Lock is in
241 use; XK_Caps_Lock should only affect alphabetic keys. With this
242 arrangement, the lock modifier should shift the character if
243 (EVENT.state & shift_lock_mask) != 0. */
244 int meta_mod_mask
, shift_lock_mask
;
246 /* These are like meta_mod_mask, but for different modifiers. */
247 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
249 /* Communication with window managers. */
250 Atom Xatom_wm_protocols
;
252 /* Kinds of protocol things we may receive. */
253 Atom Xatom_wm_take_focus
;
254 Atom Xatom_wm_save_yourself
;
255 Atom Xatom_wm_delete_window
;
257 /* Atom for indicating window state to the window manager. */
258 Atom Xatom_wm_change_state
;
260 /* Other WM communication */
261 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
262 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
263 Atom Xatom_wm_client_leader
; /* Id of client leader window. */
265 /* EditRes protocol */
268 /* More atoms, which are selection types. */
269 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
270 Xatom_COMPOUND_TEXT
, Xatom_UTF8_STRING
,
271 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
274 /* More atoms for font properties. The last three are private
275 properties, see the comments in src/fontset.h. */
276 Atom Xatom_PIXEL_SIZE
, Xatom_AVERAGE_WIDTH
,
277 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
278 Xatom_MULE_DEFAULT_ASCENT
;
280 /* More atoms for Ghostscript support. */
281 Atom Xatom_DONE
, Xatom_PAGE
;
283 /* Atom used in toolkit scroll bar client messages. */
284 Atom Xatom_Scrollbar
;
286 /* Atom used in XEmbed client messages. */
289 int cut_buffers_initialized
; /* Whether we're sure they all exist */
291 /* The frame (if any) which has the X window that has keyboard focus.
292 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
293 that a mere EnterNotify event can set this; if you need to know the
294 last frame specified in a FocusIn or FocusOut event, use
295 x_focus_event_frame. */
296 struct frame
*x_focus_frame
;
298 /* The last frame mentioned in a FocusIn or FocusOut event. This is
299 separate from x_focus_frame, because whether or not LeaveNotify
300 events cause us to lose focus depends on whether or not we have
301 received a FocusIn event for it. */
302 struct frame
*x_focus_event_frame
;
304 /* The frame which currently has the visual highlight, and should get
305 keyboard input (other sorts of input have the frame encoded in the
306 event). It points to the X focus frame's selected window's
307 frame. It differs from x_focus_frame when we're using a global
309 struct frame
*x_highlight_frame
;
311 /* The null pixel used for filling a character background with
312 background color of a gc. */
315 /* The gray pixmap. */
319 /* XIM (X Input method). */
321 XIMStyles
*xim_styles
;
324 /* If non-null, a cache of the colors in the color map. Don't
325 use this directly, call x_color_cells instead. */
329 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
330 int red_bits
, blue_bits
, green_bits
;
331 int red_offset
, blue_offset
, green_offset
;
333 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
334 to x/y 0/0, some window managers (type A) puts the window manager
335 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
336 Other window managers (type B) puts the window including decorations
337 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
338 Record the type of WM in use so we can compensate for type A WMs. */
347 /* Atoms that are drag and drop atoms */
349 size_t x_dnd_atoms_size
;
350 size_t x_dnd_atoms_length
;
352 /* Extended window manager hints, Atoms supported by the window manager */
353 Atom
*net_supported_atoms
;
354 int nr_net_supported_atoms
;
355 Window net_supported_window
;
359 /* Whether or not to use XIM if we have it. */
363 /* This checks to make sure we have a display. */
364 extern void check_x
P_ ((void));
366 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
368 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
369 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
370 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
371 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
374 /* This is a chain of structures for all the X displays currently in use. */
375 extern struct x_display_info
*x_display_list
;
377 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
378 one for each element of x_display_list and in the same order.
379 NAME is the name of the frame.
380 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
381 extern Lisp_Object x_display_name_list
;
383 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
384 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
386 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
387 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
388 extern void x_set_frame_alpha
P_ ((struct frame
*));
390 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
391 extern int x_display_ok
P_ ((const char *));
393 extern void select_visual
P_ ((struct x_display_info
*));
398 /* Each X frame object points to its own struct x_output object
399 in the output_data.x field. The x_output structure contains
400 the information that is specific to X windows. */
404 /* Height of menu bar widget, in pixels.
405 Zero if not using the X toolkit.
406 When using the toolkit, this value is not meaningful
407 if the menubar is turned off. */
410 /* Height of tool bar widget, in pixels.
411 Zero if not using an external tool bar. */
414 /* The tiled border used when the mouse is out of the frame. */
417 /* Here are the Graphics Contexts for the default font. */
418 GC normal_gc
; /* Normal video */
419 GC reverse_gc
; /* Reverse video */
420 GC cursor_gc
; /* cursor drawing */
422 /* The X window used for this frame.
423 May be zero while the frame object is being created
424 and the X window has not yet been created. */
427 /* The X window used for the bitmap icon;
428 or 0 if we don't have a bitmap icon. */
431 /* The X window that is the parent of this X window.
432 Usually this is a window that was made by the window manager,
433 but it can be the root window, and it can be explicitly specified
434 (see the explicit_parent field, below). */
438 /* The widget of this screen. This is the window of a "shell" widget. */
440 /* The XmPanedWindows... */
441 Widget column_widget
;
442 /* The widget of the edit portion of this screen; the window in
443 "window_desc" is inside of this. */
446 Widget menubar_widget
;
450 /* The widget of this screen. This is the window of a top widget. */
452 /* The widget of the edit portion of this screen; the window in
453 "window_desc" is inside of this. */
454 GtkWidget
*edit_widget
;
455 /* The widget used for laying out widgets vertically. */
456 GtkWidget
*vbox_widget
;
457 /* The menubar in this frame. */
458 GtkWidget
*menubar_widget
;
459 /* The tool bar in this frame */
460 GtkWidget
*toolbar_widget
;
461 /* The handle box that makes the tool bar detachable. */
462 GtkWidget
*handlebox_widget
;
463 /* Non-zero if the tool bar is detached. */
464 int toolbar_detached
;
466 /* The last size hints set. */
467 GdkGeometry size_hints
;
471 /* If >=0, a bitmap index. The indicated bitmap is used for the
475 /* Default ASCII font of this frame. */
478 /* The baseline offset of the default ASCII font. */
481 /* If a fontset is specified for this frame instead of font, this
482 value contains an ID of the fontset, else -1. */
485 /* Pixel values used for various purposes.
486 border_pixel may be -1 meaning use a gray tile. */
487 #if 0 /* These are also defined in struct frame. Use that instead. */
488 unsigned long background_pixel
;
489 unsigned long foreground_pixel
;
491 unsigned long cursor_pixel
;
492 unsigned long border_pixel
;
493 unsigned long mouse_pixel
;
494 unsigned long cursor_foreground_pixel
;
496 /* Foreground color for scroll bars. A value of -1 means use the
497 default (black for non-toolkit scroll bars). */
498 unsigned long scroll_bar_foreground_pixel
;
500 /* Background color for scroll bars. A value of -1 means use the
501 default (background color of the frame for non-toolkit scroll
503 unsigned long scroll_bar_background_pixel
;
505 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
506 let the scroll compute them itself. */
507 unsigned long scroll_bar_top_shadow_pixel
;
508 unsigned long scroll_bar_bottom_shadow_pixel
;
510 /* Descriptor for the cursor in use for this window. */
512 Cursor nontext_cursor
;
513 Cursor modeline_cursor
;
515 Cursor hourglass_cursor
;
516 Cursor horizontal_drag_cursor
;
518 /* Window whose cursor is hourglass_cursor. This window is temporarily
519 mapped to display an hourglass cursor. */
520 Window hourglass_window
;
522 /* Non-zero means hourglass cursor is currently displayed. */
523 unsigned hourglass_p
: 1;
525 /* Flag to set when the X window needs to be completely repainted. */
528 /* These are the current window manager hints. It seems that
529 XSetWMHints, when presented with an unset bit in the `flags'
530 member of the hints structure, does not leave the corresponding
531 attribute unchanged; rather, it resets that attribute to its
532 default value. For example, unless you set the `icon_pixmap'
533 field and the `IconPixmapHint' bit, XSetWMHints will forget what
534 your icon pixmap was. This is rather troublesome, since some of
535 the members (for example, `input' and `icon_pixmap') want to stay
536 the same throughout the execution of Emacs. So, we keep this
537 structure around, just leaving values in it and adding new bits
538 to the mask as we go. */
541 /* This is the Emacs structure for the X display this frame is on. */
542 struct x_display_info
*display_info
;
544 /* This is a button event that wants to activate the menubar.
545 We save it here until the command loop gets to think about it. */
546 XEvent
*saved_menu_event
;
548 /* This is the widget id used for this frame's menubar in lwlib. */
553 /* Nonzero means our parent is another application's window
554 and was explicitly specified. */
555 char explicit_parent
;
557 /* Nonzero means tried already to make this frame visible. */
558 char asked_for_visible
;
560 /* Nonzero if this frame was ever previously visible. */
561 char has_been_visible
;
564 /* Input context (currently, this means Compose key handler setup). */
568 char *xic_base_fontname
;
571 /* Relief GCs, colors etc. */
578 black_relief
, white_relief
;
580 /* The background for which the above relief GCs were set up.
581 They are changed only when a different background is involved. */
582 unsigned long relief_background
;
584 /* Xt waits for a ConfigureNotify event from the window manager in
585 EmacsFrameSetCharSize when the shell widget is resized. For some
586 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
587 arrive for an unknown reason and Emacs hangs in Xt. If this is
588 zero, tell Xt not to wait. */
591 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
592 two might differ by a pixel, depending on WM */
593 int x_pixels_outer_diff
;
595 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
596 these may differ because this does not take into account possible
597 menubar. y_pixels_diff is with menubar height included */
598 int y_pixels_outer_diff
;
600 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
601 frame, or IMPLICIT if we received an EnterNotify.
602 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
605 /* The offset we need to add to compensate for type A WMs. */
607 int move_offset_left
;
609 /* The frame's left/top offsets before we call XMoveWindow. See
610 x_check_expected_move. */
611 int left_before_move
;
615 #define No_Cursor (None)
619 /* Values for focus_state, used as bit mask.
620 EXPLICIT means we received a FocusIn for the frame and know it has
621 the focus. IMPLICIT means we recevied an EnterNotify and the frame
622 may have the focus if no window manager is running.
623 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
630 /* Return the X output data for frame F. */
631 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
633 /* Return the X window used for displaying data in frame F. */
634 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
636 /* Return the outermost X window associated with the frame F. */
638 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
639 XtWindow ((f)->output_data.x->widget) : \
643 #define GTK_WIDGET_TO_X_WIN(w) \
644 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
646 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
647 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
648 #define FRAME_OUTER_WINDOW(f) \
649 (FRAME_GTK_OUTER_WIDGET (f) ? \
650 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
654 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
655 #endif /* !USE_GTK */
659 #define FRAME_FONT(f) ((f)->output_data.x->font)
660 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
661 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
662 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
663 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
665 /* This gives the x_display_info structure for the display F is on. */
666 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
668 /* This is the `Display *' which frame F is on. */
669 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
671 /* This is the `Screen *' which frame F is on. */
672 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
673 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
675 /* This is the Visual which frame F is on. */
676 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
678 /* This is the Colormap which frame F uses. */
679 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
681 /* This is the 'font_info *' which frame F has. */
682 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
684 /* The difference in pixels between the top left corner of the
685 Emacs window (including possible window manager decorations)
686 and FRAME_X_WINDOW (f). */
687 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
688 ((f)->output_data.x->x_pixels_outer_diff)
689 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
690 ((f)->output_data.x->y_pixels_outer_diff \
691 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
694 #define FRAME_XIC(f) ((f)->output_data.x->xic)
695 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
696 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
697 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
698 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
699 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
701 /* Value is the smallest width of any character in any font on frame F. */
703 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
704 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
706 /* Value is the smallest height of any font on frame F. */
708 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
709 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
711 /* X-specific scroll bar stuff. */
713 /* We represent scroll bars as lisp vectors. This allows us to place
714 references to them in windows without worrying about whether we'll
715 end up with windows referring to dead scroll bars; the garbage
716 collector will free it when its time comes.
718 We use struct scroll_bar as a template for accessing fields of the
723 /* These fields are shared by all vectors. */
724 EMACS_INT size_from_Lisp_Vector_struct
;
725 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
727 /* The window we're a scroll bar for. */
730 /* The next and previous in the chain of scroll bars in this frame. */
731 Lisp_Object next
, prev
;
733 /* Fields from `x_window' down will not be traced by the GC. */
735 /* The X window representing this scroll bar. */
738 /* The position and size of the scroll bar in pixels, relative to the
740 int top
, left
, width
, height
;
742 /* The starting and ending positions of the handle, relative to the
743 handle area (i.e. zero is the top position, not
744 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
745 hasn't been drawn yet.
747 These are not actually the locations where the beginning and end
748 are drawn; in order to keep handles from becoming invisible when
749 editing large files, we establish a minimum height by always
750 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
751 where they would be normally; the bottom and top are in a
752 different co-ordinate system. */
755 /* If the scroll bar handle is currently being dragged by the user,
756 this is the number of pixels from the top of the handle to the
757 place where the user grabbed it. If the handle isn't currently
758 being dragged, this is Qnil. */
759 Lisp_Object dragging
;
761 /* 1 if the background of the fringe that is adjacent to a scroll
762 bar is extended to the gap between the fringe and the bar. */
763 unsigned int fringe_extended_p
: 1;
766 /* The number of elements a vector holding a struct scroll_bar needs. */
767 #define SCROLL_BAR_VEC_SIZE \
768 ((sizeof (struct scroll_bar) \
769 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
770 / sizeof (Lisp_Object))
772 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
773 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
776 /* Extract the X widget of the scroll bar from a struct scroll_bar.
777 XtWindowToWidget should be fast enough since Xt uses a hash table
778 to map windows to widgets. */
780 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
781 XtWindowToWidget (dpy, ptr->x_window)
783 /* Store a widget id in a struct scroll_bar. */
785 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
787 Window window = XtWindow (w); \
788 ptr->x_window = window; \
792 /* Return the inside width of a vertical scroll bar, given the outside
794 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
796 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
797 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
798 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
800 /* Return the length of the rectangle within which the top of the
801 handle must stay. This isn't equivalent to the inside height,
802 because the scroll bar handle has a minimum height.
804 This is the real range of motion for the scroll bar, so when we're
805 scaling buffer positions to scroll bar positions, we use this, not
806 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
807 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
808 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
810 /* Return the inside height of vertical scroll bar, given the outside
811 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
812 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
813 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
816 /* Border widths for scroll bars.
818 Scroll bar windows don't have any X borders; their border width is
819 set to zero, and we redraw borders ourselves. This makes the code
820 a bit cleaner, since we don't have to convert between outside width
821 (used when relating to the rest of the screen) and inside width
822 (used when sizing and drawing the scroll bar window itself).
824 The handle moves up and down/back and forth in a rectangle inset
825 from the edges of the scroll bar. These are widths by which we
826 inset the handle boundaries from the scroll bar edges. */
827 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
828 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
829 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
830 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
832 /* Minimum lengths for scroll bar handles, in pixels. */
833 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
835 /* Trimming off a few pixels from each side prevents
836 text from glomming up against the scroll bar */
837 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
840 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
841 or SELECTION_CLEAR_EVENT, then its contents are really described
842 by this structure. */
844 /* For an event of kind SELECTION_REQUEST_EVENT,
845 this structure really describes the contents.
846 **Don't make this struct longer!**
847 If it overlaps the frame_or_window field of struct input_event,
848 that will cause GC to crash. */
849 struct selection_input_event
853 /* We spell it with an "o" here because X does. */
855 Atom selection
, target
, property
;
859 #define SELECTION_EVENT_DISPLAY(eventp) \
860 (((struct selection_input_event *) (eventp))->display)
861 /* We spell it with an "o" here because X does. */
862 #define SELECTION_EVENT_REQUESTOR(eventp) \
863 (((struct selection_input_event *) (eventp))->requestor)
864 #define SELECTION_EVENT_SELECTION(eventp) \
865 (((struct selection_input_event *) (eventp))->selection)
866 #define SELECTION_EVENT_TARGET(eventp) \
867 (((struct selection_input_event *) (eventp))->target)
868 #define SELECTION_EVENT_PROPERTY(eventp) \
869 (((struct selection_input_event *) (eventp))->property)
870 #define SELECTION_EVENT_TIME(eventp) \
871 (((struct selection_input_event *) (eventp))->time)
881 /* From xselect.c. */
883 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
884 void x_handle_property_notify
P_ ((XPropertyEvent
*));
888 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
889 Lisp_Object
, Lisp_Object
,
890 Lisp_Object
, Lisp_Object
));
891 struct frame
*check_x_frame
P_ ((Lisp_Object
));
892 EXFUN (Fx_display_color_p
, 1);
893 EXFUN (Fx_display_grayscale_p
, 1);
894 extern void x_free_gcs
P_ ((struct frame
*));
898 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
899 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
900 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
901 XrmRepresentation
, XrmValue
*));
902 void x_delete_display
P_ ((struct x_display_info
*));
903 void x_make_frame_visible
P_ ((struct frame
*));
904 void x_iconify_frame
P_ ((struct frame
*));
905 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
906 int x_text_icon
P_ ((struct frame
*, char *));
907 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
908 void x_set_window_size
P_ ((struct frame
*, int, int, int));
909 void x_wm_set_window_state
P_ ((struct frame
*, int));
910 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
912 /* Defined in xterm.c */
914 extern void cancel_mouse_face
P_ ((struct frame
*));
915 extern void x_scroll_bar_clear
P_ ((struct frame
*));
916 extern int x_text_icon
P_ ((struct frame
*, char *));
917 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
918 extern void x_catch_errors
P_ ((Display
*));
919 extern void x_check_errors
P_ ((Display
*, char *));
920 extern int x_had_errors_p
P_ ((Display
*));
921 extern int x_catching_errors
P_ ((void));
922 extern void x_uncatch_errors
P_ ((void));
923 extern void x_clear_errors
P_ ((Display
*));
924 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
925 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
926 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
927 extern void x_ewmh_activate_frame
P_ ((struct frame
*));
928 extern void x_raise_frame
P_ ((struct frame
*));
929 extern void x_lower_frame
P_ ((struct frame
*));
930 extern void x_make_frame_visible
P_ ((struct frame
*));
931 extern void x_make_frame_invisible
P_ ((struct frame
*));
932 extern void x_iconify_frame
P_ ((struct frame
*));
933 extern void x_free_frame_resources
P_ ((struct frame
*));
934 extern void x_destroy_window
P_ ((struct frame
*));
935 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
936 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
937 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
938 extern void x_delete_display
P_ ((struct x_display_info
*));
939 extern void x_delete_terminal
P_ ((struct terminal
*terminal
));
940 extern void x_initialize
P_ ((void));
941 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
943 extern XtAppContext Xt_app_con
;
944 extern int x_alloc_lighter_color_for_widget
__P ((Widget
, Display
*, Colormap
,
947 extern void x_activate_timeout_atimer
P_ ((void));
949 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
950 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
951 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
952 extern void set_vertical_scroll_bar
P_ ((struct window
*));
954 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
955 extern unsigned int x_x_to_emacs_modifiers
P_ ((struct x_display_info
*,
958 /* Defined in xselect.c */
960 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
961 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
962 extern void x_handle_selection_event
P_ ((struct input_event
*));
963 extern void x_clear_frame_selections
P_ ((struct frame
*));
965 extern int x_handle_dnd_message
P_ ((struct frame
*,
966 XClientMessageEvent
*,
967 struct x_display_info
*,
968 struct input_event
*bufp
));
969 extern int x_check_property_data
P_ ((Lisp_Object
));
970 extern void x_fill_property_data
P_ ((Display
*,
974 extern Lisp_Object x_property_data_to_lisp
P_ ((struct frame
*,
980 /* Defined in xfns.c */
982 extern struct x_display_info
* check_x_display_info
P_ ((Lisp_Object frame
));
985 extern int xg_set_icon
P_ ((struct frame
*, Lisp_Object
));
986 extern int xg_set_icon_from_xpm_data
P_ ((struct frame
*, char**));
989 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
990 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
991 extern void x_set_border_pixel
P_ ((struct frame
*, int));
992 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
993 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
994 extern void xic_free_xfontset
P_ ((struct frame
*));
995 extern void create_frame_xic
P_ ((struct frame
*));
996 extern void destroy_frame_xic
P_ ((struct frame
*));
997 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
998 extern void xic_set_statusarea
P_ ((struct frame
*));
999 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1000 extern int x_pixel_width
P_ ((struct frame
*));
1001 extern int x_pixel_height
P_ ((struct frame
*));
1002 extern int x_char_width
P_ ((struct frame
*));
1003 extern int x_char_height
P_ ((struct frame
*));
1004 extern int x_screen_planes
P_ ((struct frame
*));
1005 extern void x_sync
P_ ((struct frame
*));
1006 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1008 extern void free_frame_xic
P_ ((struct frame
*));
1010 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1012 /* Defined in xfaces.c */
1014 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1015 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1016 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1017 unsigned long *, int));
1019 /* Defined in xmenu.c */
1021 extern void x_menu_set_in_use
P_ ((int));
1022 extern void x_menu_wait_for_event
P_ ((void *data
));
1023 extern void x_activate_menubar
P_ ((struct frame
*));
1024 extern int popup_activated
P_ ((void));
1025 extern void initialize_frame_menubar
P_ ((struct frame
*));
1026 extern void free_frame_menubar
P_ ((struct frame
*));
1028 /* Defined in widget.c */
1030 #ifdef USE_X_TOOLKIT
1031 extern void widget_store_internal_border
P_ ((Widget
));
1034 /* Defined in xsmfns.c */
1036 extern void x_session_initialize
P_ ((struct x_display_info
*dpyinfo
));
1037 extern int x_session_check_input
P_ ((struct input_event
*bufp
));
1038 extern int x_session_have_connection
P_ ((void));
1039 extern void x_session_close
P_ ((void));
1042 /* XEmbed implementation. */
1044 #define XEMBED_VERSION 0
1048 XEMBED_MAPPED
= 1 << 0
1053 XEMBED_EMBEDDED_NOTIFY
= 0,
1054 XEMBED_WINDOW_ACTIVATE
= 1,
1055 XEMBED_WINDOW_DEACTIVATE
= 2,
1056 XEMBED_REQUEST_FOCUS
= 3,
1057 XEMBED_FOCUS_IN
= 4,
1058 XEMBED_FOCUS_OUT
= 5,
1059 XEMBED_FOCUS_NEXT
= 6,
1060 XEMBED_FOCUS_PREV
= 7,
1062 XEMBED_MODALITY_ON
= 10,
1063 XEMBED_MODALITY_OFF
= 11,
1064 XEMBED_REGISTER_ACCELERATOR
= 12,
1065 XEMBED_UNREGISTER_ACCELERATOR
= 13,
1066 XEMBED_ACTIVATE_ACCELERATOR
= 14
1071 XEMBED_FOCUS_CURRENT
= 0,
1072 XEMBED_FOCUS_FIRST
= 1,
1073 XEMBED_FOCUS_LAST
= 2
1076 enum xembed_modifier
1078 XEMBED_MODIFIER_SHIFT
= 1 << 0,
1079 XEMBED_MODIFIER_CONTROL
= 1 << 1,
1080 XEMBED_MODIFIER_ALT
= 1 << 2,
1081 XEMBED_MODIFIER_SUPER
= 1 << 3,
1082 XEMBED_MODIFIER_HYPER
= 1 << 4
1085 enum xembed_accelerator
1087 XEMBED_ACCELERATOR_OVERLOADED
= 1 << 0
1090 /* Defined in xterm.c */
1092 extern void xembed_set_info
P_ ((struct frame
*f
, enum xembed_info flags
));
1093 extern void xembed_send_message
P_ ((struct frame
*f
, Time time
,
1094 enum xembed_message message
,
1095 long detail
, long data1
, long data2
));
1097 /* Is the frame embedded into another application? */
1099 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1102 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1103 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1105 #define STORE_XCHAR2B(chp, b1, b2) \
1106 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1108 #define XCHAR2B_BYTE1(chp) \
1111 #define XCHAR2B_BYTE2(chp) \
1115 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1118 (nr).width = (rwidth), \
1119 (nr).height = (rheight))
1121 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1122 (do not change this comment) */