Two minor doc/consistency fixes.
[emacs.git] / src / xterm.h
blob86daa7bd27e61a7864614e5c6e0117f85cb4bb3a
1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993-1994, 1998-2012 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 3 of the License, or
9 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
19 #include <X11/Xlib.h>
20 #include <X11/cursorfont.h>
22 /* Include Xutil.h after keysym.h to work around a bug that prevents
23 correct recognition of AltGr key in some X versions. */
25 #include <X11/keysym.h>
26 #include <X11/Xutil.h>
28 #include <X11/Xatom.h>
29 #include <X11/Xresource.h>
31 #ifdef USE_X_TOOLKIT
32 #include <X11/StringDefs.h>
33 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
34 #include <X11/CoreP.h> /* foul, but we need this to use our own
35 window inside a widget instead of one
36 that Xt creates... */
37 #include <X11/StringDefs.h>
39 typedef Widget xt_or_gtk_widget;
40 #endif
42 #ifdef USE_GTK
43 #include <gtk/gtk.h>
44 #include <gdk/gdkx.h>
46 /* Some definitions to reduce conditionals. */
47 typedef GtkWidget *xt_or_gtk_widget;
48 #define XtParent(x) (gtk_widget_get_parent (x))
49 #undef XSync
50 #define XSync(d, b) do { gdk_window_process_all_updates (); \
51 XSync (d, b); } while (0)
53 /* The GtkTooltip API came in 2.12, but gtk-enable-tooltips in 2.14. */
54 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 13
55 #define USE_GTK_TOOLTIP
56 #endif
58 #endif /* USE_GTK */
61 /* Bookkeeping to distinguish X versions. */
64 #ifdef HAVE_X_I18N
65 #include <X11/Xlocale.h>
66 #endif
68 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
69 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
70 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
71 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
73 #define FONT_WIDTH(f) ((f)->max_width)
74 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
75 #define FONT_BASE(f) ((f)->ascent)
76 #define FONT_DESCENT(f) ((f)->descent)
78 /* The mask of events that text windows always want to receive. This
79 includes mouse movement events, since handling the mouse-font text property
80 means that we must track mouse motion all the time. */
82 #define STANDARD_EVENT_SET \
83 (KeyPressMask \
84 | ExposureMask \
85 | ButtonPressMask \
86 | ButtonReleaseMask \
87 | PointerMotionMask \
88 | StructureNotifyMask \
89 | FocusChangeMask \
90 | LeaveWindowMask \
91 | EnterWindowMask \
92 | VisibilityChangeMask)
94 #ifdef HAVE_X11R6_XIM
95 /* Data structure passed to xim_instantiate_callback. */
96 struct xim_inst_t
98 struct x_display_info *dpyinfo;
99 char *resource_name;
101 #endif /* HAVE_X11R6_XIM */
103 /* Structure recording X pixmap and reference count.
104 If REFCOUNT is 0 then this record is free to be reused. */
106 struct x_bitmap_record
108 Pixmap pixmap;
109 int have_mask;
110 Pixmap mask;
111 char *file;
112 int refcount;
113 /* Record some info about this pixmap. */
114 int height, width, depth;
117 /* For each X display, we have a structure that records
118 information about it. */
120 struct x_display_info
122 /* Chain of all x_display_info structures. */
123 struct x_display_info *next;
125 /* The generic display parameters corresponding to this X display. */
126 struct terminal *terminal;
128 /* Connection number (normally a file descriptor number). */
129 int connection;
131 /* This says how to access this display in Xlib. */
132 Display *display;
134 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
135 The same cons cell also appears in x_display_name_list. */
136 Lisp_Object name_list_element;
138 /* Number of frames that are on this display. */
139 int reference_count;
141 /* The Screen this connection is connected to. */
142 Screen *screen;
144 /* Dots per inch of the screen. */
145 double resx, resy;
147 /* The Visual being used for this display. */
148 Visual *visual;
150 /* The colormap being used. */
151 Colormap cmap;
153 /* Number of planes on this screen. */
154 int n_planes;
156 /* Mask of things that cause the mouse to be grabbed. */
157 int grabbed;
159 /* Emacs bitmap-id of the default icon bitmap for this frame.
160 Or -1 if none has been allocated yet. */
161 ptrdiff_t icon_bitmap_id;
163 /* The root window of this screen. */
164 Window root_window;
166 /* Client leader window. */
167 Window client_leader_window;
169 /* The cursor to use for vertical scroll bars. */
170 Cursor vertical_scroll_bar_cursor;
172 /* The invisible cursor used for pointer blanking. */
173 Cursor invisible_cursor;
175 #ifdef USE_GTK
176 /* The GDK cursor for scroll bars and popup menus. */
177 GdkCursor *xg_cursor;
178 #endif
180 /* X Resource data base */
181 XrmDatabase xrdb;
183 /* Minimum width over all characters in all fonts in font_table. */
184 int smallest_char_width;
186 /* Minimum font height over all fonts in font_table. */
187 int smallest_font_height;
189 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
190 GC scratch_cursor_gc;
192 /* Information about the range of text currently shown in
193 mouse-face. */
194 Mouse_HLInfo mouse_highlight;
196 char *x_id_name;
198 /* The number of fonts opened for this display. */
199 int n_fonts;
201 /* Pointer to bitmap records. */
202 struct x_bitmap_record *bitmaps;
204 /* Allocated size of bitmaps field. */
205 ptrdiff_t bitmaps_size;
207 /* Last used bitmap index. */
208 ptrdiff_t bitmaps_last;
210 /* Which modifier keys are on which modifier bits?
212 With each keystroke, X returns eight bits indicating which modifier
213 keys were held down when the key was pressed. The interpretation
214 of the top five modifier bits depends on what keys are attached
215 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
216 is the meta bit.
218 meta_mod_mask is a mask containing the bits used for the meta key.
219 It may have more than one bit set, if more than one modifier bit
220 has meta keys on it. Basically, if EVENT is a KeyPress event,
221 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
223 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
224 lock modifier bit, or zero otherwise. Non-alphabetic keys should
225 only be affected by the lock modifier bit if XK_Shift_Lock is in
226 use; XK_Caps_Lock should only affect alphabetic keys. With this
227 arrangement, the lock modifier should shift the character if
228 (EVENT.state & shift_lock_mask) != 0. */
229 int meta_mod_mask, shift_lock_mask;
231 /* These are like meta_mod_mask, but for different modifiers. */
232 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
234 /* Communication with window managers. */
235 Atom Xatom_wm_protocols;
237 /* Kinds of protocol things we may receive. */
238 Atom Xatom_wm_take_focus;
239 Atom Xatom_wm_save_yourself;
240 Atom Xatom_wm_delete_window;
242 /* Atom for indicating window state to the window manager. */
243 Atom Xatom_wm_change_state;
245 /* Other WM communication */
246 Atom Xatom_wm_configure_denied; /* When our config request is denied */
247 Atom Xatom_wm_window_moved; /* When the WM moves us. */
248 Atom Xatom_wm_client_leader; /* Id of client leader window. */
250 /* EditRes protocol */
251 Atom Xatom_editres;
253 /* More atoms, which are selection types. */
254 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
255 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
256 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
257 Xatom_ATOM, Xatom_ATOM_PAIR, Xatom_CLIPBOARD_MANAGER;
259 /* More atoms for font properties. The last three are private
260 properties, see the comments in src/fontset.h. */
261 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
262 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
263 Xatom_MULE_DEFAULT_ASCENT;
265 /* More atoms for Ghostscript support. */
266 Atom Xatom_DONE, Xatom_PAGE;
268 /* Atom used in toolkit scroll bar client messages. */
269 Atom Xatom_Scrollbar;
271 /* Atom used in XEmbed client messages. */
272 Atom Xatom_XEMBED, Xatom_XEMBED_INFO;
274 /* The frame (if any) which has the X window that has keyboard focus.
275 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
276 that a mere EnterNotify event can set this; if you need to know the
277 last frame specified in a FocusIn or FocusOut event, use
278 x_focus_event_frame. */
279 struct frame *x_focus_frame;
281 /* The last frame mentioned in a FocusIn or FocusOut event. This is
282 separate from x_focus_frame, because whether or not LeaveNotify
283 events cause us to lose focus depends on whether or not we have
284 received a FocusIn event for it. */
285 struct frame *x_focus_event_frame;
287 /* The frame which currently has the visual highlight, and should get
288 keyboard input (other sorts of input have the frame encoded in the
289 event). It points to the X focus frame's selected window's
290 frame. It differs from x_focus_frame when we're using a global
291 minibuffer. */
292 struct frame *x_highlight_frame;
294 /* The gray pixmap. */
295 Pixmap gray;
297 #ifdef HAVE_X_I18N
298 /* XIM (X Input method). */
299 XIM xim;
300 XIMStyles *xim_styles;
301 struct xim_inst_t *xim_callback_data;
302 #endif
304 /* If non-null, a cache of the colors in the color map. Don't
305 use this directly, call x_color_cells instead. */
306 XColor *color_cells;
307 int ncolor_cells;
309 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
310 int red_bits, blue_bits, green_bits;
311 int red_offset, blue_offset, green_offset;
313 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
314 to x/y 0/0, some window managers (type A) puts the window manager
315 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
316 Other window managers (type B) puts the window including decorations
317 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
318 Record the type of WM in use so we can compensate for type A WMs. */
319 enum
321 X_WMTYPE_UNKNOWN,
322 X_WMTYPE_A,
323 X_WMTYPE_B
324 } wm_type;
327 /* Atoms that are drag and drop atoms */
328 Atom *x_dnd_atoms;
329 ptrdiff_t x_dnd_atoms_size;
330 ptrdiff_t x_dnd_atoms_length;
332 /* Extended window manager hints, Atoms supported by the window manager and
333 atoms for setting the window type. */
334 Atom Xatom_net_supported, Xatom_net_supporting_wm_check;
335 Atom *net_supported_atoms;
336 int nr_net_supported_atoms;
337 Window net_supported_window;
338 Atom Xatom_net_window_type, Xatom_net_window_type_tooltip;
339 Atom Xatom_net_active_window;
341 /* Atoms dealing with EWMH (i.e. _NET_...) */
342 Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen,
343 Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
344 Xatom_net_wm_state_sticky, Xatom_net_wm_state_hidden,
345 Xatom_net_frame_extents;
347 /* XSettings atoms and windows. */
348 Atom Xatom_xsettings_sel, Xatom_xsettings_prop, Xatom_xsettings_mgr;
349 Window xsettings_window;
351 /* Frame name and icon name */
352 Atom Xatom_net_wm_name, Xatom_net_wm_icon_name;
353 /* Frame opacity */
354 Atom Xatom_net_wm_window_opacity;
356 /* SM */
357 Atom Xatom_SM_CLIENT_ID;
360 #ifdef HAVE_X_I18N
361 /* Whether or not to use XIM if we have it. */
362 extern int use_xim;
363 #endif
365 /* This checks to make sure we have a display. */
367 extern void check_x (void);
369 extern struct frame *x_window_to_frame (struct x_display_info *, int);
371 extern struct frame *x_any_window_to_frame (struct x_display_info *, int);
372 extern struct frame *x_menubar_window_to_frame (struct x_display_info *,
373 XEvent *);
375 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
377 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
378 #define x_any_window_to_frame x_window_to_frame
379 #define x_top_window_to_frame x_window_to_frame
380 #endif
382 /* This is a chain of structures for all the X displays currently in use. */
383 extern struct x_display_info *x_display_list;
385 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
386 one for each element of x_display_list and in the same order.
387 NAME is the name of the frame.
388 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
389 extern Lisp_Object x_display_name_list;
391 extern struct x_display_info *x_display_info_for_display (Display *);
392 extern void x_set_frame_alpha (struct frame *);
394 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
395 extern int x_display_ok (const char *);
397 extern void select_visual (struct x_display_info *);
400 struct font;
402 /* Each X frame object points to its own struct x_output object
403 in the output_data.x field. The x_output structure contains
404 the information that is specific to X windows. */
406 struct x_output
408 /* Height of menu bar widget, in pixels.
409 Zero if not using the X toolkit.
410 When using the toolkit, this value is not meaningful
411 if the menubar is turned off. */
412 int menubar_height;
414 /* Height of tool bar widget, in pixels. top_height is used if tool bar
415 at top, bottom_height if tool bar is at the bottom.
416 Zero if not using an external tool bar or if tool bar is vertical. */
417 int toolbar_top_height, toolbar_bottom_height;
419 /* Width of tool bar widget, in pixels. left_width is used if tool bar
420 at left, right_width if tool bar is at the right.
421 Zero if not using an external tool bar or if tool bar is horizontal. */
422 int toolbar_left_width, toolbar_right_width;
424 /* The tiled border used when the mouse is out of the frame. */
425 Pixmap border_tile;
427 /* Here are the Graphics Contexts for the default font. */
428 GC normal_gc; /* Normal video */
429 GC reverse_gc; /* Reverse video */
430 GC cursor_gc; /* cursor drawing */
432 /* The X window used for this frame.
433 May be zero while the frame object is being created
434 and the X window has not yet been created. */
435 Window window_desc;
437 /* The X window used for the bitmap icon;
438 or 0 if we don't have a bitmap icon. */
439 Window icon_desc;
441 /* The X window that is the parent of this X window.
442 Usually this is a window that was made by the window manager,
443 but it can be the root window, and it can be explicitly specified
444 (see the explicit_parent field, below). */
445 Window parent_desc;
447 #ifdef USE_X_TOOLKIT
448 /* The widget of this screen. This is the window of a "shell" widget. */
449 Widget widget;
450 /* The XmPanedWindows... */
451 Widget column_widget;
452 /* The widget of the edit portion of this screen; the window in
453 "window_desc" is inside of this. */
454 Widget edit_widget;
456 Widget menubar_widget;
457 #endif
459 #ifdef USE_GTK
460 /* The widget of this screen. This is the window of a top widget. */
461 GtkWidget *widget;
462 /* The widget of the edit portion of this screen; the window in
463 "window_desc" is inside of this. */
464 GtkWidget *edit_widget;
465 /* The widget used for laying out widgets vertically. */
466 GtkWidget *vbox_widget;
467 /* The widget used for laying out widgets horizontally. */
468 GtkWidget *hbox_widget;
469 /* The menubar in this frame. */
470 GtkWidget *menubar_widget;
471 /* The tool bar in this frame */
472 GtkWidget *toolbar_widget;
473 /* The handle box that makes the tool bar detachable. */
474 GtkWidget *handlebox_widget;
475 /* Non-zero if the tool bar is detached. */
476 int toolbar_detached;
477 /* Non-zero if tool bar is packed into the hbox widget (i.e. vertical). */
478 int toolbar_in_hbox;
480 /* The last size hints set. */
481 GdkGeometry size_hints;
482 long hint_flags;
484 #ifdef USE_GTK_TOOLTIP
485 GtkTooltip *ttip_widget;
486 GtkWidget *ttip_lbl;
487 GtkWindow *ttip_window;
488 #endif /* USE_GTK_TOOLTIP */
490 #endif /* USE_GTK */
492 /* If >=0, a bitmap index. The indicated bitmap is used for the
493 icon. */
494 ptrdiff_t icon_bitmap;
496 /* Default ASCII font of this frame. */
497 struct font *font;
499 /* The baseline offset of the default ASCII font. */
500 int baseline_offset;
502 /* If a fontset is specified for this frame instead of font, this
503 value contains an ID of the fontset, else -1. */
504 int fontset;
506 /* Pixel values used for various purposes.
507 border_pixel may be -1 meaning use a gray tile. */
508 #if 0 /* These are also defined in struct frame. Use that instead. */
509 unsigned long background_pixel;
510 unsigned long foreground_pixel;
511 #endif
512 unsigned long cursor_pixel;
513 unsigned long border_pixel;
514 unsigned long mouse_pixel;
515 unsigned long cursor_foreground_pixel;
517 /* Foreground color for scroll bars. A value of -1 means use the
518 default (black for non-toolkit scroll bars). */
519 unsigned long scroll_bar_foreground_pixel;
521 /* Background color for scroll bars. A value of -1 means use the
522 default (background color of the frame for non-toolkit scroll
523 bars). */
524 unsigned long scroll_bar_background_pixel;
526 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
527 let the scroll compute them itself. */
528 unsigned long scroll_bar_top_shadow_pixel;
529 unsigned long scroll_bar_bottom_shadow_pixel;
531 /* Descriptor for the cursor in use for this window. */
532 Cursor text_cursor;
533 Cursor nontext_cursor;
534 Cursor modeline_cursor;
535 Cursor hand_cursor;
536 Cursor hourglass_cursor;
537 Cursor horizontal_drag_cursor;
538 Cursor current_cursor;
540 /* Window whose cursor is hourglass_cursor. This window is temporarily
541 mapped to display an hourglass cursor. */
542 Window hourglass_window;
544 /* Non-zero means hourglass cursor is currently displayed. */
545 unsigned hourglass_p : 1;
547 /* Flag to set when the X window needs to be completely repainted. */
548 int needs_exposure;
550 /* These are the current window manager hints. It seems that
551 XSetWMHints, when presented with an unset bit in the `flags'
552 member of the hints structure, does not leave the corresponding
553 attribute unchanged; rather, it resets that attribute to its
554 default value. For example, unless you set the `icon_pixmap'
555 field and the `IconPixmapHint' bit, XSetWMHints will forget what
556 your icon pixmap was. This is rather troublesome, since some of
557 the members (for example, `input' and `icon_pixmap') want to stay
558 the same throughout the execution of Emacs. So, we keep this
559 structure around, just leaving values in it and adding new bits
560 to the mask as we go. */
561 XWMHints wm_hints;
563 /* This is the Emacs structure for the X display this frame is on. */
564 struct x_display_info *display_info;
566 /* This is a button event that wants to activate the menubar.
567 We save it here until the command loop gets to think about it. */
568 XEvent *saved_menu_event;
570 /* This is the widget id used for this frame's menubar in lwlib. */
571 #ifdef USE_X_TOOLKIT
572 int id;
573 #endif
575 /* Nonzero means our parent is another application's window
576 and was explicitly specified. */
577 char explicit_parent;
579 /* Nonzero means tried already to make this frame visible. */
580 char asked_for_visible;
582 /* Nonzero if this frame was ever previously visible. */
583 char has_been_visible;
585 #ifdef HAVE_X_I18N
586 /* Input context (currently, this means Compose key handler setup). */
587 XIC xic;
588 XIMStyle xic_style;
589 XFontSet xic_xfs;
590 char *xic_base_fontname;
591 #endif
593 /* Relief GCs, colors etc. */
594 struct relief
596 GC gc;
597 unsigned long pixel;
598 int allocated_p;
600 black_relief, white_relief;
602 /* The background for which the above relief GCs were set up.
603 They are changed only when a different background is involved. */
604 unsigned long relief_background;
606 /* Xt waits for a ConfigureNotify event from the window manager in
607 EmacsFrameSetCharSize when the shell widget is resized. For some
608 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
609 arrive for an unknown reason and Emacs hangs in Xt. If this is
610 zero, tell Xt not to wait. */
611 int wait_for_wm;
613 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
614 two might differ by a pixel, depending on WM */
615 int x_pixels_outer_diff;
617 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
618 these may differ because this does not take into account possible
619 menubar. y_pixels_diff is with menubar height included */
620 int y_pixels_outer_diff;
622 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
623 frame, or IMPLICIT if we received an EnterNotify.
624 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
625 int focus_state;
627 /* The offset we need to add to compensate for type A WMs. */
628 int move_offset_top;
629 int move_offset_left;
631 /* The frame's left/top offsets before we call XMoveWindow. See
632 x_check_expected_move. */
633 int left_before_move;
634 int top_before_move;
636 /* Non-zero if _NET_WM_STATE_HIDDEN is set for this frame. */
637 int net_wm_state_hidden_seen;
640 #define No_Cursor (None)
642 enum
644 /* Values for focus_state, used as bit mask.
645 EXPLICIT means we received a FocusIn for the frame and know it has
646 the focus. IMPLICIT means we received an EnterNotify and the frame
647 may have the focus if no window manager is running.
648 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
649 FOCUS_NONE = 0,
650 FOCUS_IMPLICIT = 1,
651 FOCUS_EXPLICIT = 2
655 /* Return the X output data for frame F. */
656 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
658 /* Return the X window used for displaying data in frame F. */
659 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
661 /* Return the outermost X window associated with the frame F. */
662 #ifdef USE_X_TOOLKIT
663 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
664 XtWindow ((f)->output_data.x->widget) : \
665 FRAME_X_WINDOW (f))
666 #else
667 #ifdef USE_GTK
668 /* Functions not present in older Gtk+ */
670 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
671 #define gtk_widget_get_window(w) ((w)->window)
672 #endif
673 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
674 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
675 #endif
676 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
677 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
678 #define gtk_adjustment_get_upper(w) ((w)->upper)
679 #endif
681 #ifdef HAVE_GTK3
682 #define DEFAULT_GDK_DISPLAY() \
683 gdk_x11_display_get_xdisplay (gdk_display_get_default ())
684 #else
685 #undef GDK_WINDOW_XID
686 #define GDK_WINDOW_XID(w) GDK_WINDOW_XWINDOW (w)
687 #define DEFAULT_GDK_DISPLAY() GDK_DISPLAY ()
688 #define gtk_widget_get_preferred_size(a, ign, b) \
689 gtk_widget_size_request (a, b)
690 #endif
692 #define GTK_WIDGET_TO_X_WIN(w) \
693 ((w) && gtk_widget_get_window (w) \
694 ? GDK_WINDOW_XID (gtk_widget_get_window (w)) : 0)
696 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
697 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
698 #define FRAME_OUTER_WINDOW(f) \
699 (FRAME_GTK_OUTER_WIDGET (f) ? \
700 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
701 FRAME_X_WINDOW (f))
703 #else /* !USE_GTK */
704 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
705 #endif /* !USE_GTK */
706 #endif
709 #define FRAME_FONT(f) ((f)->output_data.x->font)
710 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
711 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
712 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
713 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
714 ((f)->output_data.x->toolbar_bottom_height)
715 #define FRAME_TOOLBAR_HEIGHT(f) \
716 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
717 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
718 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
719 #define FRAME_TOOLBAR_WIDTH(f) \
720 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
721 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
723 /* This gives the x_display_info structure for the display F is on. */
724 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
726 /* This is the `Display *' which frame F is on. */
727 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
729 /* This is the `Screen *' which frame F is on. */
730 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
731 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
733 /* This is the Visual which frame F is on. */
734 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
736 /* This is the Colormap which frame F uses. */
737 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
739 /* This is the 'font_info *' which frame F has. */
740 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
742 /* The difference in pixels between the top left corner of the
743 Emacs window (including possible window manager decorations)
744 and FRAME_X_WINDOW (f). */
745 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
746 ((f)->output_data.x->x_pixels_outer_diff)
747 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
748 ((f)->output_data.x->y_pixels_outer_diff \
749 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
752 #define FRAME_XIC(f) ((f)->output_data.x->xic)
753 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
754 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
755 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
756 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
757 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
759 /* Value is the smallest width of any character in any font on frame F. */
761 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
762 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
764 /* Value is the smallest height of any font on frame F. */
766 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
767 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
769 /* X-specific scroll bar stuff. */
771 /* We represent scroll bars as lisp vectors. This allows us to place
772 references to them in windows without worrying about whether we'll
773 end up with windows referring to dead scroll bars; the garbage
774 collector will free it when its time comes.
776 We use struct scroll_bar as a template for accessing fields of the
777 vector. */
779 struct scroll_bar
781 /* These fields are shared by all vectors. */
782 EMACS_INT size_from_Lisp_Vector_struct;
783 struct Lisp_Vector *next_from_Lisp_Vector_struct;
785 /* The window we're a scroll bar for. */
786 Lisp_Object window;
788 /* The next and previous in the chain of scroll bars in this frame. */
789 Lisp_Object next, prev;
791 /* Fields from `x_window' down will not be traced by the GC. */
793 /* The X window representing this scroll bar. */
794 Window x_window;
796 /* The position and size of the scroll bar in pixels, relative to the
797 frame. */
798 int top, left, width, height;
800 /* The starting and ending positions of the handle, relative to the
801 handle area (i.e. zero is the top position, not
802 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
803 hasn't been drawn yet.
805 These are not actually the locations where the beginning and end
806 are drawn; in order to keep handles from becoming invisible when
807 editing large files, we establish a minimum height by always
808 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
809 where they would be normally; the bottom and top are in a
810 different co-ordinate system. */
811 int start, end;
813 /* If the scroll bar handle is currently being dragged by the user,
814 this is the number of pixels from the top of the handle to the
815 place where the user grabbed it. If the handle isn't currently
816 being dragged, this is Qnil. */
817 Lisp_Object dragging;
819 /* 1 if the background of the fringe that is adjacent to a scroll
820 bar is extended to the gap between the fringe and the bar. */
821 unsigned int fringe_extended_p : 1;
824 /* The number of elements a vector holding a struct scroll_bar needs. */
825 #define SCROLL_BAR_VEC_SIZE \
826 ((sizeof (struct scroll_bar) \
827 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
828 / sizeof (Lisp_Object))
830 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
831 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
834 /* Extract the X widget of the scroll bar from a struct scroll_bar.
835 XtWindowToWidget should be fast enough since Xt uses a hash table
836 to map windows to widgets. */
838 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
839 XtWindowToWidget (dpy, ptr->x_window)
841 /* Store a widget id in a struct scroll_bar. */
843 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
844 do { \
845 Window window = XtWindow (w); \
846 ptr->x_window = window; \
847 } while (0)
850 /* Return the inside width of a vertical scroll bar, given the outside
851 width. */
852 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
853 ((width) \
854 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
855 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
856 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
858 /* Return the length of the rectangle within which the top of the
859 handle must stay. This isn't equivalent to the inside height,
860 because the scroll bar handle has a minimum height.
862 This is the real range of motion for the scroll bar, so when we're
863 scaling buffer positions to scroll bar positions, we use this, not
864 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
865 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
866 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
868 /* Return the inside height of vertical scroll bar, given the outside
869 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
870 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
871 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
874 /* Border widths for scroll bars.
876 Scroll bar windows don't have any X borders; their border width is
877 set to zero, and we redraw borders ourselves. This makes the code
878 a bit cleaner, since we don't have to convert between outside width
879 (used when relating to the rest of the screen) and inside width
880 (used when sizing and drawing the scroll bar window itself).
882 The handle moves up and down/back and forth in a rectangle inset
883 from the edges of the scroll bar. These are widths by which we
884 inset the handle boundaries from the scroll bar edges. */
885 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
886 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
887 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
888 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
890 /* Minimum lengths for scroll bar handles, in pixels. */
891 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
893 /* Trimming off a few pixels from each side prevents
894 text from glomming up against the scroll bar */
895 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
898 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
899 or SELECTION_CLEAR_EVENT, then its contents are really described
900 by this structure. */
902 /* For an event of kind SELECTION_REQUEST_EVENT,
903 this structure really describes the contents.
904 **Don't make this struct longer!**
905 If it overlaps the frame_or_window field of struct input_event,
906 that will cause GC to crash. */
907 struct selection_input_event
909 int kind;
910 Display *display;
911 /* We spell it with an "o" here because X does. */
912 Window requestor;
913 Atom selection, target, property;
914 Time time;
917 #define SELECTION_EVENT_DISPLAY(eventp) \
918 (((struct selection_input_event *) (eventp))->display)
919 /* We spell it with an "o" here because X does. */
920 #define SELECTION_EVENT_REQUESTOR(eventp) \
921 (((struct selection_input_event *) (eventp))->requestor)
922 #define SELECTION_EVENT_SELECTION(eventp) \
923 (((struct selection_input_event *) (eventp))->selection)
924 #define SELECTION_EVENT_TARGET(eventp) \
925 (((struct selection_input_event *) (eventp))->target)
926 #define SELECTION_EVENT_PROPERTY(eventp) \
927 (((struct selection_input_event *) (eventp))->property)
928 #define SELECTION_EVENT_TIME(eventp) \
929 (((struct selection_input_event *) (eventp))->time)
932 struct window;
933 struct glyph_matrix;
934 struct frame;
935 struct input_event;
936 struct face;
937 struct image;
939 /* From xselect.c. */
941 void x_handle_selection_notify (XSelectionEvent *);
942 void x_handle_property_notify (XPropertyEvent *);
944 /* From xfns.c. */
946 struct frame *check_x_frame (Lisp_Object);
947 EXFUN (Fx_display_grayscale_p, 1);
948 extern void x_free_gcs (struct frame *);
949 extern int gray_bitmap_width, gray_bitmap_height;
950 extern char *gray_bitmap_bits;
952 /* From xrdb.c. */
954 XrmDatabase x_load_resources (Display *, const char *, const char *,
955 const char *);
957 /* Defined in xterm.c */
959 extern int x_text_icon (struct frame *, const char *);
960 extern int x_bitmap_icon (struct frame *, Lisp_Object);
961 extern void x_catch_errors (Display *);
962 extern void x_check_errors (Display *, const char *)
963 ATTRIBUTE_FORMAT_PRINTF (2, 0);
964 extern int x_had_errors_p (Display *);
965 extern void x_uncatch_errors (void);
966 extern void x_clear_errors (Display *);
967 extern void x_set_window_size (struct frame *, int, int, int);
968 extern void x_set_mouse_position (struct frame *, int, int);
969 extern void x_set_mouse_pixel_position (struct frame *, int, int);
970 extern void xembed_request_focus (struct frame *);
971 extern void x_ewmh_activate_frame (struct frame *);
972 extern void x_make_frame_visible (struct frame *);
973 extern void x_make_frame_invisible (struct frame *);
974 extern void x_iconify_frame (struct frame *);
975 extern void x_free_frame_resources (struct frame *);
976 extern void x_wm_set_size_hint (struct frame *, long, int);
977 extern void x_delete_terminal (struct terminal *terminal);
978 extern unsigned long x_copy_color (struct frame *, unsigned long);
979 #ifdef USE_X_TOOLKIT
980 extern XtAppContext Xt_app_con;
981 extern void x_activate_timeout_atimer (void);
982 #endif
983 #ifdef USE_LUCID
984 extern int x_alloc_lighter_color_for_widget (Widget, Display *, Colormap,
985 unsigned long *,
986 double, int);
987 #endif
988 extern int x_alloc_nearest_color (struct frame *, Colormap, XColor *);
989 extern void x_query_colors (struct frame *f, XColor *, int);
990 extern void x_query_color (struct frame *f, XColor *);
991 extern void x_clear_area (Display *, Window, int, int, int, int, int);
992 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
993 extern void x_mouse_leave (struct x_display_info *);
994 #endif
996 #ifdef USE_X_TOOLKIT
997 extern int x_dispatch_event (XEvent *, Display *);
998 #endif
999 extern EMACS_INT x_x_to_emacs_modifiers (struct x_display_info *, int);
1000 extern int x_display_pixel_height (struct x_display_info *);
1001 extern int x_display_pixel_width (struct x_display_info *);
1003 extern void x_set_sticky (struct frame *, Lisp_Object, Lisp_Object);
1004 extern void x_wait_for_event (struct frame *, int);
1006 /* Defined in xselect.c */
1008 extern void x_handle_property_notify (XPropertyEvent *);
1009 extern void x_handle_selection_notify (XSelectionEvent *);
1010 extern void x_handle_selection_event (struct input_event *);
1011 extern void x_clear_frame_selections (struct frame *);
1013 extern void x_send_client_event (Lisp_Object display,
1014 Lisp_Object dest,
1015 Lisp_Object from,
1016 Atom message_type,
1017 Lisp_Object format,
1018 Lisp_Object values);
1020 extern int x_handle_dnd_message (struct frame *,
1021 XClientMessageEvent *,
1022 struct x_display_info *,
1023 struct input_event *bufp);
1024 extern int x_check_property_data (Lisp_Object);
1025 extern void x_fill_property_data (Display *,
1026 Lisp_Object,
1027 void *,
1028 int);
1029 extern Lisp_Object x_property_data_to_lisp (struct frame *,
1030 const unsigned char *,
1031 Atom,
1032 int,
1033 unsigned long);
1034 extern void x_clipboard_manager_save_frame (Lisp_Object);
1035 extern void x_clipboard_manager_save_all (void);
1037 /* Defined in xfns.c */
1039 extern struct x_display_info * check_x_display_info (Lisp_Object);
1040 extern Lisp_Object x_get_focus_frame (struct frame *);
1042 #ifdef USE_GTK
1043 extern int xg_set_icon (struct frame *, Lisp_Object);
1044 extern int xg_set_icon_from_xpm_data (struct frame *, const char**);
1045 #endif /* USE_GTK */
1047 extern void x_real_positions (struct frame *, int *, int *);
1048 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1049 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1050 extern void xic_free_xfontset (struct frame *);
1051 extern void create_frame_xic (struct frame *);
1052 extern void destroy_frame_xic (struct frame *);
1053 extern void xic_set_preeditarea (struct window *, int, int);
1054 extern void xic_set_statusarea (struct frame *);
1055 extern void xic_set_xfontset (struct frame *, const char *);
1056 extern int x_pixel_width (struct frame *);
1057 extern int x_pixel_height (struct frame *);
1058 extern int x_char_width (struct frame *);
1059 extern int x_char_height (struct frame *);
1060 extern void x_sync (struct frame *);
1061 extern int x_defined_color (struct frame *, const char *, XColor *, int);
1062 #ifdef HAVE_X_I18N
1063 extern void free_frame_xic (struct frame *);
1064 # if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1065 extern char * xic_create_fontsetname (const char *base_fontname, int motif);
1066 # endif
1067 #endif
1068 extern void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1070 /* Defined in xfaces.c */
1072 #ifdef USE_X_TOOLKIT
1073 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1074 unsigned long *, int);
1075 #endif /* USE_X_TOOLKIT */
1077 /* Defined in xmenu.c */
1079 #if defined USE_GTK || defined USE_MOTIF
1080 extern void x_menu_set_in_use (int);
1081 #endif
1082 #ifdef USE_MOTIF
1083 extern void x_menu_wait_for_event (void *data);
1084 #endif
1085 extern void x_activate_menubar (struct frame *);
1086 extern int popup_activated (void);
1087 extern void initialize_frame_menubar (struct frame *);
1088 extern void free_frame_menubar (struct frame *);
1090 /* Defined in widget.c */
1092 #ifdef USE_X_TOOLKIT
1093 extern void widget_store_internal_border (Widget);
1094 #endif
1096 /* Defined in xsmfns.c */
1097 #ifdef HAVE_X_SM
1098 extern void x_session_initialize (struct x_display_info *dpyinfo);
1099 extern int x_session_have_connection (void);
1100 extern void x_session_close (void);
1101 #endif
1103 /* Defined in xterm.c */
1105 extern Lisp_Object Qx_gtk_map_stock;
1107 /* Is the frame embedded into another application? */
1109 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1112 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1113 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1115 #define STORE_XCHAR2B(chp, b1, b2) \
1116 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1118 #define XCHAR2B_BYTE1(chp) \
1119 ((chp)->byte1)
1121 #define XCHAR2B_BYTE2(chp) \
1122 ((chp)->byte2)
1125 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1126 ((nr).x = (rx), \
1127 (nr).y = (ry), \
1128 (nr).width = (rwidth), \
1129 (nr).height = (rheight))