(x_wm_set_size_hint): Always set PWinGravity.
[bpt/emacs.git] / src / xterm.h
CommitLineData
3f930d20 1/* Definitions and headers for communication with X protocol.
4e027793 2 Copyright (C) 1989, 1993 Free Software Foundation, Inc.
3f930d20
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
4e027793 8the Free Software Foundation; either version 2, or (at your option)
3f930d20
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20#ifdef HAVE_X11
21#include <X11/Xlib.h>
22#include <X11/cursorfont.h>
23#include <X11/Xutil.h>
24#include <X11/keysym.h>
25#include <X11/Xatom.h>
26#include <X11/Xresource.h>
27#else
28#include <X/Xlib.h>
29#endif /* HAVE_X11 */
30
0be31d57
RS
31#ifdef USE_X_TOOLKIT
32#include <X11/StringDefs.h>
33#include <X11/IntrinsicP.h> /* CoreP.h needs this */
34#include <X11/CoreP.h> /* foul, but we need this to use our own
35 window inside a widget instead of one
36 that Xt creates... */
37#include <X11/StringDefs.h>
0be31d57
RS
38#endif
39
3f930d20
JB
40/* Define a queue for X-events. One such queue is used for mouse clicks.
41 Another is used for expose events. */
42
43#define EVENT_BUFFER_SIZE 64
44
3f930d20
JB
45/* Max and Min sizes in character columns. */
46#define MINWIDTH 10
47#define MINHEIGHT 10
48#define MAXWIDTH 300
49#define MAXHEIGHT 80
50
51#ifdef HAVE_X11
ef15f270 52
d2729198
JB
53/* HAVE_X11R4 is defined if we have the features of X11R4. It should
54 be defined when we're using X11R5, since X11R5 has the features of
55 X11R4. If, in the future, we find we need more of these flags
56 (HAVE_X11R5, for example), code should always be written to test
57 the most recent flag first:
58
59 #ifdef HAVE_X11R5
60 ...
61 #elif HAVE_X11R4
62 ...
63 #elif HAVE_X11
64 ...
65 #endif
66
67 If you ever find yourself writing a "#ifdef HAVE_FOO" clause that
68 looks a lot like another one, consider moving the text into a macro
69 whose definition is configuration-dependent, but whose usage is
70 universal - like the stuff in systime.h.
71
72 It turns out that we can auto-detect whether we're being compiled
ef15f270
JB
73 with X11R3 or X11R4 by looking for the flag macros for R4 structure
74 members that R3 doesn't have. */
75#ifdef PBaseSize
3fe53836
RS
76/* AIX 3.1's X is somewhere between X11R3 and X11R4. It has
77 PBaseSize, but not XWithdrawWindow, XSetWMName, XSetWMNormalHints,
48508a3a
FP
78 XSetWMIconName.
79 AIX 3.2 is at least X11R4. */
80#if (!defined AIX) || (defined AIX3_2)
ef15f270
JB
81#define HAVE_X11R4
82#endif
3fe53836 83#endif
ef15f270 84
6bde6341
JB
85#ifdef XlibSpecificationRelease
86#if XlibSpecificationRelease >= 5
87#define HAVE_X11R5
673fea7a
RS
88/* In case someone has X11R5 on AIX 3.1,
89 make sure HAVE_X11R4 is defined as well as HAVE_X11R5. */
90#define HAVE_X11R4
6bde6341
JB
91#endif
92#endif
93
3f930d20
JB
94#define PIX_TYPE unsigned long
95#define XDISPLAY x_current_display,
96#define XFlushQueue() XFlush(x_current_display)
97#define BLACK_PIX_DEFAULT BlackPixel (x_current_display, \
98 XDefaultScreen (x_current_display))
99#define WHITE_PIX_DEFAULT WhitePixel (x_current_display, \
100 XDefaultScreen (x_current_display))
101#define DISPLAY_SCREEN_ARG x_current_display, \
102 XDefaultScreen (x_current_display)
103#define DISPLAY_CELLS DisplayCells (x_current_display, XDefaultScreen (x_current_display))
bbe42033 104#define ROOT_WINDOW RootWindow (x_current_display, DefaultScreen (x_current_display))
3f930d20
JB
105#define FONT_TYPE XFontStruct
106#define Color XColor
107
108#define XExposeRegionEvent XExposeEvent
546714cf
KH
109#define Bitmap Pixmap /* In X11, Bitmaps are a kind of
110 Pixmap. */
3f930d20
JB
111#define WINDOWINFO_TYPE XWindowAttributes
112#define XGetWindowInfo(w, i) XGetWindowAttributes (x_current_display, \
113 (w), (i))
114#define XGetFont(f) XLoadQueryFont (x_current_display, (f))
115#define XLoseFont(f) XFreeFont (x_current_display, (f))
116#define XStuffPending() XPending (x_current_display)
117#define XClear(w) XClearWindow (x_current_display, (w))
118#define XWarpMousePointer(w,x,y) XWarpPointer (x_current_display, None, w, \
119 0,0,0,0, x, y)
120#define XHandleError XSetErrorHandler
121#define XHandleIOError XSetIOErrorHandler
122
123#define XChangeWindowSize(w,x,y) XResizeWindow(x_current_display,w,x,y)
124
125#define FONT_WIDTH(f) ((f)->max_bounds.width)
126#define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
127#define FONT_BASE(f) ((f)->ascent)
128
3f930d20 129/* The mask of events that text windows always want to receive. This
8828b393
JB
130 does not include mouse movement events. It is used when the window
131 is created (in x_window) and when we ask/unask for mouse movement
132 events (in XTmouse_tracking_enable).
133
134 We do include ButtonReleases in this set because elisp isn't always
135 fast enough to catch them when it wants them, and they're rare
136 enough that they don't use much processor time. */
3f930d20
JB
137
138#define STANDARD_EVENT_SET \
139 (KeyPressMask \
140 | ExposureMask \
141 | ButtonPressMask \
8828b393
JB
142 | ButtonReleaseMask \
143 | PointerMotionMask \
144 | PointerMotionHintMask \
3f930d20
JB
145 | StructureNotifyMask \
146 | FocusChangeMask \
147 | LeaveWindowMask \
148 | EnterWindowMask \
149 | VisibilityChangeMask)
150
151#else /* X10 */
152
153#define ConnectionNumber(dpy) dpyno()
154#define PIX_TYPE int
155#define XDISPLAY
156#define XFlushQueue() XFlush()
157#define BLACK_PIX_DEFAULT BlackPixel
158#define WHITE_PIX_DEFAULT WhitePixel
159#define DISPLAY_SCREEN_ARG
160#define DISPLAY_CELLS DisplayCells ()
161#define ROOT_WINDOW RootWindow
162#define XFree free
163#define FONT_TYPE FontInfo
164
165#define WINDOWINFO_TYPE WindowInfo
166#define XGetWindowInfo(w, i) XQueryWindow ((w), (i))
167#define XGetFont(f) XOpenFont ((f))
168#define XLoseFont(f) XCloseFont ((f))
169#define XStuffPending() XPending ()
170#define XWarpMousePointer(w,x,y) XWarpMouse (w,x,y)
171#define XHandleError XErrorHandler
172#define XHandleIOError XIOErrorHandler
173
174#define FONT_WIDTH(f) ((f)->width)
175#define FONT_HEIGHT(f) ((f)->height)
176#define FONT_BASE(f) ((f)->base)
177
178#define XChangeWindowSize(w,x,y) XChangeWindow(w,x,y)
179
180#endif /* X10 */
181
182struct event_queue
183 {
184 int rindex; /* Index at which to fetch next. */
185 int windex; /* Index at which to store next. */
186 XEvent xrep[EVENT_BUFFER_SIZE];
187 };
188
189/* Queue for mouse clicks. */
190extern struct event_queue x_mouse_queue;
191
3f930d20
JB
192/* This is the X connection that we are using. */
193
194extern Display *x_current_display;
195
3868b9ec
KH
196/* This checks to make sure we have a display. */
197extern void check_x ();
198
f676886a 199extern struct frame *x_window_to_frame ();
3f930d20 200
0be31d57
RS
201#ifdef USE_X_TOOLKIT
202extern struct frame *x_any_window_to_frame ();
090cebb5 203extern struct frame *x_top_window_to_frame ();
0be31d57
RS
204#endif
205
f676886a
JB
206/* The frame (if any) which has the X window that has keyboard focus.
207 Zero if none. This is examined by Ffocus_frame in xfns.c */
3f930d20 208
f802f8e0 209extern struct frame *x_focus_frame;
3f930d20
JB
210
211#ifdef HAVE_X11
212/* Variables associated with the X display screen this emacs is using. */
213
214/* How many screens this X display has. */
259c5af9 215extern int x_screen_count;
3f930d20
JB
216
217/* The vendor supporting this X server. */
218extern Lisp_Object Vx_vendor;
219
220/* The vendor's release number for this X server. */
259c5af9 221extern int x_release;
3f930d20
JB
222
223/* Height of this X screen in pixels. */
259c5af9 224extern int x_screen_height;
3f930d20
JB
225
226/* Height of this X screen in millimeters. */
259c5af9 227extern int x_screen_height_mm;
3f930d20
JB
228
229/* Width of this X screen in pixels. */
259c5af9 230extern int x_screen_width;
3f930d20
JB
231
232/* Width of this X screen in millimeters. */
259c5af9 233extern int x_screen_width_mm;
3f930d20
JB
234
235/* Does this X screen do backing store? */
236extern Lisp_Object Vx_backing_store;
237
238/* Does this X screen do save-unders? */
259c5af9 239extern int x_save_under;
3f930d20
JB
240
241/* Number of planes for this screen. */
259c5af9 242extern int x_screen_planes;
3f930d20
JB
243
244/* X Visual type of this screen. */
245extern Lisp_Object Vx_screen_visual;
246
247#endif /* HAVE_X11 */
248\f
249enum text_cursor_kinds {
250 filled_box_cursor, hollow_box_cursor, bar_cursor
251};
252
f676886a 253/* Each X frame object points to its own struct x_display object
3f930d20
JB
254 in the display.x field. The x_display structure contains all
255 the information that is specific to X windows. */
256
257struct x_display
258{
259 /* Position of the X window (x and y offsets in root window). */
260 int left_pos;
261 int top_pos;
262
263 /* Border width of the X window as known by the X window system. */
264 int border_width;
265
266 /* Size of the X window in pixels. */
267 int pixel_height, pixel_width;
268
2ba6876c
RS
269 /* Height of a line, in pixels. */
270 int line_height;
271
3f930d20 272#ifdef HAVE_X11
f676886a 273 /* The tiled border used when the mouse is out of the frame. */
3f930d20
JB
274 Pixmap border_tile;
275
276 /* Here are the Graphics Contexts for the default font. */
277 GC normal_gc; /* Normal video */
278 GC reverse_gc; /* Reverse video */
279 GC cursor_gc; /* cursor drawing */
280#endif /* HAVE_X11 */
281
282 /* Width of the internal border. This is a line of background color
f676886a 283 just inside the window's border. When the frame is selected,
3f930d20
JB
284 a highlighting is displayed inside the internal border. */
285 int internal_border_width;
286
f676886a
JB
287 /* The X window used for this frame.
288 May be zero while the frame object is being created
3f930d20
JB
289 and the X window has not yet been created. */
290 Window window_desc;
291
292 /* The X window used for the bitmap icon;
293 or 0 if we don't have a bitmap icon. */
294 Window icon_desc;
295
296 /* The X window that is the parent of this X window.
297 Usually but not always RootWindow. */
298 Window parent_desc;
299
0be31d57
RS
300#ifdef USE_X_TOOLKIT
301 /* The widget of this screen. This is the window of a "shell" widget. */
302 Widget widget;
303 /* The XmPanedWindows... */
304 Widget column_widget;
305 /* The widget of the edit portion of this screen; the window in
306 "window_desc" is inside of this. */
307 Widget edit_widget;
308
309 Widget menubar_widget;
310#endif
311
3f930d20
JB
312 /* 1 for bitmap icon, 0 for text icon. */
313 int icon_bitmap_flag;
314
315 FONT_TYPE *font;
316
317 /* Pixel values used for various purposes.
318 border_pixel may be -1 meaning use a gray tile. */
319 PIX_TYPE background_pixel;
320 PIX_TYPE foreground_pixel;
321 PIX_TYPE cursor_pixel;
322 PIX_TYPE border_pixel;
323 PIX_TYPE mouse_pixel;
67710a63 324 PIX_TYPE cursor_foreground_pixel;
3f930d20 325
3f930d20
JB
326 /* Descriptor for the cursor in use for this window. */
327#ifdef HAVE_X11
328 Cursor text_cursor;
329 Cursor nontext_cursor;
330 Cursor modeline_cursor;
6bfbdaeb 331 Cursor cross_cursor;
3f930d20
JB
332#else
333 Cursor cursor;
334#endif
335
336 /* The name that was associated with the icon, the last time
337 it was refreshed. Usually the same as the name of the
f676886a 338 buffer in the currently selected window in the frame */
3f930d20
JB
339 char *icon_label;
340
341 /* Flag to set when the X window needs to be completely repainted. */
342 int needs_exposure;
343
dbc4e1c1
JB
344 /* What kind of text cursor is drawn in this window right now?
345 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
346 enum text_cursor_kinds current_cursor;
347
348 /* What kind of text cursor should we draw in the future?
349 This should always be filled_box_cursor or bar_cursor. */
350 enum text_cursor_kinds desired_cursor;
ef15f270
JB
351
352 /* These are the current window manager hints. It seems that
353 XSetWMHints, when presented with an unset bit in the `flags'
354 member of the hints structure, does not leave the corresponding
355 attribute unchanged; rather, it resets that attribute to its
356 default value. For example, unless you set the `icon_pixmap'
357 field and the `IconPixmapHint' bit, XSetWMHints will forget what
358 your icon pixmap was. This is rather troublesome, since some of
359 the members (for example, `input' and `icon_pixmap') want to stay
360 the same throughout the execution of Emacs. So, we keep this
361 structure around, just leaving values in it and adding new bits
362 to the mask as we go. */
363 XWMHints wm_hints;
c8e3cbe0 364
c8e3cbe0 365 /* The size of the extra width currently allotted for vertical
a3c87d4e
JB
366 scroll bars, in pixels. */
367 int vertical_scroll_bar_extra;
13bd51a5 368
28f72798
JB
369 /* Table of parameter faces for this frame. Any X resources (pixel
370 values, fonts) referred to here have been allocated explicitly
371 for this face, and should be freed if we change the face. */
372 struct face **param_faces;
373 int n_param_faces;
374
375 /* Table of computed faces for this frame. These are the faces
376 whose indexes go into the upper bits of a glyph, computed by
377 combining the parameter faces specified by overlays, text
378 properties, and what have you. The X resources mentioned here
379 are all shared with parameter faces. */
380 struct face **computed_faces;
381 int n_computed_faces; /* How many are valid */
382 int size_computed_faces; /* How many are allocated */
379564d6
RS
383
384 /* This is the gravity value for the specified window position. */
385 int win_gravity;
3f930d20 386};
d2729198 387
28f72798
JB
388/* Get at the computed faces of an X window frame. */
389#define FRAME_PARAM_FACES(f) ((f)->display.x->param_faces)
390#define FRAME_N_PARAM_FACES(f) ((f)->display.x->n_param_faces)
391#define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
392#define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
393
394#define FRAME_COMPUTED_FACES(f) ((f)->display.x->computed_faces)
395#define FRAME_N_COMPUTED_FACES(f) ((f)->display.x->n_computed_faces)
396#define FRAME_SIZE_COMPUTED_FACES(f) ((f)->display.x->size_computed_faces)
397#define FRAME_DEFAULT_FACE(f) ((f)->display.x->computed_faces[0])
398#define FRAME_MODE_LINE_FACE(f) ((f)->display.x->computed_faces[1])
13bd51a5 399
d2729198
JB
400/* Return the window associated with the frame F. */
401#define FRAME_X_WINDOW(f) ((f)->display.x->window_desc)
402
dbc4e1c1
JB
403/* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
404#define PIXEL_WIDTH(f) ((f)->display.x->pixel_width)
405#define PIXEL_HEIGHT(f) ((f)->display.x->pixel_height)
406
407#define FRAME_DESIRED_CURSOR(f) ((f)->display.x->desired_cursor)
408
3f930d20 409\f
13bd51a5 410/* When X windows are used, a glyph may be a 16 bit unsigned datum.
3f930d20
JB
411 The high order byte is the face number and is used as an index
412 in the face table. A face is a font plus:
413 1) the unhighlighted foreground color,
414 2) the unhighlighted background color.
415 For highlighting, the two colors are exchanged.
13bd51a5 416 Face number 0 is unused. The low order byte of a glyph gives
3f930d20
JB
417 the character within the font. All fonts are assumed to be
418 fixed width, and to have the same height and width. */
419
420#ifdef HAVE_X11
3f930d20 421
9d46c2e6 422/* Face declared in dispextern.h */
3f930d20
JB
423
424#else /* X10 */
425
426struct face
427{
428 FONT_TYPE *font; /* Font info for specified font. */
429 int fg; /* Unhighlighted foreground. */
430 int bg; /* Unhighlighted background. */
431};
432#endif /* X10 */
433
434#define MAX_FACES_AND_GLYPHS 256
435extern struct face *x_face_table[];
c8e3cbe0
JB
436
437\f
a3c87d4e 438/* X-specific scroll bar stuff. */
c8e3cbe0 439
a3c87d4e 440/* We represent scroll bars as lisp vectors. This allows us to place
4e027793 441 references to them in windows without worrying about whether we'll
a3c87d4e 442 end up with windows referring to dead scroll bars; the garbage
4e027793
JB
443 collector will free it when its time comes.
444
a3c87d4e 445 We use struct scroll_bar as a template for accessing fields of the
4e027793
JB
446 vector. */
447
a3c87d4e 448struct scroll_bar {
c8e3cbe0 449
4e027793
JB
450 /* These fields are shared by all vectors. */
451 int size_from_Lisp_Vector_struct;
452 struct Lisp_Vector *next_from_Lisp_Vector_struct;
453
a3c87d4e 454 /* The window we're a scroll bar for. */
4e027793 455 Lisp_Object window;
c8e3cbe0 456
a3c87d4e 457 /* The next and previous in the chain of scroll bars in this frame. */
4e027793 458 Lisp_Object next, prev;
c8e3cbe0 459
a3c87d4e 460 /* The X window representing this scroll bar. Since this is a full
4e027793
JB
461 32-bit quantity, we store it split into two 32-bit values. */
462 Lisp_Object x_window_low, x_window_high;
c8e3cbe0 463
a3c87d4e 464 /* The position and size of the scroll bar in pixels, relative to the
c8e3cbe0 465 frame. */
4e027793 466 Lisp_Object top, left, width, height;
c8e3cbe0 467
4e027793
JB
468 /* The starting and ending positions of the handle, relative to the
469 handle area (i.e. zero is the top position, not
a3c87d4e 470 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
4e027793 471 hasn't been drawn yet.
c8e3cbe0 472
4e027793
JB
473 These are not actually the locations where the beginning and end
474 are drawn; in order to keep handles from becoming invisible when
475 editing large files, we establish a minimum height by always
a3c87d4e 476 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
4e027793
JB
477 where they would be normally; the bottom and top are in a
478 different co-ordinate system. */
479 Lisp_Object start, end;
c8e3cbe0 480
a3c87d4e 481 /* If the scroll bar handle is currently being dragged by the user,
c8e3cbe0
JB
482 this is the number of pixels from the top of the handle to the
483 place where the user grabbed it. If the handle isn't currently
4e027793
JB
484 being dragged, this is Qnil. */
485 Lisp_Object dragging;
c8e3cbe0
JB
486};
487
a3c87d4e
JB
488/* The number of elements a vector holding a struct scroll_bar needs. */
489#define SCROLL_BAR_VEC_SIZE \
490 ((sizeof (struct scroll_bar) - sizeof (int) - sizeof (struct Lisp_Vector *)) \
4e027793
JB
491 / sizeof (Lisp_Object))
492
a3c87d4e
JB
493/* Turning a lisp vector value into a pointer to a struct scroll_bar. */
494#define XSCROLL_BAR(vec) ((struct scroll_bar *) XPNTR (vec))
4e027793
JB
495
496
497/* Building a 32-bit C integer from two 16-bit lisp integers. */
a3c87d4e 498#define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
4e027793
JB
499
500/* Setting two lisp integers to the low and high words of a 32-bit C int. */
a3c87d4e 501#define SCROLL_BAR_UNPACK(low, high, int32) \
4e027793
JB
502 (XSET ((low), Lisp_Int, (int32) & 0xffff), \
503 XSET ((high), Lisp_Int, ((int32) >> 16) & 0xffff))
504
505
a3c87d4e
JB
506/* Extract the X window id of the scroll bar from a struct scroll_bar. */
507#define SCROLL_BAR_X_WINDOW(ptr) \
508 ((Window) SCROLL_BAR_PACK ((ptr)->x_window_low, (ptr)->x_window_high))
4e027793 509
a3c87d4e
JB
510/* Store a window id in a struct scroll_bar. */
511#define SET_SCROLL_BAR_X_WINDOW(ptr, id) \
512 (SCROLL_BAR_UNPACK ((ptr)->x_window_low, (ptr)->x_window_high, (int) id))
4e027793
JB
513
514
a3c87d4e
JB
515/* Return the outside pixel width for a vertical scroll bar on frame F. */
516#define VERTICAL_SCROLL_BAR_PIXEL_WIDTH(f) (2*FONT_WIDTH ((f)->display.x->font))
c8e3cbe0 517
a3c87d4e 518/* Return the outside pixel height for a vertical scroll bar HEIGHT
c8e3cbe0 519 rows high on frame F. */
a3c87d4e 520#define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
2ba6876c 521 ((height) * (f)->display.x->line_height)
c8e3cbe0 522
a3c87d4e 523/* Return the inside width of a vertical scroll bar, given the outside
4e027793 524 width. */
a3c87d4e
JB
525#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
526 ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
c8e3cbe0 527
4e027793
JB
528/* Return the length of the rectangle within which the top of the
529 handle must stay. This isn't equivalent to the inside height,
a3c87d4e 530 because the scroll bar handle has a minimum height.
4e027793 531
a3c87d4e
JB
532 This is the real range of motion for the scroll bar, so when we're
533 scaling buffer positions to scroll bar positions, we use this, not
534 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
535#define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
536 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
4e027793 537
a3c87d4e
JB
538/* Return the inside height of vertical scroll bar, given the outside
539 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
540#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
541 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
4e027793
JB
542
543
a3c87d4e 544/* Border widths for scroll bars.
4e027793 545
a3c87d4e 546 Scroll bar windows don't have any X borders; their border width is
4e027793
JB
547 set to zero, and we redraw borders ourselves. This makes the code
548 a bit cleaner, since we don't have to convert between outside width
549 (used when relating to the rest of the screen) and inside width
a3c87d4e 550 (used when sizing and drawing the scroll bar window itself).
4e027793 551
eb8c3be9 552 The handle moves up and down/back and forth in a rectangle inset
a3c87d4e
JB
553 from the edges of the scroll bar. These are widths by which we
554 inset the handle boundaries from the scroll bar edges. */
555#define VERTICAL_SCROLL_BAR_LEFT_BORDER (2)
d68eb3a2 556#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (2)
a3c87d4e
JB
557#define VERTICAL_SCROLL_BAR_TOP_BORDER (2)
558#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (2)
4e027793 559
a3c87d4e
JB
560/* Minimum lengths for scroll bar handles, in pixels. */
561#define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
c8e3cbe0
JB
562
563\f
564/* Manipulating pixel sizes and character sizes.
565 Knowledge of which factors affect the overall size of the window should
566 be hidden in these macros, if that's possible.
567
4e027793
JB
568/* Return the upper/left pixel position of the character cell on frame F
569 at ROW/COL. */
570#define CHAR_TO_PIXEL_ROW(f, row) \
571 ((f)->display.x->internal_border_width \
2ba6876c 572 + (row) * (f)->display.x->line_height)
4e027793
JB
573#define CHAR_TO_PIXEL_COL(f, col) \
574 ((f)->display.x->internal_border_width \
575 + (col) * FONT_WIDTH ((f)->display.x->font))
576
577/* Return the pixel width/height of frame F if it has
578 WIDTH columns/HEIGHT rows. */
c8e3cbe0 579#define CHAR_TO_PIXEL_WIDTH(f, width) \
4e027793 580 (CHAR_TO_PIXEL_COL (f, width) \
a3c87d4e 581 + (f)->display.x->vertical_scroll_bar_extra \
4e027793 582 + (f)->display.x->internal_border_width)
c8e3cbe0 583#define CHAR_TO_PIXEL_HEIGHT(f, height) \
4e027793
JB
584 (CHAR_TO_PIXEL_ROW (f, height) \
585 + (f)->display.x->internal_border_width)
c8e3cbe0 586
c8e3cbe0 587
4e027793
JB
588/* Return the row/column (zero-based) of the character cell containing
589 the pixel on FRAME at ROW/COL. */
cecfe612 590#define PIXEL_TO_CHAR_ROW(f, row) \
4e027793 591 (((row) - (f)->display.x->internal_border_width) \
2ba6876c 592 / (f)->display.x->line_height)
cecfe612 593#define PIXEL_TO_CHAR_COL(f, col) \
4e027793
JB
594 (((col) - (f)->display.x->internal_border_width) \
595 / FONT_WIDTH ((f)->display.x->font))
c8e3cbe0 596
4e027793
JB
597/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
598 frame F? */
599#define PIXEL_TO_CHAR_WIDTH(f, width) \
600 (PIXEL_TO_CHAR_COL (f, ((width) \
601 - (f)->display.x->internal_border_width \
a3c87d4e 602 - (f)->display.x->vertical_scroll_bar_extra)))
4e027793
JB
603#define PIXEL_TO_CHAR_HEIGHT(f, height) \
604 (PIXEL_TO_CHAR_ROW (f, ((height) \
605 - (f)->display.x->internal_border_width)))
c352056c
RS
606\f
607/* If a struct input_event has a kind which is selection_request_event
608 or selection_clear_event, then its contents are really described
609 by this structure. */
610
611/* For an event of kind selection_request_event,
612 this structure really describes the contents. */
613struct selection_input_event
614{
615 int kind;
616 Display *display;
617 Window requestor;
618 Atom selection, target, property;
619 Time time;
620};
621
622#define SELECTION_EVENT_DISPLAY(eventp) \
623 (((struct selection_input_event *) (eventp))->display)
624#define SELECTION_EVENT_REQUESTOR(eventp) \
625 (((struct selection_input_event *) (eventp))->requestor)
626#define SELECTION_EVENT_SELECTION(eventp) \
627 (((struct selection_input_event *) (eventp))->selection)
628#define SELECTION_EVENT_TARGET(eventp) \
629 (((struct selection_input_event *) (eventp))->target)
630#define SELECTION_EVENT_PROPERTY(eventp) \
631 (((struct selection_input_event *) (eventp))->property)
632#define SELECTION_EVENT_TIME(eventp) \
633 (((struct selection_input_event *) (eventp))->time)
bf489d26
JB
634
635\f
636/* Interface to the face code functions. */
637
28f72798
JB
638/* Create the first two computed faces for a frame -- the ones that
639 have GC's. */
bf489d26
JB
640extern void init_frame_faces (/* FRAME_PTR */);
641
642/* Free the resources for the faces associated with a frame. */
643extern void free_frame_faces (/* FRAME_PTR */);
644
28f72798 645/* Given a computed face, find or make an equivalent display face
bf489d26
JB
646 in face_vector, and return a pointer to it. */
647extern struct face *intern_face (/* FRAME_PTR, struct face * */);
648
649/* Given a frame and a face name, return the face's ID number, or
650 zero if it isn't a recognized face name. */
651extern int face_name_id_number (/* FRAME_PTR, Lisp_Object */);
652
653/* Return non-zero if FONT1 and FONT2 have the same size bounding box.
654 We assume that they're both character-cell fonts. */
655extern int same_size_fonts (/* XFontStruct *, XFontStruct * */);
656
657/* Recompute the GC's for the default and modeline faces.
658 We call this after changing frame parameters on which those GC's
659 depend. */
660extern void recompute_basic_faces (/* FRAME_PTR */);
661
28f72798
JB
662/* Return the face ID associated with a buffer position POS. Store
663 into *ENDPTR the next position at which a different face is
664 needed. This does not take account of glyphs that specify their
665 own face codes. F is the frame in use for display, and W is a
666 window displaying the current buffer.
bf489d26
JB
667
668 REGION_BEG, REGION_END delimit the region, so it can be highlighted. */
669extern int compute_char_face (/* FRAME_PTR frame,
670 struct window *w,
671 int pos,
672 int region_beg, int region_end,
673 int *endptr */);
674/* Return the face ID to use to display a special glyph which selects
675 FACE_CODE as the face ID, assuming that ordinarily the face would
676 be BASIC_FACE. F is the frame. */
677extern int compute_glyph_face (/* FRAME_PTR, int */);