]> code.delx.au - gnu-emacs/blob - src/xterm.h
Merged from emacs@sv.gnu.org
[gnu-emacs] / 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 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22 #include <X11/Xlib.h>
23 #include <X11/cursorfont.h>
24
25 /* Include Xutil.h after keysym.h to work around a bug that prevents
26 correct recognition of AltGr key in some X versions. */
27
28 #include <X11/keysym.h>
29 #include <X11/Xutil.h>
30
31 #include <X11/Xatom.h>
32 #include <X11/Xresource.h>
33
34 #ifdef USE_X_TOOLKIT
35 #include <X11/StringDefs.h>
36 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
37 #include <X11/CoreP.h> /* foul, but we need this to use our own
38 window inside a widget instead of one
39 that Xt creates... */
40 #include <X11/StringDefs.h>
41
42 typedef Widget xt_or_gtk_widget;
43 #endif
44
45 #ifdef USE_GTK
46 #include <gtk/gtk.h>
47 #include <gdk/gdkx.h>
48
49 /* Some definitions to reduce conditionals. */
50 typedef GtkWidget *xt_or_gtk_widget;
51 #define XtParent(x) (gtk_widget_get_parent (x))
52 #undef XSync
53 #define XSync(d, b) do { gdk_window_process_all_updates (); \
54 XSync (d, b); } while (0)
55
56
57 #endif /* USE_GTK */
58
59 \f
60 /* Bookkeeping to distinguish X versions. */
61
62 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
63 be defined when we're using X11R5, since X11R5 has the features of
64 X11R4. If, in the future, we find we need more of these flags
65 (HAVE_X11R5, for example), code should always be written to test
66 the most recent flag first:
67
68 #ifdef HAVE_X11R5
69 ...
70 #elif HAVE_X11R4
71 ...
72 #elif HAVE_X11
73 ...
74 #endif
75
76 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
77 looks a lot like another one, consider moving the text into a macro
78 whose definition is configuration-dependent, but whose usage is
79 universal - like the stuff in systime.h.
80
81 It turns out that we can auto-detect whether we're being compiled
82 with X11R3 or X11R4 by looking for the flag macros for R4 structure
83 members that R3 doesn't have. */
84 #ifdef PBaseSize
85 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
86 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
87 XSetWMIconName.
88 AIX 3.2 is at least X11R4. */
89 #if (!defined AIX) || (defined AIX3_2)
90 #define HAVE_X11R4
91 #endif
92 #endif
93
94 #ifdef HAVE_X11R5
95 /* In case someone has X11R5 on AIX 3.1,
96 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
97 #define HAVE_X11R4
98 #endif
99
100 #ifdef HAVE_X_I18N
101 #include <X11/Xlocale.h>
102 #endif
103 \f
104 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
105 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
106 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
107 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
108
109 #define FONT_WIDTH(f) ((f)->max_bounds.width)
110 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
111 #define FONT_BASE(f) ((f)->ascent)
112 #define FONT_DESCENT(f) ((f)->descent)
113
114 /* The mask of events that text windows always want to receive. This
115 includes mouse movement events, since handling the mouse-font text property
116 means that we must track mouse motion all the time. */
117
118 #define STANDARD_EVENT_SET \
119 (KeyPressMask \
120 | ExposureMask \
121 | ButtonPressMask \
122 | ButtonReleaseMask \
123 | PointerMotionMask \
124 | StructureNotifyMask \
125 | FocusChangeMask \
126 | LeaveWindowMask \
127 | EnterWindowMask \
128 | VisibilityChangeMask)
129
130 /* Structure recording X pixmap and reference count.
131 If REFCOUNT is 0 then this record is free to be reused. */
132
133 struct x_bitmap_record
134 {
135 Pixmap pixmap;
136 int have_mask;
137 Pixmap mask;
138 char *file;
139 int refcount;
140 /* Record some info about this pixmap. */
141 int height, width, depth;
142 };
143 \f
144 /* For each X display, we have a structure that records
145 information about it. */
146
147 struct x_display_info
148 {
149 /* Chain of all x_display_info structures. */
150 struct x_display_info *next;
151
152 /* The generic display parameters corresponding to this X display. */
153 struct terminal *terminal;
154
155 /* Connection number (normally a file descriptor number). */
156 int connection;
157
158 /* This says how to access this display in Xlib. */
159 Display *display;
160
161 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
162 The same cons cell also appears in x_display_name_list. */
163 Lisp_Object name_list_element;
164
165 /* Number of frames that are on this display. */
166 int reference_count;
167
168 /* The Screen this connection is connected to. */
169 Screen *screen;
170
171 /* Dots per inch of the screen. */
172 double resx, resy;
173
174 /* The Visual being used for this display. */
175 Visual *visual;
176
177 /* The colormap being used. */
178 Colormap cmap;
179
180 /* Number of planes on this screen. */
181 int n_planes;
182
183 /* Dimensions of this screen. */
184 int height, width;
185
186 /* Mask of things that cause the mouse to be grabbed. */
187 int grabbed;
188
189 /* Emacs bitmap-id of the default icon bitmap for this frame.
190 Or -1 if none has been allocated yet. */
191 int icon_bitmap_id;
192
193 /* The root window of this screen. */
194 Window root_window;
195
196 /* Client leader window. */
197 Window client_leader_window;
198
199 /* The cursor to use for vertical scroll bars. */
200 Cursor vertical_scroll_bar_cursor;
201
202 #ifdef USE_GTK
203 /* The GDK cursor for scroll bars and popup menus. */
204 GdkCursor *xg_cursor;
205 #endif
206
207 /* X Resource data base */
208 XrmDatabase xrdb;
209
210 /* A table of all the fonts we have already loaded. */
211 struct font_info *font_table;
212
213 /* The current capacity of x_font_table. */
214 int font_table_size;
215
216 /* Minimum width over all characters in all fonts in font_table. */
217 int smallest_char_width;
218
219 /* Minimum font height over all fonts in font_table. */
220 int smallest_font_height;
221
222 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
223 GC scratch_cursor_gc;
224
225 /* These variables describe the range of text currently shown in its
226 mouse-face, together with the window they apply to. As long as
227 the mouse stays within this range, we need not redraw anything on
228 its account. Rows and columns are glyph matrix positions in
229 MOUSE_FACE_WINDOW. */
230 int mouse_face_beg_row, mouse_face_beg_col;
231 int mouse_face_beg_x, mouse_face_beg_y;
232 int mouse_face_end_row, mouse_face_end_col;
233 int mouse_face_end_x, mouse_face_end_y;
234 int mouse_face_past_end;
235 Lisp_Object mouse_face_window;
236 int mouse_face_face_id;
237 Lisp_Object mouse_face_overlay;
238
239 /* 1 if a mouse motion event came and we didn't handle it right away because
240 gc was in progress. */
241 int mouse_face_deferred_gc;
242
243 /* FRAME and X, Y position of mouse when last checked for
244 highlighting. X and Y can be negative or out of range for the frame. */
245 struct frame *mouse_face_mouse_frame;
246 int mouse_face_mouse_x, mouse_face_mouse_y;
247
248 /* Nonzero means defer mouse-motion highlighting. */
249 int mouse_face_defer;
250
251 /* Nonzero means that the mouse highlight should not be shown. */
252 int mouse_face_hidden;
253
254 int mouse_face_image_state;
255
256 char *x_id_name;
257
258 /* The number of fonts actually stored in x_font_table.
259 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
260 n_fonts <= font_table_size and font_table[i].name != 0. */
261 int n_fonts;
262
263 /* Pointer to bitmap records. */
264 struct x_bitmap_record *bitmaps;
265
266 /* Allocated size of bitmaps field. */
267 int bitmaps_size;
268
269 /* Last used bitmap index. */
270 int bitmaps_last;
271
272 /* Which modifier keys are on which modifier bits?
273
274 With each keystroke, X returns eight bits indicating which modifier
275 keys were held down when the key was pressed. The interpretation
276 of the top five modifier bits depends on what keys are attached
277 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
278 is the meta bit.
279
280 meta_mod_mask is a mask containing the bits used for the meta key.
281 It may have more than one bit set, if more than one modifier bit
282 has meta keys on it. Basically, if EVENT is a KeyPress event,
283 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
284
285 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
286 lock modifier bit, or zero otherwise. Non-alphabetic keys should
287 only be affected by the lock modifier bit if XK_Shift_Lock is in
288 use; XK_Caps_Lock should only affect alphabetic keys. With this
289 arrangement, the lock modifier should shift the character if
290 (EVENT.state & shift_lock_mask) != 0. */
291 int meta_mod_mask, shift_lock_mask;
292
293 /* These are like meta_mod_mask, but for different modifiers. */
294 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
295
296 /* Communication with window managers. */
297 Atom Xatom_wm_protocols;
298
299 /* Kinds of protocol things we may receive. */
300 Atom Xatom_wm_take_focus;
301 Atom Xatom_wm_save_yourself;
302 Atom Xatom_wm_delete_window;
303
304 /* Atom for indicating window state to the window manager. */
305 Atom Xatom_wm_change_state;
306
307 /* Other WM communication */
308 Atom Xatom_wm_configure_denied; /* When our config request is denied */
309 Atom Xatom_wm_window_moved; /* When the WM moves us. */
310 Atom Xatom_wm_client_leader; /* Id of client leader window. */
311
312 /* EditRes protocol */
313 Atom Xatom_editres;
314
315 /* More atoms, which are selection types. */
316 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
317 Xatom_COMPOUND_TEXT, Xatom_UTF8_STRING,
318 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
319 Xatom_ATOM_PAIR;
320
321 /* More atoms for font properties. The last three are private
322 properties, see the comments in src/fontset.h. */
323 Atom Xatom_PIXEL_SIZE, Xatom_AVERAGE_WIDTH,
324 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
325 Xatom_MULE_DEFAULT_ASCENT;
326
327 /* More atoms for Ghostscript support. */
328 Atom Xatom_DONE, Xatom_PAGE;
329
330 /* Atom used in toolkit scroll bar client messages. */
331 Atom Xatom_Scrollbar;
332
333 int cut_buffers_initialized; /* Whether we're sure they all exist */
334
335 /* The frame (if any) which has the X window that has keyboard focus.
336 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
337 that a mere EnterNotify event can set this; if you need to know the
338 last frame specified in a FocusIn or FocusOut event, use
339 x_focus_event_frame. */
340 struct frame *x_focus_frame;
341
342 /* The last frame mentioned in a FocusIn or FocusOut event. This is
343 separate from x_focus_frame, because whether or not LeaveNotify
344 events cause us to lose focus depends on whether or not we have
345 received a FocusIn event for it. */
346 struct frame *x_focus_event_frame;
347
348 /* The frame which currently has the visual highlight, and should get
349 keyboard input (other sorts of input have the frame encoded in the
350 event). It points to the X focus frame's selected window's
351 frame. It differs from x_focus_frame when we're using a global
352 minibuffer. */
353 struct frame *x_highlight_frame;
354
355 /* The null pixel used for filling a character background with
356 background color of a gc. */
357 Pixmap null_pixel;
358
359 /* The gray pixmap. */
360 Pixmap gray;
361
362 /* Cache of images. */
363 struct image_cache *image_cache;
364
365 #ifdef HAVE_X_I18N
366 /* XIM (X Input method). */
367 XIM xim;
368 XIMStyles *xim_styles;
369 #endif
370
371 /* If non-null, a cache of the colors in the color map. Don't
372 use this directly, call x_color_cells instead. */
373 XColor *color_cells;
374 int ncolor_cells;
375
376 /* Bits and shifts to use to compose pixel values on TrueColor visuals. */
377 int red_bits, blue_bits, green_bits;
378 int red_offset, blue_offset, green_offset;
379
380 /* The type of window manager we have. If we move FRAME_OUTER_WINDOW
381 to x/y 0/0, some window managers (type A) puts the window manager
382 decorations outside the screen and FRAME_OUTER_WINDOW exactly at 0/0.
383 Other window managers (type B) puts the window including decorations
384 at 0/0, so FRAME_OUTER_WINDOW is a bit below 0/0.
385 Record the type of WM in use so we can compensate for type A WMs. */
386 enum
387 {
388 X_WMTYPE_UNKNOWN,
389 X_WMTYPE_A,
390 X_WMTYPE_B
391 } wm_type;
392
393
394 /* Atoms that are drag and drop atoms */
395 Atom *x_dnd_atoms;
396 size_t x_dnd_atoms_size;
397 size_t x_dnd_atoms_length;
398 };
399
400 #ifdef HAVE_X_I18N
401 /* Whether or not to use XIM if we have it. */
402 extern int use_xim;
403 #endif
404
405 /* This checks to make sure we have a display. */
406 extern void check_x P_ ((void));
407
408 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
409
410 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
411 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
412 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
413 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
414 #endif
415
416 /* This is a chain of structures for all the X displays currently in use. */
417 extern struct x_display_info *x_display_list;
418
419 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
420 one for each element of x_display_list and in the same order.
421 NAME is the name of the frame.
422 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
423 extern Lisp_Object x_display_name_list;
424
425 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
426 extern Lisp_Object Vx_pixel_size_width_font_regexp;
427
428 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
429 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
430
431 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
432 extern int x_display_ok P_ ((const char *));
433
434 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
435 extern void select_visual P_ ((struct x_display_info *));
436 extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
437 extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
438 extern struct font_info *x_query_font P_ ((struct frame *, char *));
439 extern void x_find_ccl_program P_ ((struct font_info *));
440 \f
441 /* Each X frame object points to its own struct x_output object
442 in the output_data.x field. The x_output structure contains
443 the information that is specific to X windows. */
444
445 struct x_output
446 {
447 /* Height of menu bar widget, in pixels.
448 Zero if not using the X toolkit.
449 When using the toolkit, this value is not meaningful
450 if the menubar is turned off. */
451 int menubar_height;
452
453 /* Height of tool bar widget, in pixels.
454 Zero if not using an external tool bar. */
455 int toolbar_height;
456
457 /* The tiled border used when the mouse is out of the frame. */
458 Pixmap border_tile;
459
460 /* Here are the Graphics Contexts for the default font. */
461 GC normal_gc; /* Normal video */
462 GC reverse_gc; /* Reverse video */
463 GC cursor_gc; /* cursor drawing */
464
465 /* The X window used for this frame.
466 May be zero while the frame object is being created
467 and the X window has not yet been created. */
468 Window window_desc;
469
470 /* The X window used for the bitmap icon;
471 or 0 if we don't have a bitmap icon. */
472 Window icon_desc;
473
474 /* The X window that is the parent of this X window.
475 Usually this is a window that was made by the window manager,
476 but it can be the root window, and it can be explicitly specified
477 (see the explicit_parent field, below). */
478 Window parent_desc;
479
480 #ifdef USE_X_TOOLKIT
481 /* The widget of this screen. This is the window of a "shell" widget. */
482 Widget widget;
483 /* The XmPanedWindows... */
484 Widget column_widget;
485 /* The widget of the edit portion of this screen; the window in
486 "window_desc" is inside of this. */
487 Widget edit_widget;
488
489 Widget menubar_widget;
490 #endif
491
492 #ifdef USE_GTK
493 /* The widget of this screen. This is the window of a top widget. */
494 GtkWidget *widget;
495 /* The widget of the edit portion of this screen; the window in
496 "window_desc" is inside of this. */
497 GtkWidget *edit_widget;
498 /* The widget used for laying out widgets vertically. */
499 GtkWidget *vbox_widget;
500 /* The menubar in this frame. */
501 GtkWidget *menubar_widget;
502 /* The tool bar in this frame */
503 GtkWidget *toolbar_widget;
504 /* The handle box that makes the tool bar detachable. */
505 GtkWidget *handlebox_widget;
506 /* Non-zero if the tool bar is detached. */
507 int toolbar_detached;
508
509 /* The last size hints set. */
510 GdkGeometry size_hints;
511 long hint_flags;
512 #endif
513
514 /* If >=0, a bitmap index. The indicated bitmap is used for the
515 icon. */
516 int icon_bitmap;
517
518 /* Default ASCII font of this frame. */
519 XFontStruct *font;
520
521 /* The baseline offset of the default ASCII font. */
522 int baseline_offset;
523
524 /* If a fontset is specified for this frame instead of font, this
525 value contains an ID of the fontset, else -1. */
526 int fontset;
527
528 /* Pixel values used for various purposes.
529 border_pixel may be -1 meaning use a gray tile. */
530 #if 0 /* These are also defined in struct frame. Use that instead. */
531 unsigned long background_pixel;
532 unsigned long foreground_pixel;
533 #endif
534 unsigned long cursor_pixel;
535 unsigned long border_pixel;
536 unsigned long mouse_pixel;
537 unsigned long cursor_foreground_pixel;
538
539 /* Foreground color for scroll bars. A value of -1 means use the
540 default (black for non-toolkit scroll bars). */
541 unsigned long scroll_bar_foreground_pixel;
542
543 /* Background color for scroll bars. A value of -1 means use the
544 default (background color of the frame for non-toolkit scroll
545 bars). */
546 unsigned long scroll_bar_background_pixel;
547
548 /* Top and bottom shadow colors for 3d toolkit scrollbars. -1 means
549 let the scroll compute them itself. */
550 unsigned long scroll_bar_top_shadow_pixel;
551 unsigned long scroll_bar_bottom_shadow_pixel;
552
553 /* Descriptor for the cursor in use for this window. */
554 Cursor text_cursor;
555 Cursor nontext_cursor;
556 Cursor modeline_cursor;
557 Cursor hand_cursor;
558 Cursor hourglass_cursor;
559 Cursor horizontal_drag_cursor;
560
561 /* Window whose cursor is hourglass_cursor. This window is temporarily
562 mapped to display an hourglass cursor. */
563 Window hourglass_window;
564
565 /* Non-zero means hourglass cursor is currently displayed. */
566 unsigned hourglass_p : 1;
567
568 /* Flag to set when the X window needs to be completely repainted. */
569 int needs_exposure;
570
571 /* These are the current window manager hints. It seems that
572 XSetWMHints, when presented with an unset bit in the `flags'
573 member of the hints structure, does not leave the corresponding
574 attribute unchanged; rather, it resets that attribute to its
575 default value. For example, unless you set the `icon_pixmap'
576 field and the `IconPixmapHint' bit, XSetWMHints will forget what
577 your icon pixmap was. This is rather troublesome, since some of
578 the members (for example, `input' and `icon_pixmap') want to stay
579 the same throughout the execution of Emacs. So, we keep this
580 structure around, just leaving values in it and adding new bits
581 to the mask as we go. */
582 XWMHints wm_hints;
583
584 /* This is the Emacs structure for the X display this frame is on. */
585 struct x_display_info *display_info;
586
587 /* This is a button event that wants to activate the menubar.
588 We save it here until the command loop gets to think about it. */
589 XEvent *saved_menu_event;
590
591 /* This is the widget id used for this frame's menubar in lwlib. */
592 #ifdef USE_X_TOOLKIT
593 int id;
594 #endif
595
596 /* Nonzero means our parent is another application's window
597 and was explicitly specified. */
598 char explicit_parent;
599
600 /* Nonzero means tried already to make this frame visible. */
601 char asked_for_visible;
602
603 /* Nonzero if this frame was ever previously visible. */
604 char has_been_visible;
605
606 #ifdef HAVE_X_I18N
607 /* Input context (currently, this means Compose key handler setup). */
608 XIC xic;
609 XIMStyle xic_style;
610 XFontSet xic_xfs;
611 char *xic_base_fontname;
612 #endif
613
614 /* Relief GCs, colors etc. */
615 struct relief
616 {
617 GC gc;
618 unsigned long pixel;
619 int allocated_p;
620 }
621 black_relief, white_relief;
622
623 /* The background for which the above relief GCs were set up.
624 They are changed only when a different background is involved. */
625 unsigned long relief_background;
626
627 /* Xt waits for a ConfigureNotify event from the window manager in
628 EmacsFrameSetCharSize when the shell widget is resized. For some
629 window managers like fvwm2 2.2.5 and KDE 2.1 this event doesn't
630 arrive for an unknown reason and Emacs hangs in Xt. If this is
631 zero, tell Xt not to wait. */
632 int wait_for_wm;
633
634 /* As x_pixels_diff, but to FRAME_OUTER_WINDOW. For some reason the
635 two might differ by a pixel, depending on WM */
636 int x_pixels_outer_diff;
637
638 /* As y_pixels_diff, but to FRAME_OUTER_WINDOW. In the toolkit version,
639 these may differ because this does not take into account possible
640 menubar. y_pixels_diff is with menubar height included */
641 int y_pixels_outer_diff;
642
643 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
644 frame, or IMPLICIT if we received an EnterNotify.
645 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
646 int focus_state;
647
648 /* The offset we need to add to compensate for type A WMs. */
649 int move_offset_top;
650 int move_offset_left;
651
652 /* The frame's left/top offsets before we call XMoveWindow. See
653 x_check_expected_move. */
654 int left_before_move;
655 int top_before_move;
656 };
657
658 #define No_Cursor (None)
659
660 enum
661 {
662 /* Values for focus_state, used as bit mask.
663 EXPLICIT means we received a FocusIn for the frame and know it has
664 the focus. IMPLICIT means we recevied an EnterNotify and the frame
665 may have the focus if no window manager is running.
666 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
667 FOCUS_NONE = 0,
668 FOCUS_IMPLICIT = 1,
669 FOCUS_EXPLICIT = 2
670 };
671
672
673 /* Return the X output data for frame F. */
674 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
675
676 /* Return the X window used for displaying data in frame F. */
677 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
678
679 /* Return the outermost X window associated with the frame F. */
680 #ifdef USE_X_TOOLKIT
681 #define FRAME_OUTER_WINDOW(f) ((f)->output_data.x->widget ? \
682 XtWindow ((f)->output_data.x->widget) : \
683 FRAME_X_WINDOW (f))
684 #else
685 #ifdef USE_GTK
686 #define GTK_WIDGET_TO_X_WIN(w) \
687 ((w) && (w)->window ? GDK_WINDOW_XWINDOW ((w)->window) : 0)
688
689 #define FRAME_GTK_OUTER_WIDGET(f) ((f)->output_data.x->widget)
690 #define FRAME_GTK_WIDGET(f) ((f)->output_data.x->edit_widget)
691 #define FRAME_OUTER_WINDOW(f) \
692 (FRAME_GTK_OUTER_WIDGET (f) ? \
693 GTK_WIDGET_TO_X_WIN (FRAME_GTK_OUTER_WIDGET (f)) : \
694 FRAME_X_WINDOW (f))
695
696 #else /* !USE_GTK */
697 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
698 #endif /* !USE_GTK */
699 #endif
700
701
702 #define FRAME_FONT(f) ((f)->output_data.x->font)
703 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
704 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
705 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.x->toolbar_height)
706 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.x->baseline_offset)
707
708 /* This gives the x_display_info structure for the display F is on. */
709 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
710
711 /* This is the `Display *' which frame F is on. */
712 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
713
714 /* This is the `Screen *' which frame F is on. */
715 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
716 #define FRAME_X_SCREEN_NUMBER(f) XScreenNumberOfScreen (FRAME_X_SCREEN (f))
717
718 /* This is the Visual which frame F is on. */
719 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
720
721 /* This is the Colormap which frame F uses. */
722 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
723
724 /* This is the 'font_info *' which frame F has. */
725 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
726
727 /* The difference in pixels between the top left corner of the
728 Emacs window (including possible window manager decorations)
729 and FRAME_X_WINDOW (f). */
730 #define FRAME_OUTER_TO_INNER_DIFF_X(f) \
731 ((f)->output_data.x->x_pixels_outer_diff)
732 #define FRAME_OUTER_TO_INNER_DIFF_Y(f) \
733 ((f)->output_data.x->y_pixels_outer_diff \
734 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
735
736
737 #define FRAME_XIC(f) ((f)->output_data.x->xic)
738 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
739 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
740 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
741 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
742 #define FRAME_XIC_BASE_FONTNAME(f) ((f)->output_data.x->xic_base_fontname)
743
744 /* Value is the smallest width of any character in any font on frame F. */
745
746 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
747 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
748
749 /* Value is the smallest height of any font on frame F. */
750
751 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
752 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
753
754 /* Return a pointer to the image cache of frame F. */
755
756 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
757
758 \f
759 /* X-specific scroll bar stuff. */
760
761 /* We represent scroll bars as lisp vectors. This allows us to place
762 references to them in windows without worrying about whether we'll
763 end up with windows referring to dead scroll bars; the garbage
764 collector will free it when its time comes.
765
766 We use struct scroll_bar as a template for accessing fields of the
767 vector. */
768
769 struct scroll_bar
770 {
771 /* These fields are shared by all vectors. */
772 EMACS_INT size_from_Lisp_Vector_struct;
773 struct Lisp_Vector *next_from_Lisp_Vector_struct;
774
775 /* The window we're a scroll bar for. */
776 Lisp_Object window;
777
778 /* The next and previous in the chain of scroll bars in this frame. */
779 Lisp_Object next, prev;
780
781 /* The X window representing this scroll bar. Since this is a full
782 32-bit quantity, we store it split into two 32-bit values. */
783 Lisp_Object x_window_low, x_window_high;
784
785 /* The position and size of the scroll bar in pixels, relative to the
786 frame. */
787 Lisp_Object top, left, width, height;
788
789 /* The starting and ending positions of the handle, relative to the
790 handle area (i.e. zero is the top position, not
791 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
792 hasn't been drawn yet.
793
794 These are not actually the locations where the beginning and end
795 are drawn; in order to keep handles from becoming invisible when
796 editing large files, we establish a minimum height by always
797 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
798 where they would be normally; the bottom and top are in a
799 different co-ordinate system. */
800 Lisp_Object start, end;
801
802 /* If the scroll bar handle is currently being dragged by the user,
803 this is the number of pixels from the top of the handle to the
804 place where the user grabbed it. If the handle isn't currently
805 being dragged, this is Qnil. */
806 Lisp_Object dragging;
807 };
808
809 /* The number of elements a vector holding a struct scroll_bar needs. */
810 #define SCROLL_BAR_VEC_SIZE \
811 ((sizeof (struct scroll_bar) \
812 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
813 / sizeof (Lisp_Object))
814
815 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
816 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
817
818
819 /* Building a 32-bit C integer from two 16-bit lisp integers. */
820 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
821
822 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
823 #define SCROLL_BAR_UNPACK(low, high, int32) \
824 (XSETINT ((low), (int32) & 0xffff), \
825 XSETINT ((high), ((int32) >> 16) & 0xffff))
826
827
828 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
829 #define SCROLL_BAR_X_WINDOW(ptr) \
830 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
831
832 /* Store a window id in a struct scroll_bar. */
833 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
834 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
835
836 /* Extract the X widget of the scroll bar from a struct scroll_bar.
837 XtWindowToWidget should be fast enough since Xt uses a hash table
838 to map windows to widgets. */
839
840 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
841 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
842
843 /* Store a widget id in a struct scroll_bar. */
844
845 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
846 do { \
847 Window window = XtWindow (w); \
848 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
849 } while (0)
850
851
852 /* Return the inside width of a vertical scroll bar, given the outside
853 width. */
854 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
855 ((width) \
856 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
857 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
858 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
859
860 /* Return the length of the rectangle within which the top of the
861 handle must stay. This isn't equivalent to the inside height,
862 because the scroll bar handle has a minimum height.
863
864 This is the real range of motion for the scroll bar, so when we're
865 scaling buffer positions to scroll bar positions, we use this, not
866 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
867 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
868 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
869
870 /* Return the inside height of vertical scroll bar, given the outside
871 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
872 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
873 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
874
875
876 /* Border widths for scroll bars.
877
878 Scroll bar windows don't have any X borders; their border width is
879 set to zero, and we redraw borders ourselves. This makes the code
880 a bit cleaner, since we don't have to convert between outside width
881 (used when relating to the rest of the screen) and inside width
882 (used when sizing and drawing the scroll bar window itself).
883
884 The handle moves up and down/back and forth in a rectangle inset
885 from the edges of the scroll bar. These are widths by which we
886 inset the handle boundaries from the scroll bar edges. */
887 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
888 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
889 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
890 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
891
892 /* Minimum lengths for scroll bar handles, in pixels. */
893 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
894
895 /* Trimming off a few pixels from each side prevents
896 text from glomming up against the scroll bar */
897 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
898
899 \f
900 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
901 or SELECTION_CLEAR_EVENT, then its contents are really described
902 by this structure. */
903
904 /* For an event of kind SELECTION_REQUEST_EVENT,
905 this structure really describes the contents.
906 **Don't make this struct longer!**
907 If it overlaps the frame_or_window field of struct input_event,
908 that will cause GC to crash. */
909 struct selection_input_event
910 {
911 int kind;
912 Display *display;
913 /* We spell it with an "o" here because X does. */
914 Window requestor;
915 Atom selection, target, property;
916 Time time;
917 };
918
919 #define SELECTION_EVENT_DISPLAY(eventp) \
920 (((struct selection_input_event *) (eventp))->display)
921 /* We spell it with an "o" here because X does. */
922 #define SELECTION_EVENT_REQUESTOR(eventp) \
923 (((struct selection_input_event *) (eventp))->requestor)
924 #define SELECTION_EVENT_SELECTION(eventp) \
925 (((struct selection_input_event *) (eventp))->selection)
926 #define SELECTION_EVENT_TARGET(eventp) \
927 (((struct selection_input_event *) (eventp))->target)
928 #define SELECTION_EVENT_PROPERTY(eventp) \
929 (((struct selection_input_event *) (eventp))->property)
930 #define SELECTION_EVENT_TIME(eventp) \
931 (((struct selection_input_event *) (eventp))->time)
932
933 \f
934 struct window;
935 struct glyph_matrix;
936 struct frame;
937 struct input_event;
938 struct face;
939 struct image;
940
941 /* From xselect.c. */
942
943 void x_handle_selection_notify P_ ((XSelectionEvent *));
944 void x_handle_property_notify P_ ((XPropertyEvent *));
945
946 /* From xfns.c. */
947
948 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
949 Lisp_Object, Lisp_Object,
950 Lisp_Object, Lisp_Object));
951 struct frame *check_x_frame P_ ((Lisp_Object));
952 EXFUN (Fx_display_color_p, 1);
953 EXFUN (Fx_display_grayscale_p, 1);
954 extern void x_free_gcs P_ ((struct frame *));
955
956 /* From xrdb.c. */
957
958 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
959 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
960 int x_get_resource P_ ((XrmDatabase, char *, char *,
961 XrmRepresentation, XrmValue *));
962 void x_delete_display P_ ((struct x_display_info *));
963 void x_make_frame_visible P_ ((struct frame *));
964 void x_iconify_frame P_ ((struct frame *));
965 void x_wm_set_size_hint P_ ((struct frame *, long, int));
966 int x_text_icon P_ ((struct frame *, char *));
967 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
968 void x_set_window_size P_ ((struct frame *, int, int, int));
969 void x_wm_set_window_state P_ ((struct frame *, int));
970 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
971
972 /* Defined in xterm.c */
973
974 extern void cancel_mouse_face P_ ((struct frame *));
975 extern void x_scroll_bar_clear P_ ((struct frame *));
976 extern int x_text_icon P_ ((struct frame *, char *));
977 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
978 extern void x_catch_errors P_ ((Display *));
979 extern void x_check_errors P_ ((Display *, char *));
980 extern int x_had_errors_p P_ ((Display *));
981 extern int x_catching_errors P_ ((void));
982 extern void x_uncatch_errors P_ ((void));
983 extern void x_clear_errors P_ ((Display *));
984 extern void x_set_window_size P_ ((struct frame *, int, int, int));
985 extern void x_set_mouse_position P_ ((struct frame *, int, int));
986 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
987 extern void x_raise_frame P_ ((struct frame *));
988 extern void x_lower_frame P_ ((struct frame *));
989 extern void x_make_frame_visible P_ ((struct frame *));
990 extern void x_make_frame_invisible P_ ((struct frame *));
991 extern void x_iconify_frame P_ ((struct frame *));
992 extern void x_free_frame_resources P_ ((struct frame *));
993 extern void x_destroy_window P_ ((struct frame *));
994 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
995 extern void x_wm_set_window_state P_ ((struct frame *, int));
996 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
997 extern void x_delete_display P_ ((struct x_display_info *));
998 extern void x_delete_terminal P_ ((struct terminal *terminal));
999 extern void x_initialize P_ ((void));
1000 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
1001 #ifdef USE_X_TOOLKIT
1002 extern XtAppContext Xt_app_con;
1003 extern int x_alloc_lighter_color_for_widget __P ((Widget, Display*, Colormap,
1004 unsigned long *,
1005 double, int));
1006 extern void x_activate_timeout_atimer P_ ((void));
1007 #endif
1008 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
1009 extern void x_query_color P_ ((struct frame *f, XColor *));
1010 extern void x_clear_area P_ ((Display *, Window, int, int, int, int, int));
1011 extern void set_vertical_scroll_bar P_ ((struct window *));
1012
1013 extern int x_dispatch_event P_ ((XEvent *, Display *));
1014 extern unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
1015 unsigned));
1016
1017 /* Defined in xselect.c */
1018
1019 extern void x_handle_property_notify P_ ((XPropertyEvent *));
1020 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
1021 extern void x_handle_selection_event P_ ((struct input_event *));
1022 extern void x_clear_frame_selections P_ ((struct frame *));
1023
1024 extern int x_handle_dnd_message P_ ((struct frame *,
1025 XClientMessageEvent *,
1026 struct x_display_info *,
1027 struct input_event *bufp));
1028 extern int x_check_property_data P_ ((Lisp_Object));
1029 extern void x_fill_property_data P_ ((Display *,
1030 Lisp_Object,
1031 void *,
1032 int));
1033 extern Lisp_Object x_property_data_to_lisp P_ ((struct frame *,
1034 unsigned char *,
1035 Atom,
1036 int,
1037 unsigned long));
1038
1039 /* Defined in xfns.c */
1040
1041 extern struct x_display_info * check_x_display_info P_ ((Lisp_Object frame));
1042 extern int have_menus_p P_ ((void));
1043
1044 #ifdef USE_GTK
1045 extern int xg_set_icon P_ ((struct frame *, Lisp_Object));
1046 extern int xg_set_icon_from_xpm_data P_ ((struct frame *, char**));
1047 #endif /* USE_GTK */
1048
1049 extern void x_real_positions P_ ((struct frame *, int *, int *));
1050 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
1051 extern void x_set_border_pixel P_ ((struct frame *, int));
1052 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1053 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
1054 extern void xic_free_xfontset P_ ((struct frame *));
1055 extern void create_frame_xic P_ ((struct frame *));
1056 extern void destroy_frame_xic P_ ((struct frame *));
1057 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1058 extern void xic_set_statusarea P_ ((struct frame *));
1059 extern void xic_set_xfontset P_ ((struct frame *, char *));
1060 extern int x_pixel_width P_ ((struct frame *));
1061 extern int x_pixel_height P_ ((struct frame *));
1062 extern int x_char_width P_ ((struct frame *));
1063 extern int x_char_height P_ ((struct frame *));
1064 extern int x_screen_planes P_ ((struct frame *));
1065 extern void x_sync P_ ((struct frame *));
1066 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1067 #ifdef HAVE_X_I18N
1068 extern void free_frame_xic P_ ((struct frame *));
1069 #endif
1070 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1071
1072 /* Defined in xfaces.c */
1073
1074 extern int compute_glyph_face P_ ((struct frame *, int, int));
1075 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1076 extern void x_free_dpy_colors P_ ((Display *, Screen *, Colormap,
1077 unsigned long *, int));
1078
1079 /* Defined in xmenu.c */
1080
1081 extern void x_menu_set_in_use P_ ((int));
1082 extern void x_menu_wait_for_event P_ ((void *data));
1083 extern void x_activate_menubar P_ ((struct frame *));
1084 extern int popup_activated P_ ((void));
1085 extern void initialize_frame_menubar P_ ((struct frame *));
1086 extern void free_frame_menubar P_ ((struct frame *));
1087
1088 /* Defined in widget.c */
1089
1090 #ifdef USE_X_TOOLKIT
1091 extern void widget_store_internal_border P_ ((Widget));
1092 #endif
1093
1094 /* Defined in xsmfns.c */
1095 #ifdef HAVE_X_SM
1096 extern void x_session_initialize P_ ((struct x_display_info *dpyinfo));
1097 extern int x_session_check_input P_ ((struct input_event *bufp));
1098 extern int x_session_have_connection P_ ((void));
1099 extern void x_session_close P_ ((void));
1100 #endif
1101
1102 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
1103 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
1104
1105 #define STORE_XCHAR2B(chp, b1, b2) \
1106 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
1107
1108 #define XCHAR2B_BYTE1(chp) \
1109 ((chp)->byte1)
1110
1111 #define XCHAR2B_BYTE2(chp) \
1112 ((chp)->byte2)
1113
1114
1115 #define STORE_NATIVE_RECT(nr,rx,ry,rwidth,rheight) \
1116 ((nr).x = (rx), \
1117 (nr).y = (ry), \
1118 (nr).width = (rwidth), \
1119 (nr).height = (rheight))
1120
1121 /* arch-tag: 78a7972a-b18f-4694-861a-0780c4b3090e
1122 (do not change this comment) */