1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993, 1994, 1998, 1999 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
22 #include <X11/cursorfont.h>
23 #include <X11/Xutil.h>
24 #include <X11/keysym.h>
25 #include <X11/Xatom.h>
26 #include <X11/Xresource.h>
29 #include <X11/StringDefs.h>
30 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
31 #include <X11/CoreP.h> /* foul, but we need this to use our own
32 window inside a widget instead of one
34 #include <X11/StringDefs.h>
37 /* The class of this X application. */
38 #define EMACS_CLASS "Emacs"
40 /* Bookkeeping to distinguish X versions. */
42 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
43 be defined when we're using X11R5, since X11R5 has the features of
44 X11R4. If, in the future, we find we need more of these flags
45 (HAVE_X11R5, for example), code should always be written to test
46 the most recent flag first:
56 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
57 looks a lot like another one, consider moving the text into a macro
58 whose definition is configuration-dependent, but whose usage is
59 universal - like the stuff in systime.h.
61 It turns out that we can auto-detect whether we're being compiled
62 with X11R3 or X11R4 by looking for the flag macros for R4 structure
63 members that R3 doesn't have. */
65 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
66 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
68 AIX 3.2 is at least X11R4. */
69 #if (!defined AIX) || (defined AIX3_2)
75 /* In case someone has X11R5 on AIX 3.1,
76 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
81 #include <X11/Xlocale.h>
84 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
85 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
86 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
87 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
89 #define FONT_WIDTH(f) ((f)->max_bounds.width)
90 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
91 #define FONT_BASE(f) ((f)->ascent)
93 /* The mask of events that text windows always want to receive. This
94 includes mouse movement events, since handling the mouse-font text property
95 means that we must track mouse motion all the time. */
97 #define STANDARD_EVENT_SET \
101 | ButtonReleaseMask \
102 | PointerMotionMask \
103 | StructureNotifyMask \
107 | VisibilityChangeMask)
109 enum text_cursor_kinds
117 /* Structure recording X pixmap and reference count.
118 If REFCOUNT is 0 then this record is free to be reused. */
120 struct x_bitmap_record
125 /* Record some info about this pixmap. */
126 int height
, width
, depth
;
129 /* For each X display, we have a structure that records
130 information about it. */
132 struct x_display_info
134 /* Chain of all x_display_info structures. */
135 struct x_display_info
*next
;
137 /* Connection number (normally a file descriptor number). */
140 /* This says how to access this display in Xlib. */
143 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
144 The same cons cell also appears in x_display_name_list. */
145 Lisp_Object name_list_element
;
147 /* Number of frames that are on this display. */
150 /* The Screen this connection is connected to. */
153 /* Dots per inch of the screen. */
156 /* The Visual being used for this display. */
159 /* THe colormap being used. */
162 /* Number of panes on this screen. */
165 /* Dimensions of this screen. */
168 /* Mask of things that cause the mouse to be grabbed. */
171 /* Emacs bitmap-id of the default icon bitmap for this frame.
172 Or -1 if none has been allocated yet. */
175 /* The root window of this screen. */
178 /* The cursor to use for vertical scroll bars. */
179 Cursor vertical_scroll_bar_cursor
;
181 /* X Resource data base */
184 /* A table of all the fonts we have already loaded. */
185 struct font_info
*font_table
;
187 /* The current capacity of x_font_table. */
190 /* Minimum width over all characters in all fonts in font_table. */
191 int smallest_char_width
;
193 /* Minimum font height over all fonts in font_table. */
194 int smallest_font_height
;
196 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
197 GC scratch_cursor_gc
;
199 /* These variables describe the range of text currently shown in its
200 mouse-face, together with the window they apply to. As long as
201 the mouse stays within this range, we need not redraw anything on
202 its account. Rows and columns are glyph matrix positions in
203 MOUSE_FACE_WINDOW. */
204 int mouse_face_beg_row
, mouse_face_beg_col
;
205 int mouse_face_beg_x
, mouse_face_beg_y
;
206 int mouse_face_end_row
, mouse_face_end_col
;
207 int mouse_face_end_x
, mouse_face_end_y
;
208 int mouse_face_past_end
;
209 Lisp_Object mouse_face_window
;
210 int mouse_face_face_id
;
212 /* 1 if a mouse motion event came and we didn't handle it right away because
213 gc was in progress. */
214 int mouse_face_deferred_gc
;
216 /* FRAME and X, Y position of mouse when last checked for
217 highlighting. X and Y can be negative or out of range for the frame. */
218 struct frame
*mouse_face_mouse_frame
;
219 int mouse_face_mouse_x
, mouse_face_mouse_y
;
221 /* Nonzero means defer mouse-motion highlighting. */
222 int mouse_face_defer
;
224 int mouse_face_image_state
;
228 /* The number of fonts actually stored in x_font_table.
229 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
230 n_fonts <= font_table_size and font_table[i].name != 0. */
233 /* Pointer to bitmap records. */
234 struct x_bitmap_record
*bitmaps
;
236 /* Allocated size of bitmaps field. */
239 /* Last used bitmap index. */
242 /* Which modifier keys are on which modifier bits?
244 With each keystroke, X returns eight bits indicating which modifier
245 keys were held down when the key was pressed. The interpretation
246 of the top five modifier bits depends on what keys are attached
247 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
250 meta_mod_mask is a mask containing the bits used for the meta key.
251 It may have more than one bit set, if more than one modifier bit
252 has meta keys on it. Basically, if EVENT is a KeyPress event,
253 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
255 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
256 lock modifier bit, or zero otherwise. Non-alphabetic keys should
257 only be affected by the lock modifier bit if XK_Shift_Lock is in
258 use; XK_Caps_Lock should only affect alphabetic keys. With this
259 arrangement, the lock modifier should shift the character if
260 (EVENT.state & shift_lock_mask) != 0. */
261 int meta_mod_mask
, shift_lock_mask
;
263 /* These are like meta_mod_mask, but for different modifiers. */
264 int alt_mod_mask
, super_mod_mask
, hyper_mod_mask
;
266 /* Communication with window managers. */
267 Atom Xatom_wm_protocols
;
269 /* Kinds of protocol things we may receive. */
270 Atom Xatom_wm_take_focus
;
271 Atom Xatom_wm_save_yourself
;
272 Atom Xatom_wm_delete_window
;
274 /* Atom for indicating window state to the window manager. */
275 Atom Xatom_wm_change_state
;
277 /* Other WM communication */
278 Atom Xatom_wm_configure_denied
; /* When our config request is denied */
279 Atom Xatom_wm_window_moved
; /* When the WM moves us. */
281 /* EditRes protocol */
284 /* More atoms, which are selection types. */
285 Atom Xatom_CLIPBOARD
, Xatom_TIMESTAMP
, Xatom_TEXT
, Xatom_DELETE
,
287 Xatom_MULTIPLE
, Xatom_INCR
, Xatom_EMACS_TMP
, Xatom_TARGETS
, Xatom_NULL
,
290 /* More atoms for font properties. The last three are private
291 properties, see the comments in src/fontset.h. */
292 Atom Xatom_PIXEL_SIZE
,
293 Xatom_MULE_BASELINE_OFFSET
, Xatom_MULE_RELATIVE_COMPOSE
,
294 Xatom_MULE_DEFAULT_ASCENT
;
296 /* More atoms for Ghostscript support. */
297 Atom Xatom_DONE
, Xatom_PAGE
;
299 /* Atom used in toolkit scroll bar client messages. */
300 Atom Xatom_Scrollbar
;
303 struct kboard
*kboard
;
305 int cut_buffers_initialized
; /* Whether we're sure they all exist */
307 /* The frame (if any) which has the X window that has keyboard focus.
308 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
309 that a mere EnterNotify event can set this; if you need to know the
310 last frame specified in a FocusIn or FocusOut event, use
311 x_focus_event_frame. */
312 struct frame
*x_focus_frame
;
314 /* The last frame mentioned in a FocusIn or FocusOut event. This is
315 separate from x_focus_frame, because whether or not LeaveNotify
316 events cause us to lose focus depends on whether or not we have
317 received a FocusIn event for it. */
318 struct frame
*x_focus_event_frame
;
320 /* The frame which currently has the visual highlight, and should get
321 keyboard input (other sorts of input have the frame encoded in the
322 event). It points to the X focus frame's selected window's
323 frame. It differs from x_focus_frame when we're using a global
325 struct frame
*x_highlight_frame
;
327 /* The null pixel used for filling a character background with
328 background color of a gc. */
331 /* The gray pixmap. */
334 /* Cache of images. */
335 struct image_cache
*image_cache
;
338 /* XIM (X Input method). */
340 XIMStyles
*xim_styles
;
343 /* If non-null, a cache of the colors in the color map. Don't
344 use this directly, call x_color_cells instead. */
349 /* This checks to make sure we have a display. */
350 extern void check_x
P_ ((void));
352 extern struct frame
*x_window_to_frame
P_ ((struct x_display_info
*, int));
355 extern struct frame
*x_any_window_to_frame
P_ ((struct x_display_info
*, int));
356 extern struct frame
*x_non_menubar_window_to_frame
P_ ((struct x_display_info
*, int));
357 extern struct frame
*x_top_window_to_frame
P_ ((struct x_display_info
*, int));
360 /* This is a chain of structures for all the X displays currently in use. */
361 extern struct x_display_info
*x_display_list
;
363 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
364 one for each element of x_display_list and in the same order.
365 NAME is the name of the frame.
366 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
367 extern Lisp_Object x_display_name_list
;
369 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
370 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
372 /* A flag to control how to display unibyte 8-bit character. */
373 extern int unibyte_display_via_language_environment
;
375 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
376 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
378 extern struct x_display_info
*x_term_init
P_ ((Lisp_Object
, char *, char *));
380 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
381 extern void select_visual
P_ ((struct x_display_info
*));
382 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
383 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
384 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
385 extern void x_find_ccl_program
P_ ((struct font_info
*));
387 /* Each X frame object points to its own struct x_output object
388 in the output_data.x field. The x_output structure contains
389 the information that is specific to X windows. */
393 /* Position of the X window (x and y offsets in root window). */
397 /* Border width of the X window as known by the X window system. */
400 /* Size of the X window in pixels. */
401 int pixel_height
, pixel_width
;
403 /* Height of menu bar widget, in pixels.
404 Zero if not using the X toolkit.
405 When using the toolkit, this value is not meaningful
406 if the menubar is turned off. */
409 /* Height of a line, in pixels. */
412 /* The tiled border used when the mouse is out of the frame. */
415 /* Here are the Graphics Contexts for the default font. */
416 GC normal_gc
; /* Normal video */
417 GC reverse_gc
; /* Reverse video */
418 GC cursor_gc
; /* cursor drawing */
420 /* Width of the internal border. This is a line of background color
421 just inside the window's border. When the frame is selected,
422 a highlighting is displayed inside the internal border. */
423 int internal_border_width
;
425 /* The X window used for this frame.
426 May be zero while the frame object is being created
427 and the X window has not yet been created. */
430 /* The X window used for the bitmap icon;
431 or 0 if we don't have a bitmap icon. */
434 /* The X window that is the parent of this X window.
435 Usually this is a window that was made by the window manager,
436 but it can be the root window, and it can be explicitly specified
437 (see the explicit_parent field, below). */
441 /* The widget of this screen. This is the window of a "shell" widget. */
443 /* The XmPanedWindows... */
444 Widget column_widget
;
445 /* The widget of the edit portion of this screen; the window in
446 "window_desc" is inside of this. */
449 Widget menubar_widget
;
452 /* If >=0, a bitmap index. The indicated bitmap is used for the
456 /* Default ASCII font of this frame. */
459 /* The baseline offset of the default ASCII font. */
462 /* If a fontset is specified for this frame instead of font, this
463 value contains an ID of the fontset, else -1. */
466 /* Pixel values used for various purposes.
467 border_pixel may be -1 meaning use a gray tile. */
468 unsigned long background_pixel
;
469 unsigned long foreground_pixel
;
470 unsigned long cursor_pixel
;
471 unsigned long border_pixel
;
472 unsigned long mouse_pixel
;
473 unsigned long cursor_foreground_pixel
;
475 /* Foreground color for scroll bars. A value of -1 means use the
476 default (black for non-toolkit scroll bars). */
477 unsigned long scroll_bar_foreground_pixel
;
479 /* Background color for scroll bars. A value of -1 means use the
480 default (background color of the frame for non-toolkit scroll
482 unsigned long scroll_bar_background_pixel
;
484 /* Descriptor for the cursor in use for this window. */
486 Cursor nontext_cursor
;
487 Cursor modeline_cursor
;
491 /* Window whose cursor is busy_cursor. This window is temporarily
492 mapped to display a busy-cursor. */
495 /* Non-zero means busy cursor is currently displayed. */
498 /* Flag to set when the X window needs to be completely repainted. */
501 /* What kind of text cursor is drawn in this window right now?
502 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
503 enum text_cursor_kinds current_cursor
;
505 /* What kind of text cursor should we draw in the future?
506 This should always be filled_box_cursor or bar_cursor. */
507 enum text_cursor_kinds desired_cursor
;
509 /* Width of bar cursor (if we are using that). */
512 /* These are the current window manager hints. It seems that
513 XSetWMHints, when presented with an unset bit in the `flags'
514 member of the hints structure, does not leave the corresponding
515 attribute unchanged; rather, it resets that attribute to its
516 default value. For example, unless you set the `icon_pixmap'
517 field and the `IconPixmapHint' bit, XSetWMHints will forget what
518 your icon pixmap was. This is rather troublesome, since some of
519 the members (for example, `input' and `icon_pixmap') want to stay
520 the same throughout the execution of Emacs. So, we keep this
521 structure around, just leaving values in it and adding new bits
522 to the mask as we go. */
525 /* The size of the extra width currently allotted for vertical
526 scroll bars, in pixels. */
527 int vertical_scroll_bar_extra
;
529 /* The extra width currently allotted for the areas in which
530 truncation marks, continuation marks, and overlay arrows are
532 int flags_areas_extra
;
534 /* This is the gravity value for the specified window position. */
537 /* The geometry flags for this window. */
540 /* This is the Emacs structure for the X display this frame is on. */
541 struct x_display_info
*display_info
;
543 /* This is a button event that wants to activate the menubar.
544 We save it here until the command loop gets to think about it. */
545 XEvent
*saved_menu_event
;
547 /* This is the widget id used for this frame's menubar in lwlib. */
552 /* Nonzero means our parent is another application's window
553 and was explicitly specified. */
554 char explicit_parent
;
556 /* Nonzero means tried already to make this frame visible. */
557 char asked_for_visible
;
559 /* Nonzero if this frame was ever previously visible. */
560 char has_been_visible
;
563 /* Input context (currently, this means Compose key handler setup). */
569 /* Relief GCs, colors etc. */
576 black_relief
, white_relief
;
578 /* The background for which the above relief GCs were set up.
579 They are changed only when a different background is involved. */
580 unsigned long relief_background
;
583 /* Return the X window used for displaying data in frame F. */
584 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
586 /* Return the outermost X window associated with the frame F. */
588 #define FRAME_OUTER_WINDOW(f) (XtWindow ((f)->output_data.x->widget))
590 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
593 #define FRAME_FONT(f) ((f)->output_data.x->font)
594 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
595 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
596 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
597 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
599 /* Width of the default font of frame F. Must be defined by each
600 terminal specific header. */
601 #define FRAME_DEFAULT_FONT_WIDTH(F) FONT_WIDTH (FRAME_FONT (F))
603 /* This gives the x_display_info structure for the display F is on. */
604 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
606 /* This is the `Display *' which frame F is on. */
607 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
609 /* This is the `Screen *' which frame F is on. */
610 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
612 /* This is the Visual which frame F is on. */
613 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
615 /* This is the Colormap which frame F uses. */
616 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
618 /* This is the 'font_info *' which frame F has. */
619 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
621 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
622 #define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
623 #define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
625 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
627 #define FRAME_XIC(f) ((f)->output_data.x->xic)
628 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
629 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
630 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
631 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
633 /* Value is the smallest width of any character in any font on frame F. */
635 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
636 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
638 /* Value is the smallest height of any font on frame F. */
640 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
641 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
643 /* Return a pointer to the image cache of frame F. */
645 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
648 /* Pixel width of the bitmaps drawn to indicate truncation,
651 #define FRAME_FLAGS_BITMAP_WIDTH(f) 8
652 #define FRAME_FLAGS_BITMAP_HEIGHT(f) 8
654 /* Total width of a areas reserved for drawing truncation bitmaps,
655 continuation bitmaps and alike. The width is in canonical char
656 units of the frame. This must currently be the case because window
657 sizes aren't pixel values. If it weren't the case, we wouldn't be
658 able to split windows horizontally nicely. */
660 #define FRAME_X_FLAGS_AREA_COLS(F) \
661 ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1) \
662 / CANON_X_UNIT ((F)))
664 /* Total width of flags areas in pixels. */
666 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
667 (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
669 /* Pixel-width of the left flags area. */
671 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
672 (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
674 /* Pixel-width of the right flags area. Note that we are doing
675 integer arithmetic here, so don't loose a pixel if the total
676 width is an odd number. */
678 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F) \
679 (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
683 /* X-specific scroll bar stuff. */
685 /* We represent scroll bars as lisp vectors. This allows us to place
686 references to them in windows without worrying about whether we'll
687 end up with windows referring to dead scroll bars; the garbage
688 collector will free it when its time comes.
690 We use struct scroll_bar as a template for accessing fields of the
695 /* These fields are shared by all vectors. */
696 EMACS_INT size_from_Lisp_Vector_struct
;
697 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
699 /* The window we're a scroll bar for. */
702 /* The next and previous in the chain of scroll bars in this frame. */
703 Lisp_Object next
, prev
;
705 /* The X window representing this scroll bar. Since this is a full
706 32-bit quantity, we store it split into two 32-bit values. */
707 Lisp_Object x_window_low
, x_window_high
;
709 /* Same as above for the widget. */
710 Lisp_Object x_widget_low
, x_widget_high
;
712 /* The position and size of the scroll bar in pixels, relative to the
714 Lisp_Object top
, left
, width
, height
;
716 /* The starting and ending positions of the handle, relative to the
717 handle area (i.e. zero is the top position, not
718 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
719 hasn't been drawn yet.
721 These are not actually the locations where the beginning and end
722 are drawn; in order to keep handles from becoming invisible when
723 editing large files, we establish a minimum height by always
724 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
725 where they would be normally; the bottom and top are in a
726 different co-ordinate system. */
727 Lisp_Object start
, end
;
729 /* If the scroll bar handle is currently being dragged by the user,
730 this is the number of pixels from the top of the handle to the
731 place where the user grabbed it. If the handle isn't currently
732 being dragged, this is Qnil. */
733 Lisp_Object dragging
;
736 /* The number of elements a vector holding a struct scroll_bar needs. */
737 #define SCROLL_BAR_VEC_SIZE \
738 ((sizeof (struct scroll_bar) \
739 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
740 / sizeof (Lisp_Object))
742 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
743 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
746 /* Building a 32-bit C integer from two 16-bit lisp integers. */
747 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
749 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
750 #define SCROLL_BAR_UNPACK(low, high, int32) \
751 (XSETINT ((low), (int32) & 0xffff), \
752 XSETINT ((high), ((int32) >> 16) & 0xffff))
755 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
756 #define SCROLL_BAR_X_WINDOW(ptr) \
757 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
759 /* Store a window id in a struct scroll_bar. */
760 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
761 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
763 /* Extract the X widget of the scroll bar from a struct scroll_bar. */
764 #define SCROLL_BAR_X_WIDGET(ptr) \
765 ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
767 /* Store a widget id in a struct scroll_bar. */
768 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
769 (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
772 /* Return the inside width of a vertical scroll bar, given the outside
774 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
776 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
777 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
778 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
780 /* Return the length of the rectangle within which the top of the
781 handle must stay. This isn't equivalent to the inside height,
782 because the scroll bar handle has a minimum height.
784 This is the real range of motion for the scroll bar, so when we're
785 scaling buffer positions to scroll bar positions, we use this, not
786 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
787 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
788 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
790 /* Return the inside height of vertical scroll bar, given the outside
791 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
792 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
793 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
796 /* Border widths for scroll bars.
798 Scroll bar windows don't have any X borders; their border width is
799 set to zero, and we redraw borders ourselves. This makes the code
800 a bit cleaner, since we don't have to convert between outside width
801 (used when relating to the rest of the screen) and inside width
802 (used when sizing and drawing the scroll bar window itself).
804 The handle moves up and down/back and forth in a rectangle inset
805 from the edges of the scroll bar. These are widths by which we
806 inset the handle boundaries from the scroll bar edges. */
807 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
808 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
809 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
810 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
812 /* Minimum lengths for scroll bar handles, in pixels. */
813 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
815 /* Trimming off a few pixels from each side prevents
816 text from glomming up against the scroll bar */
817 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
820 /* Manipulating pixel sizes and character sizes.
821 Knowledge of which factors affect the overall size of the window should
822 be hidden in these macros, if that's possible.
824 Return the upper/left pixel position of the character cell on frame F
826 #define CHAR_TO_PIXEL_ROW(f, row) \
827 ((f)->output_data.x->internal_border_width \
828 + (row) * (f)->output_data.x->line_height)
829 #define CHAR_TO_PIXEL_COL(f, col) \
830 ((f)->output_data.x->internal_border_width \
831 + (col) * FONT_WIDTH ((f)->output_data.x->font))
833 /* Return the pixel width/height of frame F if it has
834 WIDTH columns/HEIGHT rows. */
835 #define CHAR_TO_PIXEL_WIDTH(f, width) \
836 (CHAR_TO_PIXEL_COL (f, width) \
837 + (f)->output_data.x->vertical_scroll_bar_extra \
838 + (f)->output_data.x->flags_areas_extra \
839 + (f)->output_data.x->internal_border_width)
840 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
841 (CHAR_TO_PIXEL_ROW (f, height) \
842 + (f)->output_data.x->internal_border_width)
845 /* Return the row/column (zero-based) of the character cell containing
846 the pixel on FRAME at ROW/COL. */
847 #define PIXEL_TO_CHAR_ROW(f, row) \
848 (((row) - (f)->output_data.x->internal_border_width) \
849 / (f)->output_data.x->line_height)
850 #define PIXEL_TO_CHAR_COL(f, col) \
851 (((col) - (f)->output_data.x->internal_border_width) \
852 / FONT_WIDTH ((f)->output_data.x->font))
854 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
856 #define PIXEL_TO_CHAR_WIDTH(f, width) \
857 (PIXEL_TO_CHAR_COL (f, ((width) \
858 - (f)->output_data.x->internal_border_width \
859 - (f)->output_data.x->flags_areas_extra \
860 - (f)->output_data.x->vertical_scroll_bar_extra)))
861 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
862 (PIXEL_TO_CHAR_ROW (f, ((height) \
863 - (f)->output_data.x->internal_border_width)))
866 /* If a struct input_event has a kind which is selection_request_event
867 or selection_clear_event, then its contents are really described
868 by this structure. */
870 /* For an event of kind selection_request_event,
871 this structure really describes the contents.
872 **Don't make this struct longer!**
873 If it overlaps the frame_or_window field of struct input_event,
874 that will cause GC to crash. */
875 struct selection_input_event
879 /* We spell it with an "o" here because X does. */
881 Atom selection
, target
, property
;
885 #define SELECTION_EVENT_DISPLAY(eventp) \
886 (((struct selection_input_event *) (eventp))->display)
887 /* We spell it with an "o" here because X does. */
888 #define SELECTION_EVENT_REQUESTOR(eventp) \
889 (((struct selection_input_event *) (eventp))->requestor)
890 #define SELECTION_EVENT_SELECTION(eventp) \
891 (((struct selection_input_event *) (eventp))->selection)
892 #define SELECTION_EVENT_TARGET(eventp) \
893 (((struct selection_input_event *) (eventp))->target)
894 #define SELECTION_EVENT_PROPERTY(eventp) \
895 (((struct selection_input_event *) (eventp))->property)
896 #define SELECTION_EVENT_TIME(eventp) \
897 (((struct selection_input_event *) (eventp))->time)
907 /* From xselect.c. */
909 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
910 void x_handle_property_notify
P_ ((XPropertyEvent
*));
914 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
915 Lisp_Object
, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
));
917 struct frame
*check_x_frame
P_ ((Lisp_Object
));
918 EXFUN (Fx_display_color_p
, 1);
919 EXFUN (Fx_display_grayscale_p
, 1);
920 int image_ascent
P_ ((struct image
*, struct face
*));
924 char *x_get_string_resource
P_ ((XrmDatabase
, char *, char *));
925 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
926 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
927 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
928 XrmRepresentation
, XrmValue
*));
929 void x_delete_display
P_ ((struct x_display_info
*));
930 void x_make_frame_visible
P_ ((struct frame
*));
931 void x_iconify_frame
P_ ((struct frame
*));
932 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
933 void x_set_offset
P_ ((struct frame
*, int, int, int));
934 void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
935 int x_catch_errors
P_ ((Display
*));
936 int x_had_errors_p
P_ ((Display
*));
937 void x_uncatch_errors
P_ ((Display
*, int));
938 void x_check_errors
P_ ((Display
*, char *));
939 int x_text_icon
P_ ((struct frame
*, char *));
940 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
941 void x_set_window_size
P_ ((struct frame
*, int, int, int));
942 void x_wm_set_window_state
P_ ((struct frame
*, int));
943 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
945 extern void pixel_to_glyph_coords
P_ ((struct frame
*, int, int,
946 int *, int *, XRectangle
*, int));
948 /* Defined in xterm.c */
950 extern void clear_mouse_face
P_ ((struct x_display_info
*));
951 extern void cancel_mouse_face
P_ ((struct frame
*));
952 extern void x_scroll_bar_clear
P_ ((struct frame
*));
953 extern void x_start_queuing_selection_requests
P_ ((Display
*));
954 extern void x_stop_queuing_selection_requests
P_ ((Display
*));
955 extern void x_update_cursor
P_ ((struct frame
*, int));
956 extern int x_text_icon
P_ ((struct frame
*, char *));
957 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
958 extern int x_catch_errors
P_ ((Display
*));
959 extern void x_check_errors
P_ ((Display
*, char *));
960 extern int x_had_errors_p
P_ ((Display
*));
961 extern void x_uncatch_errors
P_ ((Display
*, int));
962 extern Lisp_Object x_new_font
P_ ((struct frame
*, char *));
963 extern Lisp_Object x_new_fontset
P_ ((struct frame
*, char *));
964 extern void x_set_offset
P_ ((struct frame
*, int, int, int));
965 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
966 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
967 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
968 extern void x_raise_frame
P_ ((struct frame
*));
969 extern void x_lower_frame
P_ ((struct frame
*));
970 extern void x_make_frame_visible
P_ ((struct frame
*));
971 extern void x_make_frame_invisible
P_ ((struct frame
*));
972 extern void x_iconify_frame
P_ ((struct frame
*));
973 extern void x_destroy_window
P_ ((struct frame
*));
974 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
975 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
976 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
977 extern void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
978 extern void x_delete_display
P_ ((struct x_display_info
*));
979 extern void x_initialize
P_ ((void));
980 extern void x_display_cursor
P_ ((struct window
*, int, int, int, int, int));
981 extern void x_update_cursor
P_ ((struct frame
*, int));
982 extern unsigned long x_copy_color
P_ ((struct frame
*, unsigned long));
984 extern XtAppContext Xt_app_con
;
986 extern void x_query_colors
P_ ((struct frame
*f
, XColor
*, int));
987 extern void x_query_color
P_ ((struct frame
*f
, XColor
*));
989 /* Defined in xselect.c */
991 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
992 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
993 extern void x_handle_selection_request
P_ ((struct input_event
*));
994 extern void x_handle_selection_clear
P_ ((struct input_event
*));
995 extern void x_clear_frame_selections
P_ ((struct frame
*));
997 /* Defined in xfns.c */
999 extern int have_menus_p
P_ ((void));
1000 extern int x_bitmap_height
P_ ((struct frame
*, int));
1001 extern int x_bitmap_width
P_ ((struct frame
*, int));
1002 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
1003 extern void x_reference_bitmap
P_ ((struct frame
*, int));
1004 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
1005 unsigned int, unsigned int));
1006 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
1007 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
1008 extern void x_set_frame_parameters
P_ ((struct frame
*, Lisp_Object
));
1009 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1010 extern void x_report_frame_params
P_ ((struct frame
*, Lisp_Object
*));
1011 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1012 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1013 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1014 extern unsigned char * x_encode_text
P_ ((Lisp_Object
, Lisp_Object
,
1016 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1017 extern void create_frame_xic
P_ ((struct frame
*));
1018 extern void destroy_frame_xic
P_ ((struct frame
*));
1019 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1020 extern void xic_set_statusarea
P_ ((struct frame
*));
1021 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1022 extern int x_pixel_width
P_ ((struct frame
*));
1023 extern int x_pixel_height
P_ ((struct frame
*));
1024 extern int x_char_width
P_ ((struct frame
*));
1025 extern int x_char_height
P_ ((struct frame
*));
1026 extern int x_screen_planes
P_ ((struct frame
*));
1027 extern void x_sync
P_ ((struct frame
*));
1028 extern enum text_cursor_kinds x_specified_cursor_type
P_ ((Lisp_Object
, int *));
1029 extern int x_defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1031 extern void free_frame_xic
P_ ((struct frame
*));
1033 extern void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1035 /* Defined in xfaces.c */
1037 extern int frame_update_line_height
P_ ((struct frame
*));
1038 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1039 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1041 /* Defined in xmenu.c */
1043 extern void x_activate_menubar
P_ ((struct frame
*));
1044 extern int popup_activated
P_ ((void));
1045 extern void initialize_frame_menubar
P_ ((struct frame
*));
1047 /* Defined in widget.c */
1049 #ifdef USE_X_TOOLKIT
1050 extern void widget_store_internal_border
P_ ((Widget
));