* xterm.h (struct x_display_info): Add invisible_cursor.
[bpt/emacs.git] / src / xterm.h
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.
4
5 This file is part of GNU Emacs.
6
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.
11
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.
16
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/>. */
19
20 #include <X11/Xlib.h>
21 #include <X11/cursorfont.h>
22
23 /* Include Xutil.h after keysym.h to work around a bug that prevents
24 correct recognition of AltGr key in some X versions. */
25
26 #include <X11/keysym.h>
27 #include <X11/Xutil.h>
28
29 #include <X11/Xatom.h>
30 #include <X11/Xresource.h>
31
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>
39
40 typedef Widget xt_or_gtk_widget;
41 #endif
42
43 #ifdef USE_GTK
44 #include <gtk/gtk.h>
45 #include <gdk/gdkx.h>
46
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)
53
54
55 #endif /* USE_GTK */
56
57 \f
58 /* Bookkeeping to distinguish X versions. */
59
60
61 #ifdef HAVE_X_I18N
62 #include <X11/Xlocale.h>
63 #endif
64 \f
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)))
69
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)
74
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. */
78
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)
90
91 #ifdef HAVE_X11R6_XIM
92 /* Data structure passed to xim_instantiate_callback. */
93 struct xim_inst_t
94 {
95 struct x_display_info *dpyinfo;
96 char *resource_name;
97 };
98 #endif /* HAVE_X11R6_XIM */
99
100 /* Structure recording X pixmap and reference count.
101 If REFCOUNT is 0 then this record is free to be reused. */
102
103 struct x_bitmap_record
104 {
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;
112 };
113 \f
114 /* For each X display, we have a structure that records
115 information about it. */
116
117 struct x_display_info
118 {
119 /* Chain of all x_display_info structures. */
120 struct x_display_info *next;
121
122 /* The generic display parameters corresponding to this X display. */
123 struct terminal *terminal;
124
125 /* Connection number (normally a file descriptor number). */
126 int connection;
127
128 /* This says how to access this display in Xlib. */
129 Display *display;
130
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;
134
135 /* Number of frames that are on this display. */
136 int reference_count;
137
138 /* The Screen this connection is connected to. */
139 Screen *screen;
140
141 /* Dots per inch of the screen. */
142 double resx, resy;
143
144 /* The Visual being used for this display. */
145 Visual *visual;
146
147 /* The colormap being used. */
148 Colormap cmap;
149
150 /* Number of planes on this screen. */
151 int n_planes;
152
153 /* Mask of things that cause the mouse to be grabbed. */
154 int grabbed;
155
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;
159
160 /* The root window of this screen. */
161 Window root_window;
162
163 /* Client leader window. */
164 Window client_leader_window;
165
166 /* The cursor to use for vertical scroll bars. */
167 Cursor vertical_scroll_bar_cursor;
168
169 /* The invisible cursor used for pointer blanking. */
170 Cursor invisible_cursor;
171
172 #ifdef USE_GTK
173 /* The GDK cursor for scroll bars and popup menus. */
174 GdkCursor *xg_cursor;
175 #endif
176
177 /* X Resource data base */
178 XrmDatabase xrdb;
179
180 /* Minimum width over all characters in all fonts in font_table. */
181 int smallest_char_width;
182
183 /* Minimum font height over all fonts in font_table. */
184 int smallest_font_height;
185
186 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
187 GC scratch_cursor_gc;
188
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;
202
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;
206
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;
211
212 /* Nonzero means defer mouse-motion highlighting. */
213 int mouse_face_defer;
214
215 /* Nonzero means that the mouse highlight should not be shown. */
216 int mouse_face_hidden;
217
218 int mouse_face_image_state;
219
220 char *x_id_name;
221
222 /* The number of fonts opened for this display. */
223 int n_fonts;
224
225 /* Pointer to bitmap records. */
226 struct x_bitmap_record *bitmaps;
227
228 /* Allocated size of bitmaps field. */
229 int bitmaps_size;
230
231 /* Last used bitmap index. */
232 int bitmaps_last;
233
234 /* Which modifier keys are on which modifier bits?
235
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.
241
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.
246
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;
254
255 /* These are like meta_mod_mask, but for different modifiers. */
256 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
257
258 /* Communication with window managers. */
259 Atom Xatom_wm_protocols;
260
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;
265
266 /* Atom for indicating window state to the window manager. */
267 Atom Xatom_wm_change_state;
268
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. */
273
274 /* EditRes protocol */
275 Atom Xatom_editres;
276
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;
282
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;
288
289 /* More atoms for Ghostscript support. */
290 Atom Xatom_DONE, Xatom_PAGE;
291
292 /* Atom used in toolkit scroll bar client messages. */
293 Atom Xatom_Scrollbar;
294
295 /* Atom used in XEmbed client messages. */
296 Atom Xatom_XEMBED;
297
298 int cut_buffers_initialized; /* Whether we're sure they all exist */
299
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;
306
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;
312
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;
319
320 /* The gray pixmap. */
321 Pixmap gray;
322
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
329
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;
334
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;
338
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
346 {
347 X_WMTYPE_UNKNOWN,
348 X_WMTYPE_A,
349 X_WMTYPE_B
350 } wm_type;
351
352
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;
357
358 /* Extended window manager hints, Atoms supported by the window manager */
359 Atom *net_supported_atoms;
360 int nr_net_supported_atoms;
361 Window net_supported_window;
362
363 /* Atoms dealing with maximization and fullscreen */
364 Atom Xatom_net_wm_state, Xatom_net_wm_state_fullscreen_atom,
365 Xatom_net_wm_state_maximized_horz, Xatom_net_wm_state_maximized_vert,
366 Xatom_net_wm_state_sticky;
367 };
368
369 #ifdef HAVE_X_I18N
370 /* Whether or not to use XIM if we have it. */
371 extern int use_xim;
372 #endif
373
374 /* This checks to make sure we have a display. */
375 extern void check_x P_ ((void));
376
377 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
378
379 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
380 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
381 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
382 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
383 #endif
384
385 /* This is a chain of structures for all the X displays currently in use. */
386 extern struct x_display_info *x_display_list;
387
388 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
389 one for each element of x_display_list and in the same order.
390 NAME is the name of the frame.
391 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
392 extern Lisp_Object x_display_name_list;
393
394 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
395 extern Lisp_Object Vx_pixel_size_width_font_regexp;
396
397 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
398 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
399 extern void x_set_frame_alpha P_ ((struct frame *));
400
401 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
402 extern int x_display_ok P_ ((const char *));
403
404 extern void select_visual P_ ((struct x_display_info *));
405
406 \f
407 struct font;
408
409 /* Each X frame object points to its own struct x_output object
410 in the output_data.x field. The x_output structure contains
411 the information that is specific to X windows. */
412
413 struct x_output
414 {
415 /* Height of menu bar widget, in pixels.
416 Zero if not using the X toolkit.
417 When using the toolkit, this value is not meaningful
418 if the menubar is turned off. */
419 int menubar_height;
420
421 /* Height of tool bar widget, in pixels.
422 Zero if not using an external tool bar. */
423 int toolbar_height;
424
425 /* The tiled border used when the mouse is out of the frame. */
426 Pixmap border_tile;
427
428 /* Here are the Graphics Contexts for the default font. */
429 GC normal_gc; /* Normal video */
430 GC reverse_gc; /* Reverse video */
431 GC cursor_gc; /* cursor drawing */
432
433 /* The X window used for this frame.
434 May be zero while the frame object is being created
435 and the X window has not yet been created. */
436 Window window_desc;
437
438 /* The X window used for the bitmap icon;
439 or 0 if we don't have a bitmap icon. */
440 Window icon_desc;
441
442 /* The X window that is the parent of this X window.
443 Usually this is a window that was made by the window manager,
444 but it can be the root window, and it can be explicitly specified
445 (see the explicit_parent field, below). */
446 Window parent_desc;
447
448 #ifdef USE_X_TOOLKIT
449 /* The widget of this screen. This is the window of a "shell" widget. */
450 Widget widget;
451 /* The XmPanedWindows... */
452 Widget column_widget;
453 /* The widget of the edit portion of this screen; the window in
454 "window_desc" is inside of this. */
455 Widget edit_widget;
456
457 Widget menubar_widget;
458 #endif
459
460 #ifdef USE_GTK
461 /* The widget of this screen. This is the window of a top widget. */
462 GtkWidget *widget;
463 /* The widget of the edit portion of this screen; the window in
464 "window_desc" is inside of this. */
465 GtkWidget *edit_widget;
466 /* The widget used for laying out widgets vertically. */
467 GtkWidget *vbox_widget;
468 /* The menubar in this frame. */
469 GtkWidget *menubar_widget;
470 /* The tool bar in this frame */
471 GtkWidget *toolbar_widget;
472 /* The handle box that makes the tool bar detachable. */
473 GtkWidget *handlebox_widget;
474 /* Non-zero if the tool bar is detached. */
475 int toolbar_detached;
476
477 /* The last size hints set. */
478 GdkGeometry size_hints;
479 long hint_flags;
480 #endif
481
482 /* If >=0, a bitmap index. The indicated bitmap is used for the
483 icon. */
484 int icon_bitmap;
485
486 /* Default ASCII font of this frame. */
487 struct font *font;
488
489 /* The baseline offset of the default ASCII font. */
490 int baseline_offset;
491
492 /* If a fontset is specified for this frame instead of font, this
493 value contains an ID of the fontset, else -1. */
494 int fontset;
495
496 /* Pixel values used for various purposes.
497 border_pixel may be -1 meaning use a gray tile. */
498 #if 0 /* These are also defined in struct frame. Use that instead. */
499 unsigned long background_pixel;
500 unsigned long foreground_pixel;
501 #endif
502 unsigned long cursor_pixel;
503 unsigned long border_pixel;
504 unsigned long mouse_pixel;
505 unsigned long cursor_foreground_pixel;
506
507 /* Foreground color for scroll bars. A value of -1 means use the
508 default (black for non-toolkit scroll bars). */
509 unsigned long scroll_bar_foreground_pixel;
510
511 /* Background color for scroll bars. A value of -1 means use the
512 default (background color of the frame for non-toolkit scroll
513 bars). */
514 unsigned long scroll_bar_background_pixel;
515
516 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
517 let the scroll compute them itself. */
518 unsigned long scroll_bar_top_shadow_pixel;
519 unsigned long scroll_bar_bottom_shadow_pixel;
520
521 /* Descriptor for the cursor in use for this window. */
522 Cursor text_cursor;
523 Cursor nontext_cursor;
524 Cursor modeline_cursor;
525 Cursor hand_cursor;
526 Cursor hourglass_cursor;
527 Cursor horizontal_drag_cursor;
528 Cursor current_cursor;
529
530 /* Window whose cursor is hourglass_cursor. This window is temporarily
531 mapped to display an hourglass cursor. */
532 Window hourglass_window;
533
534 /* Non-zero means hourglass cursor is currently displayed. */
535 unsigned hourglass_p : 1;
536
537 /* Flag to set when the X window needs to be completely repainted. */
538 int needs_exposure;
539
540 /* These are the current window manager hints. It seems that
541 XSetWMHints, when presented with an unset bit in the `flags'
542 member of the hints structure, does not leave the corresponding
543 attribute unchanged; rather, it resets that attribute to its
544 default value. For example, unless you set the `icon_pixmap'
545 field and the `IconPixmapHint' bit, XSetWMHints will forget what
546 your icon pixmap was. This is rather troublesome, since some of
547 the members (for example, `input' and `icon_pixmap') want to stay
548 the same throughout the execution of Emacs. So, we keep this
549 structure around, just leaving values in it and adding new bits
550 to the mask as we go. */
551 XWMHints wm_hints;
552
553 /* This is the Emacs structure for the X display this frame is on. */
554 struct x_display_info *display_info;
555
556 /* This is a button event that wants to activate the menubar.
557 We save it here until the command loop gets to think about it. */
558 XEvent *saved_menu_event;
559
560 /* This is the widget id used for this frame's menubar in lwlib. */
561 #ifdef USE_X_TOOLKIT
562 int id;
563 #endif
564
565 /* Nonzero means our parent is another application's window
566 and was explicitly specified. */
567 char explicit_parent;
568
569 /* Nonzero means tried already to make this frame visible. */
570 char asked_for_visible;
571
572 /* Nonzero if this frame was ever previously visible. */
573 char has_been_visible;
574
575 #ifdef HAVE_X_I18N
576 /* Input context (currently, this means Compose key handler setup). */
577 XIC xic;
578 XIMStyle xic_style;
579 XFontSet xic_xfs;
580 char *xic_base_fontname;
581 #endif
582
583 /* Relief GCs, colors etc. */
584 struct relief
585 {
586 GC gc;
587 unsigned long pixel;
588 int allocated_p;
589 }
590 black_relief, white_relief;
591
592 /* The background for which the above relief GCs were set up.
593 They are changed only when a different background is involved. */
594 unsigned long relief_background;
595
596 /* Xt waits for a ConfigureNotify event from the window manager in
597 EmacsFrameSetCharSize when the shell widget is resized. For some
598 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
599 arrive for an unknown reason and Emacs hangs in Xt. If this is
600 zero, tell Xt not to wait. */
601 int wait_for_wm;
602
603 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
604 two might differ by a pixel, depending on WM */
605 int x_pixels_outer_diff;
606
607 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
608 these may differ because this does not take into account possible
609 menubar. y_pixels_diff is with menubar height included */
610 int y_pixels_outer_diff;
611
612 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
613 frame, or IMPLICIT if we received an EnterNotify.
614 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
615 int focus_state;
616
617 /* The offset we need to add to compensate for type A WMs. */
618 int move_offset_top;
619 int move_offset_left;
620
621 /* The frame's left/top offsets before we call XMoveWindow. See
622 x_check_expected_move. */
623 int left_before_move;
624 int top_before_move;
625 };
626
627 #define No_Cursor (None)
628
629 enum
630 {
631 /* Values for focus_state, used as bit mask.
632 EXPLICIT means we received a FocusIn for the frame and know it has
633 the focus. IMPLICIT means we recevied an EnterNotify and the frame
634 may have the focus if no window manager is running.
635 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
636 FOCUS_NONE = 0,
637 FOCUS_IMPLICIT = 1,
638 FOCUS_EXPLICIT = 2
639 };
640
641
642 /* Return the X output data for frame F. */
643 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
644
645 /* Return the X window used for displaying data in frame F. */
646 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
647
648 /* Return the outermost X window associated with the frame F. */
649 #ifdef USE_X_TOOLKIT
650 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
651 XtWindow ((f)->output_data.x->widget) : \
652 FRAME_X_WINDOW (f))
653 #else
654 #ifdef USE_GTK
655 #define GTK_WIDGET_TO_X_WIN(w) \
656 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
657
658 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
659 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
660 #define FRAME_OUTER_WINDOW(f) \
661 (FRAME_GTK_OUTER_WIDGET (f) ? \
662 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
663 FRAME_X_WINDOW (f))
664
665 #else /* !USE_GTK */
666 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
667 #endif /* !USE_GTK */
668 #endif
669
670
671 #define FRAME_FONT(f) ((f)->output_data.x->font)
672 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
673 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
674 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
675 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
676
677 /* This gives the x_display_info structure for the display F is on. */
678 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
679
680 /* This is the `Display *' which frame F is on. */
681 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
682
683 /* This is the `Screen *' which frame F is on. */
684 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
685 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
686
687 /* This is the Visual which frame F is on. */
688 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
689
690 /* This is the Colormap which frame F uses. */
691 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
692
693 /* This is the 'font_info *' which frame F has. */
694 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
695
696 /* The difference in pixels between the top left corner of the
697 Emacs window (including possible window manager decorations)
698 and FRAME_X_WINDOW (f). */
699 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
700 ((f)->output_data.x->x_pixels_outer_diff)
701 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
702 ((f)->output_data.x->y_pixels_outer_diff \
703 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
704
705
706 #define FRAME_XIC(f) ((f)->output_data.x->xic)
707 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
708 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
709 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
710 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
711 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
712
713 /* Value is the smallest width of any character in any font on frame F. */
714
715 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
716 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
717
718 /* Value is the smallest height of any font on frame F. */
719
720 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
721 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
722 \f
723 /* X-specific scroll bar stuff. */
724
725 /* We represent scroll bars as lisp vectors. This allows us to place
726 references to them in windows without worrying about whether we'll
727 end up with windows referring to dead scroll bars; the garbage
728 collector will free it when its time comes.
729
730 We use struct scroll_bar as a template for accessing fields of the
731 vector. */
732
733 struct scroll_bar
734 {
735 /* These fields are shared by all vectors. */
736 EMACS_INT size_from_Lisp_Vector_struct;
737 struct Lisp_Vector *next_from_Lisp_Vector_struct;
738
739 /* The window we're a scroll bar for. */
740 Lisp_Object window;
741
742 /* The next and previous in the chain of scroll bars in this frame. */
743 Lisp_Object next, prev;
744
745 /* Fields from `x_window' down will not be traced by the GC. */
746
747 /* The X window representing this scroll bar. */
748 Window x_window;
749
750 /* The position and size of the scroll bar in pixels, relative to the
751 frame. */
752 int top, left, width, height;
753
754 /* The starting and ending positions of the handle, relative to the
755 handle area (i.e. zero is the top position, not
756 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
757 hasn't been drawn yet.
758
759 These are not actually the locations where the beginning and end
760 are drawn; in order to keep handles from becoming invisible when
761 editing large files, we establish a minimum height by always
762 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
763 where they would be normally; the bottom and top are in a
764 different co-ordinate system. */
765 int start, end;
766
767 /* If the scroll bar handle is currently being dragged by the user,
768 this is the number of pixels from the top of the handle to the
769 place where the user grabbed it. If the handle isn't currently
770 being dragged, this is Qnil. */
771 Lisp_Object dragging;
772
773 /* 1 if the background of the fringe that is adjacent to a scroll
774 bar is extended to the gap between the fringe and the bar. */
775 unsigned int fringe_extended_p : 1;
776 };
777
778 /* The number of elements a vector holding a struct scroll_bar needs. */
779 #define SCROLL_BAR_VEC_SIZE \
780 ((sizeof (struct scroll_bar) \
781 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
782 / sizeof (Lisp_Object))
783
784 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
785 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
786
787
788 /* Extract the X widget of the scroll bar from a struct scroll_bar.
789 XtWindowToWidget should be fast enough since Xt uses a hash table
790 to map windows to widgets. */
791
792 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
793 XtWindowToWidget (dpy, ptr->x_window)
794
795 /* Store a widget id in a struct scroll_bar. */
796
797 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
798 do { \
799 Window window = XtWindow (w); \
800 ptr->x_window = window; \
801 } while (0)
802
803
804 /* Return the inside width of a vertical scroll bar, given the outside
805 width. */
806 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
807 ((width) \
808 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
809 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
810 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
811
812 /* Return the length of the rectangle within which the top of the
813 handle must stay. This isn't equivalent to the inside height,
814 because the scroll bar handle has a minimum height.
815
816 This is the real range of motion for the scroll bar, so when we're
817 scaling buffer positions to scroll bar positions, we use this, not
818 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
819 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
820 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
821
822 /* Return the inside height of vertical scroll bar, given the outside
823 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
824 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
825 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
826
827
828 /* Border widths for scroll bars.
829
830 Scroll bar windows don't have any X borders; their border width is
831 set to zero, and we redraw borders ourselves. This makes the code
832 a bit cleaner, since we don't have to convert between outside width
833 (used when relating to the rest of the screen) and inside width
834 (used when sizing and drawing the scroll bar window itself).
835
836 The handle moves up and down/back and forth in a rectangle inset
837 from the edges of the scroll bar. These are widths by which we
838 inset the handle boundaries from the scroll bar edges. */
839 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
840 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
841 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
842 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
843
844 /* Minimum lengths for scroll bar handles, in pixels. */
845 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
846
847 /* Trimming off a few pixels from each side prevents
848 text from glomming up against the scroll bar */
849 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
850
851 \f
852 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
853 or SELECTION_CLEAR_EVENT, then its contents are really described
854 by this structure. */
855
856 /* For an event of kind SELECTION_REQUEST_EVENT,
857 this structure really describes the contents.
858 **Don't make this struct longer!**
859 If it overlaps the frame_or_window field of struct input_event,
860 that will cause GC to crash. */
861 struct selection_input_event
862 {
863 int kind;
864 Display *display;
865 /* We spell it with an "o" here because X does. */
866 Window requestor;
867 Atom selection, target, property;
868 Time time;
869 };
870
871 #define SELECTION_EVENT_DISPLAY(eventp) \
872 (((struct selection_input_event *) (eventp))->display)
873 /* We spell it with an "o" here because X does. */
874 #define SELECTION_EVENT_REQUESTOR(eventp) \
875 (((struct selection_input_event *) (eventp))->requestor)
876 #define SELECTION_EVENT_SELECTION(eventp) \
877 (((struct selection_input_event *) (eventp))->selection)
878 #define SELECTION_EVENT_TARGET(eventp) \
879 (((struct selection_input_event *) (eventp))->target)
880 #define SELECTION_EVENT_PROPERTY(eventp) \
881 (((struct selection_input_event *) (eventp))->property)
882 #define SELECTION_EVENT_TIME(eventp) \
883 (((struct selection_input_event *) (eventp))->time)
884
885 \f
886 struct window;
887 struct glyph_matrix;
888 struct frame;
889 struct input_event;
890 struct face;
891 struct image;
892
893 /* From xselect.c. */
894
895 void x_handle_selection_notify P_ ((XSelectionEvent *));
896 void x_handle_property_notify P_ ((XPropertyEvent *));
897
898 /* From xfns.c. */
899
900 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
901 Lisp_Object, Lisp_Object,
902 Lisp_Object, Lisp_Object));
903 struct frame *check_x_frame P_ ((Lisp_Object));
904 EXFUN (Fx_display_color_p, 1);
905 EXFUN (Fx_display_grayscale_p, 1);
906 extern void x_free_gcs P_ ((struct frame *));
907
908 /* From xrdb.c. */
909
910 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
911 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
912 int x_get_resource P_ ((XrmDatabase, char *, char *,
913 XrmRepresentation, XrmValue *));
914 void x_delete_display P_ ((struct x_display_info *));
915 void x_make_frame_visible P_ ((struct frame *));
916 void x_iconify_frame P_ ((struct frame *));
917 void x_wm_set_size_hint P_ ((struct frame *, long, int));
918 int x_text_icon P_ ((struct frame *, char *));
919 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
920 void x_set_window_size P_ ((struct frame *, int, int, int));
921 void x_wm_set_window_state P_ ((struct frame *, int));
922 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
923
924 /* Defined in xterm.c */
925
926 extern void cancel_mouse_face P_ ((struct frame *));
927 extern void x_scroll_bar_clear P_ ((struct frame *));
928 extern int x_text_icon P_ ((struct frame *, char *));
929 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
930 extern void x_catch_errors P_ ((Display *));
931 extern void x_check_errors P_ ((Display *, char *));
932 extern int x_had_errors_p P_ ((Display *));
933 extern int x_catching_errors P_ ((void));
934 extern void x_uncatch_errors P_ ((void));
935 extern void x_clear_errors P_ ((Display *));
936 extern void x_set_window_size P_ ((struct frame *, int, int, int));
937 extern void x_set_mouse_position P_ ((struct frame *, int, int));
938 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
939 extern void x_ewmh_activate_frame P_ ((struct frame *));
940 extern void x_raise_frame P_ ((struct frame *));
941 extern void x_lower_frame P_ ((struct frame *));
942 extern void x_make_frame_visible P_ ((struct frame *));
943 extern void x_make_frame_invisible P_ ((struct frame *));
944 extern void x_iconify_frame P_ ((struct frame *));
945 extern void x_free_frame_resources P_ ((struct frame *));
946 extern void x_destroy_window P_ ((struct frame *));
947 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
948 extern void x_wm_set_window_state P_ ((struct frame *, int));
949 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
950 extern void x_delete_display P_ ((struct x_display_info *));
951 extern void x_delete_terminal P_ ((struct terminal *terminal));
952 extern void x_initialize P_ ((void));
953 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
954 #ifdef USE_X_TOOLKIT
955 extern XtAppContext Xt_app_con;
956 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
957 unsigned long *,
958 double, int));
959 extern void x_activate_timeout_atimer P_ ((void));
960 #endif
961 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
962 extern void x_query_color P_ ((struct frame *f, XColor *));
963 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
964 extern void set_vertical_scroll_bar P_ ((struct window *));
965
966 extern int x_dispatch_event P_ ((XEvent *, Display *));
967 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
968 unsigned));
969 extern int x_display_pixel_height P_ ((struct x_display_info *));
970 extern int x_display_pixel_width P_ ((struct x_display_info *));
971
972 extern void x_set_sticky P_ ((struct frame *, Lisp_Object, Lisp_Object));
973
974 /* Defined in xselect.c */
975
976 extern void x_handle_property_notify P_ ((XPropertyEvent *));
977 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
978 extern void x_handle_selection_event P_ ((struct input_event *));
979 extern void x_clear_frame_selections P_ ((struct frame *));
980
981 extern int x_handle_dnd_message P_ ((struct frame *,
982 XClientMessageEvent *,
983 struct x_display_info *,
984 struct input_event *bufp));
985 extern int x_check_property_data P_ ((Lisp_Object));
986 extern void x_fill_property_data P_ ((Display *,
987 Lisp_Object,
988 void *,
989 int));
990 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
991 unsigned char *,
992 Atom,
993 int,
994 unsigned long));
995
996 /* Defined in xfns.c */
997
998 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
999
1000 #ifdef USE_GTK
1001 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
1002 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
1003 #endif /* USE_GTK */
1004
1005 extern void x_real_positions P_ ((struct frame *, int *, int *));
1006 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
1007 extern void x_set_border_pixel P_ ((struct frame *, int));
1008 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1009 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
1010 extern void xic_free_xfontset P_ ((struct frame *));
1011 extern void create_frame_xic P_ ((struct frame *));
1012 extern void destroy_frame_xic P_ ((struct frame *));
1013 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1014 extern void xic_set_statusarea P_ ((struct frame *));
1015 extern void xic_set_xfontset P_ ((struct frame *, char *));
1016 extern int x_pixel_width P_ ((struct frame *));
1017 extern int x_pixel_height P_ ((struct frame *));
1018 extern int x_char_width P_ ((struct frame *));
1019 extern int x_char_height P_ ((struct frame *));
1020 extern int x_screen_planes P_ ((struct frame *));
1021 extern void x_sync P_ ((struct frame *));
1022 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1023 #ifdef HAVE_X_I18N
1024 extern void free_frame_xic P_ ((struct frame *));
1025 #endif
1026 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1027
1028 /* Defined in xfaces.c */
1029
1030 extern int compute_glyph_face P_ ((struct frame *, int, int));
1031 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1032 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1033 unsigned long *, int));
1034
1035 /* Defined in xmenu.c */
1036
1037 extern void x_menu_set_in_use P_ ((int));
1038 extern void x_menu_wait_for_event P_ ((void *data));
1039 extern void x_activate_menubar P_ ((struct frame *));
1040 extern int popup_activated P_ ((void));
1041 extern void initialize_frame_menubar P_ ((struct frame *));
1042 extern void free_frame_menubar P_ ((struct frame *));
1043
1044 /* Defined in widget.c */
1045
1046 #ifdef USE_X_TOOLKIT
1047 extern void widget_store_internal_border P_ ((Widget));
1048 #endif
1049
1050 /* Defined in xsmfns.c */
1051 #ifdef HAVE_X_SM
1052 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1053 extern int x_session_check_input P_ ((struct input_event *bufp));
1054 extern int x_session_have_connection P_ ((void));
1055 extern void x_session_close P_ ((void));
1056 #endif
1057
1058 /* XEmbed implementation. */
1059
1060 #define XEMBED_VERSION 0
1061
1062 enum xembed_info
1063 {
1064 XEMBED_MAPPED = 1 << 0
1065 };
1066
1067 enum xembed_message
1068 {
1069 XEMBED_EMBEDDED_NOTIFY = 0,
1070 XEMBED_WINDOW_ACTIVATE = 1,
1071 XEMBED_WINDOW_DEACTIVATE = 2,
1072 XEMBED_REQUEST_FOCUS = 3,
1073 XEMBED_FOCUS_IN = 4,
1074 XEMBED_FOCUS_OUT = 5,
1075 XEMBED_FOCUS_NEXT = 6,
1076 XEMBED_FOCUS_PREV = 7,
1077
1078 XEMBED_MODALITY_ON = 10,
1079 XEMBED_MODALITY_OFF = 11,
1080 XEMBED_REGISTER_ACCELERATOR = 12,
1081 XEMBED_UNREGISTER_ACCELERATOR = 13,
1082 XEMBED_ACTIVATE_ACCELERATOR = 14
1083 };
1084
1085 enum xembed_focus
1086 {
1087 XEMBED_FOCUS_CURRENT = 0,
1088 XEMBED_FOCUS_FIRST = 1,
1089 XEMBED_FOCUS_LAST = 2
1090 };
1091
1092 enum xembed_modifier
1093 {
1094 XEMBED_MODIFIER_SHIFT = 1 << 0,
1095 XEMBED_MODIFIER_CONTROL = 1 << 1,
1096 XEMBED_MODIFIER_ALT = 1 << 2,
1097 XEMBED_MODIFIER_SUPER = 1 << 3,
1098 XEMBED_MODIFIER_HYPER = 1 << 4
1099 };
1100
1101 enum xembed_accelerator
1102 {
1103 XEMBED_ACCELERATOR_OVERLOADED = 1 << 0
1104 };
1105
1106 /* Defined in xterm.c */
1107
1108 extern void xembed_set_info P_ ((struct frame *f, enum xembed_info flags));
1109 extern void xembed_send_message P_ ((struct frame *f, Time time,
1110 enum xembed_message message,
1111 long detail, long data1, long data2));
1112
1113 /* Is the frame embedded into another application? */
1114
1115 #define FRAME_X_EMBEDDED_P(f) (FRAME_X_OUTPUT(f)->explicit_parent != 0)
1116
1117
1118 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1119 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1120
1121 #define STORE_XCHAR2B(chp, b1, b2) \
1122 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1123
1124 #define XCHAR2B_BYTE1(chp) \
1125 ((chp)->byte1)
1126
1127 #define XCHAR2B_BYTE2(chp) \
1128 ((chp)->byte2)
1129
1130
1131 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1132 ((nr).x = (rx), \
1133 (nr).y = (ry), \
1134 (nr).width = (rwidth), \
1135 (nr).height = (rheight))
1136
1137 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1138 (do not change this comment) */