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 ()
53 /* Bookkeeping to distinguish X versions. */
55 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
56 be defined when we're using X11R5, since X11R5 has the features of
57 X11R4. If, in the future, we find we need more of these flags
58 (HAVE_X11R5, for example), code should always be written to test
59 the most recent flag first:
69 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
70 looks a lot like another one, consider moving the text into a macro
71 whose definition is configuration-dependent, but whose usage is
72 universal - like the stuff in systime.h.
74 It turns out that we can auto-detect whether we're being compiled
75 with X11R3 or X11R4 by looking for the flag macros for R4 structure
76 members that R3 doesn't have. */
78 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
79 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
81 AIX 3.2 is at least X11R4. */
82 #if (!defined AIX) || (defined AIX3_2)
88 /* In case someone has X11R5 on AIX 3.1,
89 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
94 #include <X11/Xlocale.h>
97 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
98 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
99 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
100 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
102 #define FONT_WIDTH(f) ((f)->max_bounds.width)
103 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
104 #define FONT_BASE(f) ((f)->ascent)
105 #define FONT_DESCENT(f) ((f)->descent)
107 /* The mask of events that text windows always want to receive. This
108 includes mouse movement events, since handling the mouse-font text property
109 means that we must track mouse motion all the time. */
111 #define STANDARD_EVENT_SET \
115 | ButtonReleaseMask \
116 | PointerMotionMask \
117 | StructureNotifyMask \
121 | VisibilityChangeMask)
123 /* Structure recording X pixmap and reference count.
124 If REFCOUNT is 0 then this record is free to be reused. */
126 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. */
362 /* Whether or not to use XIM if we have it. */
366 /* This checks to make sure we have a display. */
367 extern void check_x
P_ ((void));
369 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
371 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
372 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
373 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
374 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
377 /* This is a chain of structures for all the X displays currently in use. */
378 extern struct x_display_info
*x_display_list
;
380 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
381 one for each element of x_display_list and in the same order.
382 NAME is the name of the frame.
383 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
384 extern Lisp_Object x_display_name_list
;
386 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
387 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
389 /* A flag to control how to display unibyte 8-bit character. */
390 extern int unibyte_display_via_language_environment
;
392 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
393 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
395 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
397 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
398 extern void select_visual
P_ ((struct x_display_info
*));
399 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
400 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
401 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
402 extern void x_find_ccl_program
P_ ((struct font_info
*));
403 extern Lisp_Object x_get_font_repertory
P_ ((struct frame
*,
404 struct font_info
*));
407 /* Each X frame object points to its own struct x_output object
408 in the output_data.x field. The x_output structure contains
409 the information that is specific to X windows. */
413 /* Height of menu bar widget, in pixels.
414 Zero if not using the X toolkit.
415 When using the toolkit, this value is not meaningful
416 if the menubar is turned off. */
419 /* Height of tool bar widget, in pixels.
420 Zero if not using an external tool bar. */
423 /* The tiled border used when the mouse is out of the frame. */
426 /* Here are the Graphics Contexts for the default font. */
427 GC normal_gc
; /* Normal video */
428 GC reverse_gc
; /* Reverse video */
429 GC cursor_gc
; /* cursor drawing */
431 /* The X window used for this frame.
432 May be zero while the frame object is being created
433 and the X window has not yet been created. */
436 /* The X window used for the bitmap icon;
437 or 0 if we don't have a bitmap icon. */
440 /* The X window that is the parent of this X window.
441 Usually this is a window that was made by the window manager,
442 but it can be the root window, and it can be explicitly specified
443 (see the explicit_parent field, below). */
447 /* The widget of this screen. This is the window of a "shell" widget. */
449 /* The XmPanedWindows... */
450 Widget column_widget
;
451 /* The widget of the edit portion of this screen; the window in
452 "window_desc" is inside of this. */
455 Widget menubar_widget
;
459 /* The widget of this screen. This is the window of a top widget. */
461 /* The widget of the edit portion of this screen; the window in
462 "window_desc" is inside of this. */
463 GtkWidget
*edit_widget
;
464 /* The widget used for laying out widgets vertically. */
465 GtkWidget
*vbox_widget
;
466 /* The menubar in this frame. */
467 GtkWidget
*menubar_widget
;
468 /* The tool bar in this frame */
469 GtkWidget
*toolbar_widget
;
470 /* The handle box that makes the tool bar detachable. */
471 GtkWidget
*handlebox_widget
;
473 /* The last size hints set. */
474 GdkGeometry size_hints
;
478 /* If >=0, a bitmap index. The indicated bitmap is used for the
482 /* Default ASCII font of this frame. */
485 /* The baseline offset of the default ASCII font. */
488 /* If a fontset is specified for this frame instead of font, this
489 value contains an ID of the fontset, else -1. */
492 /* Pixel values used for various purposes.
493 border_pixel may be -1 meaning use a gray tile. */
494 unsigned long background_pixel
;
495 unsigned long foreground_pixel
;
496 unsigned long cursor_pixel
;
497 unsigned long border_pixel
;
498 unsigned long mouse_pixel
;
499 unsigned long cursor_foreground_pixel
;
501 /* Foreground color for scroll bars. A value of -1 means use the
502 default (black for non-toolkit scroll bars). */
503 unsigned long scroll_bar_foreground_pixel
;
505 /* Background color for scroll bars. A value of -1 means use the
506 default (background color of the frame for non-toolkit scroll
508 unsigned long scroll_bar_background_pixel
;
510 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
511 let the scroll compute them itself. */
512 unsigned long scroll_bar_top_shadow_pixel
;
513 unsigned long scroll_bar_bottom_shadow_pixel
;
515 /* Descriptor for the cursor in use for this window. */
517 Cursor nontext_cursor
;
518 Cursor modeline_cursor
;
520 Cursor hourglass_cursor
;
521 Cursor horizontal_drag_cursor
;
523 /* Window whose cursor is hourglass_cursor. This window is temporarily
524 mapped to display an hourglass cursor. */
525 Window hourglass_window
;
527 /* Non-zero means hourglass cursor is currently displayed. */
528 unsigned hourglass_p
: 1;
530 /* Flag to set when the X window needs to be completely repainted. */
533 /* These are the current window manager hints. It seems that
534 XSetWMHints, when presented with an unset bit in the `flags'
535 member of the hints structure, does not leave the corresponding
536 attribute unchanged; rather, it resets that attribute to its
537 default value. For example, unless you set the `icon_pixmap'
538 field and the `IconPixmapHint' bit, XSetWMHints will forget what
539 your icon pixmap was. This is rather troublesome, since some of
540 the members (for example, `input' and `icon_pixmap') want to stay
541 the same throughout the execution of Emacs. So, we keep this
542 structure around, just leaving values in it and adding new bits
543 to the mask as we go. */
546 /* This is the Emacs structure for the X display this frame is on. */
547 struct x_display_info
*display_info
;
549 /* This is a button event that wants to activate the menubar.
550 We save it here until the command loop gets to think about it. */
551 XEvent
*saved_menu_event
;
553 /* This is the widget id used for this frame's menubar in lwlib. */
558 /* Nonzero means our parent is another application's window
559 and was explicitly specified. */
560 char explicit_parent
;
562 /* Nonzero means tried already to make this frame visible. */
563 char asked_for_visible
;
565 /* Nonzero if this frame was ever previously visible. */
566 char has_been_visible
;
569 /* Input context (currently, this means Compose key handler setup). */
575 /* Relief GCs, colors etc. */
582 black_relief
, white_relief
;
584 /* The background for which the above relief GCs were set up.
585 They are changed only when a different background is involved. */
586 unsigned long relief_background
;
588 /* Xt waits for a ConfigureNotify event from the window manager in
589 EmacsFrameSetCharSize when the shell widget is resized. For some
590 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
591 arrive for an unknown reason and Emacs hangs in Xt. If this is
592 zero, tell Xt not to wait. */
595 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
596 two might differ by a pixel, depending on WM */
597 int x_pixels_outer_diff
;
599 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
600 these may differ because this does not take into account possible
601 menubar. y_pixels_diff is with menubar height included */
602 int y_pixels_outer_diff
;
604 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
605 frame, or IMPLICIT if we received an EnterNotify.
606 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
610 #define No_Cursor (None)
614 /* Values for focus_state, used as bit mask.
615 EXPLICIT means we received a FocusIn for the frame and know it has
616 the focus. IMPLICIT means we recevied an EnterNotify and the frame
617 may have the focus if no window manager is running.
618 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
625 /* Return the X output data for frame F. */
626 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
628 /* Return the X window used for displaying data in frame F. */
629 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
631 /* Return the outermost X window associated with the frame F. */
633 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
634 XtWindow ((f)->output_data.x->widget) : \
638 #define GTK_WIDGET_TO_X_WIN(w) \
639 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
641 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
642 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
643 #define FRAME_OUTER_WINDOW(f) \
644 (FRAME_GTK_OUTER_WIDGET (f) ? \
645 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
649 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
650 #endif /* !USE_GTK */
654 #define FRAME_FONT(f) ((f)->output_data.x->font)
655 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
656 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
657 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
658 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
660 /* This gives the x_display_info structure for the display F is on. */
661 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
663 /* This is the `Display *' which frame F is on. */
664 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
666 /* This is the `Screen *' which frame F is on. */
667 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
668 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
670 /* This is the Visual which frame F is on. */
671 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
673 /* This is the Colormap which frame F uses. */
674 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
676 /* This is the 'font_info *' which frame F has. */
677 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
679 /* The difference in pixels between the top left corner of the
680 Emacs window (including possible window manager decorations)
681 and FRAME_X_WINDOW (f). */
682 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
683 ((f)->output_data.x->x_pixels_outer_diff)
684 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
685 ((f)->output_data.x->y_pixels_outer_diff \
686 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
689 #define FRAME_XIC(f) ((f)->output_data.x->xic)
690 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
691 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
692 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
693 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
695 /* Value is the smallest width of any character in any font on frame F. */
697 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
698 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
700 /* Value is the smallest height of any font on frame F. */
702 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
703 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
705 /* Return a pointer to the image cache of frame F. */
707 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
710 /* X-specific scroll bar stuff. */
712 /* We represent scroll bars as lisp vectors. This allows us to place
713 references to them in windows without worrying about whether we'll
714 end up with windows referring to dead scroll bars; the garbage
715 collector will free it when its time comes.
717 We use struct scroll_bar as a template for accessing fields of the
722 /* These fields are shared by all vectors. */
723 EMACS_INT size_from_Lisp_Vector_struct
;
724 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
726 /* The window we're a scroll bar for. */
729 /* The next and previous in the chain of scroll bars in this frame. */
730 Lisp_Object next
, prev
;
732 /* The X window representing this scroll bar. Since this is a full
733 32-bit quantity, we store it split into two 32-bit values. */
734 Lisp_Object x_window_low
, x_window_high
;
736 /* The position and size of the scroll bar in pixels, relative to the
738 Lisp_Object top
, left
, width
, height
;
740 /* The starting and ending positions of the handle, relative to the
741 handle area (i.e. zero is the top position, not
742 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
743 hasn't been drawn yet.
745 These are not actually the locations where the beginning and end
746 are drawn; in order to keep handles from becoming invisible when
747 editing large files, we establish a minimum height by always
748 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
749 where they would be normally; the bottom and top are in a
750 different co-ordinate system. */
751 Lisp_Object start
, end
;
753 /* If the scroll bar handle is currently being dragged by the user,
754 this is the number of pixels from the top of the handle to the
755 place where the user grabbed it. If the handle isn't currently
756 being dragged, this is Qnil. */
757 Lisp_Object dragging
;
760 /* The number of elements a vector holding a struct scroll_bar needs. */
761 #define SCROLL_BAR_VEC_SIZE \
762 ((sizeof (struct scroll_bar) \
763 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
764 / sizeof (Lisp_Object))
766 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
767 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
770 /* Building a 32-bit C integer from two 16-bit lisp integers. */
771 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
773 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
774 #define SCROLL_BAR_UNPACK(low, high, int32) \
775 (XSETINT ((low), (int32) & 0xffff), \
776 XSETINT ((high), ((int32) >> 16) & 0xffff))
779 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
780 #define SCROLL_BAR_X_WINDOW(ptr) \
781 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
783 /* Store a window id in a struct scroll_bar. */
784 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
785 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
787 /* Extract the X widget of the scroll bar from a struct scroll_bar.
788 XtWindowToWidget should be fast enough since Xt uses a hash table
789 to map windows to widgets. */
791 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
792 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
794 /* Store a widget id in a struct scroll_bar. */
796 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
798 Window window = XtWindow (w); \
799 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
803 /* Return the inside width of a vertical scroll bar, given the outside
805 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
807 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
808 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
809 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
811 /* Return the length of the rectangle within which the top of the
812 handle must stay. This isn't equivalent to the inside height,
813 because the scroll bar handle has a minimum height.
815 This is the real range of motion for the scroll bar, so when we're
816 scaling buffer positions to scroll bar positions, we use this, not
817 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
818 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
819 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
821 /* Return the inside height of vertical scroll bar, given the outside
822 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
823 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
824 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
827 /* Border widths for scroll bars.
829 Scroll bar windows don't have any X borders; their border width is
830 set to zero, and we redraw borders ourselves. This makes the code
831 a bit cleaner, since we don't have to convert between outside width
832 (used when relating to the rest of the screen) and inside width
833 (used when sizing and drawing the scroll bar window itself).
835 The handle moves up and down/back and forth in a rectangle inset
836 from the edges of the scroll bar. These are widths by which we
837 inset the handle boundaries from the scroll bar edges. */
838 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
839 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
840 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
841 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
843 /* Minimum lengths for scroll bar handles, in pixels. */
844 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
846 /* Trimming off a few pixels from each side prevents
847 text from glomming up against the scroll bar */
848 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
851 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
852 or SELECTION_CLEAR_EVENT, then its contents are really described
853 by this structure. */
855 /* For an event of kind SELECTION_REQUEST_EVENT,
856 this structure really describes the contents.
857 **Don't make this struct longer!**
858 If it overlaps the frame_or_window field of struct input_event,
859 that will cause GC to crash. */
860 struct selection_input_event
864 /* We spell it with an "o" here because X does. */
866 Atom selection
, target
, property
;
870 #define SELECTION_EVENT_DISPLAY(eventp) \
871 (((struct selection_input_event *) (eventp))->display)
872 /* We spell it with an "o" here because X does. */
873 #define SELECTION_EVENT_REQUESTOR(eventp) \
874 (((struct selection_input_event *) (eventp))->requestor)
875 #define SELECTION_EVENT_SELECTION(eventp) \
876 (((struct selection_input_event *) (eventp))->selection)
877 #define SELECTION_EVENT_TARGET(eventp) \
878 (((struct selection_input_event *) (eventp))->target)
879 #define SELECTION_EVENT_PROPERTY(eventp) \
880 (((struct selection_input_event *) (eventp))->property)
881 #define SELECTION_EVENT_TIME(eventp) \
882 (((struct selection_input_event *) (eventp))->time)
892 /* From xselect.c. */
894 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
895 void x_handle_property_notify
P_ ((XPropertyEvent
*));
899 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
900 Lisp_Object
, Lisp_Object
,
901 Lisp_Object
, Lisp_Object
));
902 struct frame
*check_x_frame
P_ ((Lisp_Object
));
903 EXFUN (Fx_display_color_p
, 1);
904 EXFUN (Fx_display_grayscale_p
, 1);
905 int image_ascent
P_ ((struct image
*, struct face
*));
906 extern void x_free_gcs
P_ ((struct frame
*));
910 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
911 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
912 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
913 XrmRepresentation
, XrmValue
*));
914 void x_delete_display
P_ ((struct x_display_info
*));
915 void x_make_frame_visible
P_ ((struct frame
*));
916 void x_iconify_frame
P_ ((struct frame
*));
917 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
918 int x_catch_errors
P_ ((Display
*));
919 int x_had_errors_p
P_ ((Display
*));
920 void x_uncatch_errors
P_ ((Display
*, int));
921 void x_check_errors
P_ ((Display
*, char *));
922 int x_text_icon
P_ ((struct frame
*, char *));
923 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
924 void x_set_window_size
P_ ((struct frame
*, int, int, int));
925 void x_wm_set_window_state
P_ ((struct frame
*, int));
926 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
928 /* Defined in xterm.c */
930 extern void cancel_mouse_face
P_ ((struct frame
*));
931 extern void x_scroll_bar_clear
P_ ((struct frame
*));
932 extern void x_start_queuing_selection_requests
P_ ((Display
*));
933 extern void x_stop_queuing_selection_requests
P_ ((Display
*));
934 extern int x_text_icon
P_ ((struct frame
*, char *));
935 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
936 extern int x_catch_errors
P_ ((Display
*));
937 extern void x_check_errors
P_ ((Display
*, char *));
938 extern int x_had_errors_p
P_ ((Display
*));
939 extern void x_uncatch_errors
P_ ((Display
*, int));
940 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
941 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
942 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
943 extern void x_raise_frame
P_ ((struct frame
*));
944 extern void x_lower_frame
P_ ((struct frame
*));
945 extern void x_make_frame_visible
P_ ((struct frame
*));
946 extern void x_make_frame_invisible
P_ ((struct frame
*));
947 extern void x_iconify_frame
P_ ((struct frame
*));
948 extern void x_free_frame_resources
P_ ((struct frame
*));
949 extern void x_destroy_window
P_ ((struct frame
*));
950 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
951 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
952 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
953 extern void x_delete_display
P_ ((struct x_display_info
*));
954 extern void x_initialize
P_ ((void));
955 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
957 extern XtAppContext Xt_app_con
;
959 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
960 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
961 extern void x_clear_area
P_ ((Display
*, Window
, int, int, int, int, int));
963 extern int x_dispatch_event
P_ ((XEvent
*, Display
*));
965 /* Defined in xselect.c */
967 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
968 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
969 extern void x_handle_selection_request
P_ ((struct input_event
*));
970 extern void x_handle_selection_clear
P_ ((struct input_event
*));
971 extern void x_clear_frame_selections
P_ ((struct frame
*));
973 /* Defined in xfns.c */
975 extern int have_menus_p
P_ ((void));
976 extern int x_bitmap_height
P_ ((struct frame
*, int));
977 extern int x_bitmap_width
P_ ((struct frame
*, int));
978 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
979 extern void x_reference_bitmap
P_ ((struct frame
*, int));
980 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
981 unsigned int, unsigned int));
982 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
983 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
984 extern int x_create_bitmap_mask
P_ ((struct frame
* , int));
987 extern int xg_set_icon
P_ ((struct frame
*, Lisp_Object
));
990 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
991 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
992 extern void x_set_border_pixel
P_ ((struct frame
*, int));
993 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
994 extern unsigned char * x_encode_text
P_ ((Lisp_Object
, Lisp_Object
, int,
996 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
997 extern void create_frame_xic
P_ ((struct frame
*));
998 extern void destroy_frame_xic
P_ ((struct frame
*));
999 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1000 extern void xic_set_statusarea
P_ ((struct frame
*));
1001 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1002 extern int x_pixel_width
P_ ((struct frame
*));
1003 extern int x_pixel_height
P_ ((struct frame
*));
1004 extern int x_char_width
P_ ((struct frame
*));
1005 extern int x_char_height
P_ ((struct frame
*));
1006 extern int x_screen_planes
P_ ((struct frame
*));
1007 extern void x_sync
P_ ((struct frame
*));
1008 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1010 extern void free_frame_xic
P_ ((struct frame
*));
1012 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1014 /* Defined in xfaces.c */
1016 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1017 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1018 extern void x_free_dpy_colors
P_ ((Display
*, Screen
*, Colormap
,
1019 unsigned long *, int));
1021 /* Defined in xmenu.c */
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
*));
1027 /* Defined in widget.c */
1029 #ifdef USE_X_TOOLKIT
1030 extern void widget_store_internal_border
P_ ((Widget
));
1033 /* Defined in xsmfns.c */
1035 extern void x_session_initialize
P_ ((void));
1036 extern int x_session_check_input
P_ ((struct input_event
*bufp
,
1038 extern int x_session_have_connection
P_ ((void));
1041 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1042 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1044 #define STORE_XCHAR2B(chp, b1, b2) \
1045 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1047 #define XCHAR2B_BYTE1(chp) \
1050 #define XCHAR2B_BYTE2(chp) \
1054 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1057 (nr).width = (rwidth), \
1058 (nr).height = (rheight))