(end-of-defun-function): Make it more clear that
[emacs.git] / src / xterm.h
blobb520c1dfd11566a586f8fd6036a1f252c0620592
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 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 #ifdef USE_GTK
170 /* The GDK cursor for scroll bars and popup menus. */
171 GdkCursor *xg_cursor;
172 #endif
174 /* X Resource data base */
175 XrmDatabase xrdb;
177 /* Minimum width over all characters in all fonts in font_table. */
178 int smallest_char_width;
180 /* Minimum font height over all fonts in font_table. */
181 int smallest_font_height;
183 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
184 GC scratch_cursor_gc;
186 /* These variables describe the range of text currently shown in its
187 mouse-face, together with the window they apply to. As long as
188 the mouse stays within this range, we need not redraw anything on
189 its account. Rows and columns are glyph matrix positions in
190 MOUSE_FACE_WINDOW. */
191 int mouse_face_beg_row, mouse_face_beg_col;
192 int mouse_face_beg_x, mouse_face_beg_y;
193 int mouse_face_end_row, mouse_face_end_col;
194 int mouse_face_end_x, mouse_face_end_y;
195 int mouse_face_past_end;
196 Lisp_Object mouse_face_window;
197 int mouse_face_face_id;
198 Lisp_Object mouse_face_overlay;
200 /* 1 if a mouse motion event came and we didn't handle it right away because
201 gc was in progress. */
202 int mouse_face_deferred_gc;
204 /* FRAME and X, Y position of mouse when last checked for
205 highlighting. X and Y can be negative or out of range for the frame. */
206 struct frame *mouse_face_mouse_frame;
207 int mouse_face_mouse_x, mouse_face_mouse_y;
209 /* Nonzero means defer mouse-motion highlighting. */
210 int mouse_face_defer;
212 /* Nonzero means that the mouse highlight should not be shown. */
213 int mouse_face_hidden;
215 int mouse_face_image_state;
217 char *x_id_name;
219 /* The number of fonts opened for this display. */
220 int n_fonts;
222 /* Pointer to bitmap records. */
223 struct x_bitmap_record *bitmaps;
225 /* Allocated size of bitmaps field. */
226 int bitmaps_size;
228 /* Last used bitmap index. */
229 int bitmaps_last;
231 /* Which modifier keys are on which modifier bits?
233 With each keystroke, X returns eight bits indicating which modifier
234 keys were held down when the key was pressed. The interpretation
235 of the top five modifier bits depends on what keys are attached
236 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
237 is the meta bit.
239 meta_mod_mask is a mask containing the bits used for the meta key.
240 It may have more than one bit set, if more than one modifier bit
241 has meta keys on it. Basically, if EVENT is a KeyPress event,
242 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
244 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
245 lock modifier bit, or zero otherwise. Non-alphabetic keys should
246 only be affected by the lock modifier bit if XK_Shift_Lock is in
247 use; XK_Caps_Lock should only affect alphabetic keys. With this
248 arrangement, the lock modifier should shift the character if
249 (EVENT.state & shift_lock_mask) != 0. */
250 int meta_mod_mask, shift_lock_mask;
252 /* These are like meta_mod_mask, but for different modifiers. */
253 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
255 /* Communication with window managers. */
256 Atom Xatom_wm_protocols;
258 /* Kinds of protocol things we may receive. */
259 Atom Xatom_wm_take_focus;
260 Atom Xatom_wm_save_yourself;
261 Atom Xatom_wm_delete_window;
263 /* Atom for indicating window state to the window manager. */
264 Atom Xatom_wm_change_state;
266 /* Other WM communication */
267 Atom Xatom_wm_configure_denied; /* When our config request is denied */
268 Atom Xatom_wm_window_moved; /* When the WM moves us. */
269 Atom Xatom_wm_client_leader; /* Id of client leader window. */
271 /* EditRes protocol */
272 Atom Xatom_editres;
274 /* More atoms, which are selection types. */
275 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
276 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
277 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
278 Xatom_ATOM_PAIR;
280 /* More atoms for font properties. The last three are private
281 properties, see the comments in src/fontset.h. */
282 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
283 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
284 Xatom_MULE_DEFAULT_ASCENT;
286 /* More atoms for Ghostscript support. */
287 Atom Xatom_DONE, Xatom_PAGE;
289 /* Atom used in toolkit scroll bar client messages. */
290 Atom Xatom_Scrollbar;
292 /* Atom used in XEmbed client messages. */
293 Atom Xatom_XEMBED;
295 int cut_buffers_initialized; /* Whether we're sure they all exist */
297 /* The frame (if any) which has the X window that has keyboard focus.
298 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
299 that a mere EnterNotify event can set this; if you need to know the
300 last frame specified in a FocusIn or FocusOut event, use
301 x_focus_event_frame. */
302 struct frame *x_focus_frame;
304 /* The last frame mentioned in a FocusIn or FocusOut event. This is
305 separate from x_focus_frame, because whether or not LeaveNotify
306 events cause us to lose focus depends on whether or not we have
307 received a FocusIn event for it. */
308 struct frame *x_focus_event_frame;
310 /* The frame which currently has the visual highlight, and should get
311 keyboard input (other sorts of input have the frame encoded in the
312 event). It points to the X focus frame's selected window's
313 frame. It differs from x_focus_frame when we're using a global
314 minibuffer. */
315 struct frame *x_highlight_frame;
317 /* The gray pixmap. */
318 Pixmap gray;
320 #ifdef HAVE_X_I18N
321 /* XIM (X Input method). */
322 XIM xim;
323 XIMStyles *xim_styles;
324 struct xim_inst_t *xim_callback_data;
325 #endif
327 /* If non-null, a cache of the colors in the color map. Don't
328 use this directly, call x_color_cells instead. */
329 XColor *color_cells;
330 int ncolor_cells;
332 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
333 int red_bits, blue_bits, green_bits;
334 int red_offset, blue_offset, green_offset;
336 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
337 to x/y 0/0, some window managers (type A) puts the window manager
338 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
339 Other window managers (type B) puts the window including decorations
340 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
341 Record the type of WM in use so we can compensate for type A WMs. */
342 enum
344 X_WMTYPE_UNKNOWN,
345 X_WMTYPE_A,
346 X_WMTYPE_B
347 } wm_type;
350 /* Atoms that are drag and drop atoms */
351 Atom *x_dnd_atoms;
352 size_t x_dnd_atoms_size;
353 size_t x_dnd_atoms_length;
355 /* Extended window manager hints, Atoms supported by the window manager */
356 Atom *net_supported_atoms;
357 int nr_net_supported_atoms;
358 Window net_supported_window;
361 #ifdef HAVE_X_I18N
362 /* Whether or not to use XIM if we have it. */
363 extern int use_xim;
364 #endif
366 /* This checks to make sure we have a display. */
367 extern void check_x P_ ((void));
369 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
371 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
372 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
373 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
374 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
375 #endif
377 /* This is a chain of structures for all the X displays currently in use. */
378 extern struct x_display_info *x_display_list;
380 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
381 one for each element of x_display_list and in the same order.
382 NAME is the name of the frame.
383 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
384 extern Lisp_Object x_display_name_list;
386 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
387 extern Lisp_Object Vx_pixel_size_width_font_regexp;
389 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
390 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
391 extern void x_set_frame_alpha P_ ((struct frame *));
393 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
394 extern int x_display_ok P_ ((const char *));
396 extern void select_visual P_ ((struct x_display_info *));
399 struct font;
401 /* Each X frame object points to its own struct x_output object
402 in the output_data.x field. The x_output structure contains
403 the information that is specific to X windows. */
405 struct x_output
407 /* Height of menu bar widget, in pixels.
408 Zero if not using the X toolkit.
409 When using the toolkit, this value is not meaningful
410 if the menubar is turned off. */
411 int menubar_height;
413 /* Height of tool bar widget, in pixels.
414 Zero if not using an external tool bar. */
415 int toolbar_height;
417 /* The tiled border used when the mouse is out of the frame. */
418 Pixmap border_tile;
420 /* Here are the Graphics Contexts for the default font. */
421 GC normal_gc; /* Normal video */
422 GC reverse_gc; /* Reverse video */
423 GC cursor_gc; /* cursor drawing */
425 /* The X window used for this frame.
426 May be zero while the frame object is being created
427 and the X window has not yet been created. */
428 Window window_desc;
430 /* The X window used for the bitmap icon;
431 or 0 if we don't have a bitmap icon. */
432 Window icon_desc;
434 /* The X window that is the parent of this X window.
435 Usually this is a window that was made by the window manager,
436 but it can be the root window, and it can be explicitly specified
437 (see the explicit_parent field, below). */
438 Window parent_desc;
440 #ifdef USE_X_TOOLKIT
441 /* The widget of this screen. This is the window of a "shell" widget. */
442 Widget widget;
443 /* The XmPanedWindows... */
444 Widget column_widget;
445 /* The widget of the edit portion of this screen; the window in
446 "window_desc" is inside of this. */
447 Widget edit_widget;
449 Widget menubar_widget;
450 #endif
452 #ifdef USE_GTK
453 /* The widget of this screen. This is the window of a top widget. */
454 GtkWidget *widget;
455 /* The widget of the edit portion of this screen; the window in
456 "window_desc" is inside of this. */
457 GtkWidget *edit_widget;
458 /* The widget used for laying out widgets vertically. */
459 GtkWidget *vbox_widget;
460 /* The menubar in this frame. */
461 GtkWidget *menubar_widget;
462 /* The tool bar in this frame */
463 GtkWidget *toolbar_widget;
464 /* The handle box that makes the tool bar detachable. */
465 GtkWidget *handlebox_widget;
466 /* Non-zero if the tool bar is detached. */
467 int toolbar_detached;
469 /* The last size hints set. */
470 GdkGeometry size_hints;
471 long hint_flags;
472 #endif
474 /* If >=0, a bitmap index. The indicated bitmap is used for the
475 icon. */
476 int icon_bitmap;
478 /* Default ASCII font of this frame. */
479 struct font *font;
481 /* The baseline offset of the default ASCII font. */
482 int baseline_offset;
484 /* If a fontset is specified for this frame instead of font, this
485 value contains an ID of the fontset, else -1. */
486 int fontset;
488 /* Pixel values used for various purposes.
489 border_pixel may be -1 meaning use a gray tile. */
490 #if 0 /* These are also defined in struct frame. Use that instead. */
491 unsigned long background_pixel;
492 unsigned long foreground_pixel;
493 #endif
494 unsigned long cursor_pixel;
495 unsigned long border_pixel;
496 unsigned long mouse_pixel;
497 unsigned long cursor_foreground_pixel;
499 /* Foreground color for scroll bars. A value of -1 means use the
500 default (black for non-toolkit scroll bars). */
501 unsigned long scroll_bar_foreground_pixel;
503 /* Background color for scroll bars. A value of -1 means use the
504 default (background color of the frame for non-toolkit scroll
505 bars). */
506 unsigned long scroll_bar_background_pixel;
508 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
509 let the scroll compute them itself. */
510 unsigned long scroll_bar_top_shadow_pixel;
511 unsigned long scroll_bar_bottom_shadow_pixel;
513 /* Descriptor for the cursor in use for this window. */
514 Cursor text_cursor;
515 Cursor nontext_cursor;
516 Cursor modeline_cursor;
517 Cursor hand_cursor;
518 Cursor hourglass_cursor;
519 Cursor horizontal_drag_cursor;
521 /* Window whose cursor is hourglass_cursor. This window is temporarily
522 mapped to display an hourglass cursor. */
523 Window hourglass_window;
525 /* Non-zero means hourglass cursor is currently displayed. */
526 unsigned hourglass_p : 1;
528 /* Flag to set when the X window needs to be completely repainted. */
529 int needs_exposure;
531 /* These are the current window manager hints. It seems that
532 XSetWMHints, when presented with an unset bit in the `flags'
533 member of the hints structure, does not leave the corresponding
534 attribute unchanged; rather, it resets that attribute to its
535 default value. For example, unless you set the `icon_pixmap'
536 field and the `IconPixmapHint' bit, XSetWMHints will forget what
537 your icon pixmap was. This is rather troublesome, since some of
538 the members (for example, `input' and `icon_pixmap') want to stay
539 the same throughout the execution of Emacs. So, we keep this
540 structure around, just leaving values in it and adding new bits
541 to the mask as we go. */
542 XWMHints wm_hints;
544 /* This is the Emacs structure for the X display this frame is on. */
545 struct x_display_info *display_info;
547 /* This is a button event that wants to activate the menubar.
548 We save it here until the command loop gets to think about it. */
549 XEvent *saved_menu_event;
551 /* This is the widget id used for this frame's menubar in lwlib. */
552 #ifdef USE_X_TOOLKIT
553 int id;
554 #endif
556 /* Nonzero means our parent is another application's window
557 and was explicitly specified. */
558 char explicit_parent;
560 /* Nonzero means tried already to make this frame visible. */
561 char asked_for_visible;
563 /* Nonzero if this frame was ever previously visible. */
564 char has_been_visible;
566 #ifdef HAVE_X_I18N
567 /* Input context (currently, this means Compose key handler setup). */
568 XIC xic;
569 XIMStyle xic_style;
570 XFontSet xic_xfs;
571 char *xic_base_fontname;
572 #endif
574 /* Relief GCs, colors etc. */
575 struct relief
577 GC gc;
578 unsigned long pixel;
579 int allocated_p;
581 black_relief, white_relief;
583 /* The background for which the above relief GCs were set up.
584 They are changed only when a different background is involved. */
585 unsigned long relief_background;
587 /* Xt waits for a ConfigureNotify event from the window manager in
588 EmacsFrameSetCharSize when the shell widget is resized. For some
589 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
590 arrive for an unknown reason and Emacs hangs in Xt. If this is
591 zero, tell Xt not to wait. */
592 int wait_for_wm;
594 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
595 two might differ by a pixel, depending on WM */
596 int x_pixels_outer_diff;
598 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
599 these may differ because this does not take into account possible
600 menubar. y_pixels_diff is with menubar height included */
601 int y_pixels_outer_diff;
603 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
604 frame, or IMPLICIT if we received an EnterNotify.
605 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
606 int focus_state;
608 /* The offset we need to add to compensate for type A WMs. */
609 int move_offset_top;
610 int move_offset_left;
612 /* The frame's left/top offsets before we call XMoveWindow. See
613 x_check_expected_move. */
614 int left_before_move;
615 int top_before_move;
618 #define No_Cursor (None)
620 enum
622 /* Values for focus_state, used as bit mask.
623 EXPLICIT means we received a FocusIn for the frame and know it has
624 the focus. IMPLICIT means we recevied an EnterNotify and the frame
625 may have the focus if no window manager is running.
626 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
627 FOCUS_NONE = 0,
628 FOCUS_IMPLICIT = 1,
629 FOCUS_EXPLICIT = 2
633 /* Return the X output data for frame F. */
634 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
636 /* Return the X window used for displaying data in frame F. */
637 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
639 /* Return the outermost X window associated with the frame F. */
640 #ifdef USE_X_TOOLKIT
641 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
642 XtWindow ((f)->output_data.x->widget) : \
643 FRAME_X_WINDOW (f))
644 #else
645 #ifdef USE_GTK
646 #define GTK_WIDGET_TO_X_WIN(w) \
647 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
649 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
650 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
651 #define FRAME_OUTER_WINDOW(f) \
652 (FRAME_GTK_OUTER_WIDGET (f) ? \
653 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
654 FRAME_X_WINDOW (f))
656 #else /* !USE_GTK */
657 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
658 #endif /* !USE_GTK */
659 #endif
662 #define FRAME_FONT(f) ((f)->output_data.x->font)
663 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
664 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
665 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
666 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
668 /* This gives the x_display_info structure for the display F is on. */
669 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
671 /* This is the `Display *' which frame F is on. */
672 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
674 /* This is the `Screen *' which frame F is on. */
675 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
676 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
678 /* This is the Visual which frame F is on. */
679 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
681 /* This is the Colormap which frame F uses. */
682 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
684 /* This is the 'font_info *' which frame F has. */
685 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
687 /* The difference in pixels between the top left corner of the
688 Emacs window (including possible window manager decorations)
689 and FRAME_X_WINDOW (f). */
690 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
691 ((f)->output_data.x->x_pixels_outer_diff)
692 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
693 ((f)->output_data.x->y_pixels_outer_diff \
694 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
697 #define FRAME_XIC(f) ((f)->output_data.x->xic)
698 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
699 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
700 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
701 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
702 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
704 /* Value is the smallest width of any character in any font on frame F. */
706 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
707 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
709 /* Value is the smallest height of any font on frame F. */
711 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
712 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
714 /* X-specific scroll bar stuff. */
716 /* We represent scroll bars as lisp vectors. This allows us to place
717 references to them in windows without worrying about whether we'll
718 end up with windows referring to dead scroll bars; the garbage
719 collector will free it when its time comes.
721 We use struct scroll_bar as a template for accessing fields of the
722 vector. */
724 struct scroll_bar
726 /* These fields are shared by all vectors. */
727 EMACS_INT size_from_Lisp_Vector_struct;
728 struct Lisp_Vector *next_from_Lisp_Vector_struct;
730 /* The window we're a scroll bar for. */
731 Lisp_Object window;
733 /* The next and previous in the chain of scroll bars in this frame. */
734 Lisp_Object next, prev;
736 /* Fields from `x_window' down will not be traced by the GC. */
738 /* The X window representing this scroll bar. */
739 Window x_window;
741 /* The position and size of the scroll bar in pixels, relative to the
742 frame. */
743 int top, left, width, height;
745 /* The starting and ending positions of the handle, relative to the
746 handle area (i.e. zero is the top position, not
747 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
748 hasn't been drawn yet.
750 These are not actually the locations where the beginning and end
751 are drawn; in order to keep handles from becoming invisible when
752 editing large files, we establish a minimum height by always
753 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
754 where they would be normally; the bottom and top are in a
755 different co-ordinate system. */
756 int start, end;
758 /* If the scroll bar handle is currently being dragged by the user,
759 this is the number of pixels from the top of the handle to the
760 place where the user grabbed it. If the handle isn't currently
761 being dragged, this is Qnil. */
762 Lisp_Object dragging;
764 /* 1 if the background of the fringe that is adjacent to a scroll
765 bar is extended to the gap between the fringe and the bar. */
766 unsigned int fringe_extended_p : 1;
769 /* The number of elements a vector holding a struct scroll_bar needs. */
770 #define SCROLL_BAR_VEC_SIZE \
771 ((sizeof (struct scroll_bar) \
772 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
773 / sizeof (Lisp_Object))
775 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
776 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
779 /* Extract the X widget of the scroll bar from a struct scroll_bar.
780 XtWindowToWidget should be fast enough since Xt uses a hash table
781 to map windows to widgets. */
783 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
784 XtWindowToWidget (dpy, ptr->x_window)
786 /* Store a widget id in a struct scroll_bar. */
788 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
789 do { \
790 Window window = XtWindow (w); \
791 ptr->x_window = window; \
792 } while (0)
795 /* Return the inside width of a vertical scroll bar, given the outside
796 width. */
797 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
798 ((width) \
799 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
800 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
801 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
803 /* Return the length of the rectangle within which the top of the
804 handle must stay. This isn't equivalent to the inside height,
805 because the scroll bar handle has a minimum height.
807 This is the real range of motion for the scroll bar, so when we're
808 scaling buffer positions to scroll bar positions, we use this, not
809 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
810 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
811 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
813 /* Return the inside height of vertical scroll bar, given the outside
814 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
815 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
816 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
819 /* Border widths for scroll bars.
821 Scroll bar windows don't have any X borders; their border width is
822 set to zero, and we redraw borders ourselves. This makes the code
823 a bit cleaner, since we don't have to convert between outside width
824 (used when relating to the rest of the screen) and inside width
825 (used when sizing and drawing the scroll bar window itself).
827 The handle moves up and down/back and forth in a rectangle inset
828 from the edges of the scroll bar. These are widths by which we
829 inset the handle boundaries from the scroll bar edges. */
830 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
831 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
832 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
833 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
835 /* Minimum lengths for scroll bar handles, in pixels. */
836 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
838 /* Trimming off a few pixels from each side prevents
839 text from glomming up against the scroll bar */
840 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
843 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
844 or SELECTION_CLEAR_EVENT, then its contents are really described
845 by this structure. */
847 /* For an event of kind SELECTION_REQUEST_EVENT,
848 this structure really describes the contents.
849 **Don't make this struct longer!**
850 If it overlaps the frame_or_window field of struct input_event,
851 that will cause GC to crash. */
852 struct selection_input_event
854 int kind;
855 Display *display;
856 /* We spell it with an "o" here because X does. */
857 Window requestor;
858 Atom selection, target, property;
859 Time time;
862 #define SELECTION_EVENT_DISPLAY(eventp) \
863 (((struct selection_input_event *) (eventp))->display)
864 /* We spell it with an "o" here because X does. */
865 #define SELECTION_EVENT_REQUESTOR(eventp) \
866 (((struct selection_input_event *) (eventp))->requestor)
867 #define SELECTION_EVENT_SELECTION(eventp) \
868 (((struct selection_input_event *) (eventp))->selection)
869 #define SELECTION_EVENT_TARGET(eventp) \
870 (((struct selection_input_event *) (eventp))->target)
871 #define SELECTION_EVENT_PROPERTY(eventp) \
872 (((struct selection_input_event *) (eventp))->property)
873 #define SELECTION_EVENT_TIME(eventp) \
874 (((struct selection_input_event *) (eventp))->time)
877 struct window;
878 struct glyph_matrix;
879 struct frame;
880 struct input_event;
881 struct face;
882 struct image;
884 /* From xselect.c. */
886 void x_handle_selection_notify P_ ((XSelectionEvent *));
887 void x_handle_property_notify P_ ((XPropertyEvent *));
889 /* From xfns.c. */
891 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
892 Lisp_Object, Lisp_Object,
893 Lisp_Object, Lisp_Object));
894 struct frame *check_x_frame P_ ((Lisp_Object));
895 EXFUN (Fx_display_color_p, 1);
896 EXFUN (Fx_display_grayscale_p, 1);
897 extern void x_free_gcs P_ ((struct frame *));
899 /* From xrdb.c. */
901 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
902 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
903 int x_get_resource P_ ((XrmDatabase, char *, char *,
904 XrmRepresentation, XrmValue *));
905 void x_delete_display P_ ((struct x_display_info *));
906 void x_make_frame_visible P_ ((struct frame *));
907 void x_iconify_frame P_ ((struct frame *));
908 void x_wm_set_size_hint P_ ((struct frame *, long, int));
909 int x_text_icon P_ ((struct frame *, char *));
910 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
911 void x_set_window_size P_ ((struct frame *, int, int, int));
912 void x_wm_set_window_state P_ ((struct frame *, int));
913 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
915 /* Defined in xterm.c */
917 extern void cancel_mouse_face P_ ((struct frame *));
918 extern void x_scroll_bar_clear P_ ((struct frame *));
919 extern int x_text_icon P_ ((struct frame *, char *));
920 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
921 extern void x_catch_errors P_ ((Display *));
922 extern void x_check_errors P_ ((Display *, char *));
923 extern int x_had_errors_p P_ ((Display *));
924 extern int x_catching_errors P_ ((void));
925 extern void x_uncatch_errors P_ ((void));
926 extern void x_clear_errors P_ ((Display *));
927 extern void x_set_window_size P_ ((struct frame *, int, int, int));
928 extern void x_set_mouse_position P_ ((struct frame *, int, int));
929 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
930 extern void x_ewmh_activate_frame P_ ((struct frame *));
931 extern void x_raise_frame P_ ((struct frame *));
932 extern void x_lower_frame P_ ((struct frame *));
933 extern void x_make_frame_visible P_ ((struct frame *));
934 extern void x_make_frame_invisible P_ ((struct frame *));
935 extern void x_iconify_frame P_ ((struct frame *));
936 extern void x_free_frame_resources P_ ((struct frame *));
937 extern void x_destroy_window P_ ((struct frame *));
938 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
939 extern void x_wm_set_window_state P_ ((struct frame *, int));
940 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
941 extern void x_delete_display P_ ((struct x_display_info *));
942 extern void x_delete_terminal P_ ((struct terminal *terminal));
943 extern void x_initialize P_ ((void));
944 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
945 #ifdef USE_X_TOOLKIT
946 extern XtAppContext Xt_app_con;
947 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
948 unsigned long *,
949 double, int));
950 extern void x_activate_timeout_atimer P_ ((void));
951 #endif
952 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
953 extern void x_query_color P_ ((struct frame *f, XColor *));
954 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
955 extern void set_vertical_scroll_bar P_ ((struct window *));
957 extern int x_dispatch_event P_ ((XEvent *, Display *));
958 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
959 unsigned));
960 extern int x_display_pixel_height P_ ((struct x_display_info *));
961 extern int x_display_pixel_width P_ ((struct x_display_info *));
963 /* Defined in xselect.c */
965 extern void x_handle_property_notify P_ ((XPropertyEvent *));
966 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
967 extern void x_handle_selection_event P_ ((struct input_event *));
968 extern void x_clear_frame_selections P_ ((struct frame *));
970 extern int x_handle_dnd_message P_ ((struct frame *,
971 XClientMessageEvent *,
972 struct x_display_info *,
973 struct input_event *bufp));
974 extern int x_check_property_data P_ ((Lisp_Object));
975 extern void x_fill_property_data P_ ((Display *,
976 Lisp_Object,
977 void *,
978 int));
979 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
980 unsigned char *,
981 Atom,
982 int,
983 unsigned long));
985 /* Defined in xfns.c */
987 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
989 #ifdef USE_GTK
990 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
991 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
992 #endif /* USE_GTK */
994 extern void x_real_positions P_ ((struct frame *, int *, int *));
995 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
996 extern void x_set_border_pixel P_ ((struct frame *, int));
997 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
998 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
999 extern void xic_free_xfontset P_ ((struct frame *));
1000 extern void create_frame_xic P_ ((struct frame *));
1001 extern void destroy_frame_xic P_ ((struct frame *));
1002 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1003 extern void xic_set_statusarea P_ ((struct frame *));
1004 extern void xic_set_xfontset P_ ((struct frame *, char *));
1005 extern int x_pixel_width P_ ((struct frame *));
1006 extern int x_pixel_height P_ ((struct frame *));
1007 extern int x_char_width P_ ((struct frame *));
1008 extern int x_char_height P_ ((struct frame *));
1009 extern int x_screen_planes P_ ((struct frame *));
1010 extern void x_sync P_ ((struct frame *));
1011 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1012 #ifdef HAVE_X_I18N
1013 extern void free_frame_xic P_ ((struct frame *));
1014 #endif
1015 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1017 /* Defined in xfaces.c */
1019 extern int compute_glyph_face P_ ((struct frame *, int, int));
1020 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1021 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1022 unsigned long *, int));
1024 /* Defined in xmenu.c */
1026 extern void x_menu_set_in_use P_ ((int));
1027 extern void x_menu_wait_for_event P_ ((void *data));
1028 extern void x_activate_menubar P_ ((struct frame *));
1029 extern int popup_activated P_ ((void));
1030 extern void initialize_frame_menubar P_ ((struct frame *));
1031 extern void free_frame_menubar P_ ((struct frame *));
1033 /* Defined in widget.c */
1035 #ifdef USE_X_TOOLKIT
1036 extern void widget_store_internal_border P_ ((Widget));
1037 #endif
1039 /* Defined in xsmfns.c */
1040 #ifdef HAVE_X_SM
1041 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1042 extern int x_session_check_input P_ ((struct input_event *bufp));
1043 extern int x_session_have_connection P_ ((void));
1044 extern void x_session_close P_ ((void));
1045 #endif
1047 /* XEmbed implementation. */
1049 #define XEMBED_VERSION 0
1051 enum xembed_info
1053 XEMBED_MAPPED = 1 << 0
1056 enum xembed_message
1058 XEMBED_EMBEDDED_NOTIFY = 0,
1059 XEMBED_WINDOW_ACTIVATE = 1,
1060 XEMBED_WINDOW_DEACTIVATE = 2,
1061 XEMBED_REQUEST_FOCUS = 3,
1062 XEMBED_FOCUS_IN = 4,
1063 XEMBED_FOCUS_OUT = 5,
1064 XEMBED_FOCUS_NEXT = 6,
1065 XEMBED_FOCUS_PREV = 7,
1067 XEMBED_MODALITY_ON = 10,
1068 XEMBED_MODALITY_OFF = 11,
1069 XEMBED_REGISTER_ACCELERATOR = 12,
1070 XEMBED_UNREGISTER_ACCELERATOR = 13,
1071 XEMBED_ACTIVATE_ACCELERATOR = 14
1074 enum xembed_focus
1076 XEMBED_FOCUS_CURRENT = 0,
1077 XEMBED_FOCUS_FIRST = 1,
1078 XEMBED_FOCUS_LAST = 2
1081 enum xembed_modifier
1083 XEMBED_MODIFIER_SHIFT = 1 << 0,
1084 XEMBED_MODIFIER_CONTROL = 1 << 1,
1085 XEMBED_MODIFIER_ALT = 1 << 2,
1086 XEMBED_MODIFIER_SUPER = 1 << 3,
1087 XEMBED_MODIFIER_HYPER = 1 << 4
1090 enum xembed_accelerator
1092 XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1095 /* Defined in xterm.c */
1097 extern void xembed_set_info P_ ((struct frame *f, enum xembed_info flags));
1098 extern void xembed_send_message P_ ((struct frame *f, Time time,
1099 enum xembed_message message,
1100 long detail, long data1, long data2));
1102 /* Is the frame embedded into another application? */
1104 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1107 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1108 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1110 #define STORE_XCHAR2B(chp, b1, b2) \
1111 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1113 #define XCHAR2B_BYTE1(chp) \
1114 ((chp)->byte1)
1116 #define XCHAR2B_BYTE2(chp) \
1117 ((chp)->byte2)
1120 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1121 ((nr).x = (rx), \
1122 (nr).y = (ry), \
1123 (nr).width = (rwidth), \
1124 (nr).height = (rheight))
1126 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1127 (do not change this comment) */