*** empty log message ***
[emacs.git] / src / xterm.h
blob829a175c0482bdcaa83ba7ee81433a0833b15142
1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993, 1994, 1998, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; 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. */
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>
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
38 /* The class of this X application. */
39 #define EMACS_CLASS "Emacs"
41 /* Bookkeeping to distinguish X versions. */
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:
49 #ifdef HAVE_X11R5
50 ...
51 #elif HAVE_X11R4
52 ...
53 #elif HAVE_X11
54 ...
55 #endif
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.
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
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
81 #ifdef HAVE_X_I18N
82 #include <X11/Xlocale.h>
83 #endif
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)))
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)
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. */
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)
110 enum text_cursor_kinds
112 NO_CURSOR = -1,
113 FILLED_BOX_CURSOR,
114 HOLLOW_BOX_CURSOR,
115 BAR_CURSOR
118 /* Structure recording X pixmap and reference count.
119 If REFCOUNT is 0 then this record is free to be reused. */
121 struct x_bitmap_record
123 Pixmap pixmap;
124 char *file;
125 int refcount;
126 /* Record some info about this pixmap. */
127 int height, width, depth;
130 /* For each X display, we have a structure that records
131 information about it. */
133 struct x_display_info
135 /* Chain of all x_display_info structures. */
136 struct x_display_info *next;
138 /* Connection number (normally a file descriptor number). */
139 int connection;
141 /* This says how to access this display in Xlib. */
142 Display *display;
144 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
145 The same cons cell also appears in x_display_name_list. */
146 Lisp_Object name_list_element;
148 /* Number of frames that are on this display. */
149 int reference_count;
151 /* The Screen this connection is connected to. */
152 Screen *screen;
154 /* Dots per inch of the screen. */
155 double resx, resy;
157 /* The Visual being used for this display. */
158 Visual *visual;
160 /* THe colormap being used. */
161 Colormap cmap;
163 /* Number of panes on this screen. */
164 int n_planes;
166 /* Dimensions of this screen. */
167 int height, width;
169 /* Mask of things that cause the mouse to be grabbed. */
170 int grabbed;
172 /* Emacs bitmap-id of the default icon bitmap for this frame.
173 Or -1 if none has been allocated yet. */
174 int icon_bitmap_id;
176 /* The root window of this screen. */
177 Window root_window;
179 /* The cursor to use for vertical scroll bars. */
180 Cursor vertical_scroll_bar_cursor;
182 /* X Resource data base */
183 XrmDatabase xrdb;
185 /* A table of all the fonts we have already loaded. */
186 struct font_info *font_table;
188 /* The current capacity of x_font_table. */
189 int font_table_size;
191 /* Minimum width over all characters in all fonts in font_table. */
192 int smallest_char_width;
194 /* Minimum font height over all fonts in font_table. */
195 int smallest_font_height;
197 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
198 GC scratch_cursor_gc;
200 /* These variables describe the range of text currently shown in its
201 mouse-face, together with the window they apply to. As long as
202 the mouse stays within this range, we need not redraw anything on
203 its account. Rows and columns are glyph matrix positions in
204 MOUSE_FACE_WINDOW. */
205 int mouse_face_beg_row, mouse_face_beg_col;
206 int mouse_face_beg_x, mouse_face_beg_y;
207 int mouse_face_end_row, mouse_face_end_col;
208 int mouse_face_end_x, mouse_face_end_y;
209 int mouse_face_past_end;
210 Lisp_Object mouse_face_window;
211 int mouse_face_face_id;
213 /* 1 if a mouse motion event came and we didn't handle it right away because
214 gc was in progress. */
215 int mouse_face_deferred_gc;
217 /* FRAME and X, Y position of mouse when last checked for
218 highlighting. X and Y can be negative or out of range for the frame. */
219 struct frame *mouse_face_mouse_frame;
220 int mouse_face_mouse_x, mouse_face_mouse_y;
222 /* Nonzero means defer mouse-motion highlighting. */
223 int mouse_face_defer;
225 int mouse_face_image_state;
227 char *x_id_name;
229 /* The number of fonts actually stored in x_font_table.
230 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
231 n_fonts <= font_table_size and font_table[i].name != 0. */
232 int n_fonts;
234 /* Pointer to bitmap records. */
235 struct x_bitmap_record *bitmaps;
237 /* Allocated size of bitmaps field. */
238 int bitmaps_size;
240 /* Last used bitmap index. */
241 int bitmaps_last;
243 /* Which modifier keys are on which modifier bits?
245 With each keystroke, X returns eight bits indicating which modifier
246 keys were held down when the key was pressed. The interpretation
247 of the top five modifier bits depends on what keys are attached
248 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
249 is the meta bit.
251 meta_mod_mask is a mask containing the bits used for the meta key.
252 It may have more than one bit set, if more than one modifier bit
253 has meta keys on it. Basically, if EVENT is a KeyPress event,
254 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
256 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
257 lock modifier bit, or zero otherwise. Non-alphabetic keys should
258 only be affected by the lock modifier bit if XK_Shift_Lock is in
259 use; XK_Caps_Lock should only affect alphabetic keys. With this
260 arrangement, the lock modifier should shift the character if
261 (EVENT.state & shift_lock_mask) != 0. */
262 int meta_mod_mask, shift_lock_mask;
264 /* These are like meta_mod_mask, but for different modifiers. */
265 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
267 /* Communication with window managers. */
268 Atom Xatom_wm_protocols;
270 /* Kinds of protocol things we may receive. */
271 Atom Xatom_wm_take_focus;
272 Atom Xatom_wm_save_yourself;
273 Atom Xatom_wm_delete_window;
275 /* Atom for indicating window state to the window manager. */
276 Atom Xatom_wm_change_state;
278 /* Other WM communication */
279 Atom Xatom_wm_configure_denied; /* When our config request is denied */
280 Atom Xatom_wm_window_moved; /* When the WM moves us. */
282 /* EditRes protocol */
283 Atom Xatom_editres;
285 /* More atoms, which are selection types. */
286 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
287 Xatom_COMPOUND_TEXT,
288 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
289 Xatom_ATOM_PAIR;
291 /* More atoms for font properties. The last three are private
292 properties, see the comments in src/fontset.h. */
293 Atom Xatom_PIXEL_SIZE,
294 Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
295 Xatom_MULE_DEFAULT_ASCENT;
297 /* More atoms for Ghostscript support. */
298 Atom Xatom_DONE, Xatom_PAGE;
300 /* Atom used in toolkit scroll bar client messages. */
301 Atom Xatom_Scrollbar;
303 #ifdef MULTI_KBOARD
304 struct kboard *kboard;
305 #endif
306 int cut_buffers_initialized; /* Whether we're sure they all exist */
308 /* The frame (if any) which has the X window that has keyboard focus.
309 Zero if none. This is examined by Ffocus_frame in xfns.c. Note
310 that a mere EnterNotify event can set this; if you need to know the
311 last frame specified in a FocusIn or FocusOut event, use
312 x_focus_event_frame. */
313 struct frame *x_focus_frame;
315 /* The last frame mentioned in a FocusIn or FocusOut event. This is
316 separate from x_focus_frame, because whether or not LeaveNotify
317 events cause us to lose focus depends on whether or not we have
318 received a FocusIn event for it. */
319 struct frame *x_focus_event_frame;
321 /* The frame which currently has the visual highlight, and should get
322 keyboard input (other sorts of input have the frame encoded in the
323 event). It points to the X focus frame's selected window's
324 frame. It differs from x_focus_frame when we're using a global
325 minibuffer. */
326 struct frame *x_highlight_frame;
328 /* The null pixel used for filling a character background with
329 background color of a gc. */
330 Pixmap null_pixel;
332 /* The gray pixmap. */
333 Pixmap gray;
335 /* Cache of images. */
336 struct image_cache *image_cache;
338 #ifdef HAVE_X_I18N
339 /* XIM (X Input method). */
340 XIM xim;
341 XIMStyles *xim_styles;
342 #endif
344 /* If non-null, a cache of the colors in the color map. Don't
345 use this directly, call x_color_cells instead. */
346 XColor *color_cells;
347 int ncolor_cells;
350 /* This checks to make sure we have a display. */
351 extern void check_x P_ ((void));
353 extern struct frame *x_window_to_frame P_ ((struct x_display_info *, int));
355 #ifdef USE_X_TOOLKIT
356 extern struct frame *x_any_window_to_frame P_ ((struct x_display_info *, int));
357 extern struct frame *x_non_menubar_window_to_frame P_ ((struct x_display_info *, int));
358 extern struct frame *x_top_window_to_frame P_ ((struct x_display_info *, int));
359 #endif
361 /* This is a chain of structures for all the X displays currently in use. */
362 extern struct x_display_info *x_display_list;
364 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
365 one for each element of x_display_list and in the same order.
366 NAME is the name of the frame.
367 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
368 extern Lisp_Object x_display_name_list;
370 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
371 extern Lisp_Object Vx_pixel_size_width_font_regexp;
373 /* A flag to control how to display unibyte 8-bit character. */
374 extern int unibyte_display_via_language_environment;
376 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
377 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
379 extern struct x_display_info *x_term_init P_ ((Lisp_Object, char *, char *));
381 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
382 extern void select_visual P_ ((struct x_display_info *));
383 extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
384 extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
385 extern struct font_info *x_query_font P_ ((struct frame *, char *));
386 extern void x_find_ccl_program P_ ((struct font_info *));
388 /* Each X frame object points to its own struct x_output object
389 in the output_data.x field. The x_output structure contains
390 the information that is specific to X windows. */
392 struct x_output
394 /* Position of the X window (x and y offsets in root window). */
395 int left_pos;
396 int top_pos;
398 /* Border width of the X window as known by the X window system. */
399 int border_width;
401 /* Size of the X window in pixels. */
402 int pixel_height, pixel_width;
404 /* Height of menu bar widget, in pixels.
405 Zero if not using the X toolkit.
406 When using the toolkit, this value is not meaningful
407 if the menubar is turned off. */
408 int menubar_height;
410 /* Height of a line, in pixels. */
411 int line_height;
413 /* The tiled border used when the mouse is out of the frame. */
414 Pixmap border_tile;
416 /* Here are the Graphics Contexts for the default font. */
417 GC normal_gc; /* Normal video */
418 GC reverse_gc; /* Reverse video */
419 GC cursor_gc; /* cursor drawing */
421 /* Width of the internal border. This is a line of background color
422 just inside the window's border. When the frame is selected,
423 a highlighting is displayed inside the internal border. */
424 int internal_border_width;
426 /* The X window used for this frame.
427 May be zero while the frame object is being created
428 and the X window has not yet been created. */
429 Window window_desc;
431 /* The X window used for the bitmap icon;
432 or 0 if we don't have a bitmap icon. */
433 Window icon_desc;
435 /* The X window that is the parent of this X window.
436 Usually this is a window that was made by the window manager,
437 but it can be the root window, and it can be explicitly specified
438 (see the explicit_parent field, below). */
439 Window parent_desc;
441 #ifdef USE_X_TOOLKIT
442 /* The widget of this screen. This is the window of a "shell" widget. */
443 Widget widget;
444 /* The XmPanedWindows... */
445 Widget column_widget;
446 /* The widget of the edit portion of this screen; the window in
447 "window_desc" is inside of this. */
448 Widget edit_widget;
450 Widget menubar_widget;
451 #endif
453 /* If >=0, a bitmap index. The indicated bitmap is used for the
454 icon. */
455 int icon_bitmap;
457 /* Default ASCII font of this frame. */
458 XFontStruct *font;
460 /* The baseline offset of the default ASCII font. */
461 int baseline_offset;
463 /* If a fontset is specified for this frame instead of font, this
464 value contains an ID of the fontset, else -1. */
465 int fontset;
467 /* Pixel values used for various purposes.
468 border_pixel may be -1 meaning use a gray tile. */
469 unsigned long background_pixel;
470 unsigned long foreground_pixel;
471 unsigned long cursor_pixel;
472 unsigned long border_pixel;
473 unsigned long mouse_pixel;
474 unsigned long cursor_foreground_pixel;
476 /* Foreground color for scroll bars. A value of -1 means use the
477 default (black for non-toolkit scroll bars). */
478 unsigned long scroll_bar_foreground_pixel;
480 /* Background color for scroll bars. A value of -1 means use the
481 default (background color of the frame for non-toolkit scroll
482 bars). */
483 unsigned long scroll_bar_background_pixel;
485 /* Descriptor for the cursor in use for this window. */
486 Cursor text_cursor;
487 Cursor nontext_cursor;
488 Cursor modeline_cursor;
489 Cursor cross_cursor;
490 Cursor busy_cursor;
491 Cursor horizontal_drag_cursor;
493 /* Window whose cursor is busy_cursor. This window is temporarily
494 mapped to display a busy-cursor. */
495 Window busy_window;
497 /* Non-zero means busy cursor is currently displayed. */
498 unsigned busy_p : 1;
500 /* Flag to set when the X window needs to be completely repainted. */
501 int needs_exposure;
503 /* What kind of text cursor is drawn in this window right now?
504 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
505 enum text_cursor_kinds current_cursor;
507 /* What kind of text cursor should we draw in the future?
508 This should always be filled_box_cursor or bar_cursor. */
509 enum text_cursor_kinds desired_cursor;
511 /* Width of bar cursor (if we are using that). */
512 int cursor_width;
514 /* These are the current window manager hints. It seems that
515 XSetWMHints, when presented with an unset bit in the `flags'
516 member of the hints structure, does not leave the corresponding
517 attribute unchanged; rather, it resets that attribute to its
518 default value. For example, unless you set the `icon_pixmap'
519 field and the `IconPixmapHint' bit, XSetWMHints will forget what
520 your icon pixmap was. This is rather troublesome, since some of
521 the members (for example, `input' and `icon_pixmap') want to stay
522 the same throughout the execution of Emacs. So, we keep this
523 structure around, just leaving values in it and adding new bits
524 to the mask as we go. */
525 XWMHints wm_hints;
527 /* The size of the extra width currently allotted for vertical
528 scroll bars, in pixels. */
529 int vertical_scroll_bar_extra;
531 /* The extra width currently allotted for the areas in which
532 truncation marks, continuation marks, and overlay arrows are
533 displayed. */
534 int flags_areas_extra;
536 /* This is the gravity value for the specified window position. */
537 int win_gravity;
539 /* The geometry flags for this window. */
540 int size_hint_flags;
542 /* This is the Emacs structure for the X display this frame is on. */
543 struct x_display_info *display_info;
545 /* This is a button event that wants to activate the menubar.
546 We save it here until the command loop gets to think about it. */
547 XEvent *saved_menu_event;
549 /* This is the widget id used for this frame's menubar in lwlib. */
550 #ifdef USE_X_TOOLKIT
551 int id;
552 #endif
554 /* Nonzero means our parent is another application's window
555 and was explicitly specified. */
556 char explicit_parent;
558 /* Nonzero means tried already to make this frame visible. */
559 char asked_for_visible;
561 /* Nonzero if this frame was ever previously visible. */
562 char has_been_visible;
564 #ifdef HAVE_X_I18N
565 /* Input context (currently, this means Compose key handler setup). */
566 XIC xic;
567 XIMStyle xic_style;
568 XFontSet xic_xfs;
569 #endif
571 /* Relief GCs, colors etc. */
572 struct relief
574 GC gc;
575 unsigned long pixel;
576 int allocated_p;
578 black_relief, white_relief;
580 /* The background for which the above relief GCs were set up.
581 They are changed only when a different background is involved. */
582 unsigned long relief_background;
585 /* Return the X window used for displaying data in frame F. */
586 #define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
588 /* Return the outermost X window associated with the frame F. */
589 #ifdef USE_X_TOOLKIT
590 #define FRAME_OUTER_WINDOW(f) (XtWindow ((f)->output_data.x->widget))
591 #else
592 #define FRAME_OUTER_WINDOW(f) (FRAME_X_WINDOW (f))
593 #endif
595 #define FRAME_FONT(f) ((f)->output_data.x->font)
596 #define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
597 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
598 #define FRAME_MENUBAR_HEIGHT(f) ((f)->output_data.x->menubar_height)
599 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
601 /* Width of the default font of frame F. Must be defined by each
602 terminal specific header. */
603 #define FRAME_DEFAULT_FONT_WIDTH(F) FONT_WIDTH (FRAME_FONT (F))
605 /* This gives the x_display_info structure for the display F is on. */
606 #define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
608 /* This is the `Display *' which frame F is on. */
609 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
611 /* This is the `Screen *' which frame F is on. */
612 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
614 /* This is the Visual which frame F is on. */
615 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
617 /* This is the Colormap which frame F uses. */
618 #define FRAME_X_COLORMAP(f) FRAME_X_DISPLAY_INFO (f)->cmap
620 /* This is the 'font_info *' which frame F has. */
621 #define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
623 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
624 #define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
625 #define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
627 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
629 #define FRAME_XIC(f) ((f)->output_data.x->xic)
630 #define FRAME_X_XIM(f) (FRAME_X_DISPLAY_INFO (f)->xim)
631 #define FRAME_X_XIM_STYLES(f) (FRAME_X_DISPLAY_INFO (f)->xim_styles)
632 #define FRAME_XIC_STYLE(f) ((f)->output_data.x->xic_style)
633 #define FRAME_XIC_FONTSET(f) ((f)->output_data.x->xic_xfs)
635 /* Value is the smallest width of any character in any font on frame F. */
637 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
638 FRAME_X_DISPLAY_INFO(F)->smallest_char_width
640 /* Value is the smallest height of any font on frame F. */
642 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
643 FRAME_X_DISPLAY_INFO(F)->smallest_font_height
645 /* Return a pointer to the image cache of frame F. */
647 #define FRAME_X_IMAGE_CACHE(F) FRAME_X_DISPLAY_INFO ((F))->image_cache
650 /* Pixel width of the bitmaps drawn to indicate truncation,
651 continuation etc. */
653 #define FRAME_FLAGS_BITMAP_WIDTH(f) 8
654 #define FRAME_FLAGS_BITMAP_HEIGHT(f) 8
656 /* Total width of a areas reserved for drawing truncation bitmaps,
657 continuation bitmaps and alike. The width is in canonical char
658 units of the frame. This must currently be the case because window
659 sizes aren't pixel values. If it weren't the case, we wouldn't be
660 able to split windows horizontally nicely. */
662 #define FRAME_X_FLAGS_AREA_COLS(F) \
663 ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1) \
664 / CANON_X_UNIT ((F)))
666 /* Total width of flags areas in pixels. */
668 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
669 (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
671 /* Pixel-width of the left flags area. */
673 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
674 (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
676 /* Pixel-width of the right flags area. Note that we are doing
677 integer arithmetic here, so don't loose a pixel if the total
678 width is an odd number. */
680 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F) \
681 (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
685 /* X-specific scroll bar stuff. */
687 /* We represent scroll bars as lisp vectors. This allows us to place
688 references to them in windows without worrying about whether we'll
689 end up with windows referring to dead scroll bars; the garbage
690 collector will free it when its time comes.
692 We use struct scroll_bar as a template for accessing fields of the
693 vector. */
695 struct scroll_bar
697 /* These fields are shared by all vectors. */
698 EMACS_INT size_from_Lisp_Vector_struct;
699 struct Lisp_Vector *next_from_Lisp_Vector_struct;
701 /* The window we're a scroll bar for. */
702 Lisp_Object window;
704 /* The next and previous in the chain of scroll bars in this frame. */
705 Lisp_Object next, prev;
707 /* The X window representing this scroll bar. Since this is a full
708 32-bit quantity, we store it split into two 32-bit values. */
709 Lisp_Object x_window_low, x_window_high;
711 /* The position and size of the scroll bar in pixels, relative to the
712 frame. */
713 Lisp_Object top, left, width, height;
715 /* The starting and ending positions of the handle, relative to the
716 handle area (i.e. zero is the top position, not
717 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
718 hasn't been drawn yet.
720 These are not actually the locations where the beginning and end
721 are drawn; in order to keep handles from becoming invisible when
722 editing large files, we establish a minimum height by always
723 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
724 where they would be normally; the bottom and top are in a
725 different co-ordinate system. */
726 Lisp_Object start, end;
728 /* If the scroll bar handle is currently being dragged by the user,
729 this is the number of pixels from the top of the handle to the
730 place where the user grabbed it. If the handle isn't currently
731 being dragged, this is Qnil. */
732 Lisp_Object dragging;
735 /* The number of elements a vector holding a struct scroll_bar needs. */
736 #define SCROLL_BAR_VEC_SIZE \
737 ((sizeof (struct scroll_bar) \
738 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
739 / sizeof (Lisp_Object))
741 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
742 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
745 /* Building a 32-bit C integer from two 16-bit lisp integers. */
746 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
748 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
749 #define SCROLL_BAR_UNPACK(low, high, int32) \
750 (XSETINT ((low), (int32) & 0xffff), \
751 XSETINT ((high), ((int32) >> 16) & 0xffff))
754 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
755 #define SCROLL_BAR_X_WINDOW(ptr) \
756 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
758 /* Store a window id in a struct scroll_bar. */
759 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
760 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
762 /* Extract the X widget of the scroll bar from a struct scroll_bar.
763 XtWindowToWidget should be fast enough since Xt uses a hash table
764 to map windows to widgets. */
766 #define SCROLL_BAR_X_WIDGET(dpy, ptr) \
767 XtWindowToWidget (dpy, SCROLL_BAR_X_WINDOW (ptr))
769 /* Store a widget id in a struct scroll_bar. */
771 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
772 do { \
773 Window window = XtWindow (w); \
774 SET_SCROLL_BAR_X_WINDOW (ptr, window); \
775 } while (0)
778 /* Return the inside width of a vertical scroll bar, given the outside
779 width. */
780 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
781 ((width) \
782 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
783 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
784 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
786 /* Return the length of the rectangle within which the top of the
787 handle must stay. This isn't equivalent to the inside height,
788 because the scroll bar handle has a minimum height.
790 This is the real range of motion for the scroll bar, so when we're
791 scaling buffer positions to scroll bar positions, we use this, not
792 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
793 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
794 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
796 /* Return the inside height of vertical scroll bar, given the outside
797 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
798 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
799 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
802 /* Border widths for scroll bars.
804 Scroll bar windows don't have any X borders; their border width is
805 set to zero, and we redraw borders ourselves. This makes the code
806 a bit cleaner, since we don't have to convert between outside width
807 (used when relating to the rest of the screen) and inside width
808 (used when sizing and drawing the scroll bar window itself).
810 The handle moves up and down/back and forth in a rectangle inset
811 from the edges of the scroll bar. These are widths by which we
812 inset the handle boundaries from the scroll bar edges. */
813 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
814 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
815 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
816 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
818 /* Minimum lengths for scroll bar handles, in pixels. */
819 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
821 /* Trimming off a few pixels from each side prevents
822 text from glomming up against the scroll bar */
823 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
826 /* Manipulating pixel sizes and character sizes.
827 Knowledge of which factors affect the overall size of the window should
828 be hidden in these macros, if that's possible.
830 Return the upper/left pixel position of the character cell on frame F
831 at ROW/COL. */
832 #define CHAR_TO_PIXEL_ROW(f, row) \
833 ((f)->output_data.x->internal_border_width \
834 + (row) * (f)->output_data.x->line_height)
835 #define CHAR_TO_PIXEL_COL(f, col) \
836 ((f)->output_data.x->internal_border_width \
837 + (col) * FONT_WIDTH ((f)->output_data.x->font))
839 /* Return the pixel width/height of frame F if it has
840 WIDTH columns/HEIGHT rows. */
841 #define CHAR_TO_PIXEL_WIDTH(f, width) \
842 (CHAR_TO_PIXEL_COL (f, width) \
843 + (f)->output_data.x->vertical_scroll_bar_extra \
844 + (f)->output_data.x->flags_areas_extra \
845 + (f)->output_data.x->internal_border_width)
846 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
847 (CHAR_TO_PIXEL_ROW (f, height) \
848 + (f)->output_data.x->internal_border_width)
851 /* Return the row/column (zero-based) of the character cell containing
852 the pixel on FRAME at ROW/COL. */
853 #define PIXEL_TO_CHAR_ROW(f, row) \
854 (((row) - (f)->output_data.x->internal_border_width) \
855 / (f)->output_data.x->line_height)
856 #define PIXEL_TO_CHAR_COL(f, col) \
857 (((col) - (f)->output_data.x->internal_border_width) \
858 / FONT_WIDTH ((f)->output_data.x->font))
860 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
861 frame F? */
862 #define PIXEL_TO_CHAR_WIDTH(f, width) \
863 (PIXEL_TO_CHAR_COL (f, ((width) \
864 - (f)->output_data.x->internal_border_width \
865 - (f)->output_data.x->flags_areas_extra \
866 - (f)->output_data.x->vertical_scroll_bar_extra)))
867 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
868 (PIXEL_TO_CHAR_ROW (f, ((height) \
869 - (f)->output_data.x->internal_border_width)))
872 /* If a struct input_event has a kind which is selection_request_event
873 or selection_clear_event, then its contents are really described
874 by this structure. */
876 /* For an event of kind selection_request_event,
877 this structure really describes the contents.
878 **Don't make this struct longer!**
879 If it overlaps the frame_or_window field of struct input_event,
880 that will cause GC to crash. */
881 struct selection_input_event
883 int kind;
884 Display *display;
885 /* We spell it with an "o" here because X does. */
886 Window requestor;
887 Atom selection, target, property;
888 Time time;
891 #define SELECTION_EVENT_DISPLAY(eventp) \
892 (((struct selection_input_event *) (eventp))->display)
893 /* We spell it with an "o" here because X does. */
894 #define SELECTION_EVENT_REQUESTOR(eventp) \
895 (((struct selection_input_event *) (eventp))->requestor)
896 #define SELECTION_EVENT_SELECTION(eventp) \
897 (((struct selection_input_event *) (eventp))->selection)
898 #define SELECTION_EVENT_TARGET(eventp) \
899 (((struct selection_input_event *) (eventp))->target)
900 #define SELECTION_EVENT_PROPERTY(eventp) \
901 (((struct selection_input_event *) (eventp))->property)
902 #define SELECTION_EVENT_TIME(eventp) \
903 (((struct selection_input_event *) (eventp))->time)
906 struct window;
907 struct glyph_matrix;
908 struct frame;
909 struct input_event;
910 struct face;
911 struct image;
913 /* From xselect.c. */
915 void x_handle_selection_notify P_ ((XSelectionEvent *));
916 void x_handle_property_notify P_ ((XPropertyEvent *));
918 /* From xfns.c. */
920 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
921 Lisp_Object, Lisp_Object,
922 Lisp_Object, Lisp_Object));
923 struct frame *check_x_frame P_ ((Lisp_Object));
924 EXFUN (Fx_display_color_p, 1);
925 EXFUN (Fx_display_grayscale_p, 1);
926 int image_ascent P_ ((struct image *, struct face *));
927 extern void x_free_gcs P_ ((struct frame *));
929 /* From xrdb.c. */
931 char *x_get_string_resource P_ ((XrmDatabase, char *, char *));
932 char *x_get_customization_string P_ ((XrmDatabase, char *, char *));
933 XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
934 int x_get_resource P_ ((XrmDatabase, char *, char *,
935 XrmRepresentation, XrmValue *));
936 void x_delete_display P_ ((struct x_display_info *));
937 void x_make_frame_visible P_ ((struct frame *));
938 void x_iconify_frame P_ ((struct frame *));
939 void x_wm_set_size_hint P_ ((struct frame *, long, int));
940 void x_set_offset P_ ((struct frame *, int, int, int));
941 void x_wm_set_icon_position P_ ((struct frame *, int, int));
942 int x_catch_errors P_ ((Display *));
943 int x_had_errors_p P_ ((Display *));
944 void x_uncatch_errors P_ ((Display *, int));
945 void x_check_errors P_ ((Display *, char *));
946 int x_text_icon P_ ((struct frame *, char *));
947 int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
948 void x_set_window_size P_ ((struct frame *, int, int, int));
949 void x_wm_set_window_state P_ ((struct frame *, int));
950 int x_alloc_nearest_color P_ ((struct frame *, Colormap, XColor *));
952 extern void pixel_to_glyph_coords P_ ((struct frame *, int, int,
953 int *, int *, XRectangle *, int));
955 /* Defined in xterm.c */
957 extern void clear_mouse_face P_ ((struct x_display_info *));
958 extern void cancel_mouse_face P_ ((struct frame *));
959 extern void x_scroll_bar_clear P_ ((struct frame *));
960 extern void x_start_queuing_selection_requests P_ ((Display *));
961 extern void x_stop_queuing_selection_requests P_ ((Display *));
962 extern void x_update_cursor P_ ((struct frame *, int));
963 extern int x_text_icon P_ ((struct frame *, char *));
964 extern int x_bitmap_icon P_ ((struct frame *, Lisp_Object));
965 extern int x_catch_errors P_ ((Display *));
966 extern void x_check_errors P_ ((Display *, char *));
967 extern int x_had_errors_p P_ ((Display *));
968 extern void x_uncatch_errors P_ ((Display *, int));
969 extern Lisp_Object x_new_font P_ ((struct frame *, char *));
970 extern Lisp_Object x_new_fontset P_ ((struct frame *, char *));
971 extern void x_set_offset P_ ((struct frame *, int, int, int));
972 extern void x_set_window_size P_ ((struct frame *, int, int, int));
973 extern void x_set_mouse_position P_ ((struct frame *, int, int));
974 extern void x_set_mouse_pixel_position P_ ((struct frame *, int, int));
975 extern void x_raise_frame P_ ((struct frame *));
976 extern void x_lower_frame P_ ((struct frame *));
977 extern void x_make_frame_visible P_ ((struct frame *));
978 extern void x_make_frame_invisible P_ ((struct frame *));
979 extern void x_iconify_frame P_ ((struct frame *));
980 extern void x_free_frame_resources P_ ((struct frame *));
981 extern void x_destroy_window P_ ((struct frame *));
982 extern void x_wm_set_size_hint P_ ((struct frame *, long, int));
983 extern void x_wm_set_window_state P_ ((struct frame *, int));
984 extern void x_wm_set_icon_pixmap P_ ((struct frame *, int));
985 extern void x_wm_set_icon_position P_ ((struct frame *, int, int));
986 extern void x_delete_display P_ ((struct x_display_info *));
987 extern void x_initialize P_ ((void));
988 extern void x_display_cursor P_ ((struct window *, int, int, int, int, int));
989 extern void x_update_cursor P_ ((struct frame *, int));
990 extern unsigned long x_copy_color P_ ((struct frame *, unsigned long));
991 #ifdef USE_X_TOOLKIT
992 extern XtAppContext Xt_app_con;
993 #endif
994 extern void x_query_colors P_ ((struct frame *f, XColor *, int));
995 extern void x_query_color P_ ((struct frame *f, XColor *));
997 /* Defined in xselect.c */
999 extern void x_handle_property_notify P_ ((XPropertyEvent *));
1000 extern void x_handle_selection_notify P_ ((XSelectionEvent *));
1001 extern void x_handle_selection_request P_ ((struct input_event *));
1002 extern void x_handle_selection_clear P_ ((struct input_event *));
1003 extern void x_clear_frame_selections P_ ((struct frame *));
1005 /* Defined in xfns.c */
1007 extern int have_menus_p P_ ((void));
1008 extern int x_bitmap_height P_ ((struct frame *, int));
1009 extern int x_bitmap_width P_ ((struct frame *, int));
1010 extern int x_bitmap_pixmap P_ ((struct frame *, int));
1011 extern void x_reference_bitmap P_ ((struct frame *, int));
1012 extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
1013 unsigned int, unsigned int));
1014 extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
1015 extern void x_destroy_bitmap P_ ((struct frame *, int));
1016 extern void x_set_frame_parameters P_ ((struct frame *, Lisp_Object));
1017 extern void x_real_positions P_ ((struct frame *, int *, int *));
1018 extern void x_report_frame_params P_ ((struct frame *, Lisp_Object *));
1019 extern int defined_color P_ ((struct frame *, char *, XColor *, int));
1020 extern void x_set_border_pixel P_ ((struct frame *, int));
1021 extern void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1022 extern unsigned char * x_encode_text P_ ((Lisp_Object, Lisp_Object,
1023 int *, int *));
1024 extern void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
1025 extern void create_frame_xic P_ ((struct frame *));
1026 extern void destroy_frame_xic P_ ((struct frame *));
1027 extern void xic_set_preeditarea P_ ((struct window *, int, int));
1028 extern void xic_set_statusarea P_ ((struct frame *));
1029 extern void xic_set_xfontset P_ ((struct frame *, char *));
1030 extern int x_pixel_width P_ ((struct frame *));
1031 extern int x_pixel_height P_ ((struct frame *));
1032 extern int x_char_width P_ ((struct frame *));
1033 extern int x_char_height P_ ((struct frame *));
1034 extern int x_screen_planes P_ ((struct frame *));
1035 extern void x_sync P_ ((struct frame *));
1036 extern enum text_cursor_kinds x_specified_cursor_type P_ ((Lisp_Object, int *));
1037 extern int x_defined_color P_ ((struct frame *, char *, XColor *, int));
1038 #ifdef HAVE_X_I18N
1039 extern void free_frame_xic P_ ((struct frame *));
1040 #endif
1041 extern void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
1043 /* Defined in xfaces.c */
1045 extern int frame_update_line_height P_ ((struct frame *));
1046 extern int compute_glyph_face P_ ((struct frame *, int, int));
1047 extern int compute_glyph_face_1 P_ ((struct frame *, Lisp_Object, int));
1049 /* Defined in xmenu.c */
1051 extern void x_activate_menubar P_ ((struct frame *));
1052 extern int popup_activated P_ ((void));
1053 extern void initialize_frame_menubar P_ ((struct frame *));
1055 /* Defined in widget.c */
1057 #ifdef USE_X_TOOLKIT
1058 extern void widget_store_internal_border P_ ((Widget));
1059 #endif