(add_menu_item, w32_menu_display_help) [USE_LISP_UNION_TYPE]: Cast
[bpt/emacs.git] / src / w32term.h
CommitLineData
de31b97a 1/* Definitions and headers for communication on the Microsoft W32 API.
5fa36066 2 Copyright (C) 1995, 2001 Free Software Foundation, Inc.
c3b8ccce
GV
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
8the Free Software Foundation; either version 2, or (at your option)
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
3b7ad313
EN
18the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19Boston, MA 02111-1307, USA. */
c3b8ccce
GV
20
21/* Added by Kevin Gallo */
22
51dcffad 23#include "w32gui.h"
c3b8ccce 24
c3b8ccce 25\f
3fed86ff
GV
26#define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
27#define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
c3b8ccce 28
25d9ec8c
GV
29#define FONT_WIDTH(f) \
30 ((f)->bdf ? (f)->bdf->width : (f)->tm.tmAveCharWidth)
31#define FONT_HEIGHT(f) \
32 ((f)->bdf ? (f)->bdf->height : (f)->tm.tmHeight)
25d9ec8c
GV
33#define FONT_BASE(f) \
34 ((f)->bdf ? (f)->bdf->ury : (f)->tm.tmAscent)
51dcffad 35#define FONT_DESCENT(f) \
905dfb8e 36 ((f)->bdf ? -((f)->bdf->lly) : (f)->tm.tmDescent)
25d9ec8c
GV
37#define FONT_MAX_WIDTH(f) \
38 ((f)->bdf ? (f)->bdf->width : (f)->tm.tmMaxCharWidth)
c3b8ccce 39
ad23de76 40#define CP_DEFAULT 1004
67526daf 41/* Special pseudo-codepages. */
6205b7ce
JR
42#define CP_8BIT -1
43#define CP_UNICODE -2
b6097c15 44#define CP_UNKNOWN -3
ad23de76 45
fbd6baed 46#define CHECK_W32_FRAME(f, frame) \
c3b8ccce 47 if (NILP (frame)) \
51dcffad 48 f = SELECTED_FRAME (); \
c3b8ccce
GV
49 else \
50 { \
51 CHECK_LIVE_FRAME (frame, 0); \
52 f = XFRAME (frame); \
53 } \
fbd6baed 54 if (! FRAME_W32_P (f))
c3b8ccce
GV
55
56/* Indicates whether we are in the readsocket call and the message we
57 are processing in the current loop */
58
59extern MSG CurMsg;
60extern BOOL bUseDflt;
61
62extern struct frame *x_window_to_frame ();
63
c3b8ccce
GV
64/* Structure recording bitmaps and reference count.
65 If REFCOUNT is 0 then this record is free to be reused. */
66
177c0ea7 67struct w32_bitmap_record
c3b8ccce
GV
68{
69 Pixmap pixmap;
70 char *file;
71 HINSTANCE hinst; /* Used to load the file */
72 int refcount;
73 /* Record some info about this pixmap. */
74 int height, width, depth;
75};
aba66c88
GV
76
77/* Palette book-keeping stuff for mapping requested colors into the
78 system palette. Keep a ref-counted list of requested colors and
79 regenerate the app palette whenever the requested list changes. */
80
fbd6baed 81extern Lisp_Object Vw32_enable_palette;
aba66c88 82
fbd6baed
GV
83struct w32_palette_entry {
84 struct w32_palette_entry * next;
aba66c88
GV
85 PALETTEENTRY entry;
86#if 0
87 unsigned refcount;
88#endif
89};
90
fbd6baed 91extern void w32_regenerate_palette(struct frame *f);
aba66c88 92
c3b8ccce 93\f
fbd6baed 94/* For each display (currently only one on w32), we have a structure that
c3b8ccce
GV
95 records information about it. */
96
fbd6baed 97struct w32_display_info
c3b8ccce 98{
fbd6baed
GV
99 /* Chain of all w32_display_info structures. */
100 struct w32_display_info *next;
51dcffad 101
c3b8ccce
GV
102 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
103 The same cons cell also appears in x_display_name_list. */
104 Lisp_Object name_list_element;
51dcffad 105
c3b8ccce
GV
106 /* Number of frames that are on this display. */
107 int reference_count;
51dcffad
JR
108
109 /* Dots per inch of the screen. */
110 double resx, resy;
111
c3b8ccce
GV
112 /* Number of planes on this screen. */
113 int n_planes;
51dcffad 114
c3b8ccce
GV
115 /* Number of bits per pixel on this screen. */
116 int n_cbits;
51dcffad 117
c3b8ccce
GV
118 /* Dimensions of this screen. */
119 int height, width;
120 int height_in,width_in;
51dcffad 121
c3b8ccce
GV
122 /* Mask of things that cause the mouse to be grabbed. */
123 int grabbed;
51dcffad
JR
124
125 /* Emacs bitmap-id of the default icon bitmap for this frame.
126 Or -1 if none has been allocated yet. */
127 int icon_bitmap_id;
128
c3b8ccce
GV
129 /* The root window of this screen. */
130 Window root_window;
51dcffad 131
c3b8ccce
GV
132 /* The cursor to use for vertical scroll bars. */
133 Cursor vertical_scroll_bar_cursor;
134
71147653 135 /* Resource data base */
abdb2fa0 136 XrmDatabase xrdb;
71147653 137
bb355434 138 /* color palette information. */
aba66c88 139 int has_palette;
fbd6baed 140 struct w32_palette_entry * color_list;
aba66c88
GV
141 unsigned num_colors;
142 HPALETTE palette;
143
bb355434 144 /* deferred action flags checked when starting frame update. */
aba66c88
GV
145 int regen_palette;
146
bb355434
GV
147 /* Keystroke that has been faked by Emacs and will be ignored when
148 received; value is reset after key is received. */
149 int faked_key;
150
c3b8ccce
GV
151 /* A table of all the fonts we have already loaded. */
152 struct font_info *font_table;
153
d82f9149 154 /* The current capacity of font_table. */
c3b8ccce
GV
155 int font_table_size;
156
51dcffad
JR
157 /* Minimum width over all characters in all fonts in font_table. */
158 int smallest_char_width;
159
160 /* Minimum font height over all fonts in font_table. */
161 int smallest_font_height;
162
163 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
164 XGCValues *scratch_cursor_gc;
165
166 /* These variables describe the range of text currently shown in its
167 mouse-face, together with the window they apply to. As long as
168 the mouse stays within this range, we need not redraw anything on
169 its account. Rows and columns are glyph matrix positions in
170 MOUSE_FACE_WINDOW. */
c3b8ccce 171 int mouse_face_beg_row, mouse_face_beg_col;
51dcffad 172 int mouse_face_beg_x, mouse_face_beg_y;
c3b8ccce 173 int mouse_face_end_row, mouse_face_end_col;
51dcffad 174 int mouse_face_end_x, mouse_face_end_y;
c3b8ccce
GV
175 int mouse_face_past_end;
176 Lisp_Object mouse_face_window;
177 int mouse_face_face_id;
42bde733 178 Lisp_Object mouse_face_overlay;
c3b8ccce
GV
179
180 /* 1 if a mouse motion event came and we didn't handle it right away because
181 gc was in progress. */
182 int mouse_face_deferred_gc;
183
184 /* FRAME and X, Y position of mouse when last checked for
185 highlighting. X and Y can be negative or out of range for the frame. */
186 struct frame *mouse_face_mouse_frame;
187 int mouse_face_mouse_x, mouse_face_mouse_y;
188
189 /* Nonzero means defer mouse-motion highlighting. */
190 int mouse_face_defer;
191
f16c05f2
KS
192 /* Nonzero means that the mouse highlight should not be shown. */
193 int mouse_face_hidden;
194
51dcffad
JR
195 int mouse_face_image_state;
196
fbd6baed 197 char *w32_id_name;
c3b8ccce 198
fbd6baed 199 /* The number of fonts actually stored in w32_font_table.
51dcffad
JR
200 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
201 n_fonts <= font_table_size. and font_table[i].name != 0. */
c3b8ccce
GV
202 int n_fonts;
203
204 /* Pointer to bitmap records. */
fbd6baed 205 struct w32_bitmap_record *bitmaps;
c3b8ccce
GV
206
207 /* Allocated size of bitmaps field. */
208 int bitmaps_size;
209
210 /* Last used bitmap index. */
211 int bitmaps_last;
212
213 /* The frame (if any) which has the window that has keyboard focus.
214 Zero if none. This is examined by Ffocus_frame in w32fns.c. Note
215 that a mere EnterNotify event can set this; if you need to know the
216 last frame specified in a FocusIn or FocusOut event, use
fbd6baed
GV
217 w32_focus_event_frame. */
218 struct frame *w32_focus_frame;
c3b8ccce
GV
219
220 /* The last frame mentioned in a FocusIn or FocusOut event. This is
fbd6baed 221 separate from w32_focus_frame, because whether or not LeaveNotify
c3b8ccce
GV
222 events cause us to lose focus depends on whether or not we have
223 received a FocusIn event for it. */
fbd6baed 224 struct frame *w32_focus_event_frame;
c3b8ccce
GV
225
226 /* The frame which currently has the visual highlight, and should get
227 keyboard input (other sorts of input have the frame encoded in the
228 event). It points to the focus frame's selected window's
fbd6baed 229 frame. It differs from w32_focus_frame when we're using a global
c3b8ccce 230 minibuffer. */
6b3acc48 231 struct frame *x_highlight_frame;
51dcffad
JR
232
233 /* Cache of images. */
234 struct image_cache *image_cache;
c3b8ccce
GV
235};
236
237/* This is a chain of structures for all the displays currently in use. */
8911aff3 238extern struct w32_display_info *x_display_list;
fbd6baed 239extern struct w32_display_info one_w32_display_info;
c3b8ccce
GV
240
241/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
fbd6baed 242 one for each element of w32_display_list and in the same order.
c3b8ccce
GV
243 NAME is the name of the frame.
244 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
fbd6baed 245extern Lisp_Object w32_display_name_list;
c3b8ccce 246
d82f9149
GV
247/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
248extern Lisp_Object Vx_pixel_size_width_font_regexp;
249
250/* A flag to control how to display unibyte 8-bit character. */
251extern int unibyte_display_via_language_environment;
252
51dcffad 253struct w32_display_info *x_display_info_for_name ();
c3b8ccce 254
fbd6baed 255extern struct w32_display_info *w32_term_init ();
c3b8ccce 256\f
51dcffad 257extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
d82f9149 258extern struct font_info *w32_get_font_info (), *w32_query_font ();
eeddd5a0 259extern void w32_cache_char_metrics (XFontStruct *font);
d82f9149
GV
260extern void w32_find_ccl_program();
261\f
51dcffad
JR
262#define PIX_TYPE COLORREF
263
fbd6baed
GV
264/* Each W32 frame object points to its own struct w32_display object
265 in the output_data.w32 field. The w32_display structure contains all
266 the information that is specific to W32 windows. */
c3b8ccce 267
51dcffad
JR
268/* Put some things in x_output for compatibility.
269 NTEMACS_TODO: Move all common things here to eliminate unneccesary
270 diffs between X and w32 code. */
271struct x_output
272{
273 PIX_TYPE background_pixel;
274 PIX_TYPE foreground_pixel;
275};
276
277
fbd6baed 278struct w32_output
c3b8ccce 279{
51dcffad 280 /* Placeholder for things accessed through output_data.x. */
42bde733 281 struct x_output x_compatible;
51dcffad 282
8694f11b
GV
283 /* Menubar "widget" handle. */
284 HMENU menubar_widget;
285
aba66c88
GV
286 /* Original palette (used to deselect real palette after drawing) */
287 HPALETTE old_palette;
288
51dcffad
JR
289 /* Here are the Graphics Contexts for the default font. */
290 XGCValues *cursor_gc; /* cursor drawing */
291
c3b8ccce
GV
292 /* The window used for this frame.
293 May be zero while the frame object is being created
294 and the window has not yet been created. */
295 Window window_desc;
296
297 /* The window that is the parent of this window.
298 Usually this is a window that was made by the window manager,
299 but it can be the root window, and it can be explicitly specified
300 (see the explicit_parent field, below). */
301 Window parent_desc;
302
d82f9149 303 /* Default ASCII font of this frame. */
c3b8ccce
GV
304 XFontStruct *font;
305
51dcffad
JR
306 /* The baseline offset of the default ASCII font. */
307 int baseline_offset;
d82f9149
GV
308
309 /* If a fontset is specified for this frame instead of font, this
310 value contains an ID of the fontset, else -1. */
311 int fontset;
312
c3b8ccce
GV
313 /* Pixel values used for various purposes.
314 border_pixel may be -1 meaning use a gray tile. */
51dcffad
JR
315 COLORREF cursor_pixel;
316 COLORREF border_pixel;
317 COLORREF mouse_pixel;
318 COLORREF cursor_foreground_pixel;
319
320 /* Foreground color for scroll bars. A value of -1 means use the
321 default (black for non-toolkit scroll bars). */
322 COLORREF scroll_bar_foreground_pixel;
177c0ea7 323
51dcffad
JR
324 /* Background color for scroll bars. A value of -1 means use the
325 default (background color of the frame for non-toolkit scroll
326 bars). */
327 COLORREF scroll_bar_background_pixel;
c3b8ccce
GV
328
329 /* Descriptor for the cursor in use for this window. */
330 Cursor text_cursor;
331 Cursor nontext_cursor;
332 Cursor modeline_cursor;
b8a93676 333 Cursor hand_cursor;
5fa36066 334 Cursor hourglass_cursor;
f03fad22 335 Cursor horizontal_drag_cursor;
51dcffad 336
5fa36066
GM
337 /* Window whose cursor is hourglass_cursor. This window is
338 temporarily mapped to display an hourglass cursor. */
339 Window hourglass_window;
177c0ea7 340
5fa36066
GM
341 /* Non-zero means hourglass cursor is currently displayed. */
342 unsigned hourglass_p : 1;
c3b8ccce
GV
343
344 /* Flag to set when the window needs to be completely repainted. */
345 int needs_exposure;
346
c3b8ccce
GV
347 DWORD dwStyle;
348
c3b8ccce 349 /* This is the Emacs structure for the display this frame is on. */
fbd6baed 350 /* struct w32_display_info *display_info; */
c3b8ccce
GV
351
352 /* Nonzero means our parent is another application's window
353 and was explicitly specified. */
354 char explicit_parent;
355
356 /* Nonzero means tried already to make this frame visible. */
357 char asked_for_visible;
8694f11b
GV
358
359 /* Nonzero means menubar is currently active. */
360 char menubar_active;
361
823b64b0
JR
362 /* Nonzero means a menu command is being processed. */
363 char menu_command_in_progress;
364
8694f11b
GV
365 /* Nonzero means menubar is about to become active, but should be
366 brought up to date first. */
367 volatile char pending_menu_activation;
51dcffad
JR
368
369 /* Relief GCs, colors etc. */
370 struct relief
371 {
372 XGCValues *gc;
373 unsigned long pixel;
374 int allocated_p;
375 }
376 black_relief, white_relief;
377
378 /* The background for which the above relief GCs were set up.
379 They are changed only when a different background is involved. */
380 unsigned long relief_background;
c3b8ccce
GV
381};
382
2d764c78
EZ
383extern struct w32_output w32term_display;
384
8e025dd5
KS
385/* Return the X output data for frame F. */
386#define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
387
c3b8ccce 388/* Return the window associated with the frame F. */
fbd6baed 389#define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
8e025dd5 390#define FRAME_X_WINDOW(f) ((f)->output_data.w32->window_desc)
c3b8ccce 391
51dcffad
JR
392#define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
393#define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
fbd6baed 394#define FRAME_FONT(f) ((f)->output_data.w32->font)
d82f9149 395#define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
51dcffad 396#define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
c3b8ccce 397
fbd6baed
GV
398/* This gives the w32_display_info structure for the display F is on. */
399#define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
51dcffad 400#define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
c3b8ccce 401
8e025dd5
KS
402/* This is the `Display *' which frame F is on. */
403#define FRAME_X_DISPLAY(f) (0)
404
d82f9149
GV
405/* This is the 'font_info *' which frame F has. */
406#define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
407
51dcffad
JR
408/* Value is the smallest width of any character in any font on frame F. */
409
410#define FRAME_SMALLEST_CHAR_WIDTH(F) \
411 FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
412
413/* Value is the smallest height of any font on frame F. */
414
415#define FRAME_SMALLEST_FONT_HEIGHT(F) \
416 FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
417
418/* Return a pointer to the image cache of frame F. */
419
420#define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
421
422\f
fbd6baed 423/* W32-specific scroll bar stuff. */
c3b8ccce
GV
424
425/* We represent scroll bars as lisp vectors. This allows us to place
426 references to them in windows without worrying about whether we'll
427 end up with windows referring to dead scroll bars; the garbage
428 collector will free it when its time comes.
429
430 We use struct scroll_bar as a template for accessing fields of the
431 vector. */
432
433struct scroll_bar {
434
435 /* These fields are shared by all vectors. */
436 EMACS_INT size_from_Lisp_Vector_struct;
437 struct Lisp_Vector *next_from_Lisp_Vector_struct;
438
439 /* The window we're a scroll bar for. */
440 Lisp_Object window;
441
442 /* The next and previous in the chain of scroll bars in this frame. */
443 Lisp_Object next, prev;
444
445 /* The window representing this scroll bar. Since this is a full
446 32-bit quantity, we store it split into two 32-bit values. */
fbd6baed 447 Lisp_Object w32_window_low, w32_window_high;
c3b8ccce 448
51dcffad
JR
449 /* Same as above for the widget. */
450 Lisp_Object w32_widget_low, w32_widget_high;
451
c3b8ccce
GV
452 /* The position and size of the scroll bar in pixels, relative to the
453 frame. */
454 Lisp_Object top, left, width, height;
455
456 /* The starting and ending positions of the handle, relative to the
457 handle area (i.e. zero is the top position, not
458 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
459 hasn't been drawn yet.
460
461 These are not actually the locations where the beginning and end
462 are drawn; in order to keep handles from becoming invisible when
463 editing large files, we establish a minimum height by always
464 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
465 where they would be normally; the bottom and top are in a
466 different co-ordinate system. */
467 Lisp_Object start, end;
468
469 /* If the scroll bar handle is currently being dragged by the user,
470 this is the number of pixels from the top of the handle to the
471 place where the user grabbed it. If the handle isn't currently
472 being dragged, this is Qnil. */
473 Lisp_Object dragging;
474};
475
476/* The number of elements a vector holding a struct scroll_bar needs. */
477#define SCROLL_BAR_VEC_SIZE \
478 ((sizeof (struct scroll_bar) \
479 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
480 / sizeof (Lisp_Object))
481
482/* Turning a lisp vector value into a pointer to a struct scroll_bar. */
483#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
484
485
486/* Building a 32-bit C integer from two 16-bit lisp integers. */
487#define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
488
489/* Setting two lisp integers to the low and high words of a 32-bit C int. */
490#define SCROLL_BAR_UNPACK(low, high, int32) \
491 (XSETINT ((low), (int32) & 0xffff), \
492 XSETINT ((high), ((int32) >> 16) & 0xffff))
493
494
495/* Extract the window id of the scroll bar from a struct scroll_bar. */
fbd6baed
GV
496#define SCROLL_BAR_W32_WINDOW(ptr) \
497 ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
c3b8ccce
GV
498
499/* Store a window id in a struct scroll_bar. */
fbd6baed
GV
500#define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
501 (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
c3b8ccce 502
51dcffad
JR
503/* Extract the X widget of the scroll bar from a struct scroll_bar. */
504#define SCROLL_BAR_X_WIDGET(ptr) \
505 ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
c3b8ccce 506
51dcffad
JR
507/* Store a widget id in a struct scroll_bar. */
508#define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
509 (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
c3b8ccce
GV
510
511/* Return the inside width of a vertical scroll bar, given the outside
512 width. */
51dcffad
JR
513#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
514 ((width) \
515 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
516 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
517 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
c3b8ccce
GV
518
519/* Return the length of the rectangle within which the top of the
520 handle must stay. This isn't equivalent to the inside height,
177c0ea7 521 because the scroll bar handle has a minimum height.
c3b8ccce
GV
522
523 This is the real range of motion for the scroll bar, so when we're
524 scaling buffer positions to scroll bar positions, we use this, not
525 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
51dcffad
JR
526#define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
527 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
c3b8ccce
GV
528
529/* Return the inside height of vertical scroll bar, given the outside
530 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
51dcffad 531#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
c3b8ccce
GV
532 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
533
534
535/* Border widths for scroll bars.
536
537 Scroll bar windows don't have any borders; their border width is
538 set to zero, and we redraw borders ourselves. This makes the code
539 a bit cleaner, since we don't have to convert between outside width
540 (used when relating to the rest of the screen) and inside width
541 (used when sizing and drawing the scroll bar window itself).
542
543 The handle moves up and down/back and forth in a rectangle inset
544 from the edges of the scroll bar. These are widths by which we
545 inset the handle boundaries from the scroll bar edges. */
546#define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
547#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
8694f11b
GV
548#define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
549#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
c3b8ccce
GV
550
551/* Minimum lengths for scroll bar handles, in pixels. */
8694f11b
GV
552#define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
553
51dcffad
JR
554/* Trimming off a few pixels from each side prevents
555 text from glomming up against the scroll bar */
556#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
c3b8ccce
GV
557
558\f
fbd6baed
GV
559extern void w32_fill_rect ();
560extern void w32_clear_window ();
c3b8ccce 561
fbd6baed 562#define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
c3b8ccce
GV
563{ \
564 RECT rect; \
565 rect.left = x; \
566 rect.top = y; \
567 rect.right = x + nx; \
568 rect.bottom = y + ny; \
fbd6baed 569 w32_fill_rect (f,hdc,pix,&rect); \
c3b8ccce
GV
570}
571
fbd6baed 572#define w32_clear_rect(f,hdc,lprect) \
51dcffad 573w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
c3b8ccce 574
51dcffad
JR
575#define w32_clear_area(f,hdc,px,py,nx,ny) \
576w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
c3b8ccce 577
d82f9149 578extern struct font_info *w32_load_font ();
fbd6baed 579extern void w32_unload_font ();
c3b8ccce 580
8694f11b
GV
581/* Define for earlier versions of Visual C */
582#ifndef WM_MOUSEWHEEL
f11f6cce 583#define WM_MOUSEWHEEL (WM_MOUSELAST + 1)
8694f11b 584#endif /* WM_MOUSEWHEEL */
f11f6cce
GV
585#ifndef MSH_MOUSEWHEEL
586#define MSH_MOUSEWHEEL "MSWHEEL_ROLLMSG"
587#endif /* MSH_MOUSEWHEEL */
76e4fd8c
JR
588#ifndef WM_XBUTTONDOWN
589#define WM_XBUTTONDOWN (WM_MOUSEWHEEL + 1)
590#define WM_XBUTTONUP (WM_MOUSEWHEEL + 2)
591#endif /* WM_XBUTTONDOWN */
8694f11b 592
c3b8ccce 593#define WM_EMACS_START (WM_USER + 1)
bb355434
GV
594#define WM_EMACS_KILL (WM_EMACS_START + 0)
595#define WM_EMACS_CREATEWINDOW (WM_EMACS_START + 1)
596#define WM_EMACS_DONE (WM_EMACS_START + 2)
597#define WM_EMACS_CREATESCROLLBAR (WM_EMACS_START + 3)
598#define WM_EMACS_SHOWWINDOW (WM_EMACS_START + 4)
599#define WM_EMACS_SETWINDOWPOS (WM_EMACS_START + 5)
600#define WM_EMACS_DESTROYWINDOW (WM_EMACS_START + 6)
601#define WM_EMACS_TRACKPOPUPMENU (WM_EMACS_START + 7)
602#define WM_EMACS_SETFOCUS (WM_EMACS_START + 8)
603#define WM_EMACS_SETFOREGROUND (WM_EMACS_START + 9)
604#define WM_EMACS_SETLOCALE (WM_EMACS_START + 10)
605#define WM_EMACS_SETKEYBOARDLAYOUT (WM_EMACS_START + 11)
606#define WM_EMACS_REGISTER_HOT_KEY (WM_EMACS_START + 12)
607#define WM_EMACS_UNREGISTER_HOT_KEY (WM_EMACS_START + 13)
93066bc2 608#define WM_EMACS_TOGGLE_LOCK_KEY (WM_EMACS_START + 14)
64ade657
JR
609#define WM_EMACS_TRACK_CARET (WM_EMACS_START + 15)
610#define WM_EMACS_DESTROY_CARET (WM_EMACS_START + 16)
ab8b2d20
JR
611#define WM_EMACS_SHOW_CARET (WM_EMACS_START + 17)
612#define WM_EMACS_HIDE_CARET (WM_EMACS_START + 18)
f3358105
JR
613#define WM_EMACS_SETCURSOR (WM_EMACS_START + 19)
614#define WM_EMACS_END (WM_EMACS_START + 20)
c3b8ccce 615
177c0ea7
JB
616#define WND_FONTWIDTH_INDEX (0)
617#define WND_LINEHEIGHT_INDEX (4)
618#define WND_BORDER_INDEX (8)
619#define WND_SCROLLBAR_INDEX (12)
620#define WND_BACKGROUND_INDEX (16)
8694f11b 621#define WND_LAST_INDEX (20)
c3b8ccce 622
c3b8ccce
GV
623#define WND_EXTRA_BYTES (WND_LAST_INDEX)
624
de31b97a
GV
625extern DWORD dwWindowsThreadId;
626extern HANDLE hWindowsThread;
c3b8ccce
GV
627extern DWORD dwMainThreadId;
628extern HANDLE hMainThread;
629
fbd6baed 630typedef struct W32Msg {
c3b8ccce
GV
631 MSG msg;
632 DWORD dwModifiers;
633 RECT rect;
fbd6baed 634} W32Msg;
c3b8ccce 635
8694f11b
GV
636/* Structure for recording message when input thread must return a
637 result that depends on lisp thread to compute. Lisp thread can
638 complete deferred messages out of order. */
639typedef struct deferred_msg
640{
641 struct deferred_msg * next;
642 W32Msg w32msg;
643 LRESULT result;
644 int completed;
645} deferred_msg;
646
aba66c88
GV
647extern CRITICAL_SECTION critsect;
648
c3b8ccce 649extern void init_crit ();
c3b8ccce
GV
650extern void delete_crit ();
651
b44c3d59
RS
652extern void signal_quit ();
653
aba66c88
GV
654#define enter_crit() EnterCriticalSection (&critsect)
655#define leave_crit() LeaveCriticalSection (&critsect)
656
657extern void select_palette (struct frame * f, HDC hdc);
658extern void deselect_palette (struct frame * f, HDC hdc);
659extern HDC get_frame_dc (struct frame * f);
660extern int release_frame_dc (struct frame * f, HDC hDC);
661
b37ac782
AI
662extern void drain_message_queue ();
663
c3b8ccce
GV
664extern BOOL get_next_msg ();
665extern BOOL post_msg ();
8694f11b 666extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
c3b8ccce
GV
667extern void wait_for_sync ();
668
669extern BOOL parse_button ();
c684f475 670
fbd6baed 671/* Keypad command key support. W32 doesn't have virtual keys defined
c684f475
GV
672 for the function keys on the keypad (they are mapped to the standard
673 fuction keys), so we define our own. */
674#define VK_NUMPAD_BEGIN 0x92
675#define VK_NUMPAD_CLEAR (VK_NUMPAD_BEGIN + 0)
676#define VK_NUMPAD_ENTER (VK_NUMPAD_BEGIN + 1)
677#define VK_NUMPAD_PRIOR (VK_NUMPAD_BEGIN + 2)
678#define VK_NUMPAD_NEXT (VK_NUMPAD_BEGIN + 3)
679#define VK_NUMPAD_END (VK_NUMPAD_BEGIN + 4)
680#define VK_NUMPAD_HOME (VK_NUMPAD_BEGIN + 5)
681#define VK_NUMPAD_LEFT (VK_NUMPAD_BEGIN + 6)
682#define VK_NUMPAD_UP (VK_NUMPAD_BEGIN + 7)
683#define VK_NUMPAD_RIGHT (VK_NUMPAD_BEGIN + 8)
684#define VK_NUMPAD_DOWN (VK_NUMPAD_BEGIN + 9)
685#define VK_NUMPAD_INSERT (VK_NUMPAD_BEGIN + 10)
686#define VK_NUMPAD_DELETE (VK_NUMPAD_BEGIN + 11)
687
688#ifndef VK_LWIN
689/* Older compiler environments don't have these defined. */
690#define VK_LWIN 0x5B
691#define VK_RWIN 0x5C
692#define VK_APPS 0x5D
693#endif
bb355434
GV
694
695/* Support for treating Windows and Apps keys as modifiers. These
696 constants must not overlap with any of the dwControlKeyState flags in
697 KEY_EVENT_RECORD. */
698#define LEFT_WIN_PRESSED 0x8000
699#define RIGHT_WIN_PRESSED 0x4000
700#define APPS_PRESSED 0x2000
51dcffad 701
a81bf19b
JR
702/* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
703 (even though they are supported on 98 and ME. */
704#ifndef WM_MOUSELEAVE
705#define WM_MOUSELEAVE 0x02A3
706#define TME_LEAVE 0x00000002;
707
177c0ea7 708typedef struct tagTRACKMOUSEEVENT
a81bf19b
JR
709{
710 DWORD cbSize;
711 DWORD dwFlags;
712 HWND hwndTrack;
713 DWORD dwHoverTime;
714} TRACKMOUSEEVENT;
715#endif
716
9f21c5a2
EZ
717struct image;
718struct face;
719
51dcffad
JR
720XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
721struct frame * check_x_frame (Lisp_Object);
ad23de76
JR
722EXFUN (Fx_display_color_p, 1);
723EXFUN (Fx_display_grayscale_p, 1);
8e025dd5
KS
724
725#define FONT_TYPE_FOR_UNIBYTE(font, ch) \
726 ((font)->bdf ? BDF_1D_FONT : ANSI_FONT)
727
728#define FONT_TYPE_FOR_MULTIBYTE(font, ch) \
729 (!(font)->bdf \
730 ? UNICODE_FONT \
731 : ((CHARSET_DIMENSION (CHAR_CHARSET ((ch))) == 1) \
732 ? BDF_1D_FONT : BDF_2D_FONT))
0390f991
JR
733
734typedef DWORD (WINAPI * ClipboardSequence_Proc) ();
ab5796a9
MB
735
736/* arch-tag: f201d05a-1240-4fc5-8ea4-ca24d4ee5671
737 (do not change this comment) */