doc/emacs copyedits re rectangle-mark-mode
[emacs.git] / src / xterm.h
blob2bed0d1d5d174847f4715e0da4eb7ea6dcbedcc4
1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993-1994, 1998-2014 Free Software Foundation,
3 Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #ifndef XTERM_H
21 #define XTERM_H
23 #include <X11/Xlib.h>
24 #include <X11/cursorfont.h>
26 /* Include Xutil.h after keysym.h to work around a bug that prevents
27 correct recognition of AltGr key in some X versions. */
29 #include <X11/keysym.h>
30 #include <X11/Xutil.h>
32 #include <X11/Xatom.h>
33 #include <X11/Xresource.h>
35 #ifdef USE_X_TOOLKIT
36 #include <X11/StringDefs.h>
37 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
38 #include <X11/CoreP.h> /* foul, but we need this to use our own
39 window inside a widget instead of one
40 that Xt creates... */
41 typedef Widget xt_or_gtk_widget;
42 #endif
44 #ifdef USE_GTK
45 #include <gtk/gtk.h>
46 #include <gdk/gdkx.h>
48 /* Some definitions to reduce conditionals. */
49 typedef GtkWidget *xt_or_gtk_widget;
50 #define XtParent(x) (gtk_widget_get_parent (x))
51 #undef XSync
52 #define XSync(d, b) do { gdk_window_process_all_updates (); \
53 XSync (d, b); } while (false)
54 #endif /* USE_GTK */
56 /* True iff GTK's version is at least I.J.K. */
57 #ifndef GTK_CHECK_VERSION
58 # ifdef USE_GTK
59 # define GTK_CHECK_VERSION(i, j, k) \
60 ((i) \
61 < GTK_MAJOR_VERSION + ((j) \
62 < GTK_MINOR_VERSION + ((k) \
63 <= GTK_MICRO_VERSION)))
64 # else
65 # define GTK_CHECK_VERSION(i, j, k) false
66 # endif
67 #endif
69 /* The GtkTooltip API came in 2.12, but gtk-enable-tooltips in 2.14. */
70 #if GTK_CHECK_VERSION (2, 14, 0)
71 #define USE_GTK_TOOLTIP
72 #endif
74 #ifdef HAVE_X_I18N
75 #include <X11/Xlocale.h>
76 #endif
78 #include "dispextern.h"
79 #include "termhooks.h"
81 /* Black and white pixel values for the screen which frame F is on. */
82 #define BLACK_PIX_DEFAULT(f) \
83 BlackPixel (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))
84 #define WHITE_PIX_DEFAULT(f) \
85 WhitePixel (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))
87 /* The mask of events that text windows always want to receive. This
88 includes mouse movement events, since handling the mouse-font text property
89 means that we must track mouse motion all the time. */
91 #define STANDARD_EVENT_SET \
92 (KeyPressMask \
93 | ExposureMask \
94 | ButtonPressMask \
95 | ButtonReleaseMask \
96 | PointerMotionMask \
97 | StructureNotifyMask \
98 | FocusChangeMask \
99 | LeaveWindowMask \
100 | EnterWindowMask \
101 | VisibilityChangeMask)
103 #ifdef HAVE_X11R6_XIM
104 /* Data structure passed to xim_instantiate_callback. */
105 struct xim_inst_t
107 struct x_display_info *dpyinfo;
108 char *resource_name;
110 #endif /* HAVE_X11R6_XIM */
112 /* Structure recording X pixmap and reference count.
113 If REFCOUNT is 0 then this record is free to be reused. */
115 struct x_bitmap_record
117 Pixmap pixmap;
118 bool have_mask;
119 Pixmap mask;
120 char *file;
121 int refcount;
122 /* Record some info about this pixmap. */
123 int height, width, depth;
126 /* For each X display, we have a structure that records
127 information about it. */
129 struct x_display_info
131 /* Chain of all x_display_info structures. */
132 struct x_display_info *next;
134 /* The generic display parameters corresponding to this X display. */
135 struct terminal *terminal;
137 /* This says how to access this display in Xlib. */
138 Display *display;
140 /* A connection number (file descriptor) for the display. */
141 int connection;
143 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE). */
144 Lisp_Object name_list_element;
146 /* Number of frames that are on this display. */
147 int reference_count;
149 /* The Screen this connection is connected to. */
150 Screen *screen;
152 /* Dots per inch of the screen. */
153 double resx, resy;
155 /* The Visual being used for this display. */
156 Visual *visual;
158 /* The colormap being used. */
159 Colormap cmap;
161 /* Number of planes on this screen. */
162 int n_planes;
164 /* Mask of things that cause the mouse to be grabbed. */
165 int grabbed;
167 /* Emacs bitmap-id of the default icon bitmap for this frame.
168 Or -1 if none has been allocated yet. */
169 ptrdiff_t icon_bitmap_id;
171 /* The root window of this screen. */
172 Window root_window;
174 /* Client leader window. */
175 Window client_leader_window;
177 /* The cursor to use for vertical scroll bars. */
178 Cursor vertical_scroll_bar_cursor;
180 /* The invisible cursor used for pointer blanking. */
181 Cursor invisible_cursor;
183 #ifdef USE_GTK
184 /* The GDK cursor for scroll bars and popup menus. */
185 GdkCursor *xg_cursor;
186 #endif
188 /* X Resource data base */
189 XrmDatabase xrdb;
191 /* Minimum width over all characters in all fonts in font_table. */
192 int smallest_char_width;
194 /* Minimum font height over all fonts in font_table. */
195 int smallest_font_height;
197 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
198 GC scratch_cursor_gc;
200 /* Information about the range of text currently shown in
201 mouse-face. */
202 Mouse_HLInfo mouse_highlight;
204 /* Logical identifier of this display. */
205 unsigned x_id;
207 /* Default name for all frames on this display. */
208 char *x_id_name;
210 /* The number of fonts opened for this display. */
211 int n_fonts;
213 /* Pointer to bitmap records. */
214 struct x_bitmap_record *bitmaps;
216 /* Allocated size of bitmaps field. */
217 ptrdiff_t bitmaps_size;
219 /* Last used bitmap index. */
220 ptrdiff_t bitmaps_last;
222 /* Which modifier keys are on which modifier bits?
224 With each keystroke, X returns eight bits indicating which modifier
225 keys were held down when the key was pressed. The interpretation
226 of the top five modifier bits depends on what keys are attached
227 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
228 is the meta bit.
230 meta_mod_mask is a mask containing the bits used for the meta key.
231 It may have more than one bit set, if more than one modifier bit
232 has meta keys on it. Basically, if EVENT is a KeyPress event,
233 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
235 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
236 lock modifier bit, or zero otherwise. Non-alphabetic keys should
237 only be affected by the lock modifier bit if XK_Shift_Lock is in
238 use; XK_Caps_Lock should only affect alphabetic keys. With this
239 arrangement, the lock modifier should shift the character if
240 (EVENT.state & shift_lock_mask) != 0. */
241 int meta_mod_mask, shift_lock_mask;
243 /* These are like meta_mod_mask, but for different modifiers. */
244 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
246 /* Communication with window managers. */
247 Atom Xatom_wm_protocols;
249 /* Kinds of protocol things we may receive. */
250 Atom Xatom_wm_take_focus;
251 Atom Xatom_wm_save_yourself;
252 Atom Xatom_wm_delete_window;
254 /* Atom for indicating window state to the window manager. */
255 Atom Xatom_wm_change_state;
257 /* Other WM communication */
258 Atom Xatom_wm_configure_denied; /* When our config request is denied */
259 Atom Xatom_wm_window_moved; /* When the WM moves us. */
260 Atom Xatom_wm_client_leader; /* Id of client leader window. */
262 /* EditRes protocol */
263 Atom Xatom_editres;
265 /* More atoms, which are selection types. */
266 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
267 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
268 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
269 Xatom_ATOM, Xatom_ATOM_PAIR, Xatom_CLIPBOARD_MANAGER;
271 /* More atoms for font properties. The last three are private
272 properties, see the comments in src/fontset.h. */
273 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
274 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
275 Xatom_MULE_DEFAULT_ASCENT;
277 /* More atoms for Ghostscript support. */
278 Atom Xatom_DONE, Xatom_PAGE;
280 /* Atom used in toolkit scroll bar client messages. */
281 Atom Xatom_Scrollbar;
283 /* Atom used in XEmbed client messages. */
284 Atom Xatom_XEMBED, Xatom_XEMBED_INFO;
286 /* The frame (if any) which has the X window that has keyboard focus.
287 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
288 that a mere EnterNotify event can set this; if you need to know the
289 last frame specified in a FocusIn or FocusOut event, use
290 x_focus_event_frame. */
291 struct frame *x_focus_frame;
293 /* The last frame mentioned in a FocusIn or FocusOut event. This is
294 separate from x_focus_frame, because whether or not LeaveNotify
295 events cause us to lose focus depends on whether or not we have
296 received a FocusIn event for it. */
297 struct frame *x_focus_event_frame;
299 /* The frame which currently has the visual highlight, and should get
300 keyboard input (other sorts of input have the frame encoded in the
301 event). It points to the X focus frame's selected window's
302 frame. It differs from x_focus_frame when we're using a global
303 minibuffer. */
304 struct frame *x_highlight_frame;
306 /* The frame waiting to be auto-raised in XTread_socket. */
307 struct frame *x_pending_autoraise_frame;
309 /* The frame where the mouse was last time we reported a ButtonPress event. */
310 struct frame *last_mouse_frame;
312 /* The frame where the mouse was last time we reported a mouse position. */
313 struct frame *last_mouse_glyph_frame;
315 /* The frame where the mouse was last time we reported a mouse motion. */
316 struct frame *last_mouse_motion_frame;
318 /* The scroll bar in which the last X motion event occurred. */
319 struct scroll_bar *last_mouse_scroll_bar;
321 /* Time of last user interaction as returned in X events on this display. */
322 Time last_user_time;
324 /* Position where the mouse was last time we reported a motion.
325 This is a position on last_mouse_motion_frame. */
326 int last_mouse_motion_x;
327 int last_mouse_motion_y;
329 /* Where the mouse was last time we reported a mouse position.
330 This is a rectangle on last_mouse_glyph_frame. */
331 XRectangle last_mouse_glyph;
333 /* Time of last mouse movement on this display. This is a hack because
334 we would really prefer that XTmouse_position would return the time
335 associated with the position it returns, but there doesn't seem to be
336 any way to wrest the time-stamp from the server along with the position
337 query. So, we just keep track of the time of the last movement we
338 received, and return that in hopes that it's somewhat accurate. */
339 Time last_mouse_movement_time;
341 /* The gray pixmap. */
342 Pixmap gray;
344 #ifdef HAVE_X_I18N
345 /* XIM (X Input method). */
346 XIM xim;
347 XIMStyles *xim_styles;
348 struct xim_inst_t *xim_callback_data;
349 #endif
351 /* If non-null, a cache of the colors in the color map. Don't
352 use this directly, call x_color_cells instead. */
353 XColor *color_cells;
354 int ncolor_cells;
356 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
357 int red_bits, blue_bits, green_bits;
358 int red_offset, blue_offset, green_offset;
360 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
361 to x/y 0/0, some window managers (type A) puts the window manager
362 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
363 Other window managers (type B) puts the window including decorations
364 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
365 Record the type of WM in use so we can compensate for type A WMs. */
366 enum
368 X_WMTYPE_UNKNOWN,
369 X_WMTYPE_A,
370 X_WMTYPE_B
371 } wm_type;
374 /* Atoms that are drag and drop atoms */
375 Atom *x_dnd_atoms;
376 ptrdiff_t x_dnd_atoms_size;
377 ptrdiff_t x_dnd_atoms_length;
379 /* Extended window manager hints, Atoms supported by the window manager and
380 atoms for setting the window type. */
381 Atom Xatom_net_supported, Xatom_net_supporting_wm_check;
382 Atom *net_supported_atoms;
383 int nr_net_supported_atoms;
384 Window net_supported_window;
385 Atom Xatom_net_window_type, Xatom_net_window_type_tooltip;
386 Atom Xatom_net_active_window;
388 /* Atoms dealing with EWMH (i.e. _NET_...) */
389 Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen,
390 Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
391 Xatom_net_wm_state_sticky, Xatom_net_wm_state_hidden,
392 Xatom_net_frame_extents,
393 Xatom_net_current_desktop, Xatom_net_workarea;
395 /* XSettings atoms and windows. */
396 Atom Xatom_xsettings_sel, Xatom_xsettings_prop, Xatom_xsettings_mgr;
397 Window xsettings_window;
399 /* Frame name and icon name */
400 Atom Xatom_net_wm_name, Xatom_net_wm_icon_name;
401 /* Frame opacity */
402 Atom Xatom_net_wm_window_opacity;
404 /* SM */
405 Atom Xatom_SM_CLIENT_ID;
408 #ifdef HAVE_X_I18N
409 /* Whether or not to use XIM if we have it. */
410 extern bool use_xim;
411 #endif
413 /* This is a chain of structures for all the X displays currently in use. */
414 extern struct x_display_info *x_display_list;
416 extern struct x_display_info *x_display_info_for_display (Display *);
417 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
418 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
419 extern bool x_display_ok (const char *);
421 extern void select_visual (struct x_display_info *);
423 /* Each X frame object points to its own struct x_output object
424 in the output_data.x field. The x_output structure contains
425 the information that is specific to X windows. */
427 struct x_output
429 /* Height of menu bar widget, in pixels.
430 Zero if not using the X toolkit.
431 When using the toolkit, this value is not meaningful
432 if the menubar is turned off. */
433 int menubar_height;
435 /* Height of tool bar widget, in pixels. top_height is used if tool bar
436 at top, bottom_height if tool bar is at the bottom.
437 Zero if not using an external tool bar or if tool bar is vertical. */
438 int toolbar_top_height, toolbar_bottom_height;
440 /* Width of tool bar widget, in pixels. left_width is used if tool bar
441 at left, right_width if tool bar is at the right.
442 Zero if not using an external tool bar or if tool bar is horizontal. */
443 int toolbar_left_width, toolbar_right_width;
445 /* The tiled border used when the mouse is out of the frame. */
446 Pixmap border_tile;
448 /* Here are the Graphics Contexts for the default font. */
449 GC normal_gc; /* Normal video */
450 GC reverse_gc; /* Reverse video */
451 GC cursor_gc; /* cursor drawing */
453 /* The X window used for this frame.
454 May be zero while the frame object is being created
455 and the X window has not yet been created. */
456 Window window_desc;
458 /* The X window used for the bitmap icon;
459 or 0 if we don't have a bitmap icon. */
460 Window icon_desc;
462 /* The X window that is the parent of this X window.
463 Usually this is a window that was made by the window manager,
464 but it can be the root window, and it can be explicitly specified
465 (see the explicit_parent field, below). */
466 Window parent_desc;
468 #ifdef USE_X_TOOLKIT
469 /* The widget of this screen. This is the window of a "shell" widget. */
470 Widget widget;
471 /* The XmPanedWindows... */
472 Widget column_widget;
473 /* The widget of the edit portion of this screen; the window in
474 "window_desc" is inside of this. */
475 Widget edit_widget;
477 Widget menubar_widget;
478 #endif
480 #ifdef USE_GTK
481 /* The widget of this screen. This is the window of a top widget. */
482 GtkWidget *widget;
483 /* The widget of the edit portion of this screen; the window in
484 "window_desc" is inside of this. */
485 GtkWidget *edit_widget;
486 /* The widget used for laying out widgets vertically. */
487 GtkWidget *vbox_widget;
488 /* The widget used for laying out widgets horizontally. */
489 GtkWidget *hbox_widget;
490 /* The menubar in this frame. */
491 GtkWidget *menubar_widget;
492 /* The tool bar in this frame */
493 GtkWidget *toolbar_widget;
494 #ifdef HAVE_GTK_HANDLE_BOX_NEW
495 /* The handle box that makes the tool bar detachable. */
496 GtkWidget *handlebox_widget;
497 #endif
498 /* True if tool bar is packed into the hbox widget (i.e. vertical). */
499 bool_bf toolbar_in_hbox : 1;
500 bool_bf toolbar_is_packed : 1;
502 /* The last size hints set. */
503 GdkGeometry size_hints;
504 long hint_flags;
506 #ifdef USE_GTK_TOOLTIP
507 GtkTooltip *ttip_widget;
508 GtkWidget *ttip_lbl;
509 GtkWindow *ttip_window;
510 #endif /* USE_GTK_TOOLTIP */
512 #endif /* USE_GTK */
514 /* If >=0, a bitmap index. The indicated bitmap is used for the
515 icon. */
516 ptrdiff_t icon_bitmap;
518 /* Default ASCII font of this frame. */
519 struct font *font;
521 /* The baseline offset of the default ASCII font. */
522 int baseline_offset;
524 /* If a fontset is specified for this frame instead of font, this
525 value contains an ID of the fontset, else -1. */
526 int fontset;
528 unsigned long cursor_pixel;
529 unsigned long border_pixel;
530 unsigned long mouse_pixel;
531 unsigned long cursor_foreground_pixel;
533 /* Foreground color for scroll bars. A value of -1 means use the
534 default (black for non-toolkit scroll bars). */
535 unsigned long scroll_bar_foreground_pixel;
537 /* Background color for scroll bars. A value of -1 means use the
538 default (background color of the frame for non-toolkit scroll
539 bars). */
540 unsigned long scroll_bar_background_pixel;
542 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
543 let the scroll compute them itself. */
544 unsigned long scroll_bar_top_shadow_pixel;
545 unsigned long scroll_bar_bottom_shadow_pixel;
547 /* Descriptor for the cursor in use for this window. */
548 Cursor text_cursor;
549 Cursor nontext_cursor;
550 Cursor modeline_cursor;
551 Cursor hand_cursor;
552 Cursor hourglass_cursor;
553 Cursor horizontal_drag_cursor;
554 Cursor vertical_drag_cursor;
555 Cursor current_cursor;
557 /* Window whose cursor is hourglass_cursor. This window is temporarily
558 mapped to display an hourglass cursor. */
559 Window hourglass_window;
561 /* These are the current window manager hints. It seems that
562 XSetWMHints, when presented with an unset bit in the `flags'
563 member of the hints structure, does not leave the corresponding
564 attribute unchanged; rather, it resets that attribute to its
565 default value. For example, unless you set the `icon_pixmap'
566 field and the `IconPixmapHint' bit, XSetWMHints will forget what
567 your icon pixmap was. This is rather troublesome, since some of
568 the members (for example, `input' and `icon_pixmap') want to stay
569 the same throughout the execution of Emacs. So, we keep this
570 structure around, just leaving values in it and adding new bits
571 to the mask as we go. */
572 XWMHints wm_hints;
574 /* This is the Emacs structure for the X display this frame is on. */
575 struct x_display_info *display_info;
577 /* This is a button event that wants to activate the menubar.
578 We save it here until the command loop gets to think about it. */
579 XEvent *saved_menu_event;
581 /* This is the widget id used for this frame's menubar in lwlib. */
582 #ifdef USE_X_TOOLKIT
583 int id;
584 #endif
586 /* True means hourglass cursor is currently displayed. */
587 bool_bf hourglass_p : 1;
589 /* True means our parent is another application's window
590 and was explicitly specified. */
591 bool_bf explicit_parent : 1;
593 /* True means tried already to make this frame visible. */
594 bool_bf asked_for_visible : 1;
596 /* True if this frame was ever previously visible. */
597 bool_bf has_been_visible : 1;
599 /* Xt waits for a ConfigureNotify event from the window manager in
600 EmacsFrameSetCharSize when the shell widget is resized. For some
601 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
602 arrive for an unknown reason and Emacs hangs in Xt. If this is
603 false, tell Xt not to wait. */
604 bool_bf wait_for_wm : 1;
606 /* True if _NET_WM_STATE_HIDDEN is set for this frame. */
607 bool_bf net_wm_state_hidden_seen : 1;
609 #ifdef HAVE_X_I18N
610 /* Input context (currently, this means Compose key handler setup). */
611 XIC xic;
612 XIMStyle xic_style;
613 XFontSet xic_xfs;
614 #endif
616 /* Relief GCs, colors etc. */
617 struct relief
619 GC gc;
620 unsigned long pixel;
622 black_relief, white_relief;
624 /* The background for which the above relief GCs were set up.
625 They are changed only when a different background is involved. */
626 unsigned long relief_background;
628 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
629 two might differ by a pixel, depending on WM */
630 int x_pixels_outer_diff;
632 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
633 these may differ because this does not take into account possible
634 menubar. y_pixels_diff is with menubar height included */
635 int y_pixels_outer_diff;
637 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
638 frame, or IMPLICIT if we received an EnterNotify.
639 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
640 int focus_state;
642 /* The offset we need to add to compensate for type A WMs. */
643 int move_offset_top;
644 int move_offset_left;
647 #define No_Cursor (None)
649 enum
651 /* Values for focus_state, used as bit mask.
652 EXPLICIT means we received a FocusIn for the frame and know it has
653 the focus. IMPLICIT means we received an EnterNotify and the frame
654 may have the focus if no window manager is running.
655 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
656 FOCUS_NONE = 0,
657 FOCUS_IMPLICIT = 1,
658 FOCUS_EXPLICIT = 2
662 /* Return the X output data for frame F. */
663 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
665 /* Return the X window used for displaying data in frame F. */
666 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
668 /* Return the outermost X window associated with the frame F. */
669 #ifdef USE_X_TOOLKIT
670 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
671 XtWindow ((f)->output_data.x->widget) : \
672 FRAME_X_WINDOW (f))
673 #else
674 #ifdef USE_GTK
675 /* Functions not present in older Gtk+ */
677 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
678 #define gtk_widget_get_window(w) ((w)->window)
679 #endif
680 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
681 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
682 #endif
683 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
684 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
685 #define gtk_adjustment_get_upper(w) ((w)->upper)
686 #endif
688 #ifdef HAVE_GTK3
689 #define DEFAULT_GDK_DISPLAY() \
690 gdk_x11_display_get_xdisplay (gdk_display_get_default ())
691 #else
692 #undef GDK_WINDOW_XID
693 #define GDK_WINDOW_XID(w) GDK_WINDOW_XWINDOW (w)
694 #define DEFAULT_GDK_DISPLAY() GDK_DISPLAY ()
695 #define gtk_widget_get_preferred_size(a, ign, b) \
696 gtk_widget_size_request (a, b)
697 #endif
699 #define GTK_WIDGET_TO_X_WIN(w) \
700 ((w) && gtk_widget_get_window (w) \
701 ? GDK_WINDOW_XID (gtk_widget_get_window (w)) : 0)
703 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
704 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
705 #define FRAME_OUTER_WINDOW(f) \
706 (FRAME_GTK_OUTER_WIDGET (f) ? \
707 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
708 FRAME_X_WINDOW (f))
710 #else /* !USE_GTK */
711 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
712 #endif /* !USE_GTK */
713 #endif
716 #define FRAME_FONT(f) ((f)->output_data.x->font)
717 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
718 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
719 #define FRAME_TOOLBAR_TOP_HEIGHT(f) ((f)->output_data.x->toolbar_top_height)
720 #define FRAME_TOOLBAR_BOTTOM_HEIGHT(f) \
721 ((f)->output_data.x->toolbar_bottom_height)
722 #define FRAME_TOOLBAR_HEIGHT(f) \
723 (FRAME_TOOLBAR_TOP_HEIGHT (f) + FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
724 #define FRAME_TOOLBAR_LEFT_WIDTH(f) ((f)->output_data.x->toolbar_left_width)
725 #define FRAME_TOOLBAR_RIGHT_WIDTH(f) ((f)->output_data.x->toolbar_right_width)
726 #define FRAME_TOOLBAR_WIDTH(f) \
727 (FRAME_TOOLBAR_LEFT_WIDTH (f) + FRAME_TOOLBAR_RIGHT_WIDTH (f))
728 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
730 /* This gives the x_display_info structure for the display F is on. */
731 #define FRAME_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
733 /* This is the `Display *' which frame F is on. */
734 #define FRAME_X_DISPLAY(f) (FRAME_DISPLAY_INFO (f)->display)
736 /* This is the `Screen *' which frame F is on. */
737 #define FRAME_X_SCREEN(f) (FRAME_DISPLAY_INFO (f)->screen)
739 /* This is the screen index number of screen which frame F is on. */
740 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
742 /* This is the Visual which frame F is on. */
743 #define FRAME_X_VISUAL(f) FRAME_DISPLAY_INFO (f)->visual
745 /* This is the Colormap which frame F uses. */
746 #define FRAME_X_COLORMAP(f) FRAME_DISPLAY_INFO (f)->cmap
748 /* The difference in pixels between the top left corner of the
749 Emacs window (including possible window manager decorations)
750 and FRAME_X_WINDOW (f). */
751 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
752 ((f)->output_data.x->x_pixels_outer_diff)
753 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
754 ((f)->output_data.x->y_pixels_outer_diff \
755 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
758 #define FRAME_XIC(f) ((f)->output_data.x->xic)
759 #define FRAME_X_XIM(f) (FRAME_DISPLAY_INFO (f)->xim)
760 #define FRAME_X_XIM_STYLES(f) (FRAME_DISPLAY_INFO (f)->xim_styles)
761 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
762 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
764 /* X-specific scroll bar stuff. */
766 /* We represent scroll bars as lisp vectors. This allows us to place
767 references to them in windows without worrying about whether we'll
768 end up with windows referring to dead scroll bars; the garbage
769 collector will free it when its time comes.
771 We use struct scroll_bar as a template for accessing fields of the
772 vector. */
774 struct scroll_bar
776 /* These fields are shared by all vectors. */
777 struct vectorlike_header header;
779 /* The window we're a scroll bar for. */
780 Lisp_Object window;
782 /* The next and previous in the chain of scroll bars in this frame. */
783 Lisp_Object next, prev;
785 /* Fields from `x_window' down will not be traced by the GC. */
787 /* The X window representing this scroll bar. */
788 Window x_window;
790 /* The position and size of the scroll bar in pixels, relative to the
791 frame. */
792 int top, left, width, height;
794 /* The starting and ending positions of the handle, relative to the
795 handle area (i.e. zero is the top position, not
796 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
797 hasn't been drawn yet.
799 These are not actually the locations where the beginning and end
800 are drawn; in order to keep handles from becoming invisible when
801 editing large files, we establish a minimum height by always
802 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
803 where they would be normally; the bottom and top are in a
804 different co-ordinate system. */
805 int start, end;
807 /* If the scroll bar handle is currently being dragged by the user,
808 this is the number of pixels from the top of the handle to the
809 place where the user grabbed it. If the handle isn't currently
810 being dragged, this is -1. */
811 int dragging;
813 #if defined (USE_TOOLKIT_SCROLL_BARS) && defined (USE_LUCID)
814 /* Last scroll bar part seen in xaw_jump_callback and xaw_scroll_callback. */
815 enum scroll_bar_part last_seen_part;
816 #endif
819 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
820 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
822 #ifdef USE_X_TOOLKIT
824 /* Extract the X widget of the scroll bar from a struct scroll_bar.
825 XtWindowToWidget should be fast enough since Xt uses a hash table
826 to map windows to widgets. */
828 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
829 XtWindowToWidget (dpy, ptr->x_window)
831 /* Store a widget id in a struct scroll_bar. */
833 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
834 do { \
835 Window window = XtWindow (w); \
836 ptr->x_window = window; \
837 } while (false)
839 #endif /* USE_X_TOOLKIT */
841 /* Return the inside width of a vertical scroll bar, given the outside
842 width. */
843 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
844 ((width) \
845 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
846 - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
848 /* Return the length of the rectangle within which the top of the
849 handle must stay. This isn't equivalent to the inside height,
850 because the scroll bar handle has a minimum height.
852 This is the real range of motion for the scroll bar, so when we're
853 scaling buffer positions to scroll bar positions, we use this, not
854 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
855 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
856 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
858 /* Return the inside height of vertical scroll bar, given the outside
859 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
860 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
861 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
864 /* Border widths for scroll bars.
866 Scroll bar windows don't have any X borders; their border width is
867 set to zero, and we redraw borders ourselves. This makes the code
868 a bit cleaner, since we don't have to convert between outside width
869 (used when relating to the rest of the screen) and inside width
870 (used when sizing and drawing the scroll bar window itself).
872 The handle moves up and down/back and forth in a rectangle inset
873 from the edges of the scroll bar. These are widths by which we
874 inset the handle boundaries from the scroll bar edges. */
875 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
876 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
877 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
878 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
880 /* Minimum lengths for scroll bar handles, in pixels. */
881 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
883 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
884 or SELECTION_CLEAR_EVENT, then its contents are really described
885 by this structure. */
887 /* For an event of kind SELECTION_REQUEST_EVENT,
888 this structure really describes the contents. */
890 struct selection_input_event
892 int kind;
893 Display *display;
894 /* We spell it with an "o" here because X does. */
895 Window requestor;
896 Atom selection, target, property;
897 Time time;
900 #define SELECTION_EVENT_DISPLAY(eventp) \
901 (((struct selection_input_event *) (eventp))->display)
902 /* We spell it with an "o" here because X does. */
903 #define SELECTION_EVENT_REQUESTOR(eventp) \
904 (((struct selection_input_event *) (eventp))->requestor)
905 #define SELECTION_EVENT_SELECTION(eventp) \
906 (((struct selection_input_event *) (eventp))->selection)
907 #define SELECTION_EVENT_TARGET(eventp) \
908 (((struct selection_input_event *) (eventp))->target)
909 #define SELECTION_EVENT_PROPERTY(eventp) \
910 (((struct selection_input_event *) (eventp))->property)
911 #define SELECTION_EVENT_TIME(eventp) \
912 (((struct selection_input_event *) (eventp))->time)
914 /* From xfns.c. */
916 extern void x_free_gcs (struct frame *);
918 /* From xrdb.c. */
920 XrmDatabase x_load_resources (Display *, const char *, const char *,
921 const char *);
923 /* Defined in xterm.c */
925 extern int x_text_icon (struct frame *, const char *);
926 extern void x_catch_errors (Display *);
927 extern void x_check_errors (Display *, const char *)
928 ATTRIBUTE_FORMAT_PRINTF (2, 0);
929 extern bool x_had_errors_p (Display *);
930 extern void x_uncatch_errors (void);
931 extern void x_clear_errors (Display *);
932 extern void x_set_window_size (struct frame *, int, int, int, bool);
933 extern void x_set_mouse_position (struct frame *, int, int);
934 extern void x_set_mouse_pixel_position (struct frame *, int, int);
935 extern void xembed_request_focus (struct frame *);
936 extern void x_ewmh_activate_frame (struct frame *);
937 extern void x_delete_terminal (struct terminal *terminal);
938 extern unsigned long x_copy_color (struct frame *, unsigned long);
939 #ifdef USE_X_TOOLKIT
940 extern XtAppContext Xt_app_con;
941 extern void x_activate_timeout_atimer (void);
942 #endif
943 #ifdef USE_LUCID
944 extern bool x_alloc_lighter_color_for_widget (Widget, Display *, Colormap,
945 unsigned long *,
946 double, int);
947 #endif
948 extern bool x_alloc_nearest_color (struct frame *, Colormap, XColor *);
949 extern void x_query_color (struct frame *f, XColor *);
950 extern void x_clear_area (Display *, Window, int, int, int, int);
951 #if !defined USE_X_TOOLKIT && !defined USE_GTK
952 extern void x_mouse_leave (struct x_display_info *);
953 #endif
955 #if defined USE_X_TOOLKIT || defined USE_MOTIF
956 extern int x_dispatch_event (XEvent *, Display *);
957 #endif
958 extern int x_x_to_emacs_modifiers (struct x_display_info *, int);
959 extern int x_display_pixel_height (struct x_display_info *);
960 extern int x_display_pixel_width (struct x_display_info *);
962 extern void x_set_sticky (struct frame *, Lisp_Object, Lisp_Object);
963 extern void x_wait_for_event (struct frame *, int);
965 /* Defined in xselect.c. */
967 extern void x_handle_property_notify (const XPropertyEvent *);
968 extern void x_handle_selection_notify (const XSelectionEvent *);
969 extern void x_handle_selection_event (struct input_event *);
970 extern void x_clear_frame_selections (struct frame *);
972 extern void x_send_client_event (Lisp_Object display,
973 Lisp_Object dest,
974 Lisp_Object from,
975 Atom message_type,
976 Lisp_Object format,
977 Lisp_Object values);
979 extern int x_handle_dnd_message (struct frame *,
980 const XClientMessageEvent *,
981 struct x_display_info *,
982 struct input_event *);
983 extern int x_check_property_data (Lisp_Object);
984 extern void x_fill_property_data (Display *,
985 Lisp_Object,
986 void *,
987 int);
988 extern Lisp_Object x_property_data_to_lisp (struct frame *,
989 const unsigned char *,
990 Atom,
991 int,
992 unsigned long);
993 extern void x_clipboard_manager_save_frame (Lisp_Object);
994 extern void x_clipboard_manager_save_all (void);
996 /* Defined in xfns.c */
998 extern Lisp_Object x_get_focus_frame (struct frame *);
1000 #ifdef USE_GTK
1001 extern int xg_set_icon (struct frame *, Lisp_Object);
1002 extern int xg_set_icon_from_xpm_data (struct frame *, const char**);
1003 #endif /* USE_GTK */
1005 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1006 extern void xic_free_xfontset (struct frame *);
1007 extern void create_frame_xic (struct frame *);
1008 extern void destroy_frame_xic (struct frame *);
1009 extern void xic_set_preeditarea (struct window *, int, int);
1010 extern void xic_set_statusarea (struct frame *);
1011 extern void xic_set_xfontset (struct frame *, const char *);
1012 extern bool x_defined_color (struct frame *, const char *, XColor *, bool);
1013 #ifdef HAVE_X_I18N
1014 extern void free_frame_xic (struct frame *);
1015 # if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1016 extern char * xic_create_fontsetname (const char *base_fontname, int motif);
1017 # endif
1018 #endif
1020 /* Defined in xfaces.c */
1022 #ifdef USE_X_TOOLKIT
1023 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1024 unsigned long *, int);
1025 #endif /* USE_X_TOOLKIT */
1027 /* Defined in xmenu.c */
1029 #if defined USE_X_TOOLKIT || defined USE_GTK
1030 extern Lisp_Object xw_popup_dialog (struct frame *, Lisp_Object, Lisp_Object);
1031 #endif
1033 #if defined USE_GTK || defined USE_MOTIF
1034 extern void x_menu_set_in_use (int);
1035 #endif
1036 #ifdef USE_MOTIF
1037 extern void x_menu_wait_for_event (void *data);
1038 #endif
1039 extern int popup_activated (void);
1040 extern void initialize_frame_menubar (struct frame *);
1042 /* Defined in widget.c */
1044 #ifdef USE_X_TOOLKIT
1045 extern void widget_store_internal_border (Widget);
1046 #endif
1048 /* Defined in xsmfns.c */
1049 #ifdef HAVE_X_SM
1050 extern void x_session_initialize (struct x_display_info *dpyinfo);
1051 extern int x_session_have_connection (void);
1052 extern void x_session_close (void);
1053 #endif
1055 /* Defined in xterm.c */
1057 extern Lisp_Object Qx_gtk_map_stock;
1059 #if !defined USE_X_TOOLKIT && !defined USE_GTK
1060 extern void x_clear_under_internal_border (struct frame *f);
1061 #endif
1063 /* Is the frame embedded into another application? */
1065 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1067 #define STORE_XCHAR2B(chp, b1, b2) \
1068 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1070 #define XCHAR2B_BYTE1(chp) \
1071 ((chp)->byte1)
1073 #define XCHAR2B_BYTE2(chp) \
1074 ((chp)->byte2)
1076 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1077 ((nr).x = (rx), \
1078 (nr).y = (ry), \
1079 (nr).width = (rwidth), \
1080 (nr).height = (rheight))
1082 #endif /* XTERM_H */