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