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. */
82 #include <X11/Xlocale.h>
85 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
86 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
87 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
88 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
90 #define FONT_WIDTH(f) ((f)->max_bounds.width)
91 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
92 #define FONT_BASE(f) ((f)->ascent)
94 /* The mask of events that text windows always want to receive. This
95 includes mouse movement events, since handling the mouse-font text property
96 means that we must track mouse motion all the time. */
98 #define STANDARD_EVENT_SET \
102 | ButtonReleaseMask \
103 | PointerMotionMask \
104 | StructureNotifyMask \
108 | VisibilityChangeMask)
110 /* This checks to make sure we have a display. */
111 extern void check_x ();
113 extern struct frame
*x_window_to_frame ();
116 extern struct frame
*x_any_window_to_frame ();
117 extern struct frame
*x_non_menubar_window_to_frame ();
118 extern struct frame
*x_top_window_to_frame ();
121 enum text_cursor_kinds
129 /* Structure recording X pixmap and reference count.
130 If REFCOUNT is 0 then this record is free to be reused. */
132 struct x_bitmap_record
137 /* Record some info about this pixmap. */
138 int height
, width
, depth
;
141 /* For each X display, we have a structure that records
142 information about it. */
144 struct x_display_info
146 /* Chain of all x_display_info structures. */
147 struct x_display_info
*next
;
149 /* Connection number (normally a file descriptor number). */
152 /* This says how to access this display in Xlib. */
155 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
156 The same cons cell also appears in x_display_name_list. */
157 Lisp_Object name_list_element
;
159 /* Number of frames that are on this display. */
162 /* The Screen this connection is connected to. */
165 /* Dots per inch of the screen. */
168 /* The Visual being used for this display. */
171 /* THe colormap being used. */
174 /* Number of panes on this screen. */
177 /* Dimensions of this screen. */
180 /* Mask of things that cause the mouse to be grabbed. */
183 /* Emacs bitmap-id of the default icon bitmap for this frame.
184 Or -1 if none has been allocated yet. */
187 /* The root window of this screen. */
190 /* The cursor to use for vertical scroll bars. */
191 Cursor vertical_scroll_bar_cursor
;
193 /* X Resource data base */
196 /* A table of all the fonts we have already loaded. */
197 struct font_info
*font_table
;
199 /* The current capacity of x_font_table. */
202 /* Minimum width over all characters in all fonts in font_table. */
203 int smallest_char_width
;
205 /* Minimum font height over all fonts in font_table. */
206 int smallest_font_height
;
208 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
209 GC scratch_cursor_gc
;
211 /* These variables describe the range of text currently shown in its
212 mouse-face, together with the window they apply to. As long as
213 the mouse stays within this range, we need not redraw anything on
214 its account. Rows and columns are glyph matrix positions in
215 MOUSE_FACE_WINDOW. */
216 int mouse_face_beg_row
, mouse_face_beg_col
;
217 int mouse_face_beg_x
, mouse_face_beg_y
;
218 int mouse_face_end_row
, mouse_face_end_col
;
219 int mouse_face_end_x
, mouse_face_end_y
;
220 int mouse_face_past_end
;
221 Lisp_Object mouse_face_window
;
222 int mouse_face_face_id
;
224 /* 1 if a mouse motion event came and we didn't handle it right away because
225 gc was in progress. */
226 int mouse_face_deferred_gc
;
228 /* FRAME and X, Y position of mouse when last checked for
229 highlighting. X and Y can be negative or out of range for the frame. */
230 struct frame
*mouse_face_mouse_frame
;
231 int mouse_face_mouse_x
, mouse_face_mouse_y
;
233 /* Nonzero means defer mouse-motion highlighting. */
234 int mouse_face_defer
;
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
,
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
;
356 /* This is a chain of structures for all the X displays currently in use. */
357 extern struct x_display_info
*x_display_list
;
359 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
360 one for each element of x_display_list and in the same order.
361 NAME is the name of the frame.
362 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
363 extern Lisp_Object x_display_name_list
;
365 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
366 extern Lisp_Object Vx_pixel_size_width_font_regexp
;
368 /* A flag to control how to display unibyte 8-bit character. */
369 extern int unibyte_display_via_language_environment
;
371 struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
372 struct x_display_info
*x_display_info_for_name ();
374 extern struct x_display_info
*x_term_init ();
376 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
377 extern void select_visual
P_ ((struct x_display_info
*));
378 extern struct font_info
*x_get_font_info(), *x_load_font (), *x_query_font ();
379 extern void x_find_ccl_program();
381 /* Each X frame object points to its own struct x_output object
382 in the output_data.x field. The x_output structure contains
383 the information that is specific to X windows. */
387 /* Position of the X window (x and y offsets in root window). */
391 /* Border width of the X window as known by the X window system. */
394 /* Size of the X window in pixels. */
395 int pixel_height
, pixel_width
;
397 /* Height of menu bar widget, in pixels.
398 Zero if not using the X toolkit.
399 When using the toolkit, this value is not meaningful
400 if the menubar is turned off. */
403 /* Height of a line, in pixels. */
406 /* The tiled border used when the mouse is out of the frame. */
409 /* Here are the Graphics Contexts for the default font. */
410 GC normal_gc
; /* Normal video */
411 GC reverse_gc
; /* Reverse video */
412 GC cursor_gc
; /* cursor drawing */
414 /* Width of the internal border. This is a line of background color
415 just inside the window's border. When the frame is selected,
416 a highlighting is displayed inside the internal border. */
417 int internal_border_width
;
419 /* The X window used for this frame.
420 May be zero while the frame object is being created
421 and the X window has not yet been created. */
424 /* The X window used for the bitmap icon;
425 or 0 if we don't have a bitmap icon. */
428 /* The X window that is the parent of this X window.
429 Usually this is a window that was made by the window manager,
430 but it can be the root window, and it can be explicitly specified
431 (see the explicit_parent field, below). */
435 /* The widget of this screen. This is the window of a "shell" widget. */
437 /* The XmPanedWindows... */
438 Widget column_widget
;
439 /* The widget of the edit portion of this screen; the window in
440 "window_desc" is inside of this. */
443 Widget menubar_widget
;
446 /* If >=0, a bitmap index. The indicated bitmap is used for the
450 /* Default ASCII font of this frame. */
453 /* The baseline offset of the default ASCII font. */
456 /* If a fontset is specified for this frame instead of font, this
457 value contains an ID of the fontset, else -1. */
460 /* Pixel values used for various purposes.
461 border_pixel may be -1 meaning use a gray tile. */
462 unsigned long background_pixel
;
463 unsigned long foreground_pixel
;
464 unsigned long cursor_pixel
;
465 unsigned long border_pixel
;
466 unsigned long mouse_pixel
;
467 unsigned long cursor_foreground_pixel
;
469 /* Foreground color for scroll bars. A value of -1 means use the
470 default (black for non-toolkit scroll bars). */
471 unsigned long scroll_bar_foreground_pixel
;
473 /* Background color for scroll bars. A value of -1 means use the
474 default (background color of the frame for non-toolkit scroll
476 unsigned long scroll_bar_background_pixel
;
478 /* Descriptor for the cursor in use for this window. */
480 Cursor nontext_cursor
;
481 Cursor modeline_cursor
;
485 /* Window whose cursor is busy_cursor. This window is temporarily
486 mapped to display a busy-cursor. */
489 /* Non-zero means busy cursor is currently displayed. */
492 /* Flag to set when the X window needs to be completely repainted. */
495 /* What kind of text cursor is drawn in this window right now?
496 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
497 enum text_cursor_kinds current_cursor
;
499 /* What kind of text cursor should we draw in the future?
500 This should always be filled_box_cursor or bar_cursor. */
501 enum text_cursor_kinds desired_cursor
;
503 /* Width of bar cursor (if we are using that). */
506 /* These are the current window manager hints. It seems that
507 XSetWMHints, when presented with an unset bit in the `flags'
508 member of the hints structure, does not leave the corresponding
509 attribute unchanged; rather, it resets that attribute to its
510 default value. For example, unless you set the `icon_pixmap'
511 field and the `IconPixmapHint' bit, XSetWMHints will forget what
512 your icon pixmap was. This is rather troublesome, since some of
513 the members (for example, `input' and `icon_pixmap') want to stay
514 the same throughout the execution of Emacs. So, we keep this
515 structure around, just leaving values in it and adding new bits
516 to the mask as we go. */
519 /* The size of the extra width currently allotted for vertical
520 scroll bars, in pixels. */
521 int vertical_scroll_bar_extra
;
523 /* The extra width currently allotted for the areas in which
524 truncation marks, continuation marks, and overlay arrows are
526 int flags_areas_extra
;
528 /* This is the gravity value for the specified window position. */
531 /* The geometry flags for this window. */
534 /* This is the Emacs structure for the X display this frame is on. */
535 struct x_display_info
*display_info
;
537 /* This is a button event that wants to activate the menubar.
538 We save it here until the command loop gets to think about it. */
539 XEvent
*saved_menu_event
;
541 /* This is the widget id used for this frame's menubar in lwlib. */
546 /* Nonzero means our parent is another application's window
547 and was explicitly specified. */
548 char explicit_parent
;
550 /* Nonzero means tried already to make this frame visible. */
551 char asked_for_visible
;
553 /* Nonzero if this frame was ever previously visible. */
554 char has_been_visible
;
557 /* Input context (currently, this means Compose key handler setup). */
563 /* Relief GCs, colors etc. */
570 black_relief
, white_relief
;
572 /* The background for which the above relief GCs were set up.
573 They are changed only when a different background is involved. */
574 unsigned long relief_background
;
577 /* Return the X window used for displaying data in frame F. */
578 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
580 /* Return the outermost X window associated with the frame F. */
582 #define FRAME_OUTER_WINDOW(f) (XtWindow ((f)->output_data.x->widget))
584 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
587 #define FRAME_FONT(f) ((f)->output_data.x->font)
588 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
589 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
590 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
591 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
593 /* Width of the default font of frame F. Must be defined by each
594 terminal specific header. */
595 #define FRAME_DEFAULT_FONT_WIDTH(F) FONT_WIDTH (FRAME_FONT (F))
597 /* This gives the x_display_info structure for the display F is on. */
598 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
600 /* This is the `Display *' which frame F is on. */
601 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
603 /* This is the `Screen *' which frame F is on. */
604 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
606 /* This is the Visual which frame F is on. */
607 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
609 /* This is the Colormap which frame F uses. */
610 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
612 /* This is the 'font_info *' which frame F has. */
613 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
615 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
616 #define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
617 #define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
619 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
621 #define FRAME_XIC(f) ((f)->output_data.x->xic)
622 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
623 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
624 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
625 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
627 /* Value is the smallest width of any character in any font on frame F. */
629 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
630 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
632 /* Value is the smallest height of any font on frame F. */
634 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
635 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
637 /* Return a pointer to the image cache of frame F. */
639 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
642 /* Pixel width of the bitmaps drawn to indicate truncation,
645 #define FRAME_FLAGS_BITMAP_WIDTH(f) 8
646 #define FRAME_FLAGS_BITMAP_HEIGHT(f) 8
648 /* Total width of a areas reserved for drawing truncation bitmaps,
649 continuation bitmaps and alike. The width is in canonical char
650 units of the frame. This must currently be the case because window
651 sizes aren't pixel values. If it weren't the case, we wouldn't be
652 able to split windows horizontally nicely. */
654 #define FRAME_X_FLAGS_AREA_COLS(F) \
655 ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1) \
656 / CANON_X_UNIT ((F)))
658 /* Total width of flags areas in pixels. */
660 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
661 (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
663 /* Pixel-width of the left flags area. */
665 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
666 (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
668 /* Pixel-width of the right flags area. Note that we are doing
669 integer arithmetic here, so don't loose a pixel if the total
670 width is an odd number. */
672 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F) \
673 (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
677 /* X-specific scroll bar stuff. */
679 /* We represent scroll bars as lisp vectors. This allows us to place
680 references to them in windows without worrying about whether we'll
681 end up with windows referring to dead scroll bars; the garbage
682 collector will free it when its time comes.
684 We use struct scroll_bar as a template for accessing fields of the
689 /* These fields are shared by all vectors. */
690 EMACS_INT size_from_Lisp_Vector_struct
;
691 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
693 /* The window we're a scroll bar for. */
696 /* The next and previous in the chain of scroll bars in this frame. */
697 Lisp_Object next
, prev
;
699 /* The X window representing this scroll bar. Since this is a full
700 32-bit quantity, we store it split into two 32-bit values. */
701 Lisp_Object x_window_low
, x_window_high
;
703 /* Same as above for the widget. */
704 Lisp_Object x_widget_low
, x_widget_high
;
706 /* The position and size of the scroll bar in pixels, relative to the
708 Lisp_Object top
, left
, width
, height
;
710 /* The starting and ending positions of the handle, relative to the
711 handle area (i.e. zero is the top position, not
712 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
713 hasn't been drawn yet.
715 These are not actually the locations where the beginning and end
716 are drawn; in order to keep handles from becoming invisible when
717 editing large files, we establish a minimum height by always
718 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
719 where they would be normally; the bottom and top are in a
720 different co-ordinate system. */
721 Lisp_Object start
, end
;
723 /* If the scroll bar handle is currently being dragged by the user,
724 this is the number of pixels from the top of the handle to the
725 place where the user grabbed it. If the handle isn't currently
726 being dragged, this is Qnil. */
727 Lisp_Object dragging
;
730 /* The number of elements a vector holding a struct scroll_bar needs. */
731 #define SCROLL_BAR_VEC_SIZE \
732 ((sizeof (struct scroll_bar) \
733 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
734 / sizeof (Lisp_Object))
736 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
737 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
740 /* Building a 32-bit C integer from two 16-bit lisp integers. */
741 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
743 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
744 #define SCROLL_BAR_UNPACK(low, high, int32) \
745 (XSETINT ((low), (int32) & 0xffff), \
746 XSETINT ((high), ((int32) >> 16) & 0xffff))
749 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
750 #define SCROLL_BAR_X_WINDOW(ptr) \
751 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
753 /* Store a window id in a struct scroll_bar. */
754 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
755 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
757 /* Extract the X widget of the scroll bar from a struct scroll_bar. */
758 #define SCROLL_BAR_X_WIDGET(ptr) \
759 ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
761 /* Store a widget id in a struct scroll_bar. */
762 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
763 (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
766 /* Return the inside width of a vertical scroll bar, given the outside
768 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
770 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
771 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
772 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
774 /* Return the length of the rectangle within which the top of the
775 handle must stay. This isn't equivalent to the inside height,
776 because the scroll bar handle has a minimum height.
778 This is the real range of motion for the scroll bar, so when we're
779 scaling buffer positions to scroll bar positions, we use this, not
780 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
781 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
782 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
784 /* Return the inside height of vertical scroll bar, given the outside
785 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
786 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
787 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
790 /* Border widths for scroll bars.
792 Scroll bar windows don't have any X borders; their border width is
793 set to zero, and we redraw borders ourselves. This makes the code
794 a bit cleaner, since we don't have to convert between outside width
795 (used when relating to the rest of the screen) and inside width
796 (used when sizing and drawing the scroll bar window itself).
798 The handle moves up and down/back and forth in a rectangle inset
799 from the edges of the scroll bar. These are widths by which we
800 inset the handle boundaries from the scroll bar edges. */
801 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
802 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
803 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
804 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
806 /* Minimum lengths for scroll bar handles, in pixels. */
807 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
809 /* Trimming off a few pixels from each side prevents
810 text from glomming up against the scroll bar */
811 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
814 /* Manipulating pixel sizes and character sizes.
815 Knowledge of which factors affect the overall size of the window should
816 be hidden in these macros, if that's possible.
818 Return the upper/left pixel position of the character cell on frame F
820 #define CHAR_TO_PIXEL_ROW(f, row) \
821 ((f)->output_data.x->internal_border_width \
822 + (row) * (f)->output_data.x->line_height)
823 #define CHAR_TO_PIXEL_COL(f, col) \
824 ((f)->output_data.x->internal_border_width \
825 + (col) * FONT_WIDTH ((f)->output_data.x->font))
827 /* Return the pixel width/height of frame F if it has
828 WIDTH columns/HEIGHT rows. */
829 #define CHAR_TO_PIXEL_WIDTH(f, width) \
830 (CHAR_TO_PIXEL_COL (f, width) \
831 + (f)->output_data.x->vertical_scroll_bar_extra \
832 + (f)->output_data.x->flags_areas_extra \
833 + (f)->output_data.x->internal_border_width)
834 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
835 (CHAR_TO_PIXEL_ROW (f, height) \
836 + (f)->output_data.x->internal_border_width)
839 /* Return the row/column (zero-based) of the character cell containing
840 the pixel on FRAME at ROW/COL. */
841 #define PIXEL_TO_CHAR_ROW(f, row) \
842 (((row) - (f)->output_data.x->internal_border_width) \
843 / (f)->output_data.x->line_height)
844 #define PIXEL_TO_CHAR_COL(f, col) \
845 (((col) - (f)->output_data.x->internal_border_width) \
846 / FONT_WIDTH ((f)->output_data.x->font))
848 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
850 #define PIXEL_TO_CHAR_WIDTH(f, width) \
851 (PIXEL_TO_CHAR_COL (f, ((width) \
852 - (f)->output_data.x->internal_border_width \
853 - (f)->output_data.x->flags_areas_extra \
854 - (f)->output_data.x->vertical_scroll_bar_extra)))
855 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
856 (PIXEL_TO_CHAR_ROW (f, ((height) \
857 - (f)->output_data.x->internal_border_width)))
860 /* If a struct input_event has a kind which is selection_request_event
861 or selection_clear_event, then its contents are really described
862 by this structure. */
864 /* For an event of kind selection_request_event,
865 this structure really describes the contents.
866 **Don't make this struct longer!**
867 If it overlaps the frame_or_window field of struct input_event,
868 that will cause GC to crash. */
869 struct selection_input_event
873 /* We spell it with an "o" here because X does. */
875 Atom selection
, target
, property
;
879 #define SELECTION_EVENT_DISPLAY(eventp) \
880 (((struct selection_input_event *) (eventp))->display)
881 /* We spell it with an "o" here because X does. */
882 #define SELECTION_EVENT_REQUESTOR(eventp) \
883 (((struct selection_input_event *) (eventp))->requestor)
884 #define SELECTION_EVENT_SELECTION(eventp) \
885 (((struct selection_input_event *) (eventp))->selection)
886 #define SELECTION_EVENT_TARGET(eventp) \
887 (((struct selection_input_event *) (eventp))->target)
888 #define SELECTION_EVENT_PROPERTY(eventp) \
889 (((struct selection_input_event *) (eventp))->property)
890 #define SELECTION_EVENT_TIME(eventp) \
891 (((struct selection_input_event *) (eventp))->time)
899 /* From xselect.c. */
901 void x_handle_selection_notify
P_ ((XSelectionEvent
*));
902 void x_handle_property_notify
P_ ((XPropertyEvent
*));
906 void x_real_positions
P_ ((struct frame
*, int *, int *));
907 void x_destroy_bitmap
P_ ((struct frame
*, int));
908 int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
909 int x_create_bitmap_from_data
P_ ((struct frame
*, char *, unsigned,
911 void x_reference_bitmap
P_ ((struct frame
*, int));
912 void x_sync
P_ ((struct frame
*));
913 int x_bitmap_pixmap
P_ ((struct frame
*, int));
914 void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
915 int x_bitmap_height
P_ ((struct frame
*, int));
916 int x_bitmap_width
P_ ((struct frame
*, int));
917 int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
918 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
919 Lisp_Object
, Lisp_Object
,
920 Lisp_Object
, Lisp_Object
));
921 struct frame
*check_x_frame
P_ ((Lisp_Object
));
922 EXFUN (Fx_display_color_p
, 1);
923 EXFUN (Fx_display_grayscale_p
, 1);
927 char *x_get_string_resource
P_ ((XrmDatabase
, char *, char *));
928 char *x_get_customization_string
P_ ((XrmDatabase
, char *, char *));
929 XrmDatabase x_load_resources
P_ ((Display
*, char *, char *, char *));
930 int x_get_resource
P_ ((XrmDatabase
, char *, char *,
931 XrmRepresentation
, XrmValue
*));
932 void x_delete_display
P_ ((struct x_display_info
*));
933 void x_make_frame_visible
P_ ((struct frame
*));
934 void x_iconify_frame
P_ ((struct frame
*));
935 void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
936 void x_set_offset
P_ ((struct frame
*, int, int, int));
937 void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
938 int x_catch_errors
P_ ((Display
*));
939 int x_had_errors_p
P_ ((Display
*));
940 void x_uncatch_errors
P_ ((Display
*, int));
941 void x_check_errors
P_ ((Display
*, char *));
942 int x_text_icon
P_ ((struct frame
*, char *));
943 int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
944 void x_set_window_size
P_ ((struct frame
*, int, int, int));
945 void x_wm_set_window_state
P_ ((struct frame
*, int));
946 int x_alloc_nearest_color
P_ ((struct frame
*, Colormap
, XColor
*));
948 extern void pixel_to_glyph_coords
P_ ((struct frame
*, int, int,
949 int *, int *, XRectangle
*, int));
951 /* Defined in xterm.c */
953 extern void clear_mouse_face
P_ ((struct x_display_info
*));
954 extern void cancel_mouse_face
P_ ((struct frame
*));
955 extern void x_scroll_bar_clear
P_ ((struct frame
*));
956 extern void x_start_queuing_selection_requests
P_ ((Display
*));
957 extern void x_stop_queuing_selection_requests
P_ ((Display
*));
958 extern void x_update_cursor
P_ ((struct frame
*, int));
959 extern int x_text_icon
P_ ((struct frame
*, char *));
960 extern int x_bitmap_icon
P_ ((struct frame
*, Lisp_Object
));
961 extern int x_catch_errors
P_ ((Display
*));
962 extern void x_check_errors
P_ ((Display
*, char *));
963 extern int x_had_errors_p
P_ ((Display
*));
964 extern void x_uncatch_errors
P_ ((Display
*, int));
965 extern Lisp_Object x_new_font
P_ ((struct frame
*, char *));
966 extern Lisp_Object x_new_fontset
P_ ((struct frame
*, char *));
967 extern void x_set_offset
P_ ((struct frame
*, int, int, int));
968 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
969 extern void x_set_mouse_position
P_ ((struct frame
*, int, int));
970 extern void x_set_mouse_pixel_position
P_ ((struct frame
*, int, int));
971 extern void x_raise_frame
P_ ((struct frame
*));
972 extern void x_lower_frame
P_ ((struct frame
*));
973 extern void x_make_frame_visible
P_ ((struct frame
*));
974 extern void x_make_frame_invisible
P_ ((struct frame
*));
975 extern void x_iconify_frame
P_ ((struct frame
*));
976 extern void x_destroy_window
P_ ((struct frame
*));
977 extern void x_wm_set_size_hint
P_ ((struct frame
*, long, int));
978 extern void x_wm_set_window_state
P_ ((struct frame
*, int));
979 extern void x_wm_set_icon_pixmap
P_ ((struct frame
*, int));
980 extern void x_wm_set_icon_position
P_ ((struct frame
*, int, int));
981 extern void x_delete_display
P_ ((struct x_display_info
*));
982 extern void x_initialize
P_ ((void));
983 void x_display_cursor
P_ ((struct window
*, int, int, int, int, int));
984 void x_update_cursor
P_ ((struct frame
*, int));
986 /* Defined in xselect.c */
988 extern void x_handle_property_notify
P_ ((XPropertyEvent
*));
989 extern void x_handle_selection_notify
P_ ((XSelectionEvent
*));
990 extern void x_handle_selection_request
P_ ((struct input_event
*));
991 extern void x_handle_selection_clear
P_ ((struct input_event
*));
992 extern void x_clear_frame_selections
P_ ((struct frame
*));
994 /* Defined in xfns.c */
996 extern int have_menus_p
P_ ((void));
997 extern int x_bitmap_height
P_ ((struct frame
*, int));
998 extern int x_bitmap_width
P_ ((struct frame
*, int));
999 extern int x_bitmap_pixmap
P_ ((struct frame
*, int));
1000 extern void x_reference_bitmap
P_ ((struct frame
*, int));
1001 extern int x_create_bitmap_from_data
P_ ((struct frame
*, char *,
1002 unsigned int, unsigned int));
1003 extern int x_create_bitmap_from_file
P_ ((struct frame
*, Lisp_Object
));
1004 extern void x_destroy_bitmap
P_ ((struct frame
*, int));
1005 extern void x_set_frame_parameters
P_ ((struct frame
*, Lisp_Object
));
1006 extern void x_real_positions
P_ ((struct frame
*, int *, int *));
1007 extern void x_report_frame_params
P_ ((struct frame
*, Lisp_Object
*));
1008 extern int defined_color
P_ ((struct frame
*, char *, XColor
*, int));
1009 extern void x_set_border_pixel
P_ ((struct frame
*, int));
1010 extern void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1011 extern void x_implicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
1012 extern void create_frame_xic
P_ ((struct frame
*));
1013 extern void destroy_frame_xic
P_ ((struct frame
*));
1014 extern void xic_set_preeditarea
P_ ((struct window
*, int, int));
1015 extern void xic_set_statusarea
P_ ((struct frame
*));
1016 extern void xic_set_xfontset
P_ ((struct frame
*, char *));
1017 extern int x_pixel_width
P_ ((struct frame
*));
1018 extern int x_pixel_height
P_ ((struct frame
*));
1019 extern int x_char_width
P_ ((struct frame
*));
1020 extern int x_char_height
P_ ((struct frame
*));
1021 extern int x_screen_planes
P_ ((struct frame
*));
1022 extern void x_sync
P_ ((struct frame
*));
1024 /* Defined in xfaces.c */
1026 extern int frame_update_line_height
P_ ((struct frame
*));
1027 extern int compute_glyph_face
P_ ((struct frame
*, int, int));
1028 extern int compute_glyph_face_1
P_ ((struct frame
*, Lisp_Object
, int));
1030 /* Defined in xmenu.c */
1032 extern void x_activate_menubar
P_ ((struct frame
*));
1033 extern int popup_activated
P_ ((void));
1034 extern void initialize_frame_menubar
P_ ((struct frame
*));
1036 /* Defined in widget.c */
1038 #ifdef USE_X_TOOLKIT
1039 extern void widget_store_internal_border
P_ ((Widget
));