Switch to recommended form of GPLv3 permissions notice.
[emacs.git] / src / xterm.h
blob6bb68cf915308fb3ba3142404a67c48ea36467f9
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 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, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #include <X11/Xlib.h>
23 #include <X11/cursorfont.h>
25 /* Include Xutil.h after keysym.h to work around a bug that prevents
26 correct recognition of AltGr key in some X versions. */
28 #include <X11/keysym.h>
29 #include <X11/Xutil.h>
31 #include <X11/Xatom.h>
32 #include <X11/Xresource.h>
34 #ifdef USE_X_TOOLKIT
35 #include <X11/StringDefs.h>
36 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
37 #include <X11/CoreP.h> /* foul, but we need this to use our own
38 window inside a widget instead of one
39 that Xt creates... */
40 #include <X11/StringDefs.h>
42 typedef Widget xt_or_gtk_widget;
43 #endif
45 #ifdef USE_GTK
46 #include <gtk/gtk.h>
47 #include <gdk/gdkx.h>
49 /* Some definitions to reduce conditionals. */
50 typedef GtkWidget *xt_or_gtk_widget;
51 #define XtParent(x) (gtk_widget_get_parent (x))
52 #undef XSync
53 #define XSync(d, b) do { gdk_window_process_all_updates (); \
54 XSync (d, b); } while (0)
57 #endif /* USE_GTK */
60 /* Bookkeeping to distinguish X versions. */
63 #ifdef HAVE_X_I18N
64 #include <X11/Xlocale.h>
65 #endif
67 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
68 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
69 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
70 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
72 #define FONT_WIDTH(f) ((f)->max_bounds.width)
73 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
74 #define FONT_BASE(f) ((f)->ascent)
75 #define FONT_DESCENT(f) ((f)->descent)
77 /* The mask of events that text windows always want to receive. This
78 includes mouse movement events, since handling the mouse-font text property
79 means that we must track mouse motion all the time. */
81 #define STANDARD_EVENT_SET \
82 (KeyPressMask \
83 | ExposureMask \
84 | ButtonPressMask \
85 | ButtonReleaseMask \
86 | PointerMotionMask \
87 | StructureNotifyMask \
88 | FocusChangeMask \
89 | LeaveWindowMask \
90 | EnterWindowMask \
91 | VisibilityChangeMask)
93 /* Structure recording X pixmap and reference count.
94 If REFCOUNT is 0 then this record is free to be reused. */
96 struct x_bitmap_record
98 Pixmap pixmap;
99 int have_mask;
100 Pixmap mask;
101 char *file;
102 int refcount;
103 /* Record some info about this pixmap. */
104 int height, width, depth;
107 /* For each X display, we have a structure that records
108 information about it. */
110 struct x_display_info
112 /* Chain of all x_display_info structures. */
113 struct x_display_info *next;
115 /* The generic display parameters corresponding to this X display. */
116 struct terminal *terminal;
118 /* Connection number (normally a file descriptor number). */
119 int connection;
121 /* This says how to access this display in Xlib. */
122 Display *display;
124 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
125 The same cons cell also appears in x_display_name_list. */
126 Lisp_Object name_list_element;
128 /* Number of frames that are on this display. */
129 int reference_count;
131 /* The Screen this connection is connected to. */
132 Screen *screen;
134 /* Dots per inch of the screen. */
135 double resx, resy;
137 /* The Visual being used for this display. */
138 Visual *visual;
140 /* The colormap being used. */
141 Colormap cmap;
143 /* Number of planes on this screen. */
144 int n_planes;
146 /* Dimensions of this screen. */
147 int height, width;
149 /* Mask of things that cause the mouse to be grabbed. */
150 int grabbed;
152 /* Emacs bitmap-id of the default icon bitmap for this frame.
153 Or -1 if none has been allocated yet. */
154 int icon_bitmap_id;
156 /* The root window of this screen. */
157 Window root_window;
159 /* Client leader window. */
160 Window client_leader_window;
162 /* The cursor to use for vertical scroll bars. */
163 Cursor vertical_scroll_bar_cursor;
165 #ifdef USE_GTK
166 /* The GDK cursor for scroll bars and popup menus. */
167 GdkCursor *xg_cursor;
168 #endif
170 /* X Resource data base */
171 XrmDatabase xrdb;
173 /* A table of all the fonts we have already loaded. */
174 struct font_info *font_table;
176 /* The current capacity of x_font_table. */
177 int font_table_size;
179 #ifdef USE_FONT_BACKEND
180 /* This provides a commonly used Font ID on this display. */
181 XFontStruct *font;
182 #endif
184 /* Minimum width over all characters in all fonts in font_table. */
185 int smallest_char_width;
187 /* Minimum font height over all fonts in font_table. */
188 int smallest_font_height;
190 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
191 GC scratch_cursor_gc;
193 /* These variables describe the range of text currently shown in its
194 mouse-face, together with the window they apply to. As long as
195 the mouse stays within this range, we need not redraw anything on
196 its account. Rows and columns are glyph matrix positions in
197 MOUSE_FACE_WINDOW. */
198 int mouse_face_beg_row, mouse_face_beg_col;
199 int mouse_face_beg_x, mouse_face_beg_y;
200 int mouse_face_end_row, mouse_face_end_col;
201 int mouse_face_end_x, mouse_face_end_y;
202 int mouse_face_past_end;
203 Lisp_Object mouse_face_window;
204 int mouse_face_face_id;
205 Lisp_Object mouse_face_overlay;
207 /* 1 if a mouse motion event came and we didn't handle it right away because
208 gc was in progress. */
209 int mouse_face_deferred_gc;
211 /* FRAME and X, Y position of mouse when last checked for
212 highlighting. X and Y can be negative or out of range for the frame. */
213 struct frame *mouse_face_mouse_frame;
214 int mouse_face_mouse_x, mouse_face_mouse_y;
216 /* Nonzero means defer mouse-motion highlighting. */
217 int mouse_face_defer;
219 /* Nonzero means that the mouse highlight should not be shown. */
220 int mouse_face_hidden;
222 int mouse_face_image_state;
224 char *x_id_name;
226 /* The number of fonts actually stored in x_font_table.
227 font_table[n] is used and valid if 0 <= n < n_fonts. 0 <=
228 n_fonts <= font_table_size and font_table[i].name != 0. */
229 int n_fonts;
231 /* Pointer to bitmap records. */
232 struct x_bitmap_record *bitmaps;
234 /* Allocated size of bitmaps field. */
235 int bitmaps_size;
237 /* Last used bitmap index. */
238 int bitmaps_last;
240 /* Which modifier keys are on which modifier bits?
242 With each keystroke, X returns eight bits indicating which modifier
243 keys were held down when the key was pressed. The interpretation
244 of the top five modifier bits depends on what keys are attached
245 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
246 is the meta bit.
248 meta_mod_mask is a mask containing the bits used for the meta key.
249 It may have more than one bit set, if more than one modifier bit
250 has meta keys on it. Basically, if EVENT is a KeyPress event,
251 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
253 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
254 lock modifier bit, or zero otherwise. Non-alphabetic keys should
255 only be affected by the lock modifier bit if XK_Shift_Lock is in
256 use; XK_Caps_Lock should only affect alphabetic keys. With this
257 arrangement, the lock modifier should shift the character if
258 (EVENT.state & shift_lock_mask) != 0. */
259 int meta_mod_mask, shift_lock_mask;
261 /* These are like meta_mod_mask, but for different modifiers. */
262 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
264 /* Communication with window managers. */
265 Atom Xatom_wm_protocols;
267 /* Kinds of protocol things we may receive. */
268 Atom Xatom_wm_take_focus;
269 Atom Xatom_wm_save_yourself;
270 Atom Xatom_wm_delete_window;
272 /* Atom for indicating window state to the window manager. */
273 Atom Xatom_wm_change_state;
275 /* Other WM communication */
276 Atom Xatom_wm_configure_denied; /* When our config request is denied */
277 Atom Xatom_wm_window_moved; /* When the WM moves us. */
278 Atom Xatom_wm_client_leader; /* Id of client leader window. */
280 /* EditRes protocol */
281 Atom Xatom_editres;
283 /* More atoms, which are selection types. */
284 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
285 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
286 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
287 Xatom_ATOM_PAIR;
289 /* More atoms for font properties. The last three are private
290 properties, see the comments in src/fontset.h. */
291 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
292 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
293 Xatom_MULE_DEFAULT_ASCENT;
295 /* More atoms for Ghostscript support. */
296 Atom Xatom_DONE, Xatom_PAGE;
298 /* Atom used in toolkit scroll bar client messages. */
299 Atom Xatom_Scrollbar;
301 /* Atom used in XEmbed client messages. */
302 Atom Xatom_XEMBED;
304 int cut_buffers_initialized; /* Whether we're sure they all exist */
306 /* The frame (if any) which has the X window that has keyboard focus.
307 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
308 that a mere EnterNotify event can set this; if you need to know the
309 last frame specified in a FocusIn or FocusOut event, use
310 x_focus_event_frame. */
311 struct frame *x_focus_frame;
313 /* The last frame mentioned in a FocusIn or FocusOut event. This is
314 separate from x_focus_frame, because whether or not LeaveNotify
315 events cause us to lose focus depends on whether or not we have
316 received a FocusIn event for it. */
317 struct frame *x_focus_event_frame;
319 /* The frame which currently has the visual highlight, and should get
320 keyboard input (other sorts of input have the frame encoded in the
321 event). It points to the X focus frame's selected window's
322 frame. It differs from x_focus_frame when we're using a global
323 minibuffer. */
324 struct frame *x_highlight_frame;
326 /* The null pixel used for filling a character background with
327 background color of a gc. */
328 Pixmap null_pixel;
330 /* The gray pixmap. */
331 Pixmap gray;
333 #ifdef HAVE_X_I18N
334 /* XIM (X Input method). */
335 XIM xim;
336 XIMStyles *xim_styles;
337 #endif
339 /* If non-null, a cache of the colors in the color map. Don't
340 use this directly, call x_color_cells instead. */
341 XColor *color_cells;
342 int ncolor_cells;
344 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
345 int red_bits, blue_bits, green_bits;
346 int red_offset, blue_offset, green_offset;
348 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
349 to x/y 0/0, some window managers (type A) puts the window manager
350 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
351 Other window managers (type B) puts the window including decorations
352 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
353 Record the type of WM in use so we can compensate for type A WMs. */
354 enum
356 X_WMTYPE_UNKNOWN,
357 X_WMTYPE_A,
358 X_WMTYPE_B
359 } wm_type;
362 /* Atoms that are drag and drop atoms */
363 Atom *x_dnd_atoms;
364 size_t x_dnd_atoms_size;
365 size_t x_dnd_atoms_length;
367 /* Extended window manager hints, Atoms supported by the window manager */
368 Atom *net_supported_atoms;
369 int nr_net_supported_atoms;
370 Window net_supported_window;
373 #ifdef HAVE_X_I18N
374 /* Whether or not to use XIM if we have it. */
375 extern int use_xim;
376 #endif
378 /* This checks to make sure we have a display. */
379 extern void check_x P_ ((void));
381 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
383 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
384 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
385 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
386 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
387 #endif
389 /* This is a chain of structures for all the X displays currently in use. */
390 extern struct x_display_info *x_display_list;
392 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
393 one for each element of x_display_list and in the same order.
394 NAME is the name of the frame.
395 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
396 extern Lisp_Object x_display_name_list;
398 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
399 extern Lisp_Object Vx_pixel_size_width_font_regexp;
401 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
402 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
404 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
405 extern int x_display_ok P_ ((const char *));
407 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
408 extern void select_visual P_ ((struct x_display_info *));
409 extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
410 extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
411 extern struct font_info *x_query_font P_ ((struct frame *, char *));
412 extern void x_find_ccl_program P_ ((struct font_info *));
413 extern Lisp_Object x_get_font_repertory P_ ((struct frame *,
414 struct font_info *));
417 /* Each X frame object points to its own struct x_output object
418 in the output_data.x field. The x_output structure contains
419 the information that is specific to X windows. */
421 struct x_output
423 /* Height of menu bar widget, in pixels.
424 Zero if not using the X toolkit.
425 When using the toolkit, this value is not meaningful
426 if the menubar is turned off. */
427 int menubar_height;
429 /* Height of tool bar widget, in pixels.
430 Zero if not using an external tool bar. */
431 int toolbar_height;
433 /* The tiled border used when the mouse is out of the frame. */
434 Pixmap border_tile;
436 /* Here are the Graphics Contexts for the default font. */
437 GC normal_gc; /* Normal video */
438 GC reverse_gc; /* Reverse video */
439 GC cursor_gc; /* cursor drawing */
441 /* The X window used for this frame.
442 May be zero while the frame object is being created
443 and the X window has not yet been created. */
444 Window window_desc;
446 /* The X window used for the bitmap icon;
447 or 0 if we don't have a bitmap icon. */
448 Window icon_desc;
450 /* The X window that is the parent of this X window.
451 Usually this is a window that was made by the window manager,
452 but it can be the root window, and it can be explicitly specified
453 (see the explicit_parent field, below). */
454 Window parent_desc;
456 #ifdef USE_X_TOOLKIT
457 /* The widget of this screen. This is the window of a "shell" widget. */
458 Widget widget;
459 /* The XmPanedWindows... */
460 Widget column_widget;
461 /* The widget of the edit portion of this screen; the window in
462 "window_desc" is inside of this. */
463 Widget edit_widget;
465 Widget menubar_widget;
466 #endif
468 #ifdef USE_GTK
469 /* The widget of this screen. This is the window of a top widget. */
470 GtkWidget *widget;
471 /* The widget of the edit portion of this screen; the window in
472 "window_desc" is inside of this. */
473 GtkWidget *edit_widget;
474 /* The widget used for laying out widgets vertically. */
475 GtkWidget *vbox_widget;
476 /* The menubar in this frame. */
477 GtkWidget *menubar_widget;
478 /* The tool bar in this frame */
479 GtkWidget *toolbar_widget;
480 /* The handle box that makes the tool bar detachable. */
481 GtkWidget *handlebox_widget;
482 /* Non-zero if the tool bar is detached. */
483 int toolbar_detached;
485 /* The last size hints set. */
486 GdkGeometry size_hints;
487 long hint_flags;
488 #endif
490 /* If >=0, a bitmap index. The indicated bitmap is used for the
491 icon. */
492 int icon_bitmap;
494 /* Default ASCII font of this frame. */
495 XFontStruct *font;
497 #ifdef USE_FONT_BACKEND
498 struct font *fontp;
499 #endif /* USE_FONT_BACKEND */
501 /* The baseline offset of the default ASCII font. */
502 int baseline_offset;
504 /* If a fontset is specified for this frame instead of font, this
505 value contains an ID of the fontset, else -1. */
506 int fontset;
508 /* Pixel values used for various purposes.
509 border_pixel may be -1 meaning use a gray tile. */
510 #if 0 /* These are also defined in struct frame. Use that instead. */
511 unsigned long background_pixel;
512 unsigned long foreground_pixel;
513 #endif
514 unsigned long cursor_pixel;
515 unsigned long border_pixel;
516 unsigned long mouse_pixel;
517 unsigned long cursor_foreground_pixel;
519 /* Foreground color for scroll bars. A value of -1 means use the
520 default (black for non-toolkit scroll bars). */
521 unsigned long scroll_bar_foreground_pixel;
523 /* Background color for scroll bars. A value of -1 means use the
524 default (background color of the frame for non-toolkit scroll
525 bars). */
526 unsigned long scroll_bar_background_pixel;
528 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
529 let the scroll compute them itself. */
530 unsigned long scroll_bar_top_shadow_pixel;
531 unsigned long scroll_bar_bottom_shadow_pixel;
533 /* Descriptor for the cursor in use for this window. */
534 Cursor text_cursor;
535 Cursor nontext_cursor;
536 Cursor modeline_cursor;
537 Cursor hand_cursor;
538 Cursor hourglass_cursor;
539 Cursor horizontal_drag_cursor;
541 /* Window whose cursor is hourglass_cursor. This window is temporarily
542 mapped to display an hourglass cursor. */
543 Window hourglass_window;
545 /* Non-zero means hourglass cursor is currently displayed. */
546 unsigned hourglass_p : 1;
548 /* Flag to set when the X window needs to be completely repainted. */
549 int needs_exposure;
551 /* These are the current window manager hints. It seems that
552 XSetWMHints, when presented with an unset bit in the `flags'
553 member of the hints structure, does not leave the corresponding
554 attribute unchanged; rather, it resets that attribute to its
555 default value. For example, unless you set the `icon_pixmap'
556 field and the `IconPixmapHint' bit, XSetWMHints will forget what
557 your icon pixmap was. This is rather troublesome, since some of
558 the members (for example, `input' and `icon_pixmap') want to stay
559 the same throughout the execution of Emacs. So, we keep this
560 structure around, just leaving values in it and adding new bits
561 to the mask as we go. */
562 XWMHints wm_hints;
564 /* This is the Emacs structure for the X display this frame is on. */
565 struct x_display_info *display_info;
567 /* This is a button event that wants to activate the menubar.
568 We save it here until the command loop gets to think about it. */
569 XEvent *saved_menu_event;
571 /* This is the widget id used for this frame's menubar in lwlib. */
572 #ifdef USE_X_TOOLKIT
573 int id;
574 #endif
576 /* Nonzero means our parent is another application's window
577 and was explicitly specified. */
578 char explicit_parent;
580 /* Nonzero means tried already to make this frame visible. */
581 char asked_for_visible;
583 /* Nonzero if this frame was ever previously visible. */
584 char has_been_visible;
586 #ifdef HAVE_X_I18N
587 /* Input context (currently, this means Compose key handler setup). */
588 XIC xic;
589 XIMStyle xic_style;
590 XFontSet xic_xfs;
591 char *xic_base_fontname;
592 #endif
594 /* Relief GCs, colors etc. */
595 struct relief
597 GC gc;
598 unsigned long pixel;
599 int allocated_p;
601 black_relief, white_relief;
603 /* The background for which the above relief GCs were set up.
604 They are changed only when a different background is involved. */
605 unsigned long relief_background;
607 /* Xt waits for a ConfigureNotify event from the window manager in
608 EmacsFrameSetCharSize when the shell widget is resized. For some
609 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
610 arrive for an unknown reason and Emacs hangs in Xt. If this is
611 zero, tell Xt not to wait. */
612 int wait_for_wm;
614 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
615 two might differ by a pixel, depending on WM */
616 int x_pixels_outer_diff;
618 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
619 these may differ because this does not take into account possible
620 menubar. y_pixels_diff is with menubar height included */
621 int y_pixels_outer_diff;
623 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
624 frame, or IMPLICIT if we received an EnterNotify.
625 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
626 int focus_state;
628 /* The offset we need to add to compensate for type A WMs. */
629 int move_offset_top;
630 int move_offset_left;
632 /* The frame's left/top offsets before we call XMoveWindow. See
633 x_check_expected_move. */
634 int left_before_move;
635 int top_before_move;
638 #define No_Cursor (None)
640 enum
642 /* Values for focus_state, used as bit mask.
643 EXPLICIT means we received a FocusIn for the frame and know it has
644 the focus. IMPLICIT means we recevied an EnterNotify and the frame
645 may have the focus if no window manager is running.
646 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
647 FOCUS_NONE = 0,
648 FOCUS_IMPLICIT = 1,
649 FOCUS_EXPLICIT = 2
653 /* Return the X output data for frame F. */
654 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
656 /* Return the X window used for displaying data in frame F. */
657 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
659 /* Return the outermost X window associated with the frame F. */
660 #ifdef USE_X_TOOLKIT
661 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
662 XtWindow ((f)->output_data.x->widget) : \
663 FRAME_X_WINDOW (f))
664 #else
665 #ifdef USE_GTK
666 #define GTK_WIDGET_TO_X_WIN(w) \
667 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
669 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
670 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
671 #define FRAME_OUTER_WINDOW(f) \
672 (FRAME_GTK_OUTER_WIDGET (f) ? \
673 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
674 FRAME_X_WINDOW (f))
676 #else /* !USE_GTK */
677 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
678 #endif /* !USE_GTK */
679 #endif
682 #define FRAME_FONT(f) ((f)->output_data.x->font)
683 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
684 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
685 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
686 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
688 #ifdef USE_FONT_BACKEND
689 #define FRAME_FONT_OBJECT(f) ((f)->output_data.x->fontp)
690 #endif /* USE_FONT_BACKEND */
692 /* This gives the x_display_info structure for the display F is on. */
693 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
695 /* This is the `Display *' which frame F is on. */
696 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
698 /* This is the `Screen *' which frame F is on. */
699 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
700 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
702 /* This is the Visual which frame F is on. */
703 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
705 /* This is the Colormap which frame F uses. */
706 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
708 /* This is the 'font_info *' which frame F has. */
709 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
711 /* The difference in pixels between the top left corner of the
712 Emacs window (including possible window manager decorations)
713 and FRAME_X_WINDOW (f). */
714 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
715 ((f)->output_data.x->x_pixels_outer_diff)
716 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
717 ((f)->output_data.x->y_pixels_outer_diff \
718 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
721 #define FRAME_XIC(f) ((f)->output_data.x->xic)
722 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
723 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
724 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
725 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
726 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
728 /* Value is the smallest width of any character in any font on frame F. */
730 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
731 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
733 /* Value is the smallest height of any font on frame F. */
735 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
736 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
738 /* X-specific scroll bar stuff. */
740 /* We represent scroll bars as lisp vectors. This allows us to place
741 references to them in windows without worrying about whether we'll
742 end up with windows referring to dead scroll bars; the garbage
743 collector will free it when its time comes.
745 We use struct scroll_bar as a template for accessing fields of the
746 vector. */
748 struct scroll_bar
750 /* These fields are shared by all vectors. */
751 EMACS_INT size_from_Lisp_Vector_struct;
752 struct Lisp_Vector *next_from_Lisp_Vector_struct;
754 /* The window we're a scroll bar for. */
755 Lisp_Object window;
757 /* The next and previous in the chain of scroll bars in this frame. */
758 Lisp_Object next, prev;
760 /* Fields from `x_window' down will not be traced by the GC. */
762 /* The X window representing this scroll bar. */
763 Window x_window;
765 /* The position and size of the scroll bar in pixels, relative to the
766 frame. */
767 int top, left, width, height;
769 /* The starting and ending positions of the handle, relative to the
770 handle area (i.e. zero is the top position, not
771 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
772 hasn't been drawn yet.
774 These are not actually the locations where the beginning and end
775 are drawn; in order to keep handles from becoming invisible when
776 editing large files, we establish a minimum height by always
777 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
778 where they would be normally; the bottom and top are in a
779 different co-ordinate system. */
780 int start, end;
782 /* If the scroll bar handle is currently being dragged by the user,
783 this is the number of pixels from the top of the handle to the
784 place where the user grabbed it. If the handle isn't currently
785 being dragged, this is Qnil. */
786 Lisp_Object dragging;
788 /* 1 if the background of the fringe that is adjacent to a scroll
789 bar is extended to the gap between the fringe and the bar. */
790 unsigned int fringe_extended_p : 1;
793 /* The number of elements a vector holding a struct scroll_bar needs. */
794 #define SCROLL_BAR_VEC_SIZE \
795 ((sizeof (struct scroll_bar) \
796 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
797 / sizeof (Lisp_Object))
799 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
800 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
803 /* Extract the X widget of the scroll bar from a struct scroll_bar.
804 XtWindowToWidget should be fast enough since Xt uses a hash table
805 to map windows to widgets. */
807 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
808 XtWindowToWidget (dpy, ptr->x_window)
810 /* Store a widget id in a struct scroll_bar. */
812 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
813 do { \
814 Window window = XtWindow (w); \
815 ptr->x_window = window; \
816 } while (0)
819 /* Return the inside width of a vertical scroll bar, given the outside
820 width. */
821 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
822 ((width) \
823 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
824 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
825 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
827 /* Return the length of the rectangle within which the top of the
828 handle must stay. This isn't equivalent to the inside height,
829 because the scroll bar handle has a minimum height.
831 This is the real range of motion for the scroll bar, so when we're
832 scaling buffer positions to scroll bar positions, we use this, not
833 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
834 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
835 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
837 /* Return the inside height of vertical scroll bar, given the outside
838 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
839 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
840 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
843 /* Border widths for scroll bars.
845 Scroll bar windows don't have any X borders; their border width is
846 set to zero, and we redraw borders ourselves. This makes the code
847 a bit cleaner, since we don't have to convert between outside width
848 (used when relating to the rest of the screen) and inside width
849 (used when sizing and drawing the scroll bar window itself).
851 The handle moves up and down/back and forth in a rectangle inset
852 from the edges of the scroll bar. These are widths by which we
853 inset the handle boundaries from the scroll bar edges. */
854 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
855 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
856 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
857 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
859 /* Minimum lengths for scroll bar handles, in pixels. */
860 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
862 /* Trimming off a few pixels from each side prevents
863 text from glomming up against the scroll bar */
864 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
867 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
868 or SELECTION_CLEAR_EVENT, then its contents are really described
869 by this structure. */
871 /* For an event of kind SELECTION_REQUEST_EVENT,
872 this structure really describes the contents.
873 **Don't make this struct longer!**
874 If it overlaps the frame_or_window field of struct input_event,
875 that will cause GC to crash. */
876 struct selection_input_event
878 int kind;
879 Display *display;
880 /* We spell it with an "o" here because X does. */
881 Window requestor;
882 Atom selection, target, property;
883 Time time;
886 #define SELECTION_EVENT_DISPLAY(eventp) \
887 (((struct selection_input_event *) (eventp))->display)
888 /* We spell it with an "o" here because X does. */
889 #define SELECTION_EVENT_REQUESTOR(eventp) \
890 (((struct selection_input_event *) (eventp))->requestor)
891 #define SELECTION_EVENT_SELECTION(eventp) \
892 (((struct selection_input_event *) (eventp))->selection)
893 #define SELECTION_EVENT_TARGET(eventp) \
894 (((struct selection_input_event *) (eventp))->target)
895 #define SELECTION_EVENT_PROPERTY(eventp) \
896 (((struct selection_input_event *) (eventp))->property)
897 #define SELECTION_EVENT_TIME(eventp) \
898 (((struct selection_input_event *) (eventp))->time)
901 struct window;
902 struct glyph_matrix;
903 struct frame;
904 struct input_event;
905 struct face;
906 struct image;
908 /* From xselect.c. */
910 void x_handle_selection_notify P_ ((XSelectionEvent *));
911 void x_handle_property_notify P_ ((XPropertyEvent *));
913 /* From xfns.c. */
915 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
916 Lisp_Object, Lisp_Object,
917 Lisp_Object, Lisp_Object));
918 struct frame *check_x_frame P_ ((Lisp_Object));
919 EXFUN (Fx_display_color_p, 1);
920 EXFUN (Fx_display_grayscale_p, 1);
921 extern void x_free_gcs P_ ((struct frame *));
923 /* From xrdb.c. */
925 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
926 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
927 int x_get_resource P_ ((XrmDatabase, char *, char *,
928 XrmRepresentation, XrmValue *));
929 void x_delete_display P_ ((struct x_display_info *));
930 void x_make_frame_visible P_ ((struct frame *));
931 void x_iconify_frame P_ ((struct frame *));
932 void x_wm_set_size_hint P_ ((struct frame *, long, int));
933 int x_text_icon P_ ((struct frame *, char *));
934 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
935 void x_set_window_size P_ ((struct frame *, int, int, int));
936 void x_wm_set_window_state P_ ((struct frame *, int));
937 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
939 /* Defined in xterm.c */
941 extern void cancel_mouse_face P_ ((struct frame *));
942 extern void x_scroll_bar_clear P_ ((struct frame *));
943 extern int x_text_icon P_ ((struct frame *, char *));
944 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
945 extern void x_catch_errors P_ ((Display *));
946 extern void x_check_errors P_ ((Display *, char *));
947 extern int x_had_errors_p P_ ((Display *));
948 extern int x_catching_errors P_ ((void));
949 extern void x_uncatch_errors P_ ((void));
950 extern void x_clear_errors P_ ((Display *));
951 extern void x_set_window_size P_ ((struct frame *, int, int, int));
952 extern void x_set_mouse_position P_ ((struct frame *, int, int));
953 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
954 extern void x_ewmh_activate_frame P_ ((struct frame *));
955 extern void x_raise_frame P_ ((struct frame *));
956 extern void x_lower_frame P_ ((struct frame *));
957 extern void x_make_frame_visible P_ ((struct frame *));
958 extern void x_make_frame_invisible P_ ((struct frame *));
959 extern void x_iconify_frame P_ ((struct frame *));
960 extern void x_free_frame_resources P_ ((struct frame *));
961 extern void x_destroy_window P_ ((struct frame *));
962 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
963 extern void x_wm_set_window_state P_ ((struct frame *, int));
964 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
965 extern void x_delete_display P_ ((struct x_display_info *));
966 extern void x_delete_terminal P_ ((struct terminal *terminal));
967 extern void x_initialize P_ ((void));
968 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
969 #ifdef USE_X_TOOLKIT
970 extern XtAppContext Xt_app_con;
971 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
972 unsigned long *,
973 double, int));
974 extern void x_activate_timeout_atimer P_ ((void));
975 #endif
976 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
977 extern void x_query_color P_ ((struct frame *f, XColor *));
978 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
979 extern void set_vertical_scroll_bar P_ ((struct window *));
981 extern int x_dispatch_event P_ ((XEvent *, Display *));
982 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
983 unsigned));
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) */