* text.texi (Special Properties): Fix typo.
[emacs.git] / src / xterm.h
blobc8601b8c43dc4f6dc53ced82d4c84e5f6732f3e4
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 P_ ((void));
383 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
385 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
386 extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
387 XEvent *));
388 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
390 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
391 #define x_any_window_to_frame x_window_to_frame
392 #define x_top_window_to_frame x_window_to_frame
393 #endif
395 /* This is a chain of structures for all the X displays currently in use. */
396 extern struct x_display_info *x_display_list;
398 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
399 one for each element of x_display_list and in the same order.
400 NAME is the name of the frame.
401 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
402 extern Lisp_Object x_display_name_list;
404 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
405 extern Lisp_Object Vx_pixel_size_width_font_regexp;
407 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
408 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
409 extern void x_set_frame_alpha P_ ((struct frame *));
411 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
412 extern int x_display_ok P_ ((const char *));
414 extern void select_visual P_ ((struct x_display_info *));
417 struct font;
419 /* Each X frame object points to its own struct x_output object
420 in the output_data.x field. The x_output structure contains
421 the information that is specific to X windows. */
423 struct x_output
425 /* Height of menu bar widget, in pixels.
426 Zero if not using the X toolkit.
427 When using the toolkit, this value is not meaningful
428 if the menubar is turned off. */
429 int menubar_height;
431 /* Height of tool bar widget, in pixels.
432 Zero if not using an external tool bar. */
433 int toolbar_height;
435 /* The tiled border used when the mouse is out of the frame. */
436 Pixmap border_tile;
438 /* Here are the Graphics Contexts for the default font. */
439 GC normal_gc; /* Normal video */
440 GC reverse_gc; /* Reverse video */
441 GC cursor_gc; /* cursor drawing */
443 /* The X window used for this frame.
444 May be zero while the frame object is being created
445 and the X window has not yet been created. */
446 Window window_desc;
448 /* The X window used for the bitmap icon;
449 or 0 if we don't have a bitmap icon. */
450 Window icon_desc;
452 /* The X window that is the parent of this X window.
453 Usually this is a window that was made by the window manager,
454 but it can be the root window, and it can be explicitly specified
455 (see the explicit_parent field, below). */
456 Window parent_desc;
458 #ifdef USE_X_TOOLKIT
459 /* The widget of this screen. This is the window of a "shell" widget. */
460 Widget widget;
461 /* The XmPanedWindows... */
462 Widget column_widget;
463 /* The widget of the edit portion of this screen; the window in
464 "window_desc" is inside of this. */
465 Widget edit_widget;
467 Widget menubar_widget;
468 #endif
470 #ifdef USE_GTK
471 /* The widget of this screen. This is the window of a top widget. */
472 GtkWidget *widget;
473 /* The widget of the edit portion of this screen; the window in
474 "window_desc" is inside of this. */
475 GtkWidget *edit_widget;
476 /* The widget used for laying out widgets vertically. */
477 GtkWidget *vbox_widget;
478 /* The menubar in this frame. */
479 GtkWidget *menubar_widget;
480 /* The tool bar in this frame */
481 GtkWidget *toolbar_widget;
482 /* The handle box that makes the tool bar detachable. */
483 GtkWidget *handlebox_widget;
484 /* Non-zero if the tool bar is detached. */
485 int toolbar_detached;
487 /* The last size hints set. */
488 GdkGeometry size_hints;
489 long hint_flags;
490 #endif
492 /* If >=0, a bitmap index. The indicated bitmap is used for the
493 icon. */
494 int 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;
637 #define No_Cursor (None)
639 enum
641 /* Values for focus_state, used as bit mask.
642 EXPLICIT means we received a FocusIn for the frame and know it has
643 the focus. IMPLICIT means we recevied an EnterNotify and the frame
644 may have the focus if no window manager is running.
645 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
646 FOCUS_NONE = 0,
647 FOCUS_IMPLICIT = 1,
648 FOCUS_EXPLICIT = 2
652 /* Return the X output data for frame F. */
653 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
655 /* Return the X window used for displaying data in frame F. */
656 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
658 /* Return the outermost X window associated with the frame F. */
659 #ifdef USE_X_TOOLKIT
660 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
661 XtWindow ((f)->output_data.x->widget) : \
662 FRAME_X_WINDOW (f))
663 #else
664 #ifdef USE_GTK
665 #define GTK_WIDGET_TO_X_WIN(w) \
666 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
668 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
669 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
670 #define FRAME_OUTER_WINDOW(f) \
671 (FRAME_GTK_OUTER_WIDGET (f) ? \
672 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
673 FRAME_X_WINDOW (f))
675 #else /* !USE_GTK */
676 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
677 #endif /* !USE_GTK */
678 #endif
681 #define FRAME_FONT(f) ((f)->output_data.x->font)
682 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
683 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
684 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
685 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
687 /* This gives the x_display_info structure for the display F is on. */
688 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
690 /* This is the `Display *' which frame F is on. */
691 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
693 /* This is the `Screen *' which frame F is on. */
694 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
695 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
697 /* This is the Visual which frame F is on. */
698 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
700 /* This is the Colormap which frame F uses. */
701 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
703 /* This is the 'font_info *' which frame F has. */
704 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
706 /* The difference in pixels between the top left corner of the
707 Emacs window (including possible window manager decorations)
708 and FRAME_X_WINDOW (f). */
709 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
710 ((f)->output_data.x->x_pixels_outer_diff)
711 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
712 ((f)->output_data.x->y_pixels_outer_diff \
713 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
716 #define FRAME_XIC(f) ((f)->output_data.x->xic)
717 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
718 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
719 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
720 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
721 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
723 /* Value is the smallest width of any character in any font on frame F. */
725 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
726 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
728 /* Value is the smallest height of any font on frame F. */
730 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
731 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
733 /* X-specific scroll bar stuff. */
735 /* We represent scroll bars as lisp vectors. This allows us to place
736 references to them in windows without worrying about whether we'll
737 end up with windows referring to dead scroll bars; the garbage
738 collector will free it when its time comes.
740 We use struct scroll_bar as a template for accessing fields of the
741 vector. */
743 struct scroll_bar
745 /* These fields are shared by all vectors. */
746 EMACS_INT size_from_Lisp_Vector_struct;
747 struct Lisp_Vector *next_from_Lisp_Vector_struct;
749 /* The window we're a scroll bar for. */
750 Lisp_Object window;
752 /* The next and previous in the chain of scroll bars in this frame. */
753 Lisp_Object next, prev;
755 /* Fields from `x_window' down will not be traced by the GC. */
757 /* The X window representing this scroll bar. */
758 Window x_window;
760 /* The position and size of the scroll bar in pixels, relative to the
761 frame. */
762 int top, left, width, height;
764 /* The starting and ending positions of the handle, relative to the
765 handle area (i.e. zero is the top position, not
766 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
767 hasn't been drawn yet.
769 These are not actually the locations where the beginning and end
770 are drawn; in order to keep handles from becoming invisible when
771 editing large files, we establish a minimum height by always
772 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
773 where they would be normally; the bottom and top are in a
774 different co-ordinate system. */
775 int start, end;
777 /* If the scroll bar handle is currently being dragged by the user,
778 this is the number of pixels from the top of the handle to the
779 place where the user grabbed it. If the handle isn't currently
780 being dragged, this is Qnil. */
781 Lisp_Object dragging;
783 /* 1 if the background of the fringe that is adjacent to a scroll
784 bar is extended to the gap between the fringe and the bar. */
785 unsigned int fringe_extended_p : 1;
788 /* The number of elements a vector holding a struct scroll_bar needs. */
789 #define SCROLL_BAR_VEC_SIZE \
790 ((sizeof (struct scroll_bar) \
791 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
792 / sizeof (Lisp_Object))
794 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
795 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
798 /* Extract the X widget of the scroll bar from a struct scroll_bar.
799 XtWindowToWidget should be fast enough since Xt uses a hash table
800 to map windows to widgets. */
802 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
803 XtWindowToWidget (dpy, ptr->x_window)
805 /* Store a widget id in a struct scroll_bar. */
807 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
808 do { \
809 Window window = XtWindow (w); \
810 ptr->x_window = window; \
811 } while (0)
814 /* Return the inside width of a vertical scroll bar, given the outside
815 width. */
816 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
817 ((width) \
818 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
819 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
820 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
822 /* Return the length of the rectangle within which the top of the
823 handle must stay. This isn't equivalent to the inside height,
824 because the scroll bar handle has a minimum height.
826 This is the real range of motion for the scroll bar, so when we're
827 scaling buffer positions to scroll bar positions, we use this, not
828 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
829 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
830 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
832 /* Return the inside height of vertical scroll bar, given the outside
833 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
834 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
835 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
838 /* Border widths for scroll bars.
840 Scroll bar windows don't have any X borders; their border width is
841 set to zero, and we redraw borders ourselves. This makes the code
842 a bit cleaner, since we don't have to convert between outside width
843 (used when relating to the rest of the screen) and inside width
844 (used when sizing and drawing the scroll bar window itself).
846 The handle moves up and down/back and forth in a rectangle inset
847 from the edges of the scroll bar. These are widths by which we
848 inset the handle boundaries from the scroll bar edges. */
849 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
850 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
851 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
852 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
854 /* Minimum lengths for scroll bar handles, in pixels. */
855 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
857 /* Trimming off a few pixels from each side prevents
858 text from glomming up against the scroll bar */
859 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
862 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
863 or SELECTION_CLEAR_EVENT, then its contents are really described
864 by this structure. */
866 /* For an event of kind SELECTION_REQUEST_EVENT,
867 this structure really describes the contents.
868 **Don't make this struct longer!**
869 If it overlaps the frame_or_window field of struct input_event,
870 that will cause GC to crash. */
871 struct selection_input_event
873 int kind;
874 Display *display;
875 /* We spell it with an "o" here because X does. */
876 Window requestor;
877 Atom selection, target, property;
878 Time time;
881 #define SELECTION_EVENT_DISPLAY(eventp) \
882 (((struct selection_input_event *) (eventp))->display)
883 /* We spell it with an "o" here because X does. */
884 #define SELECTION_EVENT_REQUESTOR(eventp) \
885 (((struct selection_input_event *) (eventp))->requestor)
886 #define SELECTION_EVENT_SELECTION(eventp) \
887 (((struct selection_input_event *) (eventp))->selection)
888 #define SELECTION_EVENT_TARGET(eventp) \
889 (((struct selection_input_event *) (eventp))->target)
890 #define SELECTION_EVENT_PROPERTY(eventp) \
891 (((struct selection_input_event *) (eventp))->property)
892 #define SELECTION_EVENT_TIME(eventp) \
893 (((struct selection_input_event *) (eventp))->time)
896 struct window;
897 struct glyph_matrix;
898 struct frame;
899 struct input_event;
900 struct face;
901 struct image;
903 /* From xselect.c. */
905 void x_handle_selection_notify P_ ((XSelectionEvent *));
906 void x_handle_property_notify P_ ((XPropertyEvent *));
908 /* From xfns.c. */
910 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
911 Lisp_Object, Lisp_Object,
912 Lisp_Object, Lisp_Object));
913 struct frame *check_x_frame P_ ((Lisp_Object));
914 EXFUN (Fx_display_color_p, 1);
915 EXFUN (Fx_display_grayscale_p, 1);
916 extern void x_free_gcs P_ ((struct frame *));
918 /* From xrdb.c. */
920 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
921 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
922 int x_get_resource P_ ((XrmDatabase, char *, char *,
923 XrmRepresentation, XrmValue *));
924 void x_delete_display P_ ((struct x_display_info *));
925 void x_make_frame_visible P_ ((struct frame *));
926 void x_iconify_frame P_ ((struct frame *));
927 void x_wm_set_size_hint P_ ((struct frame *, long, int));
928 int x_text_icon P_ ((struct frame *, char *));
929 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
930 void x_set_window_size P_ ((struct frame *, int, int, int));
931 void x_wm_set_window_state P_ ((struct frame *, int));
932 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
934 /* Defined in xterm.c */
936 extern void cancel_mouse_face P_ ((struct frame *));
937 extern void x_scroll_bar_clear P_ ((struct frame *));
938 extern int x_text_icon P_ ((struct frame *, char *));
939 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
940 extern void x_catch_errors P_ ((Display *));
941 extern void x_check_errors P_ ((Display *, char *));
942 extern int x_had_errors_p P_ ((Display *));
943 extern int x_catching_errors P_ ((void));
944 extern void x_uncatch_errors P_ ((void));
945 extern void x_clear_errors P_ ((Display *));
946 extern void x_set_window_size P_ ((struct frame *, int, int, int));
947 extern void x_set_mouse_position P_ ((struct frame *, int, int));
948 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
949 extern void x_ewmh_activate_frame P_ ((struct frame *));
950 extern void x_raise_frame P_ ((struct frame *));
951 extern void x_lower_frame P_ ((struct frame *));
952 extern void x_make_frame_visible P_ ((struct frame *));
953 extern void x_make_frame_invisible P_ ((struct frame *));
954 extern void x_iconify_frame P_ ((struct frame *));
955 extern void x_free_frame_resources P_ ((struct frame *));
956 extern void x_destroy_window P_ ((struct frame *));
957 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
958 extern void x_wm_set_window_state P_ ((struct frame *, int));
959 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
960 extern void x_delete_display P_ ((struct x_display_info *));
961 extern void x_delete_terminal P_ ((struct terminal *terminal));
962 extern void x_initialize P_ ((void));
963 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
964 #ifdef USE_X_TOOLKIT
965 extern XtAppContext Xt_app_con;
966 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
967 unsigned long *,
968 double, int));
969 extern void x_activate_timeout_atimer P_ ((void));
970 #endif
971 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
972 extern void x_query_color P_ ((struct frame *f, XColor *));
973 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
974 extern void set_vertical_scroll_bar P_ ((struct window *));
976 extern int x_dispatch_event P_ ((XEvent *, Display *));
977 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
978 unsigned));
979 extern int x_display_pixel_height P_ ((struct x_display_info *));
980 extern int x_display_pixel_width P_ ((struct x_display_info *));
982 extern void x_set_sticky P_ ((struct frame *, Lisp_Object, Lisp_Object));
983 extern void x_wait_for_event P_ ((struct frame *, int));
985 /* Defined in xselect.c */
987 extern void x_handle_property_notify P_ ((XPropertyEvent *));
988 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
989 extern void x_handle_selection_event P_ ((struct input_event *));
990 extern void x_clear_frame_selections P_ ((struct frame *));
992 extern int x_handle_dnd_message P_ ((struct frame *,
993 XClientMessageEvent *,
994 struct x_display_info *,
995 struct input_event *bufp));
996 extern int x_check_property_data P_ ((Lisp_Object));
997 extern void x_fill_property_data P_ ((Display *,
998 Lisp_Object,
999 void *,
1000 int));
1001 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
1002 unsigned char *,
1003 Atom,
1004 int,
1005 unsigned long));
1007 /* Defined in xfns.c */
1009 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
1011 #ifdef USE_GTK
1012 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
1013 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
1014 #endif /* USE_GTK */
1016 extern void x_real_positions P_ ((struct frame *, int *, int *));
1017 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
1018 extern void x_set_border_pixel P_ ((struct frame *, int));
1019 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1020 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
1021 extern void xic_free_xfontset P_ ((struct frame *));
1022 extern void create_frame_xic P_ ((struct frame *));
1023 extern void destroy_frame_xic P_ ((struct frame *));
1024 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1025 extern void xic_set_statusarea P_ ((struct frame *));
1026 extern void xic_set_xfontset P_ ((struct frame *, char *));
1027 extern int x_pixel_width P_ ((struct frame *));
1028 extern int x_pixel_height P_ ((struct frame *));
1029 extern int x_char_width P_ ((struct frame *));
1030 extern int x_char_height P_ ((struct frame *));
1031 extern int x_screen_planes P_ ((struct frame *));
1032 extern void x_sync P_ ((struct frame *));
1033 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1034 #ifdef HAVE_X_I18N
1035 extern void free_frame_xic P_ ((struct frame *));
1036 #endif
1037 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1039 /* Defined in xfaces.c */
1041 extern int compute_glyph_face P_ ((struct frame *, int, int));
1042 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1043 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1044 unsigned long *, int));
1046 /* Defined in xmenu.c */
1048 extern void x_menu_set_in_use P_ ((int));
1049 extern void x_menu_wait_for_event P_ ((void *data));
1050 extern void x_activate_menubar P_ ((struct frame *));
1051 extern int popup_activated P_ ((void));
1052 extern void initialize_frame_menubar P_ ((struct frame *));
1053 extern void free_frame_menubar P_ ((struct frame *));
1055 /* Defined in widget.c */
1057 #ifdef USE_X_TOOLKIT
1058 extern void widget_store_internal_border P_ ((Widget));
1059 #endif
1061 /* Defined in xsmfns.c */
1062 #ifdef HAVE_X_SM
1063 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1064 extern int x_session_check_input P_ ((struct input_event *bufp));
1065 extern int x_session_have_connection P_ ((void));
1066 extern void x_session_close P_ ((void));
1067 #endif
1069 /* XEmbed implementation. */
1071 #define XEMBED_VERSION 0
1073 enum xembed_info
1075 XEMBED_MAPPED = 1 << 0
1078 enum xembed_message
1080 XEMBED_EMBEDDED_NOTIFY = 0,
1081 XEMBED_WINDOW_ACTIVATE = 1,
1082 XEMBED_WINDOW_DEACTIVATE = 2,
1083 XEMBED_REQUEST_FOCUS = 3,
1084 XEMBED_FOCUS_IN = 4,
1085 XEMBED_FOCUS_OUT = 5,
1086 XEMBED_FOCUS_NEXT = 6,
1087 XEMBED_FOCUS_PREV = 7,
1089 XEMBED_MODALITY_ON = 10,
1090 XEMBED_MODALITY_OFF = 11,
1091 XEMBED_REGISTER_ACCELERATOR = 12,
1092 XEMBED_UNREGISTER_ACCELERATOR = 13,
1093 XEMBED_ACTIVATE_ACCELERATOR = 14
1096 enum xembed_focus
1098 XEMBED_FOCUS_CURRENT = 0,
1099 XEMBED_FOCUS_FIRST = 1,
1100 XEMBED_FOCUS_LAST = 2
1103 enum xembed_modifier
1105 XEMBED_MODIFIER_SHIFT = 1 << 0,
1106 XEMBED_MODIFIER_CONTROL = 1 << 1,
1107 XEMBED_MODIFIER_ALT = 1 << 2,
1108 XEMBED_MODIFIER_SUPER = 1 << 3,
1109 XEMBED_MODIFIER_HYPER = 1 << 4
1112 enum xembed_accelerator
1114 XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1117 /* Defined in xterm.c */
1119 extern void xembed_set_info P_ ((struct frame *f, enum xembed_info flags));
1120 extern void xembed_send_message P_ ((struct frame *f, Time time,
1121 enum xembed_message message,
1122 long detail, long data1, long data2));
1124 /* Is the frame embedded into another application? */
1126 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1129 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1130 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1132 #define STORE_XCHAR2B(chp, b1, b2) \
1133 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1135 #define XCHAR2B_BYTE1(chp) \
1136 ((chp)->byte1)
1138 #define XCHAR2B_BYTE2(chp) \
1139 ((chp)->byte2)
1142 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1143 ((nr).x = (rx), \
1144 (nr).y = (ry), \
1145 (nr).width = (rwidth), \
1146 (nr).height = (rheight))
1148 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1149 (do not change this comment) */