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