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