Remove P_ and __P macros.
[emacs.git] / src / xterm.h
blob099c194ad72a84ce7188329c7a0703dac8e9872f
1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 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 #include <X11/Xlib.h>
21 #include <X11/cursorfont.h>
23 /* Include Xutil.h after keysym.h to work around a bug that prevents
24 correct recognition of AltGr key in some X versions. */
26 #include <X11/keysym.h>
27 #include <X11/Xutil.h>
29 #include <X11/Xatom.h>
30 #include <X11/Xresource.h>
32 #ifdef USE_X_TOOLKIT
33 #include <X11/StringDefs.h>
34 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
35 #include <X11/CoreP.h> /* foul, but we need this to use our own
36 window inside a widget instead of one
37 that Xt creates... */
38 #include <X11/StringDefs.h>
40 typedef Widget xt_or_gtk_widget;
41 #endif
43 #ifdef USE_GTK
44 #include <gtk/gtk.h>
45 #include <gdk/gdkx.h>
47 /* Some definitions to reduce conditionals. */
48 typedef GtkWidget *xt_or_gtk_widget;
49 #define XtParent(x) (gtk_widget_get_parent (x))
50 #undef XSync
51 #define XSync(d, b) do { gdk_window_process_all_updates (); \
52 XSync (d, b); } while (0)
55 #endif /* USE_GTK */
58 /* Bookkeeping to distinguish X versions. */
61 #ifdef HAVE_X_I18N
62 #include <X11/Xlocale.h>
63 #endif
65 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
66 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
67 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
68 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
70 #define FONT_WIDTH(f) ((f)->max_width)
71 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
72 #define FONT_BASE(f) ((f)->ascent)
73 #define FONT_DESCENT(f) ((f)->descent)
75 /* The mask of events that text windows always want to receive. This
76 includes mouse movement events, since handling the mouse-font text property
77 means that we must track mouse motion all the time. */
79 #define STANDARD_EVENT_SET \
80 (KeyPressMask \
81 | ExposureMask \
82 | ButtonPressMask \
83 | ButtonReleaseMask \
84 | PointerMotionMask \
85 | StructureNotifyMask \
86 | FocusChangeMask \
87 | LeaveWindowMask \
88 | EnterWindowMask \
89 | VisibilityChangeMask)
91 #ifdef HAVE_X11R6_XIM
92 /* Data structure passed to xim_instantiate_callback. */
93 struct xim_inst_t
95 struct x_display_info *dpyinfo;
96 char *resource_name;
98 #endif /* HAVE_X11R6_XIM */
100 /* Structure recording X pixmap and reference count.
101 If REFCOUNT is 0 then this record is free to be reused. */
103 struct x_bitmap_record
105 Pixmap pixmap;
106 int have_mask;
107 Pixmap mask;
108 char *file;
109 int refcount;
110 /* Record some info about this pixmap. */
111 int height, width, depth;
114 /* For each X display, we have a structure that records
115 information about it. */
117 struct x_display_info
119 /* Chain of all x_display_info structures. */
120 struct x_display_info *next;
122 /* The generic display parameters corresponding to this X display. */
123 struct terminal *terminal;
125 /* Connection number (normally a file descriptor number). */
126 int connection;
128 /* This says how to access this display in Xlib. */
129 Display *display;
131 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
132 The same cons cell also appears in x_display_name_list. */
133 Lisp_Object name_list_element;
135 /* Number of frames that are on this display. */
136 int reference_count;
138 /* The Screen this connection is connected to. */
139 Screen *screen;
141 /* Dots per inch of the screen. */
142 double resx, resy;
144 /* The Visual being used for this display. */
145 Visual *visual;
147 /* The colormap being used. */
148 Colormap cmap;
150 /* Number of planes on this screen. */
151 int n_planes;
153 /* Mask of things that cause the mouse to be grabbed. */
154 int grabbed;
156 /* Emacs bitmap-id of the default icon bitmap for this frame.
157 Or -1 if none has been allocated yet. */
158 int icon_bitmap_id;
160 /* The root window of this screen. */
161 Window root_window;
163 /* Client leader window. */
164 Window client_leader_window;
166 /* The cursor to use for vertical scroll bars. */
167 Cursor vertical_scroll_bar_cursor;
169 /* The invisible cursor used for pointer blanking. */
170 Cursor invisible_cursor;
172 #ifdef USE_GTK
173 /* The GDK cursor for scroll bars and popup menus. */
174 GdkCursor *xg_cursor;
175 #endif
177 /* X Resource data base */
178 XrmDatabase xrdb;
180 /* Minimum width over all characters in all fonts in font_table. */
181 int smallest_char_width;
183 /* Minimum font height over all fonts in font_table. */
184 int smallest_font_height;
186 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
187 GC scratch_cursor_gc;
189 /* These variables describe the range of text currently shown in its
190 mouse-face, together with the window they apply to. As long as
191 the mouse stays within this range, we need not redraw anything on
192 its account. Rows and columns are glyph matrix positions in
193 MOUSE_FACE_WINDOW. */
194 int mouse_face_beg_row, mouse_face_beg_col;
195 int mouse_face_beg_x, mouse_face_beg_y;
196 int mouse_face_end_row, mouse_face_end_col;
197 int mouse_face_end_x, mouse_face_end_y;
198 int mouse_face_past_end;
199 Lisp_Object mouse_face_window;
200 int mouse_face_face_id;
201 Lisp_Object mouse_face_overlay;
203 /* 1 if a mouse motion event came and we didn't handle it right away because
204 gc was in progress. */
205 int mouse_face_deferred_gc;
207 /* FRAME and X, Y position of mouse when last checked for
208 highlighting. X and Y can be negative or out of range for the frame. */
209 struct frame *mouse_face_mouse_frame;
210 int mouse_face_mouse_x, mouse_face_mouse_y;
212 /* Nonzero means defer mouse-motion highlighting. */
213 int mouse_face_defer;
215 /* Nonzero means that the mouse highlight should not be shown. */
216 int mouse_face_hidden;
218 int mouse_face_image_state;
220 char *x_id_name;
222 /* The number of fonts opened for this display. */
223 int n_fonts;
225 /* Pointer to bitmap records. */
226 struct x_bitmap_record *bitmaps;
228 /* Allocated size of bitmaps field. */
229 int bitmaps_size;
231 /* Last used bitmap index. */
232 int bitmaps_last;
234 /* Which modifier keys are on which modifier bits?
236 With each keystroke, X returns eight bits indicating which modifier
237 keys were held down when the key was pressed. The interpretation
238 of the top five modifier bits depends on what keys are attached
239 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
240 is the meta bit.
242 meta_mod_mask is a mask containing the bits used for the meta key.
243 It may have more than one bit set, if more than one modifier bit
244 has meta keys on it. Basically, if EVENT is a KeyPress event,
245 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
247 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
248 lock modifier bit, or zero otherwise. Non-alphabetic keys should
249 only be affected by the lock modifier bit if XK_Shift_Lock is in
250 use; XK_Caps_Lock should only affect alphabetic keys. With this
251 arrangement, the lock modifier should shift the character if
252 (EVENT.state & shift_lock_mask) != 0. */
253 int meta_mod_mask, shift_lock_mask;
255 /* These are like meta_mod_mask, but for different modifiers. */
256 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
258 /* Communication with window managers. */
259 Atom Xatom_wm_protocols;
261 /* Kinds of protocol things we may receive. */
262 Atom Xatom_wm_take_focus;
263 Atom Xatom_wm_save_yourself;
264 Atom Xatom_wm_delete_window;
266 /* Atom for indicating window state to the window manager. */
267 Atom Xatom_wm_change_state;
269 /* Other WM communication */
270 Atom Xatom_wm_configure_denied; /* When our config request is denied */
271 Atom Xatom_wm_window_moved; /* When the WM moves us. */
272 Atom Xatom_wm_client_leader; /* Id of client leader window. */
274 /* EditRes protocol */
275 Atom Xatom_editres;
277 /* More atoms, which are selection types. */
278 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
279 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
280 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
281 Xatom_ATOM_PAIR;
283 /* More atoms for font properties. The last three are private
284 properties, see the comments in src/fontset.h. */
285 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
286 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
287 Xatom_MULE_DEFAULT_ASCENT;
289 /* More atoms for Ghostscript support. */
290 Atom Xatom_DONE, Xatom_PAGE;
292 /* Atom used in toolkit scroll bar client messages. */
293 Atom Xatom_Scrollbar;
295 /* Atom used in XEmbed client messages. */
296 Atom Xatom_XEMBED;
298 int cut_buffers_initialized; /* Whether we're sure they all exist */
300 /* The frame (if any) which has the X window that has keyboard focus.
301 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
302 that a mere EnterNotify event can set this; if you need to know the
303 last frame specified in a FocusIn or FocusOut event, use
304 x_focus_event_frame. */
305 struct frame *x_focus_frame;
307 /* The last frame mentioned in a FocusIn or FocusOut event. This is
308 separate from x_focus_frame, because whether or not LeaveNotify
309 events cause us to lose focus depends on whether or not we have
310 received a FocusIn event for it. */
311 struct frame *x_focus_event_frame;
313 /* The frame which currently has the visual highlight, and should get
314 keyboard input (other sorts of input have the frame encoded in the
315 event). It points to the X focus frame's selected window's
316 frame. It differs from x_focus_frame when we're using a global
317 minibuffer. */
318 struct frame *x_highlight_frame;
320 /* The gray pixmap. */
321 Pixmap gray;
323 #ifdef HAVE_X_I18N
324 /* XIM (X Input method). */
325 XIM xim;
326 XIMStyles *xim_styles;
327 struct xim_inst_t *xim_callback_data;
328 #endif
330 /* If non-null, a cache of the colors in the color map. Don't
331 use this directly, call x_color_cells instead. */
332 XColor *color_cells;
333 int ncolor_cells;
335 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
336 int red_bits, blue_bits, green_bits;
337 int red_offset, blue_offset, green_offset;
339 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
340 to x/y 0/0, some window managers (type A) puts the window manager
341 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
342 Other window managers (type B) puts the window including decorations
343 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
344 Record the type of WM in use so we can compensate for type A WMs. */
345 enum
347 X_WMTYPE_UNKNOWN,
348 X_WMTYPE_A,
349 X_WMTYPE_B
350 } wm_type;
353 /* Atoms that are drag and drop atoms */
354 Atom *x_dnd_atoms;
355 size_t x_dnd_atoms_size;
356 size_t x_dnd_atoms_length;
358 /* Extended window manager hints, Atoms supported by the window manager and
359 atoms for settig the window type. */
360 Atom *net_supported_atoms;
361 int nr_net_supported_atoms;
362 Window net_supported_window;
363 Atom Xatom_net_window_type, Xatom_net_window_type_tooltip;
365 /* Atoms dealing with maximization and fullscreen */
366 Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen_atom,
367 Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
368 Xatom_net_wm_state_sticky;
370 /* XSettings atoms and windows. */
371 Atom Xatom_xsettings_sel, Xatom_xsettings_prop, Xatom_xsettings_mgr;
372 Window xsettings_window;
375 #ifdef HAVE_X_I18N
376 /* Whether or not to use XIM if we have it. */
377 extern int use_xim;
378 #endif
380 /* This checks to make sure we have a display. */
381 extern void check_x (void);
383 extern struct frame *x_window_to_frame (struct x_display_info *, int);
385 extern struct frame *x_any_window_to_frame (struct x_display_info *, int);
386 extern struct frame *x_menubar_window_to_frame (struct x_display_info *, int);
387 extern struct frame *x_top_window_to_frame (struct x_display_info *, int);
389 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
390 #define x_any_window_to_frame x_window_to_frame
391 #define x_top_window_to_frame x_window_to_frame
392 #endif
394 /* This is a chain of structures for all the X displays currently in use. */
395 extern struct x_display_info *x_display_list;
397 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
398 one for each element of x_display_list and in the same order.
399 NAME is the name of the frame.
400 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
401 extern Lisp_Object x_display_name_list;
403 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
404 extern Lisp_Object Vx_pixel_size_width_font_regexp;
406 extern struct x_display_info *x_display_info_for_display (Display *);
407 extern struct x_display_info *x_display_info_for_name (Lisp_Object);
408 extern void x_set_frame_alpha (struct frame *);
410 extern struct x_display_info *x_term_init (Lisp_Object, char *, char *);
411 extern int x_display_ok (const char *);
413 extern void select_visual (struct x_display_info *);
416 struct font;
418 /* Each X frame object points to its own struct x_output object
419 in the output_data.x field. The x_output structure contains
420 the information that is specific to X windows. */
422 struct x_output
424 /* Height of menu bar widget, in pixels.
425 Zero if not using the X toolkit.
426 When using the toolkit, this value is not meaningful
427 if the menubar is turned off. */
428 int menubar_height;
430 /* Height of tool bar widget, in pixels.
431 Zero if not using an external tool bar. */
432 int toolbar_height;
434 /* The tiled border used when the mouse is out of the frame. */
435 Pixmap border_tile;
437 /* Here are the Graphics Contexts for the default font. */
438 GC normal_gc; /* Normal video */
439 GC reverse_gc; /* Reverse video */
440 GC cursor_gc; /* cursor drawing */
442 /* The X window used for this frame.
443 May be zero while the frame object is being created
444 and the X window has not yet been created. */
445 Window window_desc;
447 /* The X window used for the bitmap icon;
448 or 0 if we don't have a bitmap icon. */
449 Window icon_desc;
451 /* The X window that is the parent of this X window.
452 Usually this is a window that was made by the window manager,
453 but it can be the root window, and it can be explicitly specified
454 (see the explicit_parent field, below). */
455 Window parent_desc;
457 #ifdef USE_X_TOOLKIT
458 /* The widget of this screen. This is the window of a "shell" widget. */
459 Widget widget;
460 /* The XmPanedWindows... */
461 Widget column_widget;
462 /* The widget of the edit portion of this screen; the window in
463 "window_desc" is inside of this. */
464 Widget edit_widget;
466 Widget menubar_widget;
467 #endif
469 #ifdef USE_GTK
470 /* The widget of this screen. This is the window of a top widget. */
471 GtkWidget *widget;
472 /* The widget of the edit portion of this screen; the window in
473 "window_desc" is inside of this. */
474 GtkWidget *edit_widget;
475 /* The widget used for laying out widgets vertically. */
476 GtkWidget *vbox_widget;
477 /* The menubar in this frame. */
478 GtkWidget *menubar_widget;
479 /* The tool bar in this frame */
480 GtkWidget *toolbar_widget;
481 /* The handle box that makes the tool bar detachable. */
482 GtkWidget *handlebox_widget;
483 /* Non-zero if the tool bar is detached. */
484 int toolbar_detached;
486 /* The last size hints set. */
487 GdkGeometry size_hints;
488 long hint_flags;
489 #endif
491 /* If >=0, a bitmap index. The indicated bitmap is used for the
492 icon. */
493 int icon_bitmap;
495 /* Default ASCII font of this frame. */
496 struct font *font;
498 /* The baseline offset of the default ASCII font. */
499 int baseline_offset;
501 /* If a fontset is specified for this frame instead of font, this
502 value contains an ID of the fontset, else -1. */
503 int fontset;
505 /* Pixel values used for various purposes.
506 border_pixel may be -1 meaning use a gray tile. */
507 #if 0 /* These are also defined in struct frame. Use that instead. */
508 unsigned long background_pixel;
509 unsigned long foreground_pixel;
510 #endif
511 unsigned long cursor_pixel;
512 unsigned long border_pixel;
513 unsigned long mouse_pixel;
514 unsigned long cursor_foreground_pixel;
516 /* Foreground color for scroll bars. A value of -1 means use the
517 default (black for non-toolkit scroll bars). */
518 unsigned long scroll_bar_foreground_pixel;
520 /* Background color for scroll bars. A value of -1 means use the
521 default (background color of the frame for non-toolkit scroll
522 bars). */
523 unsigned long scroll_bar_background_pixel;
525 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
526 let the scroll compute them itself. */
527 unsigned long scroll_bar_top_shadow_pixel;
528 unsigned long scroll_bar_bottom_shadow_pixel;
530 /* Descriptor for the cursor in use for this window. */
531 Cursor text_cursor;
532 Cursor nontext_cursor;
533 Cursor modeline_cursor;
534 Cursor hand_cursor;
535 Cursor hourglass_cursor;
536 Cursor horizontal_drag_cursor;
537 Cursor current_cursor;
539 /* Window whose cursor is hourglass_cursor. This window is temporarily
540 mapped to display an hourglass cursor. */
541 Window hourglass_window;
543 /* Non-zero means hourglass cursor is currently displayed. */
544 unsigned hourglass_p : 1;
546 /* Flag to set when the X window needs to be completely repainted. */
547 int needs_exposure;
549 /* These are the current window manager hints. It seems that
550 XSetWMHints, when presented with an unset bit in the `flags'
551 member of the hints structure, does not leave the corresponding
552 attribute unchanged; rather, it resets that attribute to its
553 default value. For example, unless you set the `icon_pixmap'
554 field and the `IconPixmapHint' bit, XSetWMHints will forget what
555 your icon pixmap was. This is rather troublesome, since some of
556 the members (for example, `input' and `icon_pixmap') want to stay
557 the same throughout the execution of Emacs. So, we keep this
558 structure around, just leaving values in it and adding new bits
559 to the mask as we go. */
560 XWMHints wm_hints;
562 /* This is the Emacs structure for the X display this frame is on. */
563 struct x_display_info *display_info;
565 /* This is a button event that wants to activate the menubar.
566 We save it here until the command loop gets to think about it. */
567 XEvent *saved_menu_event;
569 /* This is the widget id used for this frame's menubar in lwlib. */
570 #ifdef USE_X_TOOLKIT
571 int id;
572 #endif
574 /* Nonzero means our parent is another application's window
575 and was explicitly specified. */
576 char explicit_parent;
578 /* Nonzero means tried already to make this frame visible. */
579 char asked_for_visible;
581 /* Nonzero if this frame was ever previously visible. */
582 char has_been_visible;
584 #ifdef HAVE_X_I18N
585 /* Input context (currently, this means Compose key handler setup). */
586 XIC xic;
587 XIMStyle xic_style;
588 XFontSet xic_xfs;
589 char *xic_base_fontname;
590 #endif
592 /* Relief GCs, colors etc. */
593 struct relief
595 GC gc;
596 unsigned long pixel;
597 int allocated_p;
599 black_relief, white_relief;
601 /* The background for which the above relief GCs were set up.
602 They are changed only when a different background is involved. */
603 unsigned long relief_background;
605 /* Xt waits for a ConfigureNotify event from the window manager in
606 EmacsFrameSetCharSize when the shell widget is resized. For some
607 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
608 arrive for an unknown reason and Emacs hangs in Xt. If this is
609 zero, tell Xt not to wait. */
610 int wait_for_wm;
612 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
613 two might differ by a pixel, depending on WM */
614 int x_pixels_outer_diff;
616 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
617 these may differ because this does not take into account possible
618 menubar. y_pixels_diff is with menubar height included */
619 int y_pixels_outer_diff;
621 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
622 frame, or IMPLICIT if we received an EnterNotify.
623 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
624 int focus_state;
626 /* The offset we need to add to compensate for type A WMs. */
627 int move_offset_top;
628 int move_offset_left;
630 /* The frame's left/top offsets before we call XMoveWindow. See
631 x_check_expected_move. */
632 int left_before_move;
633 int top_before_move;
636 #define No_Cursor (None)
638 enum
640 /* Values for focus_state, used as bit mask.
641 EXPLICIT means we received a FocusIn for the frame and know it has
642 the focus. IMPLICIT means we recevied an EnterNotify and the frame
643 may have the focus if no window manager is running.
644 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
645 FOCUS_NONE = 0,
646 FOCUS_IMPLICIT = 1,
647 FOCUS_EXPLICIT = 2
651 /* Return the X output data for frame F. */
652 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
654 /* Return the X window used for displaying data in frame F. */
655 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
657 /* Return the outermost X window associated with the frame F. */
658 #ifdef USE_X_TOOLKIT
659 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
660 XtWindow ((f)->output_data.x->widget) : \
661 FRAME_X_WINDOW (f))
662 #else
663 #ifdef USE_GTK
664 /* Functions not present in older Gtk+ */
666 #ifndef HAVE_GTK_WIDGET_GET_WINDOW
667 #define gtk_widget_get_window(w) ((w)->window)
668 #endif
669 #ifndef HAVE_GTK_WIDGET_GET_MAPPED
670 #define gtk_widget_get_mapped(w) (GTK_WIDGET_MAPPED (w))
671 #endif
672 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
673 #define gtk_adjustment_get_page_size(w) ((w)->page_size)
674 #define gtk_adjustment_get_upper(w) ((w)->upper)
675 #endif
677 #define GTK_WIDGET_TO_X_WIN(w) \
678 ((w) && gtk_widget_get_window (w) \
679 ? GDK_WINDOW_XWINDOW (gtk_widget_get_window (w)) : 0)
681 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
682 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
683 #define FRAME_OUTER_WINDOW(f) \
684 (FRAME_GTK_OUTER_WIDGET (f) ? \
685 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
686 FRAME_X_WINDOW (f))
688 #else /* !USE_GTK */
689 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
690 #endif /* !USE_GTK */
691 #endif
694 #define FRAME_FONT(f) ((f)->output_data.x->font)
695 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
696 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
697 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
698 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
700 /* This gives the x_display_info structure for the display F is on. */
701 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
703 /* This is the `Display *' which frame F is on. */
704 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
706 /* This is the `Screen *' which frame F is on. */
707 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
708 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
710 /* This is the Visual which frame F is on. */
711 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
713 /* This is the Colormap which frame F uses. */
714 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
716 /* This is the 'font_info *' which frame F has. */
717 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
719 /* The difference in pixels between the top left corner of the
720 Emacs window (including possible window manager decorations)
721 and FRAME_X_WINDOW (f). */
722 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
723 ((f)->output_data.x->x_pixels_outer_diff)
724 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
725 ((f)->output_data.x->y_pixels_outer_diff \
726 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
729 #define FRAME_XIC(f) ((f)->output_data.x->xic)
730 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
731 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
732 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
733 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
734 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
736 /* Value is the smallest width of any character in any font on frame F. */
738 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
739 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
741 /* Value is the smallest height of any font on frame F. */
743 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
744 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
746 /* X-specific scroll bar stuff. */
748 /* We represent scroll bars as lisp vectors. This allows us to place
749 references to them in windows without worrying about whether we'll
750 end up with windows referring to dead scroll bars; the garbage
751 collector will free it when its time comes.
753 We use struct scroll_bar as a template for accessing fields of the
754 vector. */
756 struct scroll_bar
758 /* These fields are shared by all vectors. */
759 EMACS_INT size_from_Lisp_Vector_struct;
760 struct Lisp_Vector *next_from_Lisp_Vector_struct;
762 /* The window we're a scroll bar for. */
763 Lisp_Object window;
765 /* The next and previous in the chain of scroll bars in this frame. */
766 Lisp_Object next, prev;
768 /* Fields from `x_window' down will not be traced by the GC. */
770 /* The X window representing this scroll bar. */
771 Window x_window;
773 /* The position and size of the scroll bar in pixels, relative to the
774 frame. */
775 int top, left, width, height;
777 /* The starting and ending positions of the handle, relative to the
778 handle area (i.e. zero is the top position, not
779 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
780 hasn't been drawn yet.
782 These are not actually the locations where the beginning and end
783 are drawn; in order to keep handles from becoming invisible when
784 editing large files, we establish a minimum height by always
785 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
786 where they would be normally; the bottom and top are in a
787 different co-ordinate system. */
788 int start, end;
790 /* If the scroll bar handle is currently being dragged by the user,
791 this is the number of pixels from the top of the handle to the
792 place where the user grabbed it. If the handle isn't currently
793 being dragged, this is Qnil. */
794 Lisp_Object dragging;
796 /* 1 if the background of the fringe that is adjacent to a scroll
797 bar is extended to the gap between the fringe and the bar. */
798 unsigned int fringe_extended_p : 1;
801 /* The number of elements a vector holding a struct scroll_bar needs. */
802 #define SCROLL_BAR_VEC_SIZE \
803 ((sizeof (struct scroll_bar) \
804 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
805 / sizeof (Lisp_Object))
807 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
808 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
811 /* Extract the X widget of the scroll bar from a struct scroll_bar.
812 XtWindowToWidget should be fast enough since Xt uses a hash table
813 to map windows to widgets. */
815 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
816 XtWindowToWidget (dpy, ptr->x_window)
818 /* Store a widget id in a struct scroll_bar. */
820 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
821 do { \
822 Window window = XtWindow (w); \
823 ptr->x_window = window; \
824 } while (0)
827 /* Return the inside width of a vertical scroll bar, given the outside
828 width. */
829 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
830 ((width) \
831 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
832 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
833 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
835 /* Return the length of the rectangle within which the top of the
836 handle must stay. This isn't equivalent to the inside height,
837 because the scroll bar handle has a minimum height.
839 This is the real range of motion for the scroll bar, so when we're
840 scaling buffer positions to scroll bar positions, we use this, not
841 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
842 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
843 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
845 /* Return the inside height of vertical scroll bar, given the outside
846 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
847 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
848 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
851 /* Border widths for scroll bars.
853 Scroll bar windows don't have any X borders; their border width is
854 set to zero, and we redraw borders ourselves. This makes the code
855 a bit cleaner, since we don't have to convert between outside width
856 (used when relating to the rest of the screen) and inside width
857 (used when sizing and drawing the scroll bar window itself).
859 The handle moves up and down/back and forth in a rectangle inset
860 from the edges of the scroll bar. These are widths by which we
861 inset the handle boundaries from the scroll bar edges. */
862 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
863 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
864 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
865 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
867 /* Minimum lengths for scroll bar handles, in pixels. */
868 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
870 /* Trimming off a few pixels from each side prevents
871 text from glomming up against the scroll bar */
872 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
875 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
876 or SELECTION_CLEAR_EVENT, then its contents are really described
877 by this structure. */
879 /* For an event of kind SELECTION_REQUEST_EVENT,
880 this structure really describes the contents.
881 **Don't make this struct longer!**
882 If it overlaps the frame_or_window field of struct input_event,
883 that will cause GC to crash. */
884 struct selection_input_event
886 int kind;
887 Display *display;
888 /* We spell it with an "o" here because X does. */
889 Window requestor;
890 Atom selection, target, property;
891 Time time;
894 #define SELECTION_EVENT_DISPLAY(eventp) \
895 (((struct selection_input_event *) (eventp))->display)
896 /* We spell it with an "o" here because X does. */
897 #define SELECTION_EVENT_REQUESTOR(eventp) \
898 (((struct selection_input_event *) (eventp))->requestor)
899 #define SELECTION_EVENT_SELECTION(eventp) \
900 (((struct selection_input_event *) (eventp))->selection)
901 #define SELECTION_EVENT_TARGET(eventp) \
902 (((struct selection_input_event *) (eventp))->target)
903 #define SELECTION_EVENT_PROPERTY(eventp) \
904 (((struct selection_input_event *) (eventp))->property)
905 #define SELECTION_EVENT_TIME(eventp) \
906 (((struct selection_input_event *) (eventp))->time)
909 struct window;
910 struct glyph_matrix;
911 struct frame;
912 struct input_event;
913 struct face;
914 struct image;
916 /* From xselect.c. */
918 void x_handle_selection_notify (XSelectionEvent *);
919 void x_handle_property_notify (XPropertyEvent *);
921 /* From xfns.c. */
923 Lisp_Object display_x_get_resource (struct x_display_info *,
924 Lisp_Object, Lisp_Object,
925 Lisp_Object, Lisp_Object);
926 struct frame *check_x_frame (Lisp_Object);
927 EXFUN (Fx_display_color_p, 1);
928 EXFUN (Fx_display_grayscale_p, 1);
929 extern void x_free_gcs (struct frame *);
931 /* From xrdb.c. */
933 char *x_get_customization_string (XrmDatabase, char *, char *);
934 XrmDatabase x_load_resources (Display *, char *, char *, char *);
935 int x_get_resource (XrmDatabase, char *, char *,
936 XrmRepresentation, XrmValue *);
937 void x_delete_display (struct x_display_info *);
938 void x_make_frame_visible (struct frame *);
939 void x_iconify_frame (struct frame *);
940 void x_wm_set_size_hint (struct frame *, long, int);
941 int x_text_icon (struct frame *, char *);
942 int x_bitmap_icon (struct frame *, Lisp_Object);
943 void x_set_window_size (struct frame *, int, int, int);
944 void x_wm_set_window_state (struct frame *, int);
945 int x_alloc_nearest_color (struct frame *, Colormap, XColor *);
947 /* Defined in xterm.c */
949 extern void cancel_mouse_face (struct frame *);
950 extern void x_scroll_bar_clear (struct frame *);
951 extern int x_text_icon (struct frame *, char *);
952 extern int x_bitmap_icon (struct frame *, Lisp_Object);
953 extern void x_catch_errors (Display *);
954 extern void x_check_errors (Display *, char *);
955 extern int x_had_errors_p (Display *);
956 extern int x_catching_errors (void);
957 extern void x_uncatch_errors (void);
958 extern void x_clear_errors (Display *);
959 extern void x_set_window_size (struct frame *, int, int, int);
960 extern void x_set_mouse_position (struct frame *, int, int);
961 extern void x_set_mouse_pixel_position (struct frame *, int, int);
962 extern void x_ewmh_activate_frame (struct frame *);
963 extern void x_raise_frame (struct frame *);
964 extern void x_lower_frame (struct frame *);
965 extern void x_make_frame_visible (struct frame *);
966 extern void x_make_frame_invisible (struct frame *);
967 extern void x_iconify_frame (struct frame *);
968 extern void x_free_frame_resources (struct frame *);
969 extern void x_destroy_window (struct frame *);
970 extern void x_wm_set_size_hint (struct frame *, long, int);
971 extern void x_wm_set_window_state (struct frame *, int);
972 extern void x_wm_set_icon_pixmap (struct frame *, int);
973 extern void x_delete_display (struct x_display_info *);
974 extern void x_delete_terminal (struct terminal *terminal);
975 extern void x_initialize (void);
976 extern unsigned long x_copy_color (struct frame *, unsigned long);
977 #ifdef USE_X_TOOLKIT
978 extern XtAppContext Xt_app_con;
979 extern int x_alloc_lighter_color_for_widget (Widget, Display*, Colormap,
980 unsigned long *,
981 double, int);
982 extern void x_activate_timeout_atimer (void);
983 #endif
984 extern void x_query_colors (struct frame *f, XColor *, int);
985 extern void x_query_color (struct frame *f, XColor *);
986 extern void x_clear_area (Display *, Window, int, int, int, int, int);
987 extern void set_vertical_scroll_bar (struct window *);
989 extern int x_dispatch_event (XEvent *, Display *);
990 extern unsigned int x_x_to_emacs_modifiers (struct x_display_info *,
991 unsigned);
992 extern int x_display_pixel_height (struct x_display_info *);
993 extern int x_display_pixel_width (struct x_display_info *);
995 extern void x_set_sticky (struct frame *, Lisp_Object, Lisp_Object);
996 extern void x_wait_for_event (struct frame *, int);
998 /* Defined in xselect.c */
1000 extern void x_handle_property_notify (XPropertyEvent *);
1001 extern void x_handle_selection_notify (XSelectionEvent *);
1002 extern void x_handle_selection_event (struct input_event *);
1003 extern void x_clear_frame_selections (struct frame *);
1005 extern int x_handle_dnd_message (struct frame *,
1006 XClientMessageEvent *,
1007 struct x_display_info *,
1008 struct input_event *bufp);
1009 extern int x_check_property_data (Lisp_Object);
1010 extern void x_fill_property_data (Display *,
1011 Lisp_Object,
1012 void *,
1013 int);
1014 extern Lisp_Object x_property_data_to_lisp (struct frame *,
1015 unsigned char *,
1016 Atom,
1017 int,
1018 unsigned long);
1020 /* Defined in xfns.c */
1022 extern struct x_display_info * check_x_display_info (Lisp_Object frame);
1024 #ifdef USE_GTK
1025 extern int xg_set_icon (struct frame *, Lisp_Object);
1026 extern int xg_set_icon_from_xpm_data (struct frame *, char**);
1027 #endif /* USE_GTK */
1029 extern void x_real_positions (struct frame *, int *, int *);
1030 extern int defined_color (struct frame *, char *, XColor *, int);
1031 extern void x_set_border_pixel (struct frame *, int);
1032 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1033 extern void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
1034 extern void xic_free_xfontset (struct frame *);
1035 extern void create_frame_xic (struct frame *);
1036 extern void destroy_frame_xic (struct frame *);
1037 extern void xic_set_preeditarea (struct window *, int, int);
1038 extern void xic_set_statusarea (struct frame *);
1039 extern void xic_set_xfontset (struct frame *, char *);
1040 extern int x_pixel_width (struct frame *);
1041 extern int x_pixel_height (struct frame *);
1042 extern int x_char_width (struct frame *);
1043 extern int x_char_height (struct frame *);
1044 extern int x_screen_planes (struct frame *);
1045 extern void x_sync (struct frame *);
1046 extern int x_defined_color (struct frame *, char *, XColor *, int);
1047 #ifdef HAVE_X_I18N
1048 extern void free_frame_xic (struct frame *);
1049 #endif
1050 extern void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
1052 /* Defined in xfaces.c */
1054 extern int compute_glyph_face (struct frame *, int, int);
1055 extern int compute_glyph_face_1 (struct frame *, Lisp_Object, int);
1056 extern void x_free_dpy_colors (Display *, Screen *, Colormap,
1057 unsigned long *, int);
1059 /* Defined in xmenu.c */
1061 extern void x_menu_set_in_use (int);
1062 extern void x_menu_wait_for_event (void *data);
1063 extern void x_activate_menubar (struct frame *);
1064 extern int popup_activated (void);
1065 extern void initialize_frame_menubar (struct frame *);
1066 extern void free_frame_menubar (struct frame *);
1068 /* Defined in widget.c */
1070 #ifdef USE_X_TOOLKIT
1071 extern void widget_store_internal_border (Widget);
1072 #endif
1074 /* Defined in xsmfns.c */
1075 #ifdef HAVE_X_SM
1076 extern void x_session_initialize (struct x_display_info *dpyinfo);
1077 extern int x_session_check_input (struct input_event *bufp);
1078 extern int x_session_have_connection (void);
1079 extern void x_session_close (void);
1080 #endif
1082 /* XEmbed implementation. */
1084 #define XEMBED_VERSION 0
1086 enum xembed_info
1088 XEMBED_MAPPED = 1 << 0
1091 enum xembed_message
1093 XEMBED_EMBEDDED_NOTIFY = 0,
1094 XEMBED_WINDOW_ACTIVATE = 1,
1095 XEMBED_WINDOW_DEACTIVATE = 2,
1096 XEMBED_REQUEST_FOCUS = 3,
1097 XEMBED_FOCUS_IN = 4,
1098 XEMBED_FOCUS_OUT = 5,
1099 XEMBED_FOCUS_NEXT = 6,
1100 XEMBED_FOCUS_PREV = 7,
1102 XEMBED_MODALITY_ON = 10,
1103 XEMBED_MODALITY_OFF = 11,
1104 XEMBED_REGISTER_ACCELERATOR = 12,
1105 XEMBED_UNREGISTER_ACCELERATOR = 13,
1106 XEMBED_ACTIVATE_ACCELERATOR = 14
1109 enum xembed_focus
1111 XEMBED_FOCUS_CURRENT = 0,
1112 XEMBED_FOCUS_FIRST = 1,
1113 XEMBED_FOCUS_LAST = 2
1116 enum xembed_modifier
1118 XEMBED_MODIFIER_SHIFT = 1 << 0,
1119 XEMBED_MODIFIER_CONTROL = 1 << 1,
1120 XEMBED_MODIFIER_ALT = 1 << 2,
1121 XEMBED_MODIFIER_SUPER = 1 << 3,
1122 XEMBED_MODIFIER_HYPER = 1 << 4
1125 enum xembed_accelerator
1127 XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1130 /* Defined in xterm.c */
1132 extern void xembed_set_info (struct frame *f, enum xembed_info flags);
1133 extern void xembed_send_message (struct frame *f, Time time,
1134 enum xembed_message message,
1135 long detail, long data1, long data2);
1137 /* Is the frame embedded into another application? */
1139 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1142 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1143 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1145 #define STORE_XCHAR2B(chp, b1, b2) \
1146 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1148 #define XCHAR2B_BYTE1(chp) \
1149 ((chp)->byte1)
1151 #define XCHAR2B_BYTE2(chp) \
1152 ((chp)->byte2)
1155 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1156 ((nr).x = (rx), \
1157 (nr).y = (ry), \
1158 (nr).width = (rwidth), \
1159 (nr).height = (rheight))
1161 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1162 (do not change this comment) */