]> code.delx.au - gnu-emacs/blob - src/xterm.h
(Fnext_property_change): Fix previous change.
[gnu-emacs] / src / xterm.h
1 /* Definitions and headers for communication with X protocol.
2 Copyright (C) 1989, 1993, 1994 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20 #include <X11/Xlib.h>
21 #include <X11/cursorfont.h>
22 #include <X11/Xutil.h>
23 #include <X11/keysym.h>
24 #include <X11/Xatom.h>
25 #include <X11/Xresource.h>
26
27 #ifdef USE_X_TOOLKIT
28 #include <X11/StringDefs.h>
29 #include <X11/IntrinsicP.h> /* CoreP.h needs this */
30 #include <X11/CoreP.h> /* foul, but we need this to use our own
31 window inside a widget instead of one
32 that Xt creates... */
33 #include <X11/StringDefs.h>
34 #endif
35
36 /* The class of this X application. */
37 #define EMACS_CLASS "Emacs"
38 \f
39 /* Bookkeeping to distinguish X versions. */
40
41 /* HAVE_X11R4 is defined if we have the features of X11R4. It should
42 be defined when we're using X11R5, since X11R5 has the features of
43 X11R4. If, in the future, we find we need more of these flags
44 (HAVE_X11R5, for example), code should always be written to test
45 the most recent flag first:
46
47 #ifdef HAVE_X11R5
48 ...
49 #elif HAVE_X11R4
50 ...
51 #elif HAVE_X11
52 ...
53 #endif
54
55 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
56 looks a lot like another one, consider moving the text into a macro
57 whose definition is configuration-dependent, but whose usage is
58 universal - like the stuff in systime.h.
59
60 It turns out that we can auto-detect whether we're being compiled
61 with X11R3 or X11R4 by looking for the flag macros for R4 structure
62 members that R3 doesn't have. */
63 #ifdef PBaseSize
64 /* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
65 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
66 XSetWMIconName.
67 AIX 3.2 is at least X11R4. */
68 #if (!defined AIX) || (defined AIX3_2)
69 #define HAVE_X11R4
70 #endif
71 #endif
72
73 #ifdef XlibSpecificationRelease
74 #if XlibSpecificationRelease >= 5
75 #define 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 #endif
81 \f
82 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
83 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
84 #define WHITE_PIX_DEFAULT(f) WhitePixel (FRAME_X_DISPLAY (f), \
85 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))
86
87 #define FONT_WIDTH(f) ((f)->max_bounds.width)
88 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
89 #define FONT_BASE(f) ((f)->ascent)
90
91 #define CHECK_X_FRAME(f, frame) \
92 if (NILP (frame)) \
93 f = selected_frame; \
94 else \
95 { \
96 CHECK_LIVE_FRAME (frame, 0); \
97 f = XFRAME (frame); \
98 } \
99 if (! FRAME_X_P (f))
100
101
102
103 /* The mask of events that text windows always want to receive. This
104 does not include mouse movement events. It is used when the window
105 is created (in x_window) and and in selection processing.
106
107 We do include ButtonReleases in this set because Emacs isn't always
108 fast enough to catch them when it wants them, and they're rare
109 enough that they don't use much processor time. */
110
111 #define STANDARD_EVENT_SET \
112 (KeyPressMask \
113 | ExposureMask \
114 | ButtonPressMask \
115 | ButtonReleaseMask \
116 | PointerMotionMask \
117 | PointerMotionHintMask \
118 | StructureNotifyMask \
119 | FocusChangeMask \
120 | LeaveWindowMask \
121 | EnterWindowMask \
122 | VisibilityChangeMask)
123
124 /* This checks to make sure we have a display. */
125 extern void check_x ();
126
127 extern struct frame *x_window_to_frame ();
128
129 #ifdef USE_X_TOOLKIT
130 extern struct frame *x_any_window_to_frame ();
131 extern struct frame *x_top_window_to_frame ();
132 #endif
133
134 /* The frame (if any) which has the X window that has keyboard focus.
135 Zero if none. This is examined by Ffocus_frame in xfns.c */
136
137 extern struct frame *x_focus_frame;
138
139 extern Visual *select_visual ();
140
141 enum text_cursor_kinds {
142 filled_box_cursor, hollow_box_cursor, bar_cursor
143 };
144
145 /* This data type is used for the font_table field
146 of struct x_display_info. */
147
148 struct font_info
149 {
150 XFontStruct *font;
151 char *name;
152 char *full_name;
153 };
154
155 /* Structure recording X pixmap and reference count.
156 If REFCOUNT is 0 then this record is free to be reused. */
157
158 struct x_bitmap_record
159 {
160 Pixmap pixmap;
161 char *file;
162 int refcount;
163 /* Record some info about this pixmap. */
164 int height, width, depth;
165 };
166 \f
167 /* For each X display, we have a structure that records
168 information about it. */
169
170 struct x_display_info
171 {
172 /* Chain of all x_display_info structures. */
173 struct x_display_info *next;
174 /* Connection number (normally a file descriptor number). */
175 int connection;
176 /* This says how to access this display in Xlib. */
177 Display *display;
178 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
179 The same cons cell also appears in x_display_name_list. */
180 Lisp_Object name_list_element;
181 /* Number of frames that are on this display. */
182 int reference_count;
183 /* The Screen this connection is connected to. */
184 Screen *screen;
185 /* The Visual being used for this display. */
186 Visual *visual;
187 /* Number of panes on this screen. */
188 int n_planes;
189 /* Dimensions of this screen. */
190 int height, width;
191 /* Mask of things that cause the mouse to be grabbed. */
192 int grabbed;
193 /* Emacs bitmap-id of the default icon bitmap for this frame.
194 Or -1 if none has been allocated yet. */
195 int icon_bitmap_id;
196 /* The root window of this screen. */
197 Window root_window;
198 /* The cursor to use for vertical scroll bars. */
199 Cursor vertical_scroll_bar_cursor;
200 /* X Resource data base */
201 XrmDatabase xrdb;
202
203 /* A table of all the fonts we have already loaded. */
204 struct font_info *font_table;
205
206 /* The current capacity of x_font_table. */
207 int font_table_size;
208
209 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
210 GC scratch_cursor_gc;
211
212 /* These variables describe the range of text currently shown
213 in its mouse-face, together with the window they apply to.
214 As long as the mouse stays within this range, we need not
215 redraw anything on its account. */
216 int mouse_face_beg_row, mouse_face_beg_col;
217 int mouse_face_end_row, mouse_face_end_col;
218 int mouse_face_past_end;
219 Lisp_Object mouse_face_window;
220 int mouse_face_face_id;
221
222 /* 1 if a mouse motion event came and we didn't handle it right away because
223 gc was in progress. */
224 int mouse_face_deferred_gc;
225
226 /* FRAME and X, Y position of mouse when last checked for
227 highlighting. X and Y can be negative or out of range for the frame. */
228 struct frame *mouse_face_mouse_frame;
229 int mouse_face_mouse_x, mouse_face_mouse_y;
230
231 /* Nonzero means defer mouse-motion highlighting. */
232 int mouse_face_defer;
233
234 char *x_id_name;
235
236 /* The number of fonts actually stored in x_font_table.
237 font_table[n] is used and valid iff 0 <= n < n_fonts.
238 0 <= n_fonts <= font_table_size. */
239 int n_fonts;
240
241 /* Pointer to bitmap records. */
242 struct x_bitmap_record *bitmaps;
243
244 /* Allocated size of bitmaps field. */
245 int bitmaps_size;
246
247 /* Last used bitmap index. */
248 int bitmaps_last;
249
250 /* Which modifier keys are on which modifier bits?
251
252 With each keystroke, X returns eight bits indicating which modifier
253 keys were held down when the key was pressed. The interpretation
254 of the top five modifier bits depends on what keys are attached
255 to them. If the Meta_L and Meta_R keysyms are on mod5, then mod5
256 is the meta bit.
257
258 meta_mod_mask is a mask containing the bits used for the meta key.
259 It may have more than one bit set, if more than one modifier bit
260 has meta keys on it. Basically, if EVENT is a KeyPress event,
261 the meta key is pressed if (EVENT.state & meta_mod_mask) != 0.
262
263 shift_lock_mask is LockMask if the XK_Shift_Lock keysym is on the
264 lock modifier bit, or zero otherwise. Non-alphabetic keys should
265 only be affected by the lock modifier bit if XK_Shift_Lock is in
266 use; XK_Caps_Lock should only affect alphabetic keys. With this
267 arrangement, the lock modifier should shift the character if
268 (EVENT.state & shift_lock_mask) != 0. */
269 int meta_mod_mask, shift_lock_mask;
270
271 /* These are like meta_mod_mask, but for different modifiers. */
272 int alt_mod_mask, super_mod_mask, hyper_mod_mask;
273
274 /* Communication with window managers. */
275 Atom Xatom_wm_protocols;
276 /* Kinds of protocol things we may receive. */
277 Atom Xatom_wm_take_focus;
278 Atom Xatom_wm_save_yourself;
279 Atom Xatom_wm_delete_window;
280 /* Atom for indicating window state to the window manager. */
281 Atom Xatom_wm_change_state;
282 /* Other WM communication */
283 Atom Xatom_wm_configure_denied; /* When our config request is denied */
284 Atom Xatom_wm_window_moved; /* When the WM moves us. */
285 /* EditRes protocol */
286 Atom Xatom_editres;
287
288 /* More atoms, which are selection types. */
289 Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
290 Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
291 Xatom_ATOM_PAIR;
292 #ifdef MULTI_KBOARD
293 KBOARD *kboard;
294 #endif
295 };
296
297 /* This is a chain of structures for all the X displays currently in use. */
298 extern struct x_display_info *x_display_list;
299
300 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
301 one for each element of x_display_list and in the same order.
302 NAME is the name of the frame.
303 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
304 extern Lisp_Object x_display_name_list;
305
306 extern struct x_display_info *x_display_info_for_display ();
307 extern struct x_display_info *x_display_info_for_name ();
308
309 extern struct x_display_info *x_term_init ();
310 \f
311 /* Each X frame object points to its own struct x_display object
312 in the display.x field. The x_display structure contains all
313 the information that is specific to X windows. */
314
315 struct x_display
316 {
317 /* Position of the X window (x and y offsets in root window). */
318 int left_pos;
319 int top_pos;
320
321 /* Border width of the X window as known by the X window system. */
322 int border_width;
323
324 /* Size of the X window in pixels. */
325 int pixel_height, pixel_width;
326
327 /* Height of a line, in pixels. */
328 int line_height;
329
330 /* The tiled border used when the mouse is out of the frame. */
331 Pixmap border_tile;
332
333 /* Here are the Graphics Contexts for the default font. */
334 GC normal_gc; /* Normal video */
335 GC reverse_gc; /* Reverse video */
336 GC cursor_gc; /* cursor drawing */
337
338 /* Width of the internal border. This is a line of background color
339 just inside the window's border. When the frame is selected,
340 a highlighting is displayed inside the internal border. */
341 int internal_border_width;
342
343 /* The X window used for this frame.
344 May be zero while the frame object is being created
345 and the X window has not yet been created. */
346 Window window_desc;
347
348 /* The X window used for the bitmap icon;
349 or 0 if we don't have a bitmap icon. */
350 Window icon_desc;
351
352 /* The X window that is the parent of this X window.
353 Usually this is a window that was made by the window manager,
354 but it can be the root window, and it can be explicitly specified
355 (see the explicit_parent field, below). */
356 Window parent_desc;
357
358 #ifdef USE_X_TOOLKIT
359 /* The widget of this screen. This is the window of a "shell" widget. */
360 Widget widget;
361 /* The XmPanedWindows... */
362 Widget column_widget;
363 /* The widget of the edit portion of this screen; the window in
364 "window_desc" is inside of this. */
365 Widget edit_widget;
366
367 Widget menubar_widget;
368 #endif
369
370 /* If >=0, a bitmap index. The indicated bitmap is used for the
371 icon. */
372 int icon_bitmap;
373
374 XFontStruct *font;
375
376 /* Pixel values used for various purposes.
377 border_pixel may be -1 meaning use a gray tile. */
378 unsigned long background_pixel;
379 unsigned long foreground_pixel;
380 unsigned long cursor_pixel;
381 unsigned long border_pixel;
382 unsigned long mouse_pixel;
383 unsigned long cursor_foreground_pixel;
384
385 /* Descriptor for the cursor in use for this window. */
386 Cursor text_cursor;
387 Cursor nontext_cursor;
388 Cursor modeline_cursor;
389 Cursor cross_cursor;
390
391 /* The name that was associated with the icon, the last time
392 it was refreshed. Usually the same as the name of the
393 buffer in the currently selected window in the frame */
394 char *icon_label;
395
396 /* Flag to set when the X window needs to be completely repainted. */
397 int needs_exposure;
398
399 /* What kind of text cursor is drawn in this window right now?
400 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
401 enum text_cursor_kinds current_cursor;
402
403 /* What kind of text cursor should we draw in the future?
404 This should always be filled_box_cursor or bar_cursor. */
405 enum text_cursor_kinds desired_cursor;
406
407 /* Width of bar cursor (if we are using that). */
408 int cursor_width;
409
410 /* These are the current window manager hints. It seems that
411 XSetWMHints, when presented with an unset bit in the `flags'
412 member of the hints structure, does not leave the corresponding
413 attribute unchanged; rather, it resets that attribute to its
414 default value. For example, unless you set the `icon_pixmap'
415 field and the `IconPixmapHint' bit, XSetWMHints will forget what
416 your icon pixmap was. This is rather troublesome, since some of
417 the members (for example, `input' and `icon_pixmap') want to stay
418 the same throughout the execution of Emacs. So, we keep this
419 structure around, just leaving values in it and adding new bits
420 to the mask as we go. */
421 XWMHints wm_hints;
422
423 /* The size of the extra width currently allotted for vertical
424 scroll bars, in pixels. */
425 int vertical_scroll_bar_extra;
426
427 /* Table of parameter faces for this frame. Any X resources (pixel
428 values, fonts) referred to here have been allocated explicitly
429 for this face, and should be freed if we change the face. */
430 struct face **param_faces;
431 int n_param_faces;
432
433 /* Table of computed faces for this frame. These are the faces
434 whose indexes go into the upper bits of a glyph, computed by
435 combining the parameter faces specified by overlays, text
436 properties, and what have you. The X resources mentioned here
437 are all shared with parameter faces. */
438 struct face **computed_faces;
439 int n_computed_faces; /* How many are valid */
440 int size_computed_faces; /* How many are allocated */
441
442 /* This is the gravity value for the specified window position. */
443 int win_gravity;
444
445 /* The geometry flags for this window. */
446 int size_hint_flags;
447
448 /* This is the Emacs structure for the X display this frame is on. */
449 struct x_display_info *display_info;
450
451 /* Nonzero means our parent is another application's window
452 and was explicitly specified. */
453 char explicit_parent;
454 };
455
456 /* Get at the computed faces of an X window frame. */
457 #define FRAME_PARAM_FACES(f) ((f)->display.x->param_faces)
458 #define FRAME_N_PARAM_FACES(f) ((f)->display.x->n_param_faces)
459 #define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
460 #define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
461
462 #define FRAME_COMPUTED_FACES(f) ((f)->display.x->computed_faces)
463 #define FRAME_N_COMPUTED_FACES(f) ((f)->display.x->n_computed_faces)
464 #define FRAME_SIZE_COMPUTED_FACES(f) ((f)->display.x->size_computed_faces)
465 #define FRAME_DEFAULT_FACE(f) ((f)->display.x->computed_faces[0])
466 #define FRAME_MODE_LINE_FACE(f) ((f)->display.x->computed_faces[1])
467
468 /* Return the window associated with the frame F. */
469 #define FRAME_X_WINDOW(f) ((f)->display.x->window_desc)
470
471 #define FRAME_FOREGROUND_PIXEL(f) ((f)->display.x->foreground_pixel)
472 #define FRAME_BACKGROUND_PIXEL(f) ((f)->display.x->background_pixel)
473 #define FRAME_FONT(f) ((f)->display.x->font)
474
475 /* This gives the x_display_info structure for the display F is on. */
476 #define FRAME_X_DISPLAY_INFO(f) ((f)->display.x->display_info)
477
478 /* This is the `Display *' which frame F is on. */
479 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
480
481 /* This is the `Screen *' which frame F is on. */
482 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
483
484 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
485 #define PIXEL_WIDTH(f) ((f)->display.x->pixel_width)
486 #define PIXEL_HEIGHT(f) ((f)->display.x->pixel_height)
487
488 #define FRAME_DESIRED_CURSOR(f) ((f)->display.x->desired_cursor)
489
490 \f
491 /* X-specific scroll bar stuff. */
492
493 /* We represent scroll bars as lisp vectors. This allows us to place
494 references to them in windows without worrying about whether we'll
495 end up with windows referring to dead scroll bars; the garbage
496 collector will free it when its time comes.
497
498 We use struct scroll_bar as a template for accessing fields of the
499 vector. */
500
501 struct scroll_bar {
502
503 /* These fields are shared by all vectors. */
504 EMACS_INT size_from_Lisp_Vector_struct;
505 struct Lisp_Vector *next_from_Lisp_Vector_struct;
506
507 /* The window we're a scroll bar for. */
508 Lisp_Object window;
509
510 /* The next and previous in the chain of scroll bars in this frame. */
511 Lisp_Object next, prev;
512
513 /* The X window representing this scroll bar. Since this is a full
514 32-bit quantity, we store it split into two 32-bit values. */
515 Lisp_Object x_window_low, x_window_high;
516
517 /* The position and size of the scroll bar in pixels, relative to the
518 frame. */
519 Lisp_Object top, left, width, height;
520
521 /* The starting and ending positions of the handle, relative to the
522 handle area (i.e. zero is the top position, not
523 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
524 hasn't been drawn yet.
525
526 These are not actually the locations where the beginning and end
527 are drawn; in order to keep handles from becoming invisible when
528 editing large files, we establish a minimum height by always
529 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
530 where they would be normally; the bottom and top are in a
531 different co-ordinate system. */
532 Lisp_Object start, end;
533
534 /* If the scroll bar handle is currently being dragged by the user,
535 this is the number of pixels from the top of the handle to the
536 place where the user grabbed it. If the handle isn't currently
537 being dragged, this is Qnil. */
538 Lisp_Object dragging;
539 };
540
541 /* The number of elements a vector holding a struct scroll_bar needs. */
542 #define SCROLL_BAR_VEC_SIZE \
543 ((sizeof (struct scroll_bar) \
544 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
545 / sizeof (Lisp_Object))
546
547 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
548 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
549
550
551 /* Building a 32-bit C integer from two 16-bit lisp integers. */
552 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
553
554 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
555 #define SCROLL_BAR_UNPACK(low, high, int32) \
556 (XSETINT ((low), (int32) & 0xffff), \
557 XSETINT ((high), ((int32) >> 16) & 0xffff))
558
559
560 /* Extract the X window id of the scroll bar from a struct scroll_bar. */
561 #define SCROLL_BAR_X_WINDOW(ptr) \
562 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
563
564 /* Store a window id in a struct scroll_bar. */
565 #define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
566 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
567
568
569 /* Return the outside pixel height for a vertical scroll bar HEIGHT
570 rows high on frame F. */
571 #define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
572 ((height) * (f)->display.x->line_height)
573
574 /* Return the inside width of a vertical scroll bar, given the outside
575 width. */
576 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
577 ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
578
579 /* Return the length of the rectangle within which the top of the
580 handle must stay. This isn't equivalent to the inside height,
581 because the scroll bar handle has a minimum height.
582
583 This is the real range of motion for the scroll bar, so when we're
584 scaling buffer positions to scroll bar positions, we use this, not
585 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
586 #define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
587 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
588
589 /* Return the inside height of vertical scroll bar, given the outside
590 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
591 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
592 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
593
594
595 /* Border widths for scroll bars.
596
597 Scroll bar windows don't have any X borders; their border width is
598 set to zero, and we redraw borders ourselves. This makes the code
599 a bit cleaner, since we don't have to convert between outside width
600 (used when relating to the rest of the screen) and inside width
601 (used when sizing and drawing the scroll bar window itself).
602
603 The handle moves up and down/back and forth in a rectangle inset
604 from the edges of the scroll bar. These are widths by which we
605 inset the handle boundaries from the scroll bar edges. */
606 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
607 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
608 #define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
609 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
610
611 /* Minimum lengths for scroll bar handles, in pixels. */
612 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
613
614 \f
615 /* Manipulating pixel sizes and character sizes.
616 Knowledge of which factors affect the overall size of the window should
617 be hidden in these macros, if that's possible.
618
619 Return the upper/left pixel position of the character cell on frame F
620 at ROW/COL. */
621 #define CHAR_TO_PIXEL_ROW(f, row) \
622 ((f)->display.x->internal_border_width \
623 + (row) * (f)->display.x->line_height)
624 #define CHAR_TO_PIXEL_COL(f, col) \
625 ((f)->display.x->internal_border_width \
626 + (col) * FONT_WIDTH ((f)->display.x->font))
627
628 /* Return the pixel width/height of frame F if it has
629 WIDTH columns/HEIGHT rows. */
630 #define CHAR_TO_PIXEL_WIDTH(f, width) \
631 (CHAR_TO_PIXEL_COL (f, width) \
632 + (f)->display.x->vertical_scroll_bar_extra \
633 + (f)->display.x->internal_border_width)
634 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
635 (CHAR_TO_PIXEL_ROW (f, height) \
636 + (f)->display.x->internal_border_width)
637
638
639 /* Return the row/column (zero-based) of the character cell containing
640 the pixel on FRAME at ROW/COL. */
641 #define PIXEL_TO_CHAR_ROW(f, row) \
642 (((row) - (f)->display.x->internal_border_width) \
643 / (f)->display.x->line_height)
644 #define PIXEL_TO_CHAR_COL(f, col) \
645 (((col) - (f)->display.x->internal_border_width) \
646 / FONT_WIDTH ((f)->display.x->font))
647
648 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
649 frame F? */
650 #define PIXEL_TO_CHAR_WIDTH(f, width) \
651 (PIXEL_TO_CHAR_COL (f, ((width) \
652 - (f)->display.x->internal_border_width \
653 - (f)->display.x->vertical_scroll_bar_extra)))
654 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
655 (PIXEL_TO_CHAR_ROW (f, ((height) \
656 - (f)->display.x->internal_border_width)))
657 \f
658 /* If a struct input_event has a kind which is selection_request_event
659 or selection_clear_event, then its contents are really described
660 by this structure. */
661
662 /* For an event of kind selection_request_event,
663 this structure really describes the contents. */
664 struct selection_input_event
665 {
666 int kind;
667 Display *display;
668 Window requestor;
669 Atom selection, target, property;
670 Time time;
671 };
672
673 #define SELECTION_EVENT_DISPLAY(eventp) \
674 (((struct selection_input_event *) (eventp))->display)
675 #define SELECTION_EVENT_REQUESTOR(eventp) \
676 (((struct selection_input_event *) (eventp))->requestor)
677 #define SELECTION_EVENT_SELECTION(eventp) \
678 (((struct selection_input_event *) (eventp))->selection)
679 #define SELECTION_EVENT_TARGET(eventp) \
680 (((struct selection_input_event *) (eventp))->target)
681 #define SELECTION_EVENT_PROPERTY(eventp) \
682 (((struct selection_input_event *) (eventp))->property)
683 #define SELECTION_EVENT_TIME(eventp) \
684 (((struct selection_input_event *) (eventp))->time)
685
686 \f
687 /* Interface to the face code functions. */
688
689 /* Create the first two computed faces for a frame -- the ones that
690 have GC's. */
691 extern void init_frame_faces (/* FRAME_PTR */);
692
693 /* Free the resources for the faces associated with a frame. */
694 extern void free_frame_faces (/* FRAME_PTR */);
695
696 /* Given a computed face, find or make an equivalent display face
697 in face_vector, and return a pointer to it. */
698 extern struct face *intern_face (/* FRAME_PTR, struct face * */);
699
700 /* Given a frame and a face name, return the face's ID number, or
701 zero if it isn't a recognized face name. */
702 extern int face_name_id_number (/* FRAME_PTR, Lisp_Object */);
703
704 /* Return non-zero if FONT1 and FONT2 have the same size bounding box.
705 We assume that they're both character-cell fonts. */
706 extern int same_size_fonts (/* XFontStruct *, XFontStruct * */);
707
708 /* Recompute the GC's for the default and modeline faces.
709 We call this after changing frame parameters on which those GC's
710 depend. */
711 extern void recompute_basic_faces (/* FRAME_PTR */);
712
713 /* Return the face ID associated with a buffer position POS. Store
714 into *ENDPTR the next position at which a different face is
715 needed. This does not take account of glyphs that specify their
716 own face codes. F is the frame in use for display, and W is a
717 window displaying the current buffer.
718
719 REGION_BEG, REGION_END delimit the region, so it can be highlighted. */
720 extern int compute_char_face (/* FRAME_PTR frame,
721 struct window *w,
722 int pos,
723 int region_beg, int region_end,
724 int *endptr */);
725 /* Return the face ID to use to display a special glyph which selects
726 FACE_CODE as the face ID, assuming that ordinarily the face would
727 be BASIC_FACE. F is the frame. */
728 extern int compute_glyph_face (/* FRAME_PTR, int */);